rack_session_manipulation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70ee014ab99f99fa2f2ad204ce13a2bd7962a7ad
+  data.tar.gz: ef49f9684ecaf820f6f8d0d0786d4c2aa0192f7c
+SHA512:
+  metadata.gz: 069c8f5fe4346c9abf868ef3ba77c770fe34b6cd067e80f281fe8cac52a432de106119ac252fb47de0184a4792a9ed824d2b6ab340ed2da2aeeadf1715263aaf
+  data.tar.gz: aa3860206e132799bad764c79cd029f4f1af5ef4403bccf0c9d3762cba2be65630025f5d8cdce8302d490252d6663f1662bab9bf0ab4905f0b0d639a2b6cb51d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+RSpec/FilePath:
+  Enabled: false
+require:
+- rubocop-rspec

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.5

data/.yardopts

@@ -0,0 +1 @@
+--default-return void --private --protected

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all
+people who contribute through reporting issues, posting feature requests,
+updating documentation, submitting pull requests or patches, and other
+activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at
+[http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sam Stelfox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# RackSessionManipulation
+
+[![Build Status](https://travis-ci.org/sstelfox/rack_session_manipulation.svg)](https://travis-ci.org/sstelfox/rack_session_manipulation)
+[![Coverage Status](https://coveralls.io/repos/sstelfox/rack_session_manipulation/badge.svg?branch=develop)](https://coveralls.io/r/sstelfox/rack_session_manipulation?branch=develop)
+[![Dependency Status](https://gemnasium.com/sstelfox/rack_session_manipulation.svg)](https://gemnasium.com/sstelfox/rack_session_manipulation)
+[![Code Climate](https://codeclimate.com/github/sstelfox/rack_session_manipulation/badges/gpa.svg)](https://codeclimate.com/github/sstelfox/rack_session_manipulation)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack_session_manipulation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_session_manipulation
+
+## Usage
+
+## Contributing
+
+1. Reivew the [Contributor Code of Conduct](CODE_OF_CONDUCT.md)
+2. Fork it ( https://github.com/sstelfox/rack_session_manipulation/fork )
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,42 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts 'RSpec isn\'t available to the rake environment'
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.formatters = %w(simple offenses)
+    task.fail_on_error = false
+    task.options = %w(--format html --out doc/rubocop.html)
+  end
+rescue LoadError
+  puts 'Rubocop isn\'t available to the rake environment'
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new(:docs)
+rescue LoadError
+  puts 'Yardoc isn\'t available to the rake environment'
+end
+
+task :default do
+  Rake::Task[:docs].invoke     if Rake::Task.task_defined?(:docs)
+  Rake::Task[:rubocop].invoke  if Rake::Task.task_defined?(:rubocop)
+  Rake::Task[:spec].invoke     if Rake::Task.task_defined?(:spec)
+end
+
+task 'environment' do
+  require 'rack_session_manipulation'
+end
+
+desc 'Run a console with the application loaded'
+task console: [:environment] do
+  require 'pry'
+  pry
+end

data/lib/rack_session_manipulation.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+require 'rack_session_manipulation/config'
+require 'rack_session_manipulation/middleware'
+require 'rack_session_manipulation/utilities'
+require 'rack_session_manipulation/version'
+
+# Parent module for the Rack Session Manipulation middleware.
+module RackSessionManipulation
+  extend RackSessionManipulation::Utilities
+
+  def self.config
+    @config ||= RackSessionManipulation::Config.new(random_path_prefix)
+  end
+
+  def self.configure
+    yield(config)
+  end
+end

data/lib/rack_session_manipulation/capybara.rb

@@ -0,0 +1,18 @@
+# Parent module for the Rack Session Manipulation middleware.
+module RackSessionManipulation
+  # Capybara helpers for accessing and setting session values
+  module Capybara
+    def session=(hash)
+      data = { 'session_data' => RackSessionManipulation.encode(hash) }
+      driver.put(RackSessionManipulation.config.path, data)
+    end
+
+    def session
+      driver.get(RackSessionManipulation.config.path)
+      RackSessionManipulation.decode(driver.response.body)
+    end
+  end
+end
+
+require 'capybara/session'
+Capybara::Session.send(:include, RackSessionManipulation::Capybara)

data/lib/rack_session_manipulation/config.rb

@@ -0,0 +1,4 @@
+# Parent module for the Rack Session Manipulation middleware.
+module RackSessionManipulation
+  Config = Struct.new(:path)
+end

data/lib/rack_session_manipulation/middleware.rb

@@ -0,0 +1,59 @@
+# Parent module for the Rack Session Manipulation middleware.
+module RackSessionManipulation
+  # Rack middleware that handles the accessing and modification of session
+  # state.
+  class Middleware
+    def call(env)
+      request = Rack::Request.new(env)
+
+      action = get_action(request)
+      action.nil? ? @app.call(env) : send(action, request)
+    end
+
+    def initialize(app, _options = {})
+      @app = app
+      @routes = {
+        'GET' => :retrieve,
+        'PUT' => :update
+      }
+    end
+
+    protected
+
+    def extract_method(request)
+      return request.request_method unless request.request_method == 'POST'
+      return request.params['_method'].upcase if request.params['_method']
+      request.request_method
+    end
+
+    def get_action(request)
+      return unless request.path == RackSessionManipulation.config.path
+      @routes[extract_method(request)]
+    end
+
+    def headers(length)
+      {
+        'Content-Type'   => 'application/json',
+        'Content-Length' => length
+      }
+    end
+
+    def retrieve(request)
+      session_hash = request.env['rack.session'].to_hash
+      content = RackSessionManipulation.encode(session_hash)
+
+      [200, headers(content.length), content]
+    end
+
+    def update(request)
+      session_data = request.params['session_data']
+      RackSessionManipulation.decode(session_data).each do |k, v|
+        request.env['rack.session'][k] = v
+      end
+
+      [204, headers(0), '']
+    rescue JSON::ParserError
+      [400, headers(0), '']
+    end
+  end
+end

data/lib/rack_session_manipulation/utilities.rb

@@ -0,0 +1,29 @@
+# Parent module for the Rack Session Manipulation middleware.
+module RackSessionManipulation
+  # Various utility methods that will be module level functions for the parent
+  # namespace module.
+  module Utilities
+    def decode(encoded_data)
+      JSON.parse(encoded_data)
+    end
+
+    def encode(obj)
+      JSON.generate(obj)
+    end
+
+    # SecureRandom raises a NotImplementedError if no random device is
+    # available in that case fallback on Kernel.rand. Shamelessly stolen from
+    # the Sinatra session secret generation code.
+    #
+    # @return [String]
+    def random_path_prefix
+      num = begin
+        require 'securerandom'
+        SecureRandom.random_number(2**64 - 1)
+      rescue LoadError, NotImplementedError
+        Kernel.rand(2**64 - 1)
+      end
+      format('/%016x', num)
+    end
+  end
+end

data/lib/rack_session_manipulation/version.rb

@@ -0,0 +1,5 @@
+# Parent module for the Rack Session Manipulation middleware.
+module RackSessionManipulation
+  # The current version of this module
+  VERSION = '0.1.0'
+end

data/rack_session_manipulation.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rack_session_manipulation/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'rack_session_manipulation'
+  spec.version  = RackSessionManipulation::VERSION
+  spec.authors  = ['Sam Stelfox']
+  spec.email    = ['sstelfox@bedroomprogrammers.net']
+  spec.files    = `git ls-files -z`.split("\x0").reject { |f| f =~ /^spec\// }
+
+  spec.summary     = 'A rack middleware for exposing session state to tests.'
+  spec.description = 'A rack middleware for exposing session state to tests.'
+  spec.homepage    = 'https://github.com/sstelfox/rack_session_manipulation'
+  spec.license     = 'MIT'
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'capybara'
+
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'redcarpet'
+  spec.add_development_dependency 'yard'
+
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: rack_session_manipulation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Stelfox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rack middleware for exposing session state to tests.
+email:
+- sstelfox@bedroomprogrammers.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack_session_manipulation.rb
+- lib/rack_session_manipulation/capybara.rb
+- lib/rack_session_manipulation/config.rb
+- lib/rack_session_manipulation/middleware.rb
+- lib/rack_session_manipulation/utilities.rb
+- lib/rack_session_manipulation/version.rb
+- rack_session_manipulation.gemspec
+homepage: https://github.com/sstelfox/rack_session_manipulation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A rack middleware for exposing session state to tests.
+test_files: []
+has_rdoc: