rails-session_cookie 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 792dd6e30fe79dd6784084ee5a126009878405d5
-  data.tar.gz: 82badc510dd7021edb6ed1f45a6442534fafc648
+  metadata.gz: cf883bbe0ecd2fa1007bd3dcaf93dea8fd30df30
+  data.tar.gz: 432aa9b0e2b4d44f9f114447faf6d244b7353db0
 SHA512:
-  metadata.gz: a9670277edd1ab22d31767e508d3719fa0d1793708298d306890b6c6ee66762566cd682f1e0f37deb8a8aafc81f9195f77e9b0ee394e6b080b71d9d439869b78
-  data.tar.gz: 7d31273b752aa31d952d09e1f39aacd97519930ac89773f21842f45f2d358e0d29b9a87d0cff6976c5a5e982d1856b7ca704f3b16999c64c228b23a7be60d9f6
+  metadata.gz: a74cf4563775b1751910d431a5fcbc4eee47f6d3ce6d405c986691317d6cc98701f00614a3b4f56589ca44bf6b080990bda869df4213824080c05dc7554168d1
+  data.tar.gz: b5d743ce4a4559657223dfed66c44eaa50f599750921b50102597fd2ab2445497cf8dc95466e31a4e7c58ba778dfe02ac3c0d96a67bd3ba5c2d179662e1f3383

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   Exclude:
+    - 'lib/rails-session_cookie.rb'
     - 'gemfiles/vendor/**/*'
 Metrics/LineLength:
   Max: 120

data/.travis.yml

@@ -13,6 +13,3 @@ gemfile:
   - gemfiles/rails_5.1.gemfile
   - gemfiles/rails_5.1_warden.gemfile
 before_install: gem install bundler -v 1.15.4
-script:
-  - bundle exec rake
-  - bundle exec codeclimate-test-reporter

data/README.md

@@ -14,7 +14,7 @@ Probably, you might have seen a lot code like this:
 # config/initializers/session_store.rb
 Rails.application.config.session_store :cookie_store
 
-# authentificaing method (maybe Devise or whatever)
+# authenticating method (maybe Devise or whatever)
 session[:current_user_id] = current_user.id
 
 # somewhere in helper for request specs
@@ -23,7 +23,7 @@ def login(current_user)
 end
 
 # now every request spec is calling login request
-RSpec.describe 'User inferface', type: :request do
+RSpec.describe 'User interface', type: :request do
   let(:user) { create :user }
 
   before do
@@ -37,13 +37,18 @@ end
 ```
 
 In a usual user-driven application this tightly couples *all* request specs, which require authentication, to the login process.
-If it fails - everything fails. If it's not blazingly fast - it slows the whole suite down.
+If it fails - everything fails. If it's not blazing fast - it slows the whole suite down.
 
-One may move to token-based authentification, especially when having API. That's reasonable and nice.
-But we can think about a session cookie as a token passed in a special header!
+One may move to token-based authentication, especially when having API. That's reasonable and nice.
+But HTTP is stateless, really we don't need to do several requests, we can think about a session cookie
+as a token passed in a special header!
 
-This gem replaces your usual process with the simplest 2 rails middleware pass.
-Rails is modular, that's cool :)
+You can easily pass headers in tests, the only hard thing is getting the cookie value.
+Rails may change how a state is serialized into the session cookie. It can be encrypted or not, marshalled
+(an old story for rails-3 legacy) or JSONed. Long story short: only rails knows how to generate cookie from data.
+
+This gem replaces your usual process of getting session cookie with the simplest rack app utilizing
+2 rails middlewares. Rails is modular, that's cool :)
 
 ## Installation
 
@@ -85,13 +90,12 @@ However, never saw this in practice, and consider caching of requests in before-
 If you need more sophisticated logic:
 
 ```ruby
-  auth_app = proc { |env|
-    # do your magic
-    env[Rails::SessionCookie::RACK_SESSION].merge!(context)
-    [200, {}, []]
-  }
-  raw_session_cookie = Rails::SessionCookie::App.new(auth_app).session_cookie
-end
+auth_app = proc { |env|
+  # do your magic
+  env[Rails::SessionCookie::RACK_SESSION].merge!(context)
+  [200, {}, []]
+}
+raw_session_cookie = Rails::SessionCookie::App.new(auth_app).session_cookie
 ```
 
 Of course, you can just make use (and reuse!) of as many procs as you wish.
@@ -119,7 +123,7 @@ Capybara.current_session.driver.browser.set_cookie raw_session_cookie
 
 ## Benchmarks
 
-*NOTE:* Sometimes devise's `sing_in` is still faster than `SessionCookie` (a little though),
+*NOTE:* Sometimes devise's `sign_in` is still faster than `SessionCookie` (a little though),
 because Warden uses an [ugly hack, in my opinion,](https://github.com/hassox/warden/blob/master/lib/warden/test/helpers.rb#L18L23)
 to support test-mode authentication.
 
@@ -128,7 +132,7 @@ Besides, authentication becomes as transparent as possible and should increase r
 if you understand HTTP session cookies principles.
 
 ```sh
