cronofy 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45bf57c6a8beff0b87cba2a4f20ce39f2d346c08
-  data.tar.gz: b44a0e902fdce56a5235777245da5401732c7e06
+  metadata.gz: d36dfd5dfa353d4d906d8ca54a6f5de39d584b13
+  data.tar.gz: 7b38f363878df9bf48df0cf16faba49c42379f67
 SHA512:
-  metadata.gz: 1c9b7b89e732c1d5f2549e7490cdee7868fd8843b1fbe52dcda029452efad15aa201ed18a7fd2b3b21359a10e3d8beaa5e32754e530356264ded15bede98c491
-  data.tar.gz: 27595f37ddb805069debcd433fa7c72aac23d6914dea8ccc57260b8ea4af28bfdcf44b4ff08d1d59bfddb60c38f9d0831ce9e308f87749c287b1108449559f8e
+  metadata.gz: 5025298994becd0ae491eaf498db26578535779bac1535fec7cf27b2e0ef3fdf4a89f71b172f01bb6a04f0c1ce804039fe465d403f5bc2ba7dbba839a17ac0dd
+  data.tar.gz: 28d0d9200ce72f96978309df3ec1bc9e908af2149b6279a3c7be9852ac4e82f635424f119ba865852aae23e283d54ef5ffd0d7bd5f81ea7dbf07bb0d9a26af2b

data/lib/cronofy/auth.rb

@@ -14,14 +14,28 @@ module Cronofy
 
     # Internal: generate a URL for authorizing the application with Cronofy
     #
-    # redirect_uri    String, the URI to return to after authorization
-    # scope           Array of String, the scope requested
+    # redirect_uri - A String specifing the URI to return the user to once they
+    #                have completed the authorization steps.
+    # options      - The Hash options used to refine the selection
+    #                (default: {}):
+    #                :scope - Array of scopes describing the access to request
+    #                         from the user to the users calendars (required).
+    #                :state - String containing the state value to retain during
+    #                         the OAuth authorization process (optional).
     #
     # See http://www.cronofy.com/developers/api#authorization for reference.
     #
     # Returns the URL as a String.
-    def user_auth_link(redirect_uri, scope)
-      @auth_client.auth_code.authorize_url(redirect_uri: redirect_uri, response_type: 'code', scope: scope.join(' '))
+    def user_auth_link(redirect_uri, options = {})
+      raise ArgumentError.new(":scope is required") unless options[:scope]
+
+      params = options.merge(redirect_uri: redirect_uri, response_type: 'code')
+
+      # Reformat params as needed
+      params.delete(:state) if params[:state].nil?
+      params[:scope] = params[:scope].join(' ')
+
+      @auth_client.auth_code.authorize_url(params)
     end
 
     def get_token_from_code(code, redirect_uri)

data/lib/cronofy/client.rb

@@ -268,17 +268,22 @@ module Cronofy
     # Public: Generates a URL to send the user to in order to perform the OAuth
     # 2.0 authorization process.
     #
-    # redirect_url - A String specifing the URL to return the user to once they
+    # redirect_uri - A String specifing the URI to return the user to once they
     #                have completed the authorization steps.
-    # scope        - Array of scopes describing the access to request from the
-    #                user to the users calendars (default:
-    #                DEFAULT_OAUTH_SCOPE).
+    # options      - The Hash options used to refine the selection
+    #                (default: {}):
+    #                :scope - Array of scopes describing the access to request
+    #                         from the user to the users calendars
+    #                         (default: DEFAULT_OAUTH_SCOPE).
+    #                :state - String containing the state value to retain during
+    #                         the OAuth authorization process (optional).
     #
     # See http://www.cronofy.com/developers/api#authorization for reference.
     #
     # Returns the URL as a String.
-    def user_auth_link(redirect_url, scope = DEFAULT_OAUTH_SCOPE)
-      @auth.user_auth_link(redirect_url, scope)
+    def user_auth_link(redirect_url, options = {})
+      options = { scope: DEFAULT_OAUTH_SCOPE }.merge(options)
+      @auth.user_auth_link(redirect_url, options)
     end
 
     # Public: Retrieves the OAuth credentials authorized for the given code and

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/spec/lib/cronofy/auth_spec.rb

@@ -78,6 +78,65 @@ describe Cronofy::Auth do
       )
   end
 
+  describe '#user_auth_link' do
+    let(:scope_array) { %w{read_events list_calendars create_event} }
+    let(:scheme) { 'https' }
+    let(:host) { 'app.cronofy.com' }
+    let(:path) { '/oauth/authorize' }
+    let(:default_params) do
+      {
+        'client_id' => client_id,
+        'redirect_uri' => redirect_uri,
+        'response_type' => 'code',
+        'scope' => scope
+      }
+    end
+
+    let(:auth) do
+      Cronofy::Auth.new(client_id, client_secret)
+    end
+
+    subject do
+      url = auth.user_auth_link(redirect_uri, scope: scope_array, state: state)
+      URI.parse(url)
+    end
+
+    shared_examples 'a user auth link provider' do
+      it 'contains the correct scheme' do
+        expect(subject.scheme).to eq scheme
+      end
+
+      it 'contains the correct host' do
+        expect(subject.host).to eq host
+      end
+
+      it 'contains the correct path' do
+        expect(subject.path).to eq path
+      end
+
+      it 'contains the correct query params' do
+        expect(Rack::Utils.parse_query(subject.query)).to eq params
+      end
+    end
+
+    context 'when no state' do
+      let(:state) { nil }
+      let(:params) { default_params }
+
+      it_behaves_like 'a user auth link provider'
+    end
+
+    context 'when state is passed' do
+      let(:state) { SecureRandom.hex }
+      let(:params) do
+        default_params['state'] = state
+        default_params
+      end
+
+      it_behaves_like 'a user auth link provider'
+    end
+  end
+
   shared_examples 'an authorization request' do
     context 'when succeeds' do
       it 'returns a correct Credentials object' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2