warden-github 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 224cc683e53b8c9473f283a08b8e1fe055c5731f
-  data.tar.gz: c7d9b17f19afd74236dbaeb9e14a1598e2bd3761
+  metadata.gz: 19f7ba1fd04d8c9480a20834ce998b07685f7bcf
+  data.tar.gz: c1dc58f92e7bb9682f17e29598b879926ddccc32
 SHA512:
-  metadata.gz: 3bc465c114cce993843b36b8c9d5273ae3bd6084babb0ac7f04d79cdaa15c45dda22c96b5246b7e91f1a6d818923acff2dfc8aa7bfa07764faf62ac48585eb6f
-  data.tar.gz: ea076c77866bc95683a747c63493ce020dd3a4c98349c7f27de81d6b8c651255961bf87df30fd539cc5f846f361ea17f4ee40e851269e9fa896d22ffa83887d6
+  metadata.gz: 9a0926d904ffc5f765d138c38cb8fdf9bf95b8ef8514111683724d550184802a867906d7e2a0a20bcd9297c791d6c51f5737bc33d8817c81bffb859df83fc357
+  data.tar.gz: 26e92ebfaedef533d2610b2a8ba91b76d7a4265ec5b8f978a3c624bf4e6199a0f0ccb5b53e489d32d1c6e2b9668ed6fe299b1fc585b51cdb66d43a35d1cacb5b

data/README.md

@@ -53,9 +53,14 @@ use Warden::Manager do |config|
                                              :client_secret => 'barfoo',
                                              :scope         => 'user,repo',
                                              :redirect_uri  => '/admin/oauth/callback' }