-$ appraisal rails-5.1-warden rspec -t performance spec/benchmarks
+$ appraisal rails-5.1-warden rspec -t performance spec/benchmarks/feature_spec.rb
 
 Speed using capybara in feature test
   correctness of
@@ -140,6 +144,34 @@ Speed using capybara in feature test
     is obviously slower separately
     is not slower than devise helpers if using cache and executing multiple specs in a suite
 
+Warming up --------------------------------------
+devise sign_in
+                        70.000  i/100ms
+session cookie
+                        70.000  i/100ms
+session cookie (no cache)
+                        62.000  i/100ms
+Calculating -------------------------------------
+devise sign_in
+                        700.554  (± 5.3%) i/s -      3.500k in   5.011356s
+session cookie
+                        686.868  (± 4.7%) i/s -      3.430k in   5.005542s
+session cookie (no cache)
+                        611.439  (± 4.9%) i/s -      3.100k in   5.083986s
+
+Comparison:
+devise sign_in           :      700.6 i/s
+session cookie           :      686.9 i/s - same-ish: difference falls within error
+session cookie (no cache):      611.4 i/s - 1.15x  slower
+
+```
+
+But when it comes with comparison to a simple custom authentication (see `spec/support/rails_app.rb`),
+this gem is several times faster! (custom action checks password, hits database, request touches the whole rails middleware stack)
+
+```sh
+$ appraisal rails-5.1-warden rspec -t performance spec/benchmarks/request_spec.rb
+
 Speed using custom sign-in in request test
   correctness of
     SessionCookie
@@ -149,8 +181,25 @@ Speed using custom sign-in in request test
   against custom sign in route
     is faster separately without cache
 
