grape_session 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e7d06bb6b8284a27df8bfb896abe49a456f64f2
-  data.tar.gz: f27a92fcce4b9c191133a033da00186d08d32b50
+  metadata.gz: 858265d4420dd157f8c933b293aa97b90ac784eb
+  data.tar.gz: 9c6fa6d502dd7890d3965ff466104974ada96219
 SHA512:
-  metadata.gz: 1b3ec0ef90c5cf13f77a262b87904b9857b4587add4dd5a59626e7ebb9b87b7252c34b4787ce88a4aeb0acd41ee2875aa2fb39b00e98a1f8be0c8d439e2bd701
-  data.tar.gz: c04593f25a502070d6773cd3f5f4ad183c276b20fb0967662e58215583be24ad8eb328c575a4054a84c8b8269fc01c9728b22a5c9caa0e5b7f93ff4044200d8f
+  metadata.gz: 8efbefeb86b221f395f250eeb2dbcf06535e480a69043f7b3ea9a0929789aa8d351631cae2053fe02ed43a0b6dd46db49381132d61b47684d2f4490e5b8eb833
+  data.tar.gz: 3dcde22738396fbd66b3842d77db28b1c6e6f1130514bbb7dcb715f5741469f257b43ff850986776a0bf103b0c1dfd5984f7654ee07954909ec95137f4e837fa

data/README.md

@@ -1,9 +1,7 @@
 # GrapeSession (Project-State: Proposal)
 
-Make Rails session and cookie handling available for grape. `cookies` method 
-will return an `ActionDispatch::Cookies::CookieJar` instead of `Grape::Cookie`.
-
-A method `session` is added.
+Make Rails cookies based session handling available for grape. `session` method 
+is added to the Endpoint classes.
 
 The following classes will be monkey patched:
 
@@ -33,32 +31,32 @@ Or install it yourself as:
 class API < Grape::API
   include GrapeSession::Ext::API
 
-  GrapeSession::Middleware::EnvSetup.settings {
-     signed_cookie_salt: 'signed cookie',
-     encrypted_cookie_salt: 'encrypted cookie',
-     encrypted_signed_cookie_salt: 'signed encrypted cookie',
-     secret_token: 'secret_token',
-     secret_key_base: 'secret base',
-     cookies_serializer: :json
-     
-     session_options: { 
-       # Rails specific ActionDispatch::Compatibility
-       key: '_grape_session_id' 
-       # Rack::Session::Abstract::ID specific
-       domain: 'foo.com',
-       path:  '/',
-       expire_after: 2592000,
-       secure: false,
-       httponly: true,
-       defer: false,
-       renew: false,
-     }
-  }
+  # Setup cookie settings
+  GrapeCookies::Middleware::EnvSetup.configure do
+     signed_cookie_salt 'signed cookie'
+     encrypted_cookie_salt 'encrypted cookie'
+     encrypted_signed_cookie_salt 'signed encrypted cookie'
+     secret_token 'secret_token'
+     secret_key_base 'secret base'
+     cookies_serializer :json
+  end
+
+  # Setup session settings
+  GrapeSession::Configuration.configure do
+    # Rails specific ActionDispatch::Compatibility
+    key '_grape_session_id' 
+    # Rack::Session::Abstract::ID specific
+    domain 'foo.com'
+    path  '/'
+    expire_after 2592000
+    secure false
+    httponly true
+    defer false
+    renew false
+  end
   
   
   get '/test' do
-    cookies.signed['test_signed'] = '1234'
-    cookies['test_unsigned_signed'] = 'unsigned_1234'
     session['session_test'] = 'session_test_value'
   end
 

data/grape_session.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = GrapeSession::VERSION
   spec.authors       = ['Dieter Späth']
   spec.email         = ['d.spaeth@faber.de']
-  spec.summary       = 'Adds Rails like session and cookie support to grape api'
-  spec.description   = 'Adds Rails like session and cookie support to grape api'
+  spec.summary       = 'Adds Rails like session support to grape api'
+  spec.description   = 'Adds Rails like session support to grape api'
   spec.homepage      = 'https://github.com/faber-lotto/grape_session'
   spec.license       = 'MIT'
 
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rack-accept'
   spec.add_runtime_dependency 'activesupport', '>=4.1.0'
   spec.add_runtime_dependency 'actionpack', '>=4.1.0'
+  spec.add_runtime_dependency 'grape_cookies'
 
   spec.add_development_dependency 'grape'
 

data/lib/grape_session.rb