+
+  config.serialize_from_session { |key| Warden::GitHub::Verifier.load(key) }
+  config.serialize_into_session { |user| Warden::GitHub::Verifier.dump(user) }
 end
 ```
 
+The two serialization methods store the API token in the session securely via the `WARDEN_GITHUB_VERIFIER_SECRET` environmental variable.
+
 ### Parameters
 
 The config parameters and their defaults are listed below.

data/config.ru

@@ -1,19 +1,6 @@
 ENV['RACK_ENV'] ||= 'development'
 
-begin
-  require File.expand_path('../.bundle/environment', __FILE__)
-rescue LoadError
-  require "rubygems"
-  require "bundler"
-  Bundler.setup
-end
-
-begin
-  require 'debugger'
-rescue LoadError
-  require 'ruby-debug'
-end
-
+require "bundler/setup"
 require 'warden/github'
 
 if ENV['MULTI_SCOPE_APP']

data/example/simple_app.rb

@@ -14,6 +14,8 @@ module Example
       config.failure_app = BadAuthentication
       config.default_strategies :github
       config.scope_defaults :default, :config => GITHUB_CONFIG
+      config.serialize_from_session { |key| Warden::GitHub::Verifier.load(key) }
+      config.serialize_into_session { |user| Warden::GitHub::Verifier.dump(user) }
     end
 
     get '/' do

data/lib/warden/github.rb

@@ -7,5 +7,7 @@ require 'warden/github/strategy'
 require 'warden/github/hook'
 require 'warden/github/config'
 require 'warden/github/membership_cache'
+require 'warden/github/verifier'
 
+require 'active_support/message_verifier'
 require 'securerandom'

data/lib/warden/github/verifier.rb

@@ -0,0 +1,38 @@
+module Warden
+  module GitHub
+    class Verifier
+      def self.dump(user)
+        new.serialize(user)
+      end
+
+      def self.load(key)
+        new.deserialize(key)
+      end
+
+      def serialize(user)
+        cookie_verifier.generate(user.marshal_dump)
+      end
+
+      def deserialize(key)
+        User.new.tap do |u|
+          u.marshal_load(cookie_verifier.verify(key))
+        end
+      rescue ::ActiveSupport::MessageVerifier::InvalidSignature
+        nil
+      end
+
+      def verifier_key
+        self.class.verifier_key
+      end
+
+      private
+      def self.verifier_key
+        @verifier_key ||= ENV['WARDEN_GITHUB_VERIFIER_SECRET'] || SecureRandom.hex
+      end
+
+      def cookie_verifier
+        @cookie_verifier ||= ::ActiveSupport::MessageVerifier.new(verifier_key, serializer: JSON)
+      end
+    end
+  end
+end

data/lib/warden/github/version.rb

@@ -1,5 +1,5 @@
 module Warden
   module GitHub
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end

data/spec/unit/membership_cache_spec.rb

@@ -7,7 +7,7 @@ describe Warden::GitHub::MembershipCache do
 
   describe '#fetch_membership' do
     it 'returns false by default' do
-      cache.fetch_membership('foo', 'bar').should be_false
+      cache.fetch_membership('foo', 'bar').should be_falsey
     end
 
     context 'when cache valid' do
@@ -17,7 +17,7 @@ describe Warden::GitHub::MembershipCache do
       end
 
       it 'returns true' do
-        cache.fetch_membership('foo', 'bar').should be_true
+        cache.fetch_membership('foo', 'bar').should be_truthy
       end
 
       it 'does not invoke the block' do
@@ -34,7 +34,7 @@ describe Warden::GitHub::MembershipCache do
 
       context 'when no block given' do
         it 'returns false' do
-          cache.fetch_membership('foo', 'bar').should be_false
+          cache.fetch_membership('foo', 'bar').should be_falsey
         end
       end
 
@@ -51,12 +51,12 @@ describe Warden::GitHub::MembershipCache do
 
     it 'caches the value when block returns true' do
       cache.fetch_membership('foo', 'bar') { true }
-      cache.fetch_membership('foo', 'bar').should be_true
+      cache.fetch_membership('foo', 'bar').should be_truthy
     end
 
     it 'does not cache the value when block returns false' do
       cache.fetch_membership('foo', 'bar') { false }
-      cache.fetch_membership('foo', 'bar').should be_false
+      cache.fetch_membership('foo', 'bar').should be_falsey
     end
   end
 end

data/spec/unit/user_spec.rb

@@ -50,14 +50,14 @@ describe Warden::GitHub::User do
       context 'when user is not member' do
         it 'returns false' do
           stub_api(user, method, ['rails', user.login], false)
-          user.send(method, 'rails').should be_false
+          user.send(method, 'rails').should be_falsey
         end
       end
 
       context 'when user is member' do
         it 'returns true' do
           stub_api(user, method, ['rails', user.login], true)
-          user.send(method, 'rails').should be_true
+          user.send(method, 'rails').should be_truthy
         end
       end
     end

data/warden-github.gemspec

@@ -14,8 +14,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "warden-github"
 
-  s.add_dependency "warden",    ">1.0"
-  s.add_dependency "octokit",   ">2.1.0"
+  s.add_dependency "warden",        ">1.0"
+  s.add_dependency "octokit",       ">2.1.0"
+  s.add_dependency "activesupport", ">3.0"
 
   s.add_development_dependency "rack",      "~>1.4.1"
   s.add_development_dependency "rake"
@@ -24,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "webmock",   "~>1.9"
   s.add_development_dependency "sinatra"
   s.add_development_dependency "shotgun"
-  s.add_development_dependency "addressable", "~>2.2.0"
+  s.add_development_dependency "addressable", ">2.2.0"
   s.add_development_dependency "rack-test",   "~>0.5.3"
   s.add_development_dependency "yajl-ruby"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warden-github
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Corey Donohoe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-13 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: warden
@@ -38,6 +38,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +154,14 @@ dependencies:
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.2.0
 - !ruby/object:Gem::Dependency
@@ -204,6 +218,7 @@ files:
 - lib/warden/github/oauth.rb
 - lib/warden/github/strategy.rb
 - lib/warden/github/user.rb
+- lib/warden/github/verifier.rb
 - lib/warden/github/version.rb
 - spec/fixtures/user.json
 - spec/integration/oauth_spec.rb