-Finished in 1.89 seconds (files took 0.89589 seconds to load)
-7 examples, 0 failures
+Warming up --------------------------------------
+custom sign in
+                         1.000  i/100ms
+session cookie
+                         1.759k i/100ms
+session cookie (no cache)
+                       482.000  i/100ms
+Calculating -------------------------------------
+custom sign in
+                         11.219  (± 0.0%) i/s -     57.000  in   5.082143s
+session cookie
+                         17.573k (± 2.0%) i/s -     87.950k in   5.006754s
+session cookie (no cache)
+                          4.714k (± 5.0%) i/s -     23.618k in   5.023448s
+
+Comparison:
+session cookie           :    17573.4 i/s
+session cookie (no cache):     4714.3 i/s - 3.73x  slower
+custom sign in           :       11.2 i/s - 1566.44x  slower
 ```
 
 ## Contributing

data/Rakefile

@@ -1,8 +1,34 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'codeclimate-test-reporter'
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 
-task default: %i[rubocop spec]
+# Same as bin/codeclimate-test-reporter, but don't complain if no coverage found
+task :coverage do
+  exit unless ENV['CI']
+
+  repo_token = ENV['CODECLIMATE_REPO_TOKEN']
+  if repo_token.nil? || repo_token.empty?
+    STDERR.puts 'Cannot post results: environment variable CODECLIMATE_REPO_TOKEN must be set.'
+    exit
+  end
+
+  COVERAGE_FILE = ARGV.first || 'coverage/.resultset.json'
+  unless File.exist?(COVERAGE_FILE)
+    STDERR.puts 'Coverage results not found'
+    exit
+  end
+
+  begin
+    results = JSON.parse(File.read(COVERAGE_FILE))
+  rescue JSON::ParserError => e
+    abort "Error encountered while parsing #{COVERAGE_FILE}: #{e}"
+  end
+
+  CodeClimate::TestReporter.run(results)
+end
+
+task default: %i[rubocop spec coverage]

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rails-session_cookie (0.2.1)
+    rails-session_cookie (0.2.2)
       rails (>= 4.0)
 
 GEM
@@ -49,6 +49,7 @@ GEM
       thor (>= 0.14.0)
     arel (6.0.4)
     ast (2.3.0)
+    benchmark-ips (2.7.2)
     benchmark-perf (0.2.1)
     builder (3.2.3)
     byebug (9.0.6)
@@ -184,6 +185,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 2.2)
+  benchmark-ips (~> 2.7.2)
   bundler (~> 1.15)
   capybara (~> 2.15)
   codeclimate-test-reporter (= 1.0.8)

data/gemfiles/rails_4.2_warden.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rails-session_cookie (0.2.1)
+    rails-session_cookie (0.2.2)
       rails (>= 4.0)
 
 GEM
@@ -50,6 +50,7 @@ GEM
     arel (6.0.4)
     ast (2.3.0)
     bcrypt (3.1.11)
+    benchmark-ips (2.7.2)
     benchmark-perf (0.2.1)
     builder (3.2.3)
     byebug (9.1.0)
@@ -197,6 +198,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 2.2)
+  benchmark-ips (~> 2.7.2)
   bundler (~> 1.15)
   capybara (~> 2.15)
   codeclimate-test-reporter (= 1.0.8)

data/gemfiles/rails_5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rails-session_cookie (0.2.1)
+    rails-session_cookie (0.2.2)
       rails (>= 4.0)
 
 GEM
@@ -52,6 +52,7 @@ GEM
       thor (>= 0.14.0)
     arel (7.1.4)
     ast (2.3.0)
+    benchmark-ips (2.7.2)
     benchmark-perf (0.2.1)
     builder (3.2.3)
     byebug (9.0.6)
@@ -190,6 +191,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 2.2)
+  benchmark-ips (~> 2.7.2)
   bundler (~> 1.15)
   capybara (~> 2.15)
   codeclimate-test-reporter (= 1.0.8)

data/gemfiles/rails_5.0_warden.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rails-session_cookie (0.2.1)
+    rails-session_cookie (0.2.2)
       rails (>= 4.0)
 
 GEM
@@ -53,6 +53,7 @@ GEM
     arel (7.1.4)
     ast (2.3.0)
     bcrypt (3.1.11)
+    benchmark-ips (2.7.2)
     benchmark-perf (0.2.1)
     builder (3.2.3)
     byebug (9.1.0)
@@ -203,6 +204,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 2.2)
+  benchmark-ips (~> 2.7.2)
   bundler (~> 1.15)
   capybara (~> 2.15)
   codeclimate-test-reporter (= 1.0.8)

data/gemfiles/rails_5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rails-session_cookie (0.2.1)
+    rails-session_cookie (0.2.2)
       rails (>= 4.0)
 
 GEM
@@ -52,6 +52,7 @@ GEM
       thor (>= 0.14.0)
     arel (8.0.0)
     ast (2.3.0)
+    benchmark-ips (2.7.2)
     benchmark-perf (0.2.1)
     builder (3.2.3)
     byebug (9.0.6)
@@ -190,6 +191,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 2.2)
+  benchmark-ips (~> 2.7.2)
   bundler (~> 1.15)
   capybara (~> 2.15)
   codeclimate-test-reporter (= 1.0.8)

data/gemfiles/rails_5.1_warden.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rails-session_cookie (0.2.1)
+    rails-session_cookie (0.2.2)
       rails (>= 4.0)
 
 GEM
@@ -53,6 +53,7 @@ GEM
     arel (8.0.0)
     ast (2.3.0)
     bcrypt (3.1.11)
+    benchmark-ips (2.7.2)
     benchmark-perf (0.2.1)
     builder (3.2.3)
     byebug (9.1.0)
@@ -203,6 +204,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 2.2)
+  benchmark-ips (~> 2.7.2)
   bundler (~> 1.15)
   capybara (~> 2.15)
   codeclimate-test-reporter (= 1.0.8)

data/lib/rails-session_cookie.rb

@@ -0,0 +1 @@
+require 'rails/session_cookie'

data/lib/rails/session_cookie/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module SessionCookie
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.2'.freeze
   end
 end

data/rails-session_cookie.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   # bench
   spec.add_development_dependency 'rspec-benchmark', '~> 0.3'
   spec.add_development_dependency 'capybara', '~> 2.15'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.7.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-session_cookie
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Vlad Bokov
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
 description: Helps to get proper integration tests run faster
 email:
 - razum2um@mail.ru
@@ -209,6 +223,7 @@ files:
 - gemfiles/rails_5.1.gemfile.lock
 - gemfiles/rails_5.1_warden.gemfile
 - gemfiles/rails_5.1_warden.gemfile.lock
+- lib/rails-session_cookie.rb
 - lib/rails/session_cookie.rb
 - lib/rails/session_cookie/app.rb
 - lib/rails/session_cookie/version.rb