@@ -1,13 +1,12 @@
 require 'rack'
 require 'grape_session/version'
 require 'active_support/concern'
+require 'grape_cookies'
 
 module GrapeSession
-  require 'grape_session/middleware/env_setup'
+  require 'grape_session/configuration'
   require 'grape_session/ext/endpoint'
-  require 'grape_session/ext/request'
   require 'grape_session/ext/api'
-  require 'grape_session/ext/cookie_jar'
 end
 
 require 'grape'
@@ -15,9 +14,3 @@ require 'grape/api'
 require 'grape/endpoint'
 
 Grape::Endpoint.send(:include, GrapeSession::Ext::Endpoint)
-Grape::Request.send(:include, GrapeSession::Ext::Request)
-# Grape::API.send(:include, GrapeSession::Ext::API)
-
-unless ActionDispatch::Cookies::CookieJar.instance_methods.include? :read
-  ActionDispatch::Cookies::CookieJar.send(:include, GrapeSession::Ext::CookieJar)
-end

data/lib/grape_session/configuration.rb

@@ -0,0 +1,10 @@
+module GrapeSession
+  class Configuration
+    include GrapeCookies::Configuration.module(:key, :domain, :path, :expire_after, :secure, :httponly, :defer, :renew)
+
+    # setup defaults
+    configure do
+      key '_grape_session_id'
+    end
+  end
+end

data/lib/grape_session/ext/api.rb

@@ -6,11 +6,11 @@ module GrapeSession
     module API
       extend ActiveSupport::Concern
 
+      include GrapeCookies::Ext::API
+
       included do
 
-        use GrapeSession::Middleware::EnvSetup
-        use ActionDispatch::Cookies
-        use ActionDispatch::Session::CookieStore, GrapeSession::Middleware::EnvSetup.settings[:session_options]
+        use ActionDispatch::Session::CookieStore, GrapeSession::Configuration.settings.dup
 
       end
 

data/lib/grape_session/ext/endpoint.rb

@@ -6,10 +6,6 @@ module GrapeSession
       included do
       end
 
-      def cookies
-        request.cookie_jar
-      end
-
       def session
         request.session
       end

data/lib/grape_session/version.rb

@@ -1,3 +1,3 @@
 module GrapeSession
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/acceptance/session_spec.rb

@@ -50,6 +50,12 @@ feature 'Use an encrypted session' do
   scenario 'Get session' do
     get '/test'
 
+    memo_session = response_cookies['_grape_session_id']
+
+    clear_cookies
+
+    set_cookie "_grape_session_id=#{memo_session}"
+
     get '/return'
 
     expect(last_response.body).to include('"session_test"=>"session_test_value"')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_session
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dieter Späth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: grape_cookies
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
@@ -262,7 +276,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Adds Rails like session and cookie support to grape api
+description: Adds Rails like session support to grape api
 email:
 - d.spaeth@faber.de
 executables: []
@@ -282,14 +296,11 @@ files:
 - Rakefile
 - grape_session.gemspec
 - lib/grape_session.rb
+- lib/grape_session/configuration.rb
 - lib/grape_session/ext/api.rb
-- lib/grape_session/ext/cookie_jar.rb
 - lib/grape_session/ext/endpoint.rb
-- lib/grape_session/ext/request.rb
-- lib/grape_session/middleware/env_setup.rb
 - lib/grape_session/version.rb
 - spec/acceptance/.gitkeep
-- spec/acceptance/cookie_spec.rb
 - spec/acceptance/session_spec.rb
 - spec/acceptance/support/.keep
 - spec/acceptance/support/feature.rb
@@ -325,10 +336,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Adds Rails like session and cookie support to grape api
+summary: Adds Rails like session support to grape api
 test_files:
 - spec/acceptance/.gitkeep
-- spec/acceptance/cookie_spec.rb
 - spec/acceptance/session_spec.rb
 - spec/acceptance/support/.keep
 - spec/acceptance/support/feature.rb

data/lib/grape_session/ext/cookie_jar.rb

@@ -1,19 +0,0 @@
-require 'action_dispatch/middleware/cookies'
-
-module GrapeSession
-  module Ext
-    module CookieJar
-      extend ActiveSupport::Concern
-
-      included do
-
-      end
-
-      def read(*)
-      end
-
-      module ClassMethods
-      end
-    end
-  end
-end

data/lib/grape_session/ext/request.rb

