cronofy 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a517f51f9e209fd7b2f27d26c97daf641a45b90
-  data.tar.gz: d701d1ca79903ab281ffe138c2d53bb22d81d723
+  metadata.gz: cf2e08298ccea5ded0fbfdda981849d4baa3afe0
+  data.tar.gz: 7e790d91714ec2aa9b426ae16e0348d7854878c6
 SHA512:
-  metadata.gz: 8aa4f73c917c397d1a2306b40a6f76d4d198186b527c4cbaa974879772551b8140b1cdbe986dcc28f103c476da92f3dae75dc56f1535d5cb87194d62a51dc152
-  data.tar.gz: f132c20db5a57edd377b3b71d8746bc96900d0bea0c642df78255cb55af36f729ffb66929517685494c1fd8f40557e50ddeb600a3d6468e142b4c9d63545a508
+  metadata.gz: 1f90a02ae698495b2d3a6b904172a9cb69526a7fb729a45e3e4bf6de965dcc0de7d11d5ff1bc96d28ebe9a88b4087eee36041c4c1d6dc71c44ef291f8e660462
+  data.tar.gz: 9b80e6db0d04ab9687dc09dde40a5bf0ae1c076c837b3674ed19cc3e43abe41cdc3db2ce0c58eb080556e727ccc916e23d09afc40681bd1190e6897fd1917909

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.18.0]
+
+ * Support multiple data centres [#30]
+
 ## [0.17.0]
 
  * Support member-specific available periods for Availability API [#27]
@@ -35,6 +39,7 @@
 [0.15.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.15.0
 [0.16.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.16.0
 [0.17.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.17.0
+[0.18.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.18.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -44,3 +49,4 @@
 [#24]: https://github.com/cronofy/cronofy-ruby/pull/24
 [#26]: https://github.com/cronofy/cronofy-ruby/pull/26
 [#27]: https://github.com/cronofy/cronofy-ruby/pull/27
+[#30]: https://github.com/cronofy/cronofy-ruby/pull/30

data/lib/cronofy.rb

@@ -7,19 +7,63 @@ require "cronofy/response_parser"
 require 'json'
 
 module Cronofy
-  def self.api_url
-    @api_url ||= (ENV['CRONOFY_API_URL'] || "https://api.cronofy.com")
+  def self.default_data_centre
+    @default_data_centre || ENV['CRONOFY_DATA_CENTRE']
+  end
+
+  def self.default_data_centre=(value)
+    @default_data_centre = value
+  end
+
+  def self.api_url(data_centre_override)
+    if data_centre_override
+      api_url_for_data_centre(data_centre_override)
+    else
+      ENV['CRONOFY_API_URL'] || api_url_for_data_centre(default_data_centre)
+    end
   end
 
   def self.api_url=(value)
     @api_url = value
   end
 
-  def self.app_url
-    @app_url ||= (ENV['CRONOFY_APP_URL'] || "https://app.cronofy.com")
+  def self.api_url_for_data_centre(dc)
+    @api_urls ||= Hash.new do |hash, key|
+      if key.nil? || key.to_sym == :us
+        url = "https://api.cronofy.com"
+      else
+        url = "https://api-#{key}.cronofy.com"
+      end
+
+      hash[key] = url.freeze
+    end
+
+    @api_urls[dc]
+  end
+
+  def self.app_url(data_centre_override)
+    if data_centre_override
+      app_url_for_data_centre(data_centre_override)
+    else
+      ENV['CRONOFY_APP_URL'] || app_url_for_data_centre(default_data_centre)
+    end
   end
 
   def self.app_url=(value)
     @app_url = value
   end
+
+  def self.app_url_for_data_centre(dc)
+    @app_urls ||= Hash.new do |hash, key|
+      if key.nil? || key.to_sym == :us
+        url = "https://app.cronofy.com"
+      else
+        url = "https://app-#{key}.cronofy.com"
+      end
+
+      hash[key] = url.freeze
+    end
+
+    @app_urls[dc]
+  end
 end

data/lib/cronofy/auth.rb

@@ -5,13 +5,19 @@ module Cronofy
   class Auth
     attr_reader :access_token
 
-    def initialize(client_id, client_secret, token = nil, refresh_token = nil)
+    def initialize(options = {})
+      access_token = options[:access_token]
+      client_id = options[:client_id]
+      client_secret = options[:client_secret]
+      data_centre = options[:data_centre]
+      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, connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
-      @api_client = OAuth2::Client.new(client_id, client_secret, site: ::Cronofy.api_url, connection_opts: { headers: { "User-Agent" => "Cronofy Ruby #{::Cronofy::VERSION}" } })
+      @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}" } })
 
-      set_access_token(token, refresh_token) if token || refresh_token
+      set_access_token(access_token, refresh_token) if access_token || refresh_token
     end
 
     # Internal: generate a URL for authorizing the application with Cronofy

data/lib/cronofy/client.rb

@@ -23,13 +23,23 @@ 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).
     def initialize(options = {})
       access_token  = options[:access_token]
       client_id     = options.fetch(:client_id, ENV["CRONOFY_CLIENT_ID"])
       client_secret = options.fetch(:client_secret, ENV["CRONOFY_CLIENT_SECRET"])
       refresh_token = options[:refresh_token]
 
-      @auth = Auth.new(client_id, client_secret, access_token, refresh_token)
+      @data_centre   = 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,
+      )
     end
 
     # Public: Creates a new calendar for the account.
@@ -207,7 +217,7 @@ module Cronofy
         params[tp] = to_iso8601(params[tp])
       end
 
-      url = ::Cronofy.api_url + "/v1/events"
+      url = api_url + "/v1/events"
       PagedResultIterator.new(PagedEventsResult, :events, access_token!, url, params)
     end
 
@@ -255,7 +265,7 @@ module Cronofy
         params[tp] = to_iso8601(params[tp])
       end
 
-      url = ::Cronofy.api_url + "/v1/free_busy"
+      url = api_url + "/v1/free_busy"
       PagedResultIterator.new(PagedFreeBusyResult, :free_busy, access_token!, url, params)
     end
 
@@ -891,6 +901,10 @@ module Cronofy
         ResponseParser.new(response).parse_json(@page_parser)
       end
     end
+
+    def api_url
+      ::Cronofy.api_url(@data_centre)
+    end
   end
 
   # Deprecated: Alias for Client for backwards compatibility.

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.17.0".freeze
+  VERSION = "0.18.0".freeze
 end

data/spec/lib/cronofy/auth_spec.rb

@@ -22,10 +22,13 @@ describe Cronofy::Auth do
     WebMock.disable_net_connect!(allow_localhost: true)
   end
 
+  let(:api_token_url) { "https://api.cronofy.com/oauth/token" }
+  let(:app_token_url) { "https://app.cronofy.com/oauth/token" }
+
   let(:response_status) { 200 }
 
   before(:each) do
-    stub_request(:post, "https://api.cronofy.com/oauth/token")
+    stub_request(:post, api_token_url)
       .with(
         body: {
           client_id: client_id,
@@ -52,7 +55,7 @@ describe Cronofy::Auth do
         }
       )
 
-    stub_request(:post, "https://app.cronofy.com/oauth/token")
+    stub_request(:post, app_token_url)
       .with(
         body: {
           client_id: client_id,
@@ -89,6 +92,7 @@ describe Cronofy::Auth do
     let(:scheme) { 'https' }
     let(:host) { 'app.cronofy.com' }
     let(:path) { '/oauth/authorize' }
+    let(:data_centre_override) { nil }
     let(:default_params) do
       {
         'client_id' => client_id,
@@ -99,7 +103,11 @@ describe Cronofy::Auth do
     end
 
     let(:auth) do
-      Cronofy::Auth.new(client_id, client_secret)
+      Cronofy::Auth.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        data_centre: data_centre_override,
+      )
     end
 
     subject do
@@ -147,6 +155,14 @@ describe Cronofy::Auth do
 
       it_behaves_like 'a user auth link provider'
     end
+
+    context 'when data centre overridden' do
+      let(:data_centre_override) { :de }
+      let(:host) { 'app-de.cronofy.com' }
+      let(:params) { default_params }
+
+      it_behaves_like 'a user auth link provider'
+    end
   end
 
   shared_examples 'an authorization request' do
@@ -188,7 +204,15 @@ describe Cronofy::Auth do
   end
 
   describe '#get_token_from_code' do
-    subject { Cronofy::Auth.new(client_id, client_secret).get_token_from_code(code, redirect_uri) }
+    let(:data_centre_override) { nil }
+
+    subject do
+      Cronofy::Auth.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        data_centre: data_centre_override,
+      ).get_token_from_code(code, redirect_uri)
+    end
 
     context "with account_id" do
       let(:account_id) { "acc_0123456789abc" }
@@ -239,13 +263,26 @@ describe Cronofy::Auth do
       end
     end
 
+    context "with data centre overridden" do
+      let(:data_centre_override) { :de }
+      let(:api_token_url) { "https://api-de.cronofy.com/oauth/token" }
+      let(:app_token_url) { "https://app-de.cronofy.com/oauth/token" }
+
+      it_behaves_like 'an authorization request'
+    end
+
     it_behaves_like 'an authorization request'
   end
 
   describe '#refresh!' do
     context "access_token and refresh_token present" do
       subject do
-        Cronofy::Auth.new(client_id, client_secret, access_token, refresh_token).refresh!
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+          access_token: access_token,
+          refresh_token: refresh_token,
+        ).refresh!
       end
 
       it_behaves_like 'an authorization request'
@@ -253,7 +290,11 @@ describe Cronofy::Auth do
 
     context "no refresh_token" do
       subject do
-        Cronofy::Auth.new(client_id, client_secret, access_token, nil).refresh!
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+          access_token: access_token,
+        ).refresh!
       end
 
       it "raises a credentials missing error" do
@@ -263,7 +304,10 @@ describe Cronofy::Auth do
 
     context "no access_token or refresh_token" do
       subject do
-        Cronofy::Auth.new(client_id, client_secret, nil, nil).refresh!
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+        ).refresh!
       end
 
       it "raises a credentials missing error" do
@@ -273,11 +317,32 @@ describe Cronofy::Auth do
 
     context "only refresh_token" do
       subject do
-        Cronofy::Auth.new(client_id, client_secret, nil, refresh_token).refresh!
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+          refresh_token: refresh_token,
+        ).refresh!
       end
 
       it_behaves_like 'an authorization request'
     end
+
+    context "with data centre 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,
+        ).refresh!
+      end
+
+      let(:api_token_url) { "https://api-de.cronofy.com/oauth/token" }
+      let(:app_token_url) { "https://app-de.cronofy.com/oauth/token" }
+
+      it_behaves_like 'an authorization request'
+    end
   end
 
   describe "#revoke!" do
@@ -315,7 +380,12 @@ describe Cronofy::Auth do
 
     context "access_token and refresh_token present" do
       let(:auth) do
-        Cronofy::Auth.new(client_id, client_secret, access_token, refresh_token)
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+          access_token: access_token,
+          refresh_token: refresh_token,
+        )
       end
 
       let(:revoke_token) { refresh_token }
@@ -325,7 +395,11 @@ describe Cronofy::Auth do
 
     context "only refresh_token" do
       let(:auth) do
-        Cronofy::Auth.new(client_id, client_secret, nil, refresh_token)
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+          refresh_token: refresh_token,
+        )
       end
 
       let(:revoke_token) { refresh_token }
@@ -335,7 +409,11 @@ describe Cronofy::Auth do
 
     context "only access_token" do
       let(:auth) do
-        Cronofy::Auth.new(client_id, client_secret, access_token, nil)
+        Cronofy::Auth.new(
+          client_id: client_id,
+          client_secret: client_secret,
+          access_token: access_token,
+        )
       end
 
       let(:revoke_token) { access_token }
@@ -345,7 +423,7 @@ describe Cronofy::Auth do
 
     context "no access_token or refresh_token" do
       let(:auth) do
-        Cronofy::Auth.new(client_id, client_secret, nil, nil)
+        Cronofy::Auth.new(client_id: client_id, client_secret: client_secret)
       end
 
       it "raises a credentials missing error" do

data/spec/lib/cronofy/client_spec.rb

@@ -1283,4 +1283,44 @@ describe Cronofy::Client do
       end
     end
   end
+
+  describe "Specified data centre" do
+    let(:data_centre) { :de }
+
+    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_centre: data_centre,
+      )
+    end
+
+    describe "Userinfo" do
+      let(:request_url) { "https://api-#{data_centre}.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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2