openid-token-proxy 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad5b40cf76aaa072761205d1bd32fe875a860823
-  data.tar.gz: 853220559755b75e246c4ed5a1f26bbc91df1d51
+  metadata.gz: c64cf28d8d4c3fb0774488c18ecae95c5e3abcbb
+  data.tar.gz: 4eaa2ce104d161d27c36ff7291bf25990fb15106
 SHA512:
-  metadata.gz: 55c42e5b66a8b7b151d320700d88b94b6993cff8f4a7e4ede2c23d2730b328bc3fa0b10edd02f5c16917873f49610d83489640e3b5b1c3501fd1e9248c705c5c
-  data.tar.gz: dcceecab4f6033cbdf6e7aaed30714034614c17cb785c9126d5bfcd6d87894a631f19bccfceef631d213f4ccb5d7447e43ca67cf0e0630bd8e2de52c55911c3e
+  metadata.gz: d76ce92ad630b77f81c9cd1c9b993c52a886728f4bed5cfbc86fbc8ddd6d702e1597e3d77addb8ee4626f542cde7f6f5ee4bb3a99e93db78715991b1cfa7e8d6
+  data.tar.gz: 3f658685bfc72a789dd1427c4632d396ee89cfcc82c606c2ae08d35c69a61eadb047fcccf2a99794a70a0cf5e3dc5e7b3e9335333a02be7a99046f4508c072a8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### v0.1.7 - February 15, 2016
+
+- Allow passing tokens from cookies.
+- Allowing hooking into token refreshment.
 
 ### v0.1.6 - October 13, 2015
 

data/README.md

@@ -148,6 +148,7 @@ Access tokens may be provided with one of the following:
 - `X-Token` header.
 - `Authorization: Bearer <token>` header.
 - Query string parameter `token`.
+- Cookie `token`.
 
 Token expiry time will be exposed through the `X-Token-Expiry-Time` header.
 
@@ -187,6 +188,7 @@ Refresh tokens may be provided with one of the following:
 
 - `X-Refresh-Token` header.
 - Query string parameter `refresh_token`.
+- Cookie `refresh_token`.
 
 Whenever an access token has expired and a refresh token is given, the module will
 attempt to obtain a new token transparently.
@@ -197,6 +199,17 @@ token was obtained:
 - `X-Token` header containing the new access token to be used in future requests.
 - `X-Refresh-Token` header containing the new refresh token.
 
+You may configure some code to be run (scoped to a controller) when a token is
+successfully refreshed:
+
+```ruby
+OpenIDTokenProxy.configure do |config|
+  config.token_refreshment_hook = proc { |token|
+    cookies[:token] = token.access_token
+  }
+end
+```
+
 
 ## Contributing
 

data/lib/openid_token_proxy/config.rb

@@ -11,6 +11,7 @@ module OpenIDTokenProxy
                   :userinfo_endpoint, :end_session_endpoint
 
     attr_accessor :token_acquirement_hook
+    attr_accessor :token_refreshment_hook
     attr_accessor :public_keys
 
     def initialize
@@ -31,6 +32,7 @@ module OpenIDTokenProxy
       @end_session_endpoint = ENV['OPENID_END_SESSION_ENDPOINT']
 
       @token_acquirement_hook = proc { }
+      @token_refreshment_hook = proc { }
 
       yield self if block_given?
     end

data/lib/openid_token_proxy/token/authentication.rb

@@ -50,7 +50,7 @@ module OpenIDTokenProxy
           return token if token
         end
 
-        request.headers['X-Token']
+        request.headers['X-Token'] || cookies[:token]
       end
     end
   end

data/lib/openid_token_proxy/token/refresh.rb

@@ -17,11 +17,18 @@ module OpenIDTokenProxy
           )
           response.headers['X-Token'] = current_token.access_token
           response.headers['X-Refresh-Token'] = current_token.refresh_token
