micro_sessions 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c46747cad6fd140413833b912ecf05a62239a36a
-  data.tar.gz: 3b79a6cb3a77fa652d49de1879e26adb7d1ec7a8
+  metadata.gz: 7056a560bd55cb5d4bb1089d0fd86d8a5dd4821d
+  data.tar.gz: 2e35c6fd8984c13cd448cbc7743dfa1a96142924
 SHA512:
-  metadata.gz: f6b498a063510ed25780015d9b346f0652e222d779ae96aa9062874972d54c81eb99058a4013d1ac80e91fe3d808f63c21f37a5ebcc1129b075b7a7fa1d38868
-  data.tar.gz: c3cff2675dcb281ced97f4c1f4739a00557eb4eb1bc24d5587b0b9562a903eed0b673cf2559317c1d7fa9039010083c109b6d4d187441c2f8832cae33a203d58
+  metadata.gz: b20f02a8790ff7d13c7c585d012c4bb9f8f8e2d00e68810f4e41de5b30fc89acb504a72ed1d8460b4ac6291a8b411704d2053458615be0d55c74689b3c13a9ae
+  data.tar.gz: ad33961eda1ebdcadf63eae1a89631c892bb1ef8c28f9681653dbcca5309a005b04d4f52d2dbda79db264482cd64c4e69b4e8c6832d73cf96b6299d285df5d46

data/Appraisals

@@ -16,3 +16,11 @@ end
 appraise 'rails-4.1' do
   gem 'rails', '~> 4.1.1'
 end
+
+appraise 'rails-4.2' do
+  gem 'rails', '~> 4.2'
+end
+
+appraise 'rails-5.1' do
+  gem 'rails', '~> 5.1'
+end

data/Gemfile

@@ -10,11 +10,10 @@ group :development do
 end
 
 group :test do
-  gem 'rspec', '>= 3'
-  gem 'capybara', '~> 2.0'
-  gem 'launchy', '~> 2.4.3'
-  gem 'sqlite3', '~> 1.3.4'
-  gem 'addressable', '~> 2.3.7'
+  gem 'rspec', '~> 3.7.0'
+  gem 'rspec-rails', '~> 3.6'
+  gem 'capybara', '~> 2.15.4'
+  gem 'activerecord-nulldb-adapter', '~> 0.3.7'
 end
 
 gemspec

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    micro_sessions (0.3.0)
-      rails (>= 3.0.0, <= 4.1.1)
+    micro_sessions (0.4.0)
+      rails (>= 3.0, <= 5.1)
 
 GEM
   remote: http://rubygems.org/
@@ -27,41 +27,40 @@ GEM
       activemodel (= 4.1.1)
       activesupport (= 4.1.1)
       arel (~> 5.0.0)
+    activerecord-nulldb-adapter (0.3.7)
+      activerecord (>= 2.0.0)
     activesupport (4.1.1)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
-    addressable (2.3.7)
+    addressable (2.3.8)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
     arel (5.0.1.20140414130214)
     builder (3.2.2)
-    capybara (2.15.2)
+    capybara (2.15.4)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (>= 1.3.3)
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
-    diff-lcs (1.2.5)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
     erubis (2.7.0)
-    hike (1.2.3)
     i18n (0.7.0)
     json (1.8.6)
-    launchy (2.4.3)
-      addressable (~> 2.3)
-    mail (2.5.4)
+    mail (2.5.5)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     mini_mime (0.1.4)
     mini_portile2 (2.3.0)
     minitest (5.5.1)
-    multi_json (1.10.1)
     nokogiri (1.8.1)
       mini_portile2 (~> 2.3.0)
     polyglot (0.3.5)
@@ -86,32 +85,36 @@ GEM
     rake (10.5.0)
     rdoc (4.2.2)
       json (~> 1.4)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    sprockets (2.12.3)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.2.4)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (2.3.3)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (>= 2.8, < 4.0)
-    sqlite3 (1.3.13)
     thor (0.19.1)
     thread_safe (0.3.4)
