cronofy 0.37.4 → 0.37.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1338eaab0825a963c74f2c5fd3c434d01185a4bbc36fa57504b0e1edd539fe9e
-  data.tar.gz: 55a045316dbb1545ee7e4f14284ebbbc0aa7b91848ba28d165968125d2221bb3
+  metadata.gz: 72f9a743962bf3c47bdef28e93c0fd4d7cf5fd66101eec219f028ea90fe6291c
+  data.tar.gz: ec455881ea2d6df1e86896508453dbcc6d89173275d23a1fe92b565ee01e1144
 SHA512:
-  metadata.gz: 38ee7c99226bfe70c6e970a22477de0130e93fe07130b9d2c0a596e17178f66435ec58a97be5f18e9b6ac5624eefef7dde96443a8cc91c85f02818016ed64f7d
-  data.tar.gz: 8d0d1641e57b0751988ac5f7978571d2dbd6d6ea12b96ff2314a33d0d9b87c7a11eb5e16775c55b070a312c2efb6b8b353dc3c3f7a8cbe9b3f42c943d6afa21a
+  metadata.gz: c00a81c85732364c3b6cc384c9bbdc1f10fbacfa756c09959734abbefbe65f58f9de764a8e019f40ba0ec17f4355fb4900c4a457e0cac2d98a0a8dfc653886fd
+  data.tar.gz: 6529d3936e84d1721b458bfdfd2acb91585ba7b425d49c7b839f2cdce621d7ae1ba9d1896c471aaecdc6e16474c6f7b0002aa09a64b1390684e5601fa64f35c7

data/CHANGELOG.md

