cronofy 0.37.5 → 0.37.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e21c23685801f569da765f2572e20cb66870a8eb2615628279bc6ff7cdcd49d9
-  data.tar.gz: 3c595df2b4fb1cf29c6bf76e31865a30cd7f09aaa12bcd80c485d8e3edc8c3e7
+  metadata.gz: f7a632c7e4036fef7e004f6310425d235fea56520b297b4a3a0c644fe57a0011
+  data.tar.gz: 0fc429f25dc4ff14003629e81139047c36ccdf7ba2e06631c0b22d913e709bb2
 SHA512:
-  metadata.gz: 151382f0d9c593b19637dd8d6c452c61dceab8e4345a361def1aee2e934545a6fc97ea73dd10ece22fb83073b1670e724bcfa32a6a712112f1c2f115010a5809
-  data.tar.gz: 95391561459fba368ef63ff522288ce50fdb08ae90c6205c825ae781495cbdb515d7ae6d9d0814080674c2fe608cb77ad306409bf28f1b62f686eb79dc5a7ca1
+  metadata.gz: 92488cee8fea969192bc9ef1aa624872201c4928087b385f5d10cac11720575191cfbc89db86016c31ba87bac8f57b6d7890ab8e3beb2925a8eafc87cb98b08f
+  data.tar.gz: 7c0651b6b64c64e50ce356699b9ea3ba58928dee2ccdb3922ae4cbbd6a6b4fd572f36871e045567675d6166e93d55c86afee92a6fba4e01e370f980fbd385d77

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [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]
@@ -202,6 +206,7 @@
 [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
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -249,3 +254,4 @@
 [#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/lib/cronofy/client.rb

@@ -1117,6 +1117,59 @@ module Cronofy
       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
     #

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.5".freeze
+  VERSION = "0.37.6".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,121 +2218,251 @@ 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"
-      }
-    end
+      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
 
-    subject { client.real_time_scheduling(args) }
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
 
-    context 'when start/end are Times' do
-      it_behaves_like 'a Cronofy request'
+      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
 
-    context 'when passing query periods' do
+    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) }
+
       it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
 
-      before do
-        availability[:query_periods] = availability.delete(:available_periods)
-        mapped_availability[:query_periods] = mapped_availability.delete(:available_periods)
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.37.5
+  version: 0.37.6
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-04-05 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.2.33
+rubygems_version: 3.3.8
 signing_key: 
 specification_version: 4
 summary: Cronofy - the scheduling platform for business