@@ -1,20 +0,0 @@
-require 'action_dispatch/middleware/cookies'
-
-module GrapeSession
-  module Ext
-    module Request
-      extend ActiveSupport::Concern
-
-      included do
-
-      end
-
-      def cookie_jar
-        env['action_dispatch.cookies'] ||= ActionDispatch::Cookies::CookieJar.build(self)
-      end
-
-      module ClassMethods
-      end
-    end
-  end
-end

data/lib/grape_session/middleware/env_setup.rb

@@ -1,56 +0,0 @@
-module GrapeSession
-  module Middleware
-    class EnvSetup
-      def self.default_settings
-        {
-          signed_cookie_salt: 'signed cookie',
-          encrypted_cookie_salt: 'encrypted cookie',
-          encrypted_signed_cookie_salt: 'signed encrypted cookie',
-          secret_token: 'secret_token',
-          secret_key_base: 'secret base',
-          cookies_serializer: :json,
-          session_options: { key: '_grape_session_id' }
-        }.freeze
-      end
-
-      def self.settings(new_settings = nil)
-        if new_settings
-          @settings_for_env = nil
-          @caching_key_generator = nil
-          @settings = default_settings.merge new_settings
-        else
-          @settings ||= default_settings
-        end
-      end
-
-      def self.key_generator
-        @caching_key_generator ||= begin
-          key_generator = ActiveSupport::KeyGenerator.new(@settings[:secret_key_base], iterations: 1000)
-          ActiveSupport::CachingKeyGenerator.new(key_generator)
-        end
-      end
-
-      def self.settings_for_env
-        @settings_for_env ||= {
-          ActionDispatch::Cookies::GENERATOR_KEY => key_generator,
-          ActionDispatch::Cookies::SIGNED_COOKIE_SALT => settings[:signed_cookie_salt],
-          ActionDispatch::Cookies::ENCRYPTED_COOKIE_SALT => settings[:encrypted_cookie_salt],
-          ActionDispatch::Cookies::ENCRYPTED_SIGNED_COOKIE_SALT => settings[:encrypted_signed_cookie_salt],
-          ActionDispatch::Cookies::SECRET_TOKEN => settings[:secret_token],
-          ActionDispatch::Cookies::SECRET_KEY_BASE => settings[:secret_key_base],
-          ActionDispatch::Cookies::COOKIES_SERIALIZER => settings[:cookies_serializer]
-        }.freeze
-      end
-
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        env.merge!(self.class.settings_for_env)
-
-        @app.call(env)
-      end
-    end
-  end
-end

data/spec/acceptance/cookie_spec.rb

@@ -1,62 +0,0 @@
-require 'acceptance_spec_helper'
-require 'grape'
-require 'rack/test'
-
-feature 'Encrypt a cookie session' do
-  include Rack::Test::Methods
-
-  let(:app) do
-
-    Class.new(Grape::API) do
-      include GrapeSession::Ext::API
-
-      get '/test' do
-        cookies.signed['test_signed'] = '1234'
-        cookies['test_unsigned_signed'] = 'unsigned_1234'
-      end
-
-      get '/return' do
-        {
-          cookies: [cookies.signed['test_signed'], cookies['test_unsigned_signed']]
-        }
-      end
-    end
-  end
-
-  let(:hostname) { Rack::Test::DEFAULT_HOST }
-  let(:port) { 80 }
-  let(:host) { "#{hostname}:#{port}" }
-
-  let(:response_cookies) { rack_mock_session.cookie_jar }
-
-  let(:verifier) do
-    key_generator = last_request.env[ActionDispatch::Cookies::GENERATOR_KEY]
-    signed_cookie_salt = last_request.env[ActionDispatch::Cookies::SIGNED_COOKIE_SALT]
-    secret = key_generator.generate_key(signed_cookie_salt)
-    ActiveSupport::MessageVerifier.new(secret, serializer: JSON)
-  end
-
-  def https?
-    port == 443
-  end
-
-  scenario 'Cookie set signed' do
-    get '/test'
-
-    expect(last_response.status).to eq 200
-
-    expect(response_cookies['test_signed']).not_to eq '1234'
-    expect(verifier.verify(response_cookies['test_signed'])).to eq '1234'
-
-    expect(response_cookies['test_unsigned_signed']).to eq 'unsigned_1234'
-
-  end
-
-  scenario 'Get signed cookie' do
-    get '/test'
-
-    get '/return'
-
-    expect(last_response.body).to eq '{:cookies=>["1234", "unsigned_1234"]}'
-  end
-end