@@ -1,22 +1,34 @@
+## [0.37.7]
+
+ * Update Gem description
+
+## [0.37.6]
+
+ * Adds support for disabling and fetching the status of Real-Time Scheduling links [#100]
+
+## [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 +209,9 @@
 [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
+[0.37.6]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.6
+[0.37.7]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.7
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -243,3 +258,5 @@
 [#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
+[#100]: https://github.com/cronofy/cronofy-ruby/pull/100

data/cronofy.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Sergii Paryzhskyi", "Garry Shutler"]
   spec.email         = ["parizhskiy@gmail.com", "garry@cronofy.com"]
   spec.summary       = %q{Cronofy - the scheduling platform for business}
-  spec.description   = %q{Ruby wrapper for Cronofy's unified calendar API}
+  spec.description   = %q{SDK for Cronofy - the Scheduling Platform for Business}
   spec.homepage      = "https://github.com/cronofy/cronofy-ruby"
   spec.license       = "MIT"
 

data/lib/cronofy/client.rb

@@ -1033,7 +1033,7 @@ module Cronofy
     #                                         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 @@ module Cronofy
     #       }
     #     ],
     #     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,13 +1110,66 @@ module Cronofy
         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)
       parse_json(AddToCalendarResponse, nil , response)
     end
 
+    # Public: Gets the status of a Real-Time Scheduling link.
+    # 
+    # Provide one of the following arguments to identify the link:
+    # id    - A String uniquely identifying the link, returned on initial
+    #         creation
+    # token - The token portion of the link's URL
+    #
+    # See https://docs.cronofy.com/developers/api/scheduling/real-time-scheduling/status/ for reference.
+    #
+    # Returns a RealTimeSchedulingStatus.
+    #
+    # Raises ArgumentError if neither 'id' nor 'token' arguments are passed.
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def get_real_time_scheduling_status(args = {})
+      if args[:token]
+        url = "/v1/real_time_scheduling?token=#{args[:token]}"
+      elsif args[:id]
+        url = "/v1/real_time_scheduling/#{args[:id]}"
+      else
+        raise ArgumentError.new("Must pass either token or id argument")
+      end
+
+      response = wrapped_request { api_key!.get(url) }
+      parse_json(RealTimeSchedulingStatus, 'real_time_scheduling' , response)
+    end
+
+    # Public: Disables a Real-Time Scheduling link.
+    # 
+    # id              - A String uniquely identifying the link, returned 
+    #                   on initial creation
+    # display_message - A message to display to visitors of the disabled link
+    #
+    # See https://docs.cronofy.com/developers/api/scheduling/real-time-scheduling/disable/ for reference.
+    #
+    # Returns a RealTimeSchedulingStatus.
+    #
+    # Raises ArgumentError if no 'id' argument is passed.
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::InvalidRequestError if the request contains invalid
+    # parameters.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def disable_real_time_scheduling(args = {})
+      id = args.delete(:id)
+
+      raise ArgumentError.new('id argument is required') unless id
+
+      response = wrapped_request { api_key!.post("/v1/real_time_scheduling/#{id}/disable", json_request_args(args)) }
+      parse_json(RealTimeSchedulingStatus, 'real_time_scheduling' , response)
+    end
+
     # Public: Generates an real time sequencing link to start the OAuth process with
     # an event to be automatically upserted
     #
@@ -1176,7 +1229,7 @@ module Cronofy
     #                                         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 +1247,8 @@ module Cronofy
 
       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 +1802,10 @@ module Cronofy
             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]

data/lib/cronofy/types.rb

@@ -413,4 +413,8 @@ module Cronofy
   class AvailabilityRule < CronofyMash
     coerce_key :weekly_periods, WeeklyPeriodEnumerable
   end
+
+  class RealTimeSchedulingStatus < CronofyMash
+    coerce_key :event, Event
+  end
 end

data/lib/cronofy/version.rb

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

data/spec/lib/cronofy/client_spec.rb

@@ -2190,25 +2190,8 @@ describe Cronofy::Client do
   end
 
   describe "Real time scheduling" do
-    let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling" }
-    let(:url) { URI("https://example.com") }
-    let(:method) { :post }
-
-    let(:request_headers) do
-      {
-        "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}",
-        "Content-Type" => "application/json; charset=utf-8",
-      }
-    end
-
-    let(:location) { { :description => "Board room" } }
-    let(:transparency) { nil }
     let(:client_id) { 'example_id' }
     let(:client_secret) { 'example_secret' }
-    let(:scope) { 'read_events delete_events' }
-    let(:state) { 'example_state' }
-    let(:redirect_uri) { 'http://example.com/redirect' }
-
     let(:client) do
       Cronofy::Client.new(
         client_id: client_id,
@@ -2216,6 +2199,9 @@ describe Cronofy::Client do
       )
     end
 
+    let(:url) { URI("https://example.com") }
+    let(:location) { { :description => "Board room" } }
+    let(:transparency) { nil }
     let(:event) do
       {
         :event_id => "qTtZdczOccgaPncGJaCiLg",
@@ -2232,115 +2218,253 @@ describe Cronofy::Client do
       }
     end
 
-    let(:oauth_body) do
+    let(:real_time_scheduling_status_response) do
       {
-        scope: scope,
-        redirect_uri: redirect_uri,
-        state: state,
+        real_time_scheduling: {
+          real_time_scheduling_id: 'example_id',
+          url: 'https://app.cronofy.com/real_time_scheduling/example_token',
+          event: event,
+          status: 'disabled',
+        }
       }
     end
 
-    let(:target_calendars) do
-      [
+    describe "#real_time_scheduling" do
+      let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling" }
+
+      let(:method) { :post }
+
+      let(:request_headers) do
         {
-          sub: "acc_567236000909002",
-          calendar_id: "cal_n23kjnwrw2_jsdfjksn234",
+          "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}",
+          "Content-Type" => "application/json; charset=utf-8",
         }
-      ]
-    end
+      end
 
-    let(:availability) do
-      {
-        participants: [
+      let(:scope) { 'read_events delete_events' }
+      let(:state) { 'example_state' }
+      let(:redirect_uri) { 'http://example.com/redirect' }
+
+      let(:oauth_body) do
+        {
+          scope: scope,
+          redirect_uri: redirect_uri,
+          state: state,
+        }
+      end
+
+      let(:target_calendars) do
+        [
           {
-            members: [{
-              sub: "acc_567236000909002",
-              calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
-            }],
-            required: 'all'
+            sub: "acc_567236000909002",
+            calendar_id: "cal_n23kjnwrw2_jsdfjksn234",
+          }
+        ]
+      end
+
+      let(:availability) do
+        {
+          participants: [
+            {
+              members: [{
+                sub: "acc_567236000909002",
+                calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
+              }],
+              required: 'all'
+            }
+          ],
+          required_duration: { minutes: 60 },
+          available_periods: [{
+            start: Time.utc(2017, 1, 1, 9, 00),
+            end:   Time.utc(2017, 1, 1, 17, 00),
+          }],
+          start_interval: { minutes: 60 },
+          buffer: {
+            before: { minutes: 30 },
+            after: { minutes: 45 },
           }
-        ],
-        required_duration: { minutes: 60 },
-        available_periods: [{
-          start: Time.utc(2017, 1, 1, 9, 00),
-          end:   Time.utc(2017, 1, 1, 17, 00),
-        }],
-        start_interval: { minutes: 60 },
-        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 },
+          start_interval: { minutes: 60 },
+          buffer: {
+            before: { minutes: 30 },
+            after: { minutes: 45 },
+          },
+          available_periods: [{
+            start: "2017-01-01T09:00:00Z",
+            end:   "2017-01-01T17:00:00Z",
+          }]
+        }
+      end
+
+      let(:args) do
+        {
+          oauth: oauth_body,
+          event: event,
+          target_calendars: target_calendars,
+          availability: availability,
+        }
+      end
+
+      let(:request_body) do
+        {
+          client_id: client_id,
+          client_secret: client_secret,
+          oauth: oauth_body,
+          event: {
+            :event_id => "qTtZdczOccgaPncGJaCiLg",
+            :summary => "Board meeting",
+            :description => "Discuss plans for the next quarter.",
+            :url => url.to_s,
+            :location => location,
+            :transparency => transparency,
+            :reminders => [
+              { :minutes => 60 },
+              { :minutes => 0 },
+              { :minutes => 10 },
+            ],
+          },
+          target_calendars: target_calendars,
+          availability: mapped_availability,
+        }
+      end
+      let(:correct_response_code) { 202 }
+      let(:correct_response_body) do
+        {
+          oauth_url: "http://www.example.com/oauth?token=example"
+        }
+      end
+
+      subject { client.real_time_scheduling(args) }
+
+      context 'when start/end are Times' do
+        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
 
-    let(:mapped_availability) do
-      {
-        participants: [
+    describe "#get_real_time_scheduling_status" do
+      let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling" }
+      let(:method) { :get }
+      let(:url) { "https://example.com" }
+      let(:request_headers) do
+        {
+          "Authorization" => "Bearer #{client_secret}",
+          "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}",
+          "Accept" => "*/*",
+          "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+        }
+      end
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) { real_time_scheduling_status_response }
+      let(:correct_mapped_result) do
+        Cronofy::RealTimeSchedulingStatus.new(correct_response_body[:real_time_scheduling])
+      end
+
+      subject { client.get_real_time_scheduling_status(args) }
+
+      context 'when passing id' do
+        let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling/example_id" }
+
+        let(:args) do
           {
-            members: [{
-              sub: "acc_567236000909002",
-              calendar_ids: ["cal_n23kjnwrw2_jsdfjksn234"]
-            }],
-            required: 'all'
+            id: 'example_id'
           }
-        ],
-        required_duration: { minutes: 60 },
-        start_interval: { minutes: 60 },
-        buffer: {
-          before: { minutes: 30 },
-          after: { minutes: 45 },
-        },
-        available_periods: [{
-          start: "2017-01-01T09:00:00Z",
-          end:   "2017-01-01T17:00:00Z",
-        }]
-      }
-    end
+        end
 
-    let(:args) do
-      {
-        oauth: oauth_body,
-        event: event,
-        target_calendars: target_calendars,
-        availability: availability,
-      }
-    end
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
 
-    let(:request_body) do
-      {
-        client_id: client_id,
-        client_secret: client_secret,
-        oauth: oauth_body,
-        event: {
-          :event_id => "qTtZdczOccgaPncGJaCiLg",
-          :summary => "Board meeting",
-          :description => "Discuss plans for the next quarter.",
-          :url => url.to_s,
-          :location => location,
-          :transparency => transparency,
-          :reminders => [
-            { :minutes => 60 },
-            { :minutes => 0 },
-            { :minutes => 10 },
-          ],
-        },
-        target_calendars: target_calendars,
-        availability: mapped_availability,
-      }
-    end
-    let(:correct_response_code) { 202 }
-    let(:correct_response_body) do
-      {
-        oauth_url: "http://www.example.com/oauth?token=example"
-      }
+      context 'when passing token' do
+        let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling?token=example_token" }
+        let(:args) do
+          {
+            token: 'example_token'
+          }
+        end
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+
+      context 'when passing neither id nor token' do
+        let(:args) { Hash.new }
+        it 'raises an ArgumentError' do
+          expect { subject }.to raise_error(ArgumentError)
+        end
+      end
     end
 
-    subject { client.real_time_scheduling(args) }
+    describe "#disable_real_time_scheduling" do
+      let(:request_url) { "https://api.cronofy.com/v1/real_time_scheduling/example_id/disable" }
+      let(:url) { "https://example.com" }
+      let(:method) { :post }
+      let(:request_headers) do
+        {
+          "Authorization" => "Bearer #{client_secret}",
+          "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}",
+          "Content-Type" => "application/json; charset=utf-8",
+        }
+      end
+
+      let(:args) do
+        {
+          id: 'example_id',
+          display_message: 'example message'
+        }
+      end
+
+      let(:request_body) do
+        {
+          display_message: 'example message'
+        }
+      end
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) { real_time_scheduling_status_response }
+      let(:correct_mapped_result) do
+        Cronofy::RealTimeSchedulingStatus.new(correct_response_body[:real_time_scheduling])
+      end
+
+      subject { client.disable_real_time_scheduling(args) }
 
-    context 'when start/end are Times' do
       it_behaves_like 'a Cronofy request'
-    end
+      it_behaves_like 'a Cronofy request with mapped return value'
 
+      context 'when omitting id argument' do
+        let(:args) do
+          {
+            display_message: 'example message'
+          }
+        end
+        
+        it 'raises an ArgumentError' do
+          expect { subject }.to raise_error(ArgumentError)
+        end
+      end
+    end
   end
 
   describe "Real time sequencing" do
@@ -2529,6 +2653,21 @@ describe Cronofy::Client do
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.37.4
+  version: 0.37.7
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -107,7 +107,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.1
-description: Ruby wrapper for Cronofy's unified calendar API
+description: SDK for Cronofy - the Scheduling Platform for Business
 email:
 - parizhskiy@gmail.com
 - garry@cronofy.com
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Cronofy - the scheduling platform for business