cronofy 0.35.0 → 0.37.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c20768b0500ee2cb9e902443eada181d2cddafad064febfe1d9e89481fc3d242
-  data.tar.gz: 822d3f453e190ef16b42a07a24ceeba06375bc8641d544cf09085d79f6fce101
+  metadata.gz: 3e09c2030d7992753a4e8f0e52af1d00d2ab6ced77f5e5b81336cb97a5c98ec6
+  data.tar.gz: 464b7a63bdfb341f67da6f4556e4ee66b36db144d9d41270c9204ee6a10ca56c
 SHA512:
-  metadata.gz: 4992da5ff0a8becd7237982e8867b67b8f32e56d5293c3758b05494b38f05307b841e9109f1299cd968e4d0b1f9f6d16da463553d8167d6bc8113c613440f122
-  data.tar.gz: 505d13d30dfced6e3c7524ceecd7efcaa51bbede71761f948a3583c91d4c35e65d3481d8851da78a03ed28ad870307bbc30ec6f18a8b0a5904926204aae17f62
+  metadata.gz: f6a6f59a184da190d6905b495a0c067437ab422561ccf26f23e1e7d6f48fd0a0d2c63bb033d46f760b9ce24e958539a58e319b8a160c2fc2a719f4f1e3f31bcd
+  data.tar.gz: a777db3452a6cc462ba526447c17fe0790d73dd8b08517d62363ac3f5d9b7cb076d2b77ef614ed51f981941451362bd0f568fab4749c08bdc9bc38533974729b

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [0.37.2]
+
+ * 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] 
+
+## [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]
@@ -162,6 +182,11 @@
 [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
+[0.37.1]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.1
+[0.37.2]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.2
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -201,3 +226,8 @@
 [#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
+[#90]: https://github.com/cronofy/cronofy-ruby/pull/90
+[#91]: https://github.com/cronofy/cronofy-ruby/pull/91

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/cronofy/cronofy-ruby.svg?branch=master)](https://travis-ci.org/cronofy/cronofy-ruby)
 [![Gem Version](https://badge.fury.io/rb/cronofy.svg)](http://badge.fury.io/rb/cronofy)
 
-[Cronofy](https://www.cronofy.com) - one API for all the calendars (Google, iCloud, Exchange, Office 365, Outlook.com)
+[Cronofy](https://www.cronofy.com) - the scheduling platform for business
 
 ## Installation
 
@@ -23,22 +23,21 @@ 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
 
 To make calls to the Cronofy API you must create a `Cronofy::Client`. This takes
-four keyword arguments, all of which are optional:
+five keyword arguments, all of which are optional:
 
 ```ruby
 cronofy = Cronofy::Client.new(
   client_id:     'CLIENT_ID',
   client_secret: 'CLIENT_SECRET',
   access_token:  'ACCESS_TOKEN',
-  refresh_token: 'REFRESH_TOKEN'
+  refresh_token: 'REFRESH_TOKEN',
+  data_center:   :de
 )
 ```
 
@@ -53,6 +52,8 @@ If `client_id` and `client_secret` are not specified explicitly the values from
 the environment variables `CRONOFY_CLIENT_ID` and `CRONOFY_CLIENT_SECRET` will
 be used if present.
 
+`data_center` is the two-letter designation for the data center you want to operate against - for example `:de` for Germany, or `:au` for Australia. When omitted, this defaults to the US data center.
+
 ## Authorization
 
 [API documentation](https://www.cronofy.com/developers/api/#authorization)

data/cronofy.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |spec|
   spec.version       = Cronofy::VERSION
   spec.authors       = ["Sergii Paryzhskyi", "Garry Shutler"]
   spec.email         = ["parizhskiy@gmail.com", "garry@cronofy.com"]
-  spec.summary       = %q{Cronofy - one API for all the calendars}
+  spec.summary       = %q{Cronofy - the scheduling platform for business}
   spec.description   = %q{Ruby wrapper for Cronofy's unified calendar API}
   spec.homepage      = "https://github.com/cronofy/cronofy-ruby"
   spec.license       = "MIT"
@@ -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.rb

@@ -13,18 +13,26 @@ require 'openssl'
 
 module Cronofy
   def self.default_data_centre
-    @default_data_centre || ENV['CRONOFY_DATA_CENTRE']
+    default_data_center
   end
 
   def self.default_data_centre=(value)
-    @default_data_centre = value
+    default_data_center= value
   end
 
-  def self.api_url(data_centre_override)
-    if data_centre_override
-      api_url_for_data_centre(data_centre_override)
+  def self.default_data_center
+    @default_data_center || ENV['CRONOFY_DATA_CENTER'] || ENV['CRONOFY_DATA_CENTRE']
+  end
+
+  def self.default_data_center=(value)
+    @default_data_center = value
+  end
+
+  def self.api_url(data_center_override)
+    if data_center_override
+      api_url_for_data_center(data_center_override)
     else
-      ENV['CRONOFY_API_URL'] || api_url_for_data_centre(default_data_centre)
+      ENV['CRONOFY_API_URL'] || api_url_for_data_center(default_data_center)
     end
   end
 
@@ -32,7 +40,11 @@ module Cronofy
     @api_url = value
   end
 
-  def self.api_url_for_data_centre(dc)
+  def self.api_url_for_data_centre
+    api_url_for_data_center
+  end
+
+  def self.api_url_for_data_center(dc)
     @api_urls ||= Hash.new do |hash, key|
       if key.nil? || key.to_sym == :us
         url = "https://api.cronofy.com"
@@ -46,11 +58,11 @@ module Cronofy
     @api_urls[dc]
   end
 
-  def self.app_url(data_centre_override)
-    if data_centre_override
-      app_url_for_data_centre(data_centre_override)
+  def self.app_url(data_center_override)
+    if data_center_override
+      app_url_for_data_center(data_center_override)
     else
-      ENV['CRONOFY_APP_URL'] || app_url_for_data_centre(default_data_centre)
+      ENV['CRONOFY_APP_URL'] || app_url_for_data_center(default_data_center)
     end
   end
 
@@ -59,6 +71,10 @@ module Cronofy
   end
 
   def self.app_url_for_data_centre(dc)
+    app_url_for_data_center(dc)
+  end
+
+  def self.app_url_for_data_center(dc)
     @app_urls ||= Hash.new do |hash, key|
       if key.nil? || key.to_sym == :us
         url = "https://app.cronofy.com"

data/lib/cronofy/auth.rb

@@ -11,13 +11,13 @@ module Cronofy
       access_token = options[:access_token]
       client_id = options[:client_id]
       client_secret = options[:client_secret]
-      data_centre = options[:data_centre]
+      data_center = options[:data_center]
       refresh_token = options[:refresh_token]
 
       @client_credentials_missing = blank?(client_id) || blank?(client_secret)
 
-      @auth_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.app_url(data_centre), connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
-      @api_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.api_url(data_centre), connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
+      @auth_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.app_url(data_center), connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
+      @api_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.api_url(data_center), connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
 
       set_access_token(access_token, refresh_token) if access_token || refresh_token
       set_api_key(client_secret) if client_secret
@@ -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
@@ -25,22 +27,22 @@ module Cronofy
     #                            ENV["CRONOFY_CLIENT_SECRET"]).
     #           :refresh_token - An existing refresh token String for the user's
     #                            account (optional).
-    #           :data_centre   - An identifier to override the default data
-    #                            centre (optional).
+    #           :data_center   - An identifier to override the default data
+    #                            center (optional).
     def initialize(options = {})
       access_token  = options[:access_token]
       refresh_token = options[:refresh_token]
 
       @client_id     = options.fetch(:client_id, ENV["CRONOFY_CLIENT_ID"])
       @client_secret = options.fetch(:client_secret, ENV["CRONOFY_CLIENT_SECRET"])
-      @data_centre   = options[:data_centre]
+      @data_center   = options[:data_center] || options[:data_centre]
 
       @auth = Auth.new(
         client_id: @client_id,
         client_secret: @client_secret,
         access_token: access_token,
         refresh_token: refresh_token,
-        data_centre: @data_centre,
+        data_center: @data_center
       )
     end
 
@@ -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: {}):
@@ -793,7 +803,7 @@ module Cronofy
     #                                for a single participant group.
     #           :required_duration - An Integer representing the minimum number
     #                                of minutes of availability required.
-    #           :available_periods - An Array of available time periods Hashes,
+    #           :query_periods     - An Array of available time periods Hashes,
     #                                each must specify a start and end Time.
     #           :start_interval    - An Integer representing the start interval
     #                                of minutes for the availability query.
@@ -823,7 +833,7 @@ module Cronofy
         options[:buffer] = map_availability_buffer(buffer)
       end
 
-      translate_available_periods(options[:available_periods])
+      translate_available_periods(options[:query_periods] || options[:available_periods])
 
       response = post("/v1/availability", options)
 
@@ -837,7 +847,7 @@ module Cronofy
     # Public: Performs an sequenced availability query.
     #
     # options - The Hash options used to refine the selection (default: {}):
-    #           :sequence          - An Array of sequence defintions containing
+    #             :sequence          - An Array of sequence defintions containing
     #                                a Hash of:
     #             :sequence_id       - A String to uniquely identify this part
     #                                of the proposed sequence.
@@ -851,7 +861,7 @@ module Cronofy
     #                                of minutes for the availability query.
     #             :buffer            - An Hash containing the buffer to apply to
     #                                the availability query.
-    #           :available_periods - An Array of available time periods Hashes,
+    #             :query_periods     - An Array of available time periods Hashes,
     #                                each must specify a start and end Time.
     #
     # Returns an Array of Sequences.
@@ -868,7 +878,7 @@ module Cronofy
     def sequenced_availability(options = {})
       options[:sequence] = map_availability_sequence(options[:sequence])
 
-      translate_available_periods(options[:available_periods])
+      translate_available_periods(options[:query_periods] || options[:available_periods])
 
       response = post("/v1/sequenced_availability", options)
       parse_collection(Sequence, "sequences", response)
@@ -1492,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
@@ -1801,7 +1889,7 @@ module Cronofy
     end
 
     def api_url
-      ::Cronofy.api_url(@data_centre)
+      ::Cronofy.api_url(@data_center)
     end
   end
 

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.35.0".freeze
+  VERSION = "0.37.2".freeze
 end

data/spec/lib/cronofy/auth_spec.rb

@@ -92,7 +92,7 @@ describe Cronofy::Auth do
     let(:scheme) { 'https' }
     let(:host) { 'app.cronofy.com' }
     let(:path) { '/oauth/authorize' }
-    let(:data_centre_override) { nil }
+    let(:data_center_override) { nil }
     let(:default_params) do
       {
         'client_id' => client_id,
@@ -106,7 +106,7 @@ describe Cronofy::Auth do
       Cronofy::Auth.new(
         client_id: client_id,
         client_secret: client_secret,
-        data_centre: data_centre_override,
+        data_center: data_center_override,
       )
     end
 
@@ -156,8 +156,8 @@ describe Cronofy::Auth do
       it_behaves_like 'a user auth link provider'
     end
 
-    context 'when data centre overridden' do
-      let(:data_centre_override) { :de }
+    context 'when data center overridden' do
+      let(:data_center_override) { :de }
       let(:host) { 'app-de.cronofy.com' }
       let(:params) { default_params }
 
@@ -204,13 +204,13 @@ describe Cronofy::Auth do
   end
 
   describe '#get_token_from_code' do
-    let(:data_centre_override) { nil }
+    let(:data_center_override) { nil }
 
     subject do
       Cronofy::Auth.new(
         client_id: client_id,
         client_secret: client_secret,
-        data_centre: data_centre_override,
+        data_center: data_center_override,
       ).get_token_from_code(code, redirect_uri)
     end
 
@@ -236,7 +236,7 @@ describe Cronofy::Auth do
     end
 
     describe '#application_calendar' do
-      let(:data_centre_override) { nil }
+      let(:data_center_override) { nil }
 
       let(:application_calendar_id) { "my-application-calendar" }
       let(:cronofy_application_calendar_id) { "apc_54475485743" }
@@ -273,7 +273,7 @@ describe Cronofy::Auth do
         Cronofy::Auth.new(
           client_id: client_id,
           client_secret: client_secret,
-          data_centre: data_centre_override,
+          data_center: data_center_override,
         ).application_calendar(application_calendar_id)
       end
 
@@ -308,8 +308,8 @@ describe Cronofy::Auth do
       end
     end
 
-    context "with data centre overridden" do
-      let(:data_centre_override) { :de }
+    context "with data center overridden" do
+      let(:data_center_override) { :de }
       let(:api_token_url) { "https://api-de.cronofy.com/oauth/token" }
       let(:app_token_url) { "https://app-de.cronofy.com/oauth/token" }
 
@@ -372,14 +372,14 @@ describe Cronofy::Auth do
       it_behaves_like 'an authorization request'
     end
 
-    context "with data centre overridden" do
+    context "with data center overridden" do
       subject do
         Cronofy::Auth.new(
           client_id: client_id,
           client_secret: client_secret,
           access_token: access_token,
           refresh_token: refresh_token,
-          data_centre: :de,
+          data_center: :de,
         ).refresh!
       end
 
@@ -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

@@ -266,6 +266,7 @@ describe Cronofy::Client do
           ],
         }
       end
+
       let(:request_body) do
         {
           :event_id => "qTtZdczOccgaPncGJaCiLg",
@@ -1718,6 +1719,57 @@ describe Cronofy::Client do
         it_behaves_like 'a Cronofy request'
         it_behaves_like 'a Cronofy request with mapped return value'
       end
+
+      context "when given query_periods instead of available_periods" do
+        let(:participants) do
+          { members: %w{acc_567236000909002 acc_678347111010113} }
+        end
+
+        let(:required_duration) { 60 }
+
+        let(:query_periods) do
+          [
+            { start: Time.parse("2017-01-03T09:00:00Z"), end: Time.parse("2017-01-03T18:00:00Z") },
+            { start: Time.parse("2017-01-04T09:00:00Z"), end: Time.parse("2017-01-04T18:00:00Z") },
+          ]
+        end
+
+        let(:request_body) do
+          {
+            "participants" => [
+              {
+                "members" => [
+                  { "sub" => "acc_567236000909002" },
+                  { "sub" => "acc_678347111010113" }
+                ],
+                "required" => "all"
+              }
+            ],
+            "query_periods" => [
+              {
+                "start" => "2017-01-03T09:00:00Z",
+                "end" => "2017-01-03T18:00:00Z"
+              },
+              {
+                "start" => "2017-01-04T09:00:00Z",
+                "end" => "2017-01-04T18:00:00Z"
+              }
+            ],
+            "required_duration" => { "minutes" => 60 },
+          }
+        end
+
+        subject do
+          client.availability(
+            participants: participants,
+            required_duration: required_duration,
+            query_periods: query_periods
+          )
+        end
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
     end
   end
 
@@ -1873,6 +1925,18 @@ describe Cronofy::Client do
 
       it_behaves_like 'a Cronofy request'
       it_behaves_like 'a Cronofy request with mapped return value'
+
+      context "when passing query_periods instead" do
+        before do
+          args[:query_periods] = args[:available_periods]
+          args.delete(:available_periods)
+          request_body["query_periods"] = request_body["available_periods"]
+          request_body.delete("available_periods")
+        end
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
     end
   end
 
@@ -2325,8 +2389,8 @@ describe Cronofy::Client do
 
   end
 
-  describe "Specified data centre" do
-    let(:data_centre) { :de }
+  describe "specifying data_centre" do
+    let(:data_center) { :de }
 
     let(:client) do
       Cronofy::Client.new(
@@ -2334,12 +2398,52 @@ describe Cronofy::Client do
         client_secret: 'client_secret_456',
         access_token: token,
         refresh_token: 'refresh_token_456',
-        data_centre: data_centre,
+        data_centre: data_center,
       )
     end
 
     describe "Userinfo" do
-      let(:request_url) { "https://api-#{data_centre}.cronofy.com/v1/userinfo" }
+      let(:request_url) { "https://api-#{data_center}.cronofy.com/v1/userinfo" }
+
+      describe "#userinfo" do
+        let(:method) { :get }
+
+        let(:correct_response_code) { 200 }
+        let(:correct_response_body) do
+          {
+            "sub" => "ser_5700a00eb0ccd07000000000",
+            "cronofy.type" => "service_account",
+            "cronofy.service_account.domain" => "example.com"
+          }
+        end
+
+        let(:correct_mapped_result) do
+          Cronofy::UserInfo.new(correct_response_body)
+        end
+
+        subject { client.userinfo }
+
+        it_behaves_like "a Cronofy request"
+        it_behaves_like "a Cronofy request with mapped return value"
+      end
+    end
+  end
+
+  describe "specifying data_center" do
+    let(:data_center) { :au }
+
+    let(:client) do
+      Cronofy::Client.new(
+        client_id: 'client_id_123',
+        client_secret: 'client_secret_456',
+        access_token: token,
+        refresh_token: 'refresh_token_456',
+        data_center: data_center,
+      )
+    end
+
+    describe "Userinfo" do
+      let(:request_url) { "https://api-#{data_center}.cronofy.com/v1/userinfo" }
 
       describe "#userinfo" do
         let(:method) { :get }
@@ -3152,4 +3256,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.35.0
+  version: 0.37.2
 platform: ruby
 authors:
 - Sergii Paryzhskyi
 - Garry Shutler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2021-01-15 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,10 +156,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
-summary: Cronofy - one API for all the calendars
+summary: Cronofy - the scheduling platform for business
 test_files:
 - spec/spec_helper.rb
 - spec/response_parser_spec.rb