+
+          instance_exec(
+            current_token,
+            &OpenIDTokenProxy.config.token_refreshment_hook
+          )
         end
       end
 
       def raw_refresh_token
-        params[:refresh_token] || request.headers['X-Refresh-Token']
+        params[:refresh_token] ||
+        request.headers['X-Refresh-Token'] ||
+        cookies[:refresh_token]
       end
     end
   end

data/lib/openid_token_proxy/version.rb

@@ -1,3 +1,3 @@
 module OpenIDTokenProxy
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/spec/controllers/openid_token_proxy/callback_controller_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe OpenIDTokenProxy::CallbackController, type: :controller do
   let(:access_token) { 'access token' }
   let(:auth_code) { 'authorization code' }
   let(:client) { OpenIDTokenProxy.client }
-  let(:token) { double(access_token: access_token) }
+  let(:token) { OpenIDTokenProxy::Token.new 'token' }
 
   context 'when authorization code is missing' do
     it 'results in 400 BAD REQUEST with error message' do
@@ -36,8 +36,10 @@ RSpec.describe OpenIDTokenProxy::CallbackController, type: :controller do
       context 'with no-op token acquirement hook' do
         it 'redirects to root' do
           OpenIDTokenProxy.configure_temporarily do |config|
-            config.token_acquirement_hook = proc { }
-            get :handle, code: auth_code
+            expect do |probe|
+              config.token_acquirement_hook = probe
+              get :handle, code: auth_code
+            end.to yield_with_args(instance_of(OpenIDTokenProxy::Token))
             expect(response).to redirect_to controller.main_app.root_url
           end
         end

data/spec/lib/openid_token_proxy/token/authentication_spec.rb

@@ -74,5 +74,11 @@ RSpec.describe OpenIDTokenProxy::Token::Authentication, type: :controller do
       get :index
       expect(controller.raw_token).to eq 'raw token'
     end
+
+    it 'may be provided as a cookie' do
+      cookies[:token] = 'raw token'
+      get :index
+      expect(controller.raw_token).to eq 'raw token'
+    end
   end
 end

data/spec/lib/openid_token_proxy/token/refresh_spec.rb

@@ -57,12 +57,17 @@ RSpec.describe OpenIDTokenProxy::Token::Refresh, type: :controller do
 
     context 'when token was refreshed successfully' do
       it 'executes actions normally returning new tokens as headers' do
-        get :index, refresh_token: refresh_token
-        expect(response).to have_http_status :ok
-        expect(response.body).to eq 'Refresh successful'
-        expect(response.headers['X-Token']).to eq 'new access token'
-        expect(response.headers['X-Refresh-Token']).to eq 'new refresh token'
-        expect(response.headers['X-Token-Expiry-Time']).to eq refreshed_expiry_time.iso8601
+        OpenIDTokenProxy.configure_temporarily do |config|
+          expect do |probe|
+            config.token_refreshment_hook = probe
+            get :index, refresh_token: refresh_token
+          end.to yield_with_args(instance_of(OpenIDTokenProxy::Token))
+          expect(response).to have_http_status :ok
+          expect(response.body).to eq 'Refresh successful'
+          expect(response.headers['X-Token']).to eq 'new access token'
+          expect(response.headers['X-Refresh-Token']).to eq 'new refresh token'
+          expect(response.headers['X-Token-Expiry-Time']).to eq refreshed_expiry_time.iso8601
+        end
       end
     end
   end
@@ -78,5 +83,11 @@ RSpec.describe OpenIDTokenProxy::Token::Refresh, type: :controller do
       get :index
       expect(controller.raw_refresh_token).to eq 'refresh token'
     end
+
+    it 'may be provided as a cookie' do
+      cookies[:refresh_token] = refresh_token
+      get :index
+      expect(controller.raw_refresh_token).to eq 'refresh token'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openid-token-proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Tim Kurvers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openid_connect
@@ -311,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Retrieves and refreshes OpenID tokens on behalf of a user