-    tilt (1.4.1)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
@@ -125,15 +128,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  addressable (~> 2.3.7)
+  activerecord-nulldb-adapter (~> 0.3.7)
   appraisal (~> 2.2.0)
-  capybara (~> 2.0)
-  launchy (~> 2.4.3)
+  capybara (~> 2.15.4)
   micro_sessions!
   rake (< 11)
   rdoc (~> 4.2.2)
-  rspec (>= 3)
-  sqlite3 (~> 1.3.4)
+  rspec (~> 3.7.0)
+  rspec-rails (~> 3.6)
   wwtd (~> 1.3.0)
 
 BUNDLED WITH

data/README.md

@@ -0,0 +1,91 @@
+# Micro Sessions
+
+[![Build Status](https://secure.travis-ci.org/rubiety/micro_sessions.png?branch=master)](http://travis-ci.org/rubiety/micro_sessions)
+
+**DEPRECATION WARNING: micro_session 0.4.0 includes breaking changes, for previous versions see [Readme](https://github.com/santiagodoldan/micro_sessions/wiki/micro_sessions---=-0.3.0-%5BREADME%5D).**
+
+In terms of passing data amongst HTTP requests there are really two options:
+* Param or form data passing
+* Storing in cookies
+* Storing in server-side session, keyed off an ID stored as a cookie.
+
+For a certain application where you're using number 3, this comes at a cost - the session is "global".  In other words, in a single browser window with multiple tabs, the server side cannot distinguish between individual "sessions" *within* that browser session. This gem introduces a fourth, more granular method:
+* Storing in server-side session, keyed off an ID stored as a cookie *and* keyed off a request parameter.
+
+This could be useful in instances such as a very complex wizard where transmitting the entire history of data RESTfully via param passing may not be feasible, yet you'd still like to support multiple tabs within the same browser window separately.
+
+## Installation
+
+Include the gem in your Gemfile:
+
+```ruby
+gem "micro_sessions"
+```
+
+## Usage
+
+Simply include MicroSessionable in your controller:
+
+```ruby
+class ApplicationController
+  include MicroSessionable
+end
+```
+
+From there you will have access to a `micro_session` object in your controllers and views, just like the `session` object.
+
+```ruby
+def new
+  micro_session[:key] = "Value"
+end
+```
+
+By default the name of the request parameter used to differentiate micro-sessions is `_msid`, though this can be configured:
+
+```ruby
+MicroSession.configure do |config|
+  config.key = "_msid"
+end
+```
+
+By default the key generated will be a 10-digit random hash, though this can be configured as well:
+
+```ruby
+MicroSession.configure do |config|
+  config.type = :integer
+  config.length = 10
+end
+```
+
+Valid values for `type` are:
+* `:random_hash`
+* `:integer`  (simply increments from one)
+* `:random_integer` (random integer with a maximum of `:length` digits)
+
+Session data is accessible to the controller and view through the `micro_session` object, which works identically to the `session` object but it specific to the micro-session:
+
+```ruby
+micro_session[:key] = "Value"
+micro_session[:key] # => "Value"
+```
+
+When transitioning between pages for which you'd like to keep the micro-session alive, just use the custom `ms_link_to` helper method:
+
+```ruby
+ms_link_to "Persist session", user_path(@user)
+```
+
+You can also build the url manually getting the proper information from micro_session:
+
+```ruby
+redirect_to user_path(@user, micro_session.url_options)
+```
+
+If you wish to transmit the identifier via a form, be sure to include the hidden field:
+
+```ruby
+<% form_for(@user) do |f| %>
+  <%= micro_session_hidden_field %>
+  ...
+<% end %>
+```

data/Rakefile

@@ -1,30 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
 
-require 'rake'
-require 'rspec/core/rake_task'
-require 'appraisal'
-
 Bundler::GemHelper.install_tasks
 
-desc 'Default: run unit tests.'
-task :default => [:clean, :all]
-
-desc "Run Specs against all Appraisals"
-task :all => :spec do
-  Rake::Task["appraisal:install"].execute
-  system("bundle exec rake -s appraisal test")
-end
-
-desc "Run Specs"
-RSpec::Core::RakeTask.new(:spec) do |t|
-end
-
-task :test => [:spec]
-
-desc "Clean up files."
-task :clean do |t|
-  FileUtils.rm_rf "tmp"
-  Dir.glob("micro_sessions-*.gem").each {|f| FileUtils.rm f }
-end
-
+desc 'Default: run the rspec examples'
+task :default => [:spec]

data/lib/micro_session/engine.rb

@@ -0,0 +1,20 @@
+module MicroSession
+  class << self
+    alias configure tap
+
+    mattr_accessor :param, :key, :param_type, :length, :counter
+
+    self.param = '_msid'
+    self.key = '_micro_sessions'
+    self.param_type = :hash
+    self.length = 11
+    self.counter = 2
+
+    def options
+      { param: param, key: key, param_type: param_type, length: length, counter: counter }
+    end
+  end
+
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/micro_session/store.rb

@@ -0,0 +1,60 @@
+module MicroSession
+  class Store
+    delegate :empty?, :to_h, :to_hash, :inspect, to: :data
+
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def data
+      @controller.session[MicroSession.key] ||= {}
+      @controller.session[MicroSession.key][id] ||= {}
+      @controller.session[MicroSession.key][id].symbolize_keys!
+    end
+
+    def [](key)
+      data[key.to_sym]
+    end
+
+    def []=(key, value)
+      data[key.to_sym] = value
+    end
+
+    def url_options
+      if empty?
+        {}
+      else
+        { MicroSession.param => id }
+      end
+    end
+
+    def id
+      @id ||= id_from_params || generate_id
+    end
+
+    private
+
+    def id_from_params
+      @controller.params[MicroSession.param] if @controller.params
+    end
+
+    def generate_id
+      case MicroSession.param_type
+      when :hash
+        secure_random.hex(MicroSession.length / 2)
+      when :integer
+        self.counter += 1
+      when :random_integer
+        secure_random.integer
+      end
+    end
+
+    def secure_random
+      if Object.const_defined?('SecureRandom')
+        SecureRandom
+      else
+        ActiveSupport::SecureRandom
+      end
+    end
+  end
+end

data/lib/micro_session/version.rb

@@ -0,0 +1,4 @@
+module MicroSession
+  VERSION = '0.4.0'
+end
+

data/lib/micro_sessions.rb

@@ -1,18 +1,4 @@
-require "rails"
-require "action_controller"
-require "action_view"
+require 'micro_session/engine'
 
-module MicroSessions
-  extend ActiveSupport::Concern
-  extend ActiveSupport::Autoload
-
-  autoload :Controller
-  autoload :Helpers
-  autoload :MicroSession
-
-  included do
-    include MicroSessions::Controller
-  end
+module MicroSession
 end
-
-require "micro_sessions/railtie"

data/spec/controllers/humans_controller_spec.rb

@@ -0,0 +1,9 @@
+require 'rails_helper'
+
+RSpec.describe HumansController do
+  describe 'GET \'index\'' do
+    it 'does not respond to micro_session' do
+      expect(subject.respond_to?(:micro_session)).to be_falsey
+    end
+  end
+end

data/spec/controllers/mutants_controller_spec.rb

@@ -0,0 +1,31 @@
+require 'rails_helper'
+
+RSpec.describe MutantsController do
+  describe 'GET \'index\'' do
+    it 'returns a MicroSession::Store instance' do
+      get :index
+
+      expect(subject.micro_session).to be_kind_of(MicroSession::Store)
+    end
+
+    context 'when there is no data stored in the session' do
+      it 'returns an empty hash' do
+        get :index
+
+        expect(subject.micro_session.to_h).to be_empty
+      end
+    end
+
+    context 'when there is data stored in the session' do
+      before do
+        subject.micro_session['test'] = 'test'
+      end
+
+      it 'returns stored data' do
+        get :index
+
+        expect(subject.micro_session.to_h).to eq(test: 'test')
+      end
+    end
+  end
+end