cronofy 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0407eb888cfab38dd60d84ad456d367da62d5021947bc9d7ccc1d66e8da8e3df
-  data.tar.gz: 24b3171b4e992004138871f4f30f92e840b22a6ef76bab5c7ec4f59574794ac1
+  metadata.gz: 70859d7df67d1abfb03702825b4a304a8e2426f7073d9055343559cb9e41e469
+  data.tar.gz: 0f778ceec16c9a4fd9f25a9cc50f6f7957f643aa8e1980e35d7690483f8cdea5
 SHA512:
-  metadata.gz: e3e3d97475b91569ff5247604a4cdfc0b975d6a9aa1199e20b2e86e85d3b5e3060bfe193d12fe694a27432f79dba2d417580a25e46de3129cf7bd83d8c621f9d
-  data.tar.gz: db4b9e733ae6acee75880ff0fe72e5e6d42713d9c725d8211552647d1c2ec421628b5211222d2f3070ecbce2e6bd0682c1b74dfd2186c6f9d40a7996e9a4dc18
+  metadata.gz: 0b15136e06190b874efc0d32c1cb4efa16bf093c0473faf1ad2fb59f66511ef44069cad5199f1f63e9d05e25e74c6376cd4534c380073ec59b55ddc8ef7f6b7c
+  data.tar.gz: 65256a5f09863beb7d620746e6d5fb9d79242c9d374adba3161c1439a9bb93ebf96cbde2b65c72a81876d03a7abec218ea60cb43e50506a47f9a98a112da39c1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.41.0]
+
+ * Adds support for the query_slots parameter [#111]
+
 ## [0.40.0]
 
  * Update version of [OAuth2](https://rubygems.org/gems/oauth2) required [#102]
@@ -227,6 +231,7 @@
 [0.38.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/0.38.0
 [0.39.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/0.39.0
 [0.40.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.40.0
+[0.41.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.41.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -278,3 +283,4 @@
 [#102]: https://github.com/cronofy/cronofy-ruby/pull/102
 [#104]: https://github.com/cronofy/cronofy-ruby/pull/104
 [#108]: https://github.com/cronofy/cronofy-ruby/pull/108
+[#111]: https://github.com/cronofy/cronofy-ruby/pull/111

data/README.md

@@ -45,8 +45,8 @@ When using a [personal access token](https://app.cronofy.com/oauth/applications/
 you only need to provide the `access_token` argument.
 
 When working against your own OAuth application you will need to provide the
-`client_id` and `client_secret` when [going through the authorization process](https://www.cronofy.com/developers/api/#authorization)
-for a user, and when [refreshing an access token](https://www.cronofy.com/developers/api/#token-refresh).
+`client_id` and `client_secret` when [going through the authorization process](https://docs.cronofy.com/developers/api/authorization/request-authorization/)
+for a user, and when [refreshing an access token](https://docs.cronofy.com/developers/api/authorization/refresh-token/).
 
 If `client_id` and `client_secret` are not specified explicitly the values from
 the environment variables `CRONOFY_CLIENT_ID` and `CRONOFY_CLIENT_SECRET` will
@@ -56,7 +56,7 @@ be used if present.
 
 ## Authorization
 
-[API documentation](https://www.cronofy.com/developers/api/#authorization)
+[API documentation](https://docs.cronofy.com/developers/api/authorization/request-authorization/)
 
 Generate a link for a user to grant access to their calendars:
 
@@ -83,7 +83,7 @@ to perform this process.
 
 ## List calendars
 
-[API documentation](https://www.cronofy.com/developers/api/#calendars)
+[API documentation](https://docs.cronofy.com/developers/api/calendars/list-calendars/)
 
 Get a list of all the user's calendars:
 
@@ -93,7 +93,7 @@ calendars = cronofy.list_calendars
 
 ## Read events
 
-[API documentation](https://www.cronofy.com/developers/api/#read-events)
+[API documentation](https://docs.cronofy.com/developers/api/events/read-events/)
 
 Get a list of events from the user's calendars:
 
@@ -105,7 +105,7 @@ Note that the gem handles iterating through the pages on your behalf.
 
 ## Create or update events
 
-[API documentation](https://www.cronofy.com/developers/api/#upsert-event)
+[API documentation](https://docs.cronofy.com/developers/api/events/upsert-event/)
 
 To create/update an event in the user's calendar:
 
@@ -126,7 +126,7 @@ cronofy.upsert_event(calendar_id, event_data)
 
 ## Delete events
 
-[API documentation](https://www.cronofy.com/developers/api/#delete-event)
+[API documentation](https://docs.cronofy.com/developers/api/events/delete-event/)
 
 To delete an event from user's calendar:
 
@@ -145,6 +145,6 @@ If you would like to request a feature is added by our team then please let us k
 
 ## Links
 
- * [API documentation](https://www.cronofy.com/developers/api)
+ * [API documentation](https://docs.cronofy.com/developers/api/)
  * [API mailing list](https://groups.google.com/d/forum/cronofy-api)
 

data/lib/cronofy/auth.rb

@@ -35,7 +35,7 @@ module Cronofy
     #                :state - Array of states to retain during the OAuth
     #                         authorization process (optional).
     #
-    # See http://www.cronofy.com/developers/api#authorization for reference.
+    # See https://docs.cronofy.com/developers/api/authorization/request-authorization/ for reference.
     #
     # Returns the URL as a String.
     def user_auth_link(redirect_uri, options = {})

data/lib/cronofy/client.rb

@@ -54,7 +54,7 @@ module Cronofy
     #              (default: {}):
     #              :color - The color to make the calendar (optional).
     #
-    # See https://www.cronofy.com/developers/api/#create-calendar for reference.
+    # See https://docs.cronofy.com/developers/api/calendars/create-calendar/ for reference.
     #
     # Returns the created Calendar
     #
@@ -77,7 +77,7 @@ module Cronofy
 
     # Public: Lists all the calendars for the account.
     #
-    # See http://www.cronofy.com/developers/api#calendars for reference.
+    # See https://docs.cronofy.com/developers/api/calendars/list-calendars/ for reference.
     #
     # Returns an Array of Calendars
     #
@@ -148,7 +148,7 @@ module Cronofy
     #       long: "0.1234"
     #     })
     #
-    # See http://www.cronofy.com/developers/api#upsert-event for reference.
+    # See https://docs.cronofy.com/developers/api/events/upsert-event/ for reference.
     #
     # Returns nothing.
     #
@@ -214,7 +214,7 @@ module Cronofy
     # The first page will be retrieved eagerly so that common errors will happen
     # inline. However, subsequent pages (if any) will be requested lazily.
     #
-    # See http://www.cronofy.com/developers/api#read-events for reference.
+    # See https://docs.cronofy.com/developers/api/events/read-events/ for reference.
     #
     # Returns a lazily-evaluated Enumerable of Events
     #
@@ -262,7 +262,7 @@ module Cronofy
     # The first page will be retrieved eagerly so that common errors will happen
     # inline. However, subsequent pages (if any) will be requested lazily.
     #
-    # See http://www.cronofy.com/developers/api/#free-busy for reference.
+    # See https://docs.cronofy.com/developers/api/events/free-busy/ for reference.
     #
     # Returns a lazily-evaluated Enumerable of FreeBusy
     #
@@ -293,7 +293,7 @@ module Cronofy
     # event_id    - A String uniquely identifying the event for your application
     #               (note: this is NOT an ID generated by Cronofy).
     #
-    # See http://www.cronofy.com/developers/api#delete-event for reference.
+    # See https://docs.cronofy.com/developers/api/events/delete-event/ for reference.
     #
     # Returns nothing.
     #
@@ -425,7 +425,7 @@ module Cronofy
 
     # Public: Deletes all events you are managing for the account.
     #
-    # See https://www.cronofy.com/developers/api/#bulk-delete-events for
+    # See https://docs.cronofy.com/developers/api/events/bulk-delete-events/ for
     # reference.
     #
     # options - The Hash options used to refine the selection (optional):
@@ -469,7 +469,7 @@ module Cronofy
     #                                           trigger notifications
     #                                           (optional).
     #
-    # See http://www.cronofy.com/developers/api#create-channel for reference.
+    # See https://docs.cronofy.com/developers/api/push-notifications/create-channel/ for reference.
     #
     # Returns a Channel.
     #
@@ -520,7 +520,7 @@ module Cronofy
 
     # Public: Lists all the notification channels for the account.
     #
-    # See http://www.cronofy.com/developers/api#list-channels for reference.
+    # See https://docs.cronofy.com/developers/api/push-notifications/list-channels/ for reference.
     #
     # Returns an Array of Channels.
     #
@@ -540,7 +540,7 @@ module Cronofy
     #
     # channel_id - The String Cronofy ID for the channel to close.
     #
-    # See http://www.cronofy.com/developers/api#close-channel for reference.
+    # See https://docs.cronofy.com/developers/api/push-notifications/close-channel/ for reference.
     #
     # Returns nothing.
     #
@@ -559,7 +559,7 @@ module Cronofy
 
     # Public: Retrieves the details of the account.
     #
-    # See http://www.cronofy.com/developers/api#account for reference.
+    # See https://docs.cronofy.com/developers/api/identity/account/ for reference.
     #
     # Returns an Account.
     #
@@ -577,7 +577,7 @@ module Cronofy
 
     # Public: Lists all the profiles for the account.
     #
-    # See https://www.cronofy.com/developers/api/#profiles for reference.
+    # See https://docs.cronofy.com/developers/api/identity/profile/ for reference.
     #
     # Returns an Array of Profiles
     #
@@ -593,7 +593,7 @@ module Cronofy
 
     # Public: Retrieves the userinfo for the account
     #
-    # See  http://openid.net/specs/openid-connect-core-1_0.html#UserInfo for
+    # See https://docs.cronofy.com/developers/api/identity/userinfo/ for
     # reference.
     #
     # Returns an UserInfo.
@@ -621,7 +621,7 @@ module Cronofy
     #               invite to
     #
     #
-    # See http://www.cronofy.com/developers/api#delete-event for reference.
+    # See https://docs.cronofy.com/developers/api/events/delete-event/ for reference.
     #
     # Returns nothing.
     #
@@ -687,7 +687,7 @@ module Cronofy
     #                :state - Array of states to retain during the OAuth
     #                         authorization process (optional).
     #
-    # See http://www.cronofy.com/developers/api#authorization for reference.
+    # See https://docs.cronofy.com/developers/api/authorization/request-authorization/ for reference.
     #
     # Returns the URL as a String.
     def user_auth_link(redirect_url, options = {})
@@ -702,7 +702,7 @@ module Cronofy
     # redirect_url - A String specifing the URL the user returned to once they
     #                had completed the authorization steps.
     #
-    # See http://www.cronofy.com/developers/api#token-issue for reference.
+    # See https://docs.cronofy.com/developers/api/authorization/request-token/ for reference.
     #
     # Returns a set of Cronofy::Credentials for the account.
     #
@@ -720,7 +720,7 @@ module Cronofy
     # these usually occur when the access token has expired and needs
     # refreshing.
     #
-    # See http://www.cronofy.com/developers/api#token-refresh for reference.
+    # See https://docs.cronofy.com/developers/api/authorization/refresh-token/ for reference.
     #
     # Returns a set of Cronofy::Credentials for the account.
     #
@@ -735,7 +735,7 @@ module Cronofy
 
     # Public: Obtains access to an application calendar
     #
-    # See http://www.cronofy.com/developers/alpha/api#application-calendar for reference.
+    # See https://docs.cronofy.com/developers/api/calendars/application-calendars/ for reference.
     #
     # Returns a set of Cronofy::Credentials for the account.
     #
@@ -753,7 +753,7 @@ module Cronofy
     # After making this call the Client will become unusable. You should also
     # delete the stored credentials used to create this instance.
     #
-    # See http://www.cronofy.com/developers/api#revoke-authorization for
+    # See https://docs.cronofy.com/developers/api/authorization/revoke/ for
     # reference.
     #
     # Returns nothing.
@@ -835,8 +835,10 @@ module Cronofy
     #                                each must specify a start and end Time.
     #           :start_interval    - An Integer representing the start interval
     #                                of minutes for the availability query.
-    #           :buffer            - An Hash containing the buffer to apply to
+    #           :buffer            - A Hash containing the buffer to apply to
     #                                the availability query.
+    #           :query_slots       - A Hash containing the query slots to be
+    #                                used in the availability query.
     #
     # Returns an Array of AvailablePeriods.
     #
@@ -861,7 +863,13 @@ module Cronofy
         options[:buffer] = map_availability_buffer(buffer)
       end
 
-      translate_available_periods(options[:query_periods] || options[:available_periods])
+      if query_periods = options[:query_periods] || options[:available_periods]
+        translate_available_periods(query_periods)
+      end
+
+      if query_slots = options[:query_slots]
+        translate_query_slots(query_slots)
+      end
 
       response = availability_post("/v1/availability", options)
 
@@ -979,7 +987,7 @@ module Cronofy
     #       long: "0.1234"
     #     })
     #
-    # See http://www.cronofy.com/developers/api#upsert-event for reference.
+    # See https://docs.cronofy.com/developers/api/events/upsert-event/ for reference.
     #
     # Returns a AddToCalendarResponse.
     #
@@ -1052,7 +1060,9 @@ module Cronofy
     #                                         call
     #                    :required_duration - A hash stating the length of time the event will
     #                                         last for
-    #                    :query_periods     - A hash stating the available periods for the event
+    #                    :query_periods     - A Hash stating the available periods for the event
+    #                    :query_slots       - A Hash containing the query slots to be
+    #                                         used in the availability query.
     #                    :start_interval    - An Integer representing the start interval
     #                                         of minutes for the availability query.
     #                    :buffer            - An Hash containing the buffer to apply to
@@ -1099,7 +1109,7 @@ module Cronofy
     #    }]
     #   )
     #
-    # See http://www.cronofy.com/developers/api#real-time-scheduling for reference.
+    # See https://docs.cronofy.com/developers/api/scheduling/real-time-scheduling/ for reference.
     #
     # Returns a AddToCalendarResponse.
     #
@@ -1129,7 +1139,14 @@ module Cronofy
         end
       end
 
-      translate_available_periods(availability[:query_periods] || availability[:available_periods])
+      if query_periods = availability[:query_periods] || availability[:available_periods]
+        translate_available_periods(query_periods)
+      end
+
+      if query_slots = availability[:query_slots]
+        translate_query_slots(query_slots)
+      end
+
       body[:availability] = availability
 
       response = raw_post("/v1/real_time_scheduling", body)
@@ -1278,7 +1295,7 @@ module Cronofy
 
     # Public: Creates a link_token to allow explicitly linking of an account
     #
-    # See https://www.cronofy.com/developers/api/alpha/#auth-explicit-linking for
+    # See https://docs.cronofy.com/developers/api-alpha/explicit-linking/ for
     # reference.
     #
     # Returns a link token
@@ -1295,7 +1312,7 @@ module Cronofy
 
     # Public: Revokes the authorization to the given profile.
     #
-    # See https://www.cronofy.com/developers/api/alpha/#revoke-profile for
+    # See https://docs.cronofy.com/developers/api/authorization/revoke-profile/ for
     # reference.
     #
     # Returns nothing.
@@ -1373,7 +1390,7 @@ module Cronofy
     #     }
     #   )
     #
-    # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference.
+    # See https://docs.cronofy.com/developers/api/smart-invites/create-smart-invite/ for reference.
     #
     # Returns a SmartInviteResponse.
     #
@@ -1400,7 +1417,7 @@ module Cronofy
     #                 :email      - A String for thee email address you are
     #                               going to send the Smart Invite to.
     #
-    # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference.
+    # See https://docs.cronofy.com/developers/api/smart-invites/cancel-invite/ for reference.
     #
     # Returns a SmartInviteResponse.
     #
@@ -1448,7 +1465,7 @@ module Cronofy
     #                   by Cronofy).
     # recipient_email - The email address for the recipient to get details for.
     #
-    # See http://www.cronofy.com/developers/alpha/api#smart-invite for reference.
+    # See https://docs.cronofy.com/developers/api/smart-invites/invite-status/ for reference.
     #
     # Returns a SmartInviteResponse.
     #
@@ -1522,7 +1539,7 @@ module Cronofy
     #     ]
     #   )
     #
-    # See http://www.cronofy.com/developers/alpha/api#availability_rules for reference.
+    # See https://docs.cronofy.com/developers/api/scheduling/availability-rules/ for reference.
     #
     # Returns an AvailabilityRuleResponse.
     #
@@ -1717,6 +1734,14 @@ module Cronofy
       end
     end
 
+    def translate_query_slots(query_slots)
+      query_slots.each do |params|
+        QUERY_SLOTS_TIME_PARAMS.select { |tp| params.key?(tp) }.each do |tp|
+          params[tp] = to_iso8601(params[tp])
+        end
+      end
+    end
+
     def map_availability_participants(participants)
       case participants
       when Hash
@@ -1847,6 +1872,10 @@ module Cronofy
       end
     }.freeze
 
+    QUERY_SLOTS_TIME_PARAMS = %i{
+      start
+    }.freeze
+
     FREE_BUSY_DEFAULT_PARAMS = { tzid: "Etc/UTC" }.freeze
     FREE_BUSY_TIME_PARAMS = %i{
       from

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.40.0".freeze
+  VERSION = "0.41.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -1783,6 +1783,51 @@ describe Cronofy::Client do
         it_behaves_like 'a Cronofy request with mapped return value'
       end
 
+      context 'when given query_slots instead of available_periods with start interval' do
+        let(:participants) do
+          { members: %w{acc_567236000909002 acc_678347111010113} }
+        end
+
+        let(:required_duration) { 60 }
+
+        let(:query_slots) do
+          [
+            { start: Time.parse("2017-01-03T09:00:00Z")},
+            { start: Time.parse("2017-01-04T09:00:00Z") },
+          ]
+        end
+
+        let(:request_body) do
+          {
+            "participants" => [
+              {
+                "members" => [
+                  { "sub" => "acc_567236000909002" },
+                  { "sub" => "acc_678347111010113" }
+                ],
+                "required" => "all"
+              }
+            ],
+            "query_slots" => [
+              { "start" => "2017-01-03T09:00:00Z" },
+              { "start" => "2017-01-04T09:00:00Z" }
+            ],
+            "required_duration" => { "minutes" => 60 },
+          }
+        end
+
+        subject do
+          client.availability(
+            participants: participants,
+            required_duration: required_duration,
+            query_slots: query_slots
+          )
+        end
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+
       context "when trying to auth with only an access_token, as originally implemented" do
         let(:access_token) { "access_token_123"}
         let(:client) { Cronofy::Client.new(access_token: access_token) }
@@ -2363,6 +2408,56 @@ describe Cronofy::Client do
           mapped_availability[:query_periods] = mapped_availability.delete(:available_periods)
         end
       end
+
+      context 'when passing query slots' do
+        let(:availability) do
+          {
+            participants: [
+              {
+                members: [{
+                  sub: "acc_567236000909002",
+                  calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
+                }],
+                required: 'all'
+              }
+            ],
+            required_duration: { minutes: 60 },
+            query_slots: [
+              { start: Time.utc(2017, 1, 1, 9, 00) }, 
+              { start: Time.utc(2017, 1, 1, 17, 00) }
+            ],
+            buffer: {
+              before: { minutes: 30 },
+              after: { minutes: 45 },
+            }
+          }
+        end
+  
+        let(:mapped_availability) do
+          {
+            participants: [
+              {
+                members: [{
+                  sub: "acc_567236000909002",
+                  calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
+                }],
+                required: 'all'
+              }
+            ],
+            required_duration: { minutes: 60 },
+            buffer: {
+              before: { minutes: 30 },
+              after: { minutes: 45 },
+            },
+            query_slots: [
+              { start: Time.utc(2017, 1, 1, 9, 00) },
+              { start: Time.utc(2017, 1, 1, 17, 00) }
+            ],
+          }
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+        end
+      end
     end
 
     describe "#get_real_time_scheduling_status" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Cronofy - the scheduling platform for business