Merge pull request #99 from cronofy/query-periods

Support query periods for Real-Time Scheduling and Real-Time Sequencing

Author: gshutler

.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.5

CHANGELOG.md

@@ -1,22 +1,26 @@
+## [0.37.5]
+
+ * Support `query_periods` as well as the original `available_periods` for Real-Time Scheduling and Real-Time Sequencing [#99]
+
 ## [0.37.4]
 
-* Support client_secret only clients being able to authorize `#availability` calls. [#97]
+ * Support client_secret only clients being able to authorize `#availability` calls. [#97]
 
 ## [0.37.3]
 
- * Support `hmac_valid` as well as the original `hmac_match` for Client to verify a HMAC from a push notification using the client's secret.[#95] 
+ * Support `hmac_valid` as well as the original `hmac_match` for Client to verify a HMAC from a push notification using the client's secret.[#95]
 
 ## [0.37.2]
 
- * Support `query_periods` as well as the original `available_periods` for Availability Query and Sequenced Availability [#91] 
+ * Support `query_periods` as well as the original `available_periods` for Availability Query and Sequenced Availability [#91]
 
 ## [0.37.1]
 
- * Rename `data_centre` to `data_centre` (with aliases for backwards compatibility) [#90] 
+ * Rename `data_centre` to `data_centre` (with aliases for backwards compatibility) [#90]
 
 ## [0.37.0]
 
- * Add `revoke_by_token` and `revoke_by_sub` to the Client [#86] 
+ * Add `revoke_by_token` and `revoke_by_sub` to the Client [#86]
 
 ## [0.36.1]
 
@@ -197,6 +201,7 @@
 [0.37.2]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.2
 [0.37.3]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.3
 [0.37.4]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.4
+[0.37.5]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.5
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -243,3 +248,4 @@
 [#91]: https://github.com/cronofy/cronofy-ruby/pull/91
 [#95]: https://github.com/cronofy/cronofy-ruby/pull/95
 [#97]: https://github.com/cronofy/cronofy-ruby/pull/97
+[#99]: https://github.com/cronofy/cronofy-ruby/pull/99

lib/cronofy/client.rb

@@ -1033,7 +1033,7 @@ def add_to_calendar(args = {})
     #                                         call
     #                    :required_duration - A hash stating the length of time the event will
     #                                         last for
-    #                    :available_periods - A hash stating the available periods for the event
+    #                    :query_periods     - A hash stating the available periods for the event
     #                    :start_interval    - An Integer representing the start interval
     #                                         of minutes for the availability query.
     #                    :buffer            - An Hash containing the buffer to apply to
@@ -1069,7 +1069,7 @@ def add_to_calendar(args = {})
     #       }
     #     ],
     #     required_duration: { minutes: 60 },
-    #     available_periods: [{
+    #     query_periods: [{
     #       start: Time.utc(2017, 1, 1, 9, 00),
     #       end:   Time.utc(2017, 1, 1, 17, 00),
     #     }]
@@ -1110,7 +1110,7 @@ def real_time_scheduling(args = {})
         end
       end
 
-      translate_available_periods(availability[:available_periods])
+      translate_available_periods(availability[:query_periods] || availability[:available_periods])
       body[:availability] = availability
 
       response = raw_post("/v1/real_time_scheduling", body)
@@ -1176,7 +1176,7 @@ def real_time_scheduling(args = {})
     #                                         an array of invitees to invite to or reject from
     #                                         the event. Invitees are represented by a hash of
     #                                         :email and :display_name (optional).
-    #          :available_periods - A hash stating the available periods for the event
+    #          :query_periods - A hash stating the query periods for the event
     # target_calendars - An array of hashes stating into which calendars to insert the created
     #                    event
     # Raises Cronofy::CredentialsMissingError if no credentials available.
@@ -1194,7 +1194,8 @@ def real_time_sequencing(args)
 
       if availability = args[:availability]
         availability[:sequence] = map_availability_sequence(availability[:sequence])
-        translate_available_periods(availability[:available_periods]) if availability[:available_periods]
+        periods = availability[:query_periods] || availability[:available_periods]
+        translate_available_periods(periods) if periods
       end
 
       body[:availability] = availability
@@ -1748,8 +1749,10 @@ def map_availability_sequence(sequence)
             hash[:required_duration] = map_availability_required_duration(value)
           end
 
-          if sequence_item[:available_periods]
-            translate_available_periods(sequence_item[:available_periods])
+          periods = sequence_item[:query_periods] || sequence_item[:available_periods]
+
+          if periods
+            translate_available_periods(periods)
           end
 
           if value = sequence_item[:start_interval]

lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.37.4".freeze
+  VERSION = "0.37.5".freeze
 end

script/ci

@@ -54,14 +54,16 @@ run_all() {
 
   for gemfile in $gemfiles; do
     echo
-    pretty_echo "Testing with $gemfile"
-    pretty_run bundle install --gemfile $gemfile --path $bundle_path --binstubs $bin_path
+    BUNDLE_GEMFILE=$gemfile
+    pretty_echo "Testing with $BUNDLE_GEMFILE"
+    pretty_run bundle install --path $bundle_path --binstubs $bin_path
     pretty_run bundle exec rake spec
   done
 
   echo
+  unset BUNDLE_GEMFILE
   pretty_echo "Testing with default Gemfile"
-  pretty_run bundle install --gemfile Gemfile --path $bundle_path --binstubs $bin_path
+  pretty_run bundle install --path $bundle_path --binstubs $bin_path
   pretty_run bundle exec rake spec
 }
 

spec/lib/cronofy/client_spec.rb

@@ -2341,6 +2341,14 @@
       it_behaves_like 'a Cronofy request'
     end
 
+    context 'when passing query periods' do
+      it_behaves_like 'a Cronofy request'
+
+      before do
+        availability[:query_periods] = availability.delete(:available_periods)
+        mapped_availability[:query_periods] = mapped_availability.delete(:available_periods)
+      end
+    end
   end
 
   describe "Real time sequencing" do
@@ -2529,6 +2537,21 @@
       it_behaves_like 'a Cronofy request'
     end
 
+    context 'when passing query periods' do
+      it_behaves_like 'a Cronofy request'
+
+      before do
+        availability[:query_periods] = availability.delete(:available_periods)
+        availability[:sequence].each do |sequence|
+          sequence[:query_periods] = sequence.delete(:available_periods)
+        end
+
+        mapped_availability[:query_periods] = mapped_availability.delete(:available_periods)
+        mapped_availability[:sequence].each do |sequence|
+          sequence[:query_periods] = sequence.delete(:available_periods)
+        end
+      end
+    end
   end
 
   describe "specifying data_centre" do