cronofy 0.33.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c592a6641e20c6bccbe1fe2a4af85f1cff4bcbe8a223436181e7f82a8ab7406
-  data.tar.gz: b008a137e2c008fcd10fc9edf83871c99a9f5b2b630ade62d39c5511e0407721
+  metadata.gz: 308d390e34e9ed071119e343cc32f18121ddcff2328fbc945b3a785e64550676
+  data.tar.gz: 2ab98066dd1c8eeef0d44a4ddef32f49945edd2d4b84c16d7f5607bbbb54220a
 SHA512:
-  metadata.gz: 53e4116e1763cc0795d270fa405d7cadb0cda41641f6edb3c8f62a20605053206c4ccfd088e5c93161f5bfeb5f07c0489b1de76ebc27105e62b181b6b399a81b
-  data.tar.gz: 35b950179483552856421bd5c967728a6e443cc11b6333f9eceea7e8ceff8ce06bf143573f552a4cd882faa94dcb0223adad123caee10beed60bbaac5ddaef16
+  metadata.gz: c61c10c546d52fee5d4af2ed2030f33a477d0b79cce98c89eb977e76cb9a1918250a00cf4fa1d74b2a35eb044da6ba338f504d6427b07173386c542dae48af97
+  data.tar.gz: 844a546be5ef240ebb964e72926363eedf023bc05ce05bfa95e5af7b1adc8bfbef18a53b1415cec348b370367ec322e5513b7330622753b29b350c1ec046fa67

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [0.37.0]
+
+ * Add `revoke_by_token` and `revoke_by_sub` to the Client [#86] 
+
+## [0.36.1]
+
+ * Loosen the version requirement on Hashie to allow 4.X
+
+## [0.36.0]
+
+ * Add support for Available Periods [#81]
+
+## [0.35.0]
+
+ * Add specific errors for network issues [#77]
+
+## [0.34.0]
+
+ * Support removing a participant from a Smart Invite [#75]
+
 ## [0.33.0]
 
  * Support listing Availability Rules [#74]
@@ -152,6 +172,11 @@
 [0.31.2]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.31.2
 [0.32.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.32.0
 [0.33.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.33.0
+[0.34.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.34.0
+[0.35.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.35.0
+[0.36.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.36.0
+[0.36.1]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.36.1
+[0.37.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -189,3 +214,8 @@
 [#72]: https://github.com/cronofy/cronofy-ruby/pull/72
 [#73]: https://github.com/cronofy/cronofy-ruby/pull/73
 [#74]: https://github.com/cronofy/cronofy-ruby/pull/74
+[#75]: https://github.com/cronofy/cronofy-ruby/pull/75
+[#77]: https://github.com/cronofy/cronofy-ruby/pull/77
+[#81]: https://github.com/cronofy/cronofy-ruby/pull/81
+[#85]: https://github.com/cronofy/cronofy-ruby/pull/85
+[#86]: https://github.com/cronofy/cronofy-ruby/pull/86

data/README.md

@@ -23,10 +23,8 @@ bundle install
 
 In order to use the Cronofy API you will need to [create a developer account](https://app.cronofy.com/sign_up/new).
 
-From there you can [use your Calendar Sandbox](https://app.cronofy.com/oauth/sandbox)
-to access your own calendars, or you can [create an OAuth application](https://app.cronofy.com/oauth/applications/new)
-to obtain an OAuth `client_id` and `client_secret` to be able to use the full
-API.
+From there you can [create an OAuth application](https://app.cronofy.com/oauth/applications/new)
+to obtain an OAuth `client_id` and `client_secret` to be able to use the full API.
 
 ## Creating a client
 

data/cronofy.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |spec|
   spec.files        += Dir['spec/**/*.rb']
   spec.test_files    = Dir['spec/**/*.rb']
 
+  spec.add_runtime_dependency "hashie", ">= 2.1", "< 5"
   spec.add_runtime_dependency "oauth2", "~> 1.0"
-  spec.add_runtime_dependency "hashie", ">= 2.1", "< 4"
 
   spec.add_development_dependency "bundler", ">=  1.6", "< 3"
   spec.add_development_dependency "rake",    "~> 10.0"
   spec.add_development_dependency "rspec",   "~>  3.2"
-  spec.add_development_dependency "webmock", "~>  1.21"
+  spec.add_development_dependency "webmock", "~>  3.9.1"
 end

data/lib/cronofy/auth.rb

@@ -118,20 +118,50 @@ module Cronofy
     def revoke!
       raise CredentialsMissingError.new("No credentials to revoke") unless access_token
 
+      token = access_token.refresh_token || access_token.token
+      revoke_by_token(token)
+      @access_token = nil
+    end
+
+    # Internal: Revokes an authorization by the sub
+    #
+    # Returns nothing.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    def revoke_by_sub(sub)
+      do_revoke(sub: sub)
+    end
+
+    # Internal: Revokes an authorization via the token
+    #
+    # Returns nothing.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    def revoke_by_token(token)
+      do_revoke(token: token)
+    end
+
+    private
+
+    def do_revoke(token: nil, sub: nil)
+      raise CredentialsMissingError.new("No credentials to revoke") unless token || sub
+
       do_request do
         body = {
           client_id: @api_client.id,
           client_secret: @api_client.secret,
-          token: access_token.refresh_token || access_token.token,
         }
 
+        if token
+          body.merge!(token: token)
+        else
+          body.merge!(sub: sub)
+        end
+
         @api_client.request(:post, "/oauth/token/revoke", body: body)
-        @access_token = nil
       end
     end
 
-    private
-
     def do_request(&block)
       if @client_credentials_missing
         raise CredentialsMissingError.new("OAuth client_id and client_secret must be set")

data/lib/cronofy/client.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 module Cronofy
   # Public: Primary class for interacting with the Cronofy API.
   class Client
@@ -735,6 +737,14 @@ module Cronofy
       @auth.revoke!
     end
 
+    def revoke_by_sub(sub)
+      @auth.revoke_by_sub(sub)
+    end
+
+    def revoke_by_token(token)
+      @auth.revoke_by_token(token)
+    end
+
     # Public: Requests elevated permissions for a set of calendars.
     #
     # args - A Hash of options used to initialize the request (default: {}):
@@ -1323,6 +1333,32 @@ module Cronofy
       parse_json(SmartInviteResponse, nil, response)
     end
 
+    # Public: Removes an individual recipient from a multiple recipient smart invite
+    #
+    # smart_invite_id - A String uniquely identifying the event for your
+    #                  application (note: this is NOT an ID generated
+    #                  by Cronofy).
+    #
+    # recipient       - A Hash containing the recipient to be removed
+    #                   :email      - A String for the email address of
+    #                                 the recipient to remove.
+    #
+    # See https://docs.cronofy.com/developers/api-alpha/smart-invites/multiple-recipients/#remove-invite-recipient
+    # for reference.
+    #
+    # Returns a SmartInviteResponse
+    #
+    # 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 remove_recipient_smart_invite(body={})
+      body[:method] = 'remove'
+      response = wrapped_request { api_key!.post("/v1/smart_invites", json_request_args(body)) }
+      parse_json(SmartInviteResponse, nil, response)
+    end
+
     # Public: Gets the details for a smart invite.
     #
     # smart_invite_id  - A String uniquely identifying the event for your
@@ -1466,6 +1502,84 @@ module Cronofy
       nil
     end
 
+    # Public: Creates or updates an AvailablePeriod.
+    #
+    # available_period_id - A String uniquely identifying the available period
+    #                       for the authenticated user in your application
+    #                       (note: this is NOT an ID generated by Cronofy).
+    # body                - A Hash describing the available period with
+    #                       symbolized keys:
+    #                       :start - A String (ISO-8601 date/time)
+    #                       :end   - A String (ISO-8601 date/time)
+    #
+    # See https://docs.cronofy.com/developers/api/scheduling/available-periods/upsert/
+    # for reference.
+    #
+    # Returns nothing.
+    #
+    # 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 upsert_available_period(available_period_id, body)
+      payload = body.merge(available_period_id: available_period_id)
+      wrapped_request { post("/v1/available_periods", payload) }
+      nil
+    end
+
+    # Public: Gets all AvailablePeriods for an account.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           :from            - The minimum Date from which to return periods
+    #                              (optional).
+    #           :to              - The Date to return periods up until (optional).
+    #           :tzid            - A String representing a known time zone
+    #                              identifier from the IANA Time Zone Database
+    #                              (default: Etc/UTC).
+    #           :localized_times - A Boolean specifying whether the start and
+    #                              end times should be returned with any
+    #                              available localization information
+    #                              (optional).
+    #
+    # Returns an array of AvailablePeriods.
+    #
+    # 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 get_available_periods(options={})
+      query = {}
+      query[:from] = to_iso8601(options[:from]) if options[:from]
+      query[:to] = to_iso8601(options[:to]) if options[:to]
+      query[:tzid] = options[:tzid] if options[:tzid]
+      query[:localized_times] = options[:localized_times] if options[:localized_times]
+      if query.any?
+        query_string = "?#{URI.encode_www_form(query)}"
+      end
+
+      response = wrapped_request { get("/v1/available_periods#{query_string}") }
+      parse_collection(AvailablePeriod, 'available_periods', response)
+    end
+
+    # Public: Deletes an AvailablePeriod.
+    #
+    # available_period_id - A String uniquely identifying the available period
+    #                      for the authenticated user in your application
+    #
+    # Returns nothing.
+    #
+    # 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 delete_available_period(available_period_id)
+      wrapped_request { delete("/v1/available_periods", available_period_id: available_period_id) }
+      nil
+    end
+
     # Public: Creates a scheduling conversation
     #
     # pre release end-point documentation to follow

data/lib/cronofy/errors.rb

@@ -68,6 +68,18 @@ module Cronofy
   class PaymentRequiredError < APIError
   end
 
+  class ServiceUnreachableError < APIError
+  end
+
+  class BadGatewayError < ServiceUnreachableError
+  end
+
+  class ServiceUnavailableError < ServiceUnreachableError
+  end
+
+  class GatewayTimeoutError < ServiceUnreachableError
+  end
+
   class UnknownError < APIError
   end
 
@@ -83,6 +95,9 @@ module Cronofy
       423 => AccountLockedError,
       429 => TooManyRequestsError,
       500 => ServerError,
+      502 => BadGatewayError,
+      503 => ServiceUnavailableError,
+      504 => GatewayTimeoutError,
     }.freeze
 
     def self.map_error(error)

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.33.0".freeze
+  VERSION = "0.37.0".freeze
 end

data/spec/lib/cronofy/auth_spec.rb

@@ -476,4 +476,84 @@ describe Cronofy::Auth do
       end
     end
   end
+
+  describe "#revoke_by_sub" do
+    let(:auth) do
+      Cronofy::Auth.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: access_token,
+        refresh_token: refresh_token,
+      )
+    end
+
+    let!(:revocation_request) do
+      stub_request(:post, "https://api.cronofy.com/oauth/token/revoke")
+        .with(
+          body: {
+            client_id: client_id,
+            client_secret: client_secret,
+            sub: sub,
+          },
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'User-Agent' => "Cronofy Ruby #{Cronofy::VERSION}",
+          }
+        ).to_return(status: response_status)
+    end
+
+    let(:sub) { "random_sub_value" }
+
+    before do
+      auth.revoke_by_sub(sub)
+    end
+
+    it "does not unset the access token for the current auth" do
+      expect(auth.access_token).not_to be_nil
+    end
+
+    it "makes the revocation request" do
+      expect(revocation_request).to have_been_requested
+    end
+  end
+
+  describe "#revoke_by_token" do
+    let(:auth) do
+      Cronofy::Auth.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: access_token,
+        refresh_token: refresh_token,
+      )
+    end
+
+    let!(:revocation_request) do
+      stub_request(:post, "https://api.cronofy.com/oauth/token/revoke")
+        .with(
+          body: {
+            client_id: client_id,
+            client_secret: client_secret,
+            token: token,
+          },
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'User-Agent' => "Cronofy Ruby #{Cronofy::VERSION}",
+          }
+        ).to_return(status: response_status)
+    end
+
+    let(:token) { "random_token_value" }
+
+    before do
+      auth.revoke_by_token(token)
+    end
+
+    it "does not unset the access token for the current auth" do
+      expect(auth.access_token).not_to be_nil
+    end
+
+    it "makes the revocation request" do
+      expect(revocation_request).to have_been_requested
+    end
+  end
 end

data/spec/lib/cronofy/client_spec.rb

@@ -2630,6 +2630,67 @@ describe Cronofy::Client do
 
   end
 
+  describe "Remove Recipient Smart Invite", test: true do
+    let(:request_url) { "https://api.cronofy.com/v1/smart_invites" }
+    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(:client_id) { 'example_id' }
+    let(:client_secret) { 'example_secret' }
+
+    let(:client) do
+      Cronofy::Client.new(
+        client_id: client_id,
+        client_secret: client_secret,
+      )
+    end
+
+    let(:args) do
+      {
+        smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+        recipient: {
+          email: "example@example.com"
+        }
+      }
+    end
+
+    let(:request_body) do
+      {
+        method: 'remove',
+        smart_invite_id: "qTtZdczOccgaPncGJaCiLg",
+        recipient: {
+          email: "example@example.com"
+        }
+      }
+    end
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) do
+      request_body.merge({
+        attachments: {
+          removed: {
+            email: "example@example.com"
+          }
+        }
+      })
+    end
+
+    let(:correct_mapped_result) do
+      Cronofy::SmartInviteResponse.new(correct_response_body)
+    end
+
+    subject { client.remove_recipient_smart_invite(request_body) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
   describe "Batch requests" do
     context "upserting an event" do
       let(:calendar_id) { 'calendar_id_123'}
@@ -3091,4 +3152,160 @@ describe Cronofy::Client do
 
     it_behaves_like 'a Cronofy request'
   end
+
+  describe "#upsert_available_period" do
+    let(:request_url) { 'https://api.cronofy.com/v1/available_periods' }
+    let(:method) { :post }
+    let(:available_period_id) { "test" }
+    let(:request_body) do
+      {
+        available_period_id: available_period_id,
+        start: "2020-07-26T15:30:00Z",
+        end: "2020-07-26T17:00:00Z"
+      }
+    end
+
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) { "" }
+    let(:correct_mapped_result) { nil }
+
+    subject {
+      client.upsert_available_period(available_period_id,
+        start: request_body[:start],
+        end: request_body[:end]
+      )
+    }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
+
+  describe "#get_available_periods" do
+    context "unfiltered" do
+      let(:request_url) { "https://api.cronofy.com/v1/available_periods" }
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "available_period_id" => "qTtZdczOccgaPncGJaCiLg",
+              "start" => "2020-07-26T15:30:00Z",
+              "end" => "2020-07-26T17:00:00Z"
+            }
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        period = correct_response_body['available_periods'][0]
+
+        [
+          Cronofy::AvailablePeriod.new(
+            available_period_id: period['available_period_id'],
+            start: period['start'],
+            end: period['end']
+          )
+        ]
+      end
+
+      subject { client.get_available_periods }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+
+    context "filterd by date range" do
+      let(:tzid) { "America/New_York" }
+      let(:from) { "2020-07-01" }
+      let(:to) { "2020-07-31" }
+      let(:request_url) { "https://api.cronofy.com/v1/available_periods?from=#{from}&to=#{to}&tzid=#{tzid}" }
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "available_period_id" => "qTtZdczOccgaPncGJaCiLg",
+              "start" => "2020-07-26T15:30:00Z",
+              "end" => "2020-07-26T17:00:00Z"
+            }
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        period = correct_response_body['available_periods'][0]
+
+        [
+          Cronofy::AvailablePeriod.new(
+            available_period_id: period['available_period_id'],
+            start: period['start'],
+            end: period['end']
+          )
+        ]
+      end
+
+      subject { client.get_available_periods(from: from, to: to, tzid: tzid) }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+
+    context "requesting localized times" do
+      let(:tzid) { "America/New_York" }
+      let(:localized_times) { true }
+      let(:request_url) { "https://api.cronofy.com/v1/available_periods?tzid=#{tzid}&localized_times=true" }
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "available_periods" => [
+            {
+              "available_period_id" => "qTtZdczOccgaPncGJaCiLg",
+              "start" => "2020-07-26T15:30:00Z",
+              "end" => "2020-07-26T17:00:00Z"
+            }
+          ]
+        }
+      end
+
+      let(:correct_mapped_result) do
+        period = correct_response_body['available_periods'][0]
+
+        [
+          Cronofy::AvailablePeriod.new(
+            available_period_id: period['available_period_id'],
+            start: period['start'],
+            end: period['end']
+          )
+        ]
+      end
+
+      subject { client.get_available_periods(tzid: tzid, localized_times: true) }
+
+      it_behaves_like 'a Cronofy request'
+      it_behaves_like 'a Cronofy request with mapped return value'
+    end
+  end
+
+  describe '#delete_available_period' do
+    let(:available_period_id) { 'default'}
+    let(:request_url) { "https://api.cronofy.com/v1/available_periods" }
+    let(:method) { :delete }
+    let(:request_body) {
+      { available_period_id: available_period_id}
+    }
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) { "" }
+    let(:correct_mapped_result) { nil }
+
+    subject { client.delete_available_period(available_period_id) }
+
+    it_behaves_like 'a Cronofy request'
+    it_behaves_like 'a Cronofy request with mapped return value'
+  end
 end

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
 - Garry Shutler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: oauth2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +20,7 @@ dependencies:
         version: '2.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +30,21 @@ dependencies:
         version: '2.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,14 +99,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 3.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: 3.9.1
 description: Ruby wrapper for Cronofy's unified calendar API
 email:
 - parizhskiy@gmail.com
@@ -141,7 +141,7 @@ homepage: https://github.com/cronofy/cronofy-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,8 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
 summary: Cronofy - one API for all the calendars
 test_files: