eldr-sessions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f309c5e8248b0c03e552a4a97442a748c84ee83b
+  data.tar.gz: de07f1a2c79be4524699032d447a64cc2cf180e7
+SHA512:
+  metadata.gz: 4032a6e45b215186680eef9eedf1a2ebc078dcf37c92b49b489464b8f08c4721b9a059552df53da422d62e3ce33559c0b39188dc2b797dd48ae0e5d8a3d0aaa2
+  data.tar.gz: cb2b7c98d4370220233d5bfd9f4bb682ad28ebe1f135f4d78be790a8ac92c33c9c6538f68a029355f426f0c02cc730f7b4a281579dfe37f726a3c647c009e4cf

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--require ./spec/spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'Gemfile'
+    - 'eldr-sessions.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-23 12:16:03 -0800 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 100
+
+# Offense count: 2
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+services:
+  - mongodb
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    eldr-sessions (0.0.1)
+      eldr (~> 0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    bson (1.11.1)
+    bson_ext (1.11.1)
+      bson (~> 1.11.1)
+    builder (3.2.2)
+    coveralls (0.7.3)
+      multi_json (~> 1.10)
+      rest-client (~> 1.7)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    eldr (0.0.3)
+      fast_blank (= 0.0.2)
+      mustermann (= 0.4.0)
+      rack (~> 1.5)
+    fast_blank (0.0.2)
+    i18n (0.7.0)
+    json (1.8.2)
+    mime-types (2.4.3)
+    minitest (5.5.1)
+    mongo (1.11.1)
+      bson (= 1.11.1)
+    mongo_mapper (0.13.1)
+      activemodel (>= 3.0.0)
+      activesupport (>= 3.0)
+      mongo (~> 1.8)
+      plucky (~> 0.6.5)
+    multi_json (1.10.1)
+    mustermann (0.4.0)
+      tool (~> 0.2)
+    netrc (0.10.2)
+    parser (2.2.0.2)
+      ast (>= 1.1, < 3.0)
+    plucky (0.6.6)
+      mongo (~> 1.5)
+    powerpack (0.0.9)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.28.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tins (1.3.3)
+    tool (0.2.3)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (= 1.11.1)
+  bundler (~> 1.7)
+  coveralls (~> 0.7)
+  eldr-sessions!
+  mongo_mapper (= 0.13.1)
+  rack-test (~> 0.6)
+  rake (= 10.4.2)
+  rspec (= 3.1.0)
+  rubocop (= 0.28.0)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 K-2052
+
+MIT License
+
+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,72 @@
+# Eldr::Sessions [![Build Status](https://travis-ci.org/eldr-rb/eldr-sessions.svg)](https://travis-ci.org/eldr-rb/eldr-sessions) [![Code Climate](https://codeclimate.com/github/eldr-rb/eldr-sessions/badges/gpa.svg)](https://codeclimate.com/github/eldr-rb/eldr-sessions) [![Coverage Status](https://coveralls.io/repos/eldr-rb/eldr-sessions/badge.svg?branch=master)](https://coveralls.io/r/eldr-rb/eldr-sessions?branch=master) [![Dependency Status](https://gemnasium.com/eldr-rb/eldr-sessions.svg)](https://gemnasium.com/eldr-rb/eldr-sessions) [![Inline docs](https://inch-ci.org/github/eldr-rb/eldr-sessions.svg?branch=master)](http://inch-ci.org/github/eldr-rb/eldr-sessions) [![Gratipay](https://img.shields.io/gratipay/k2052.svg)](https://www.gratipay.com/k2052)
+
+Provides session helpers like `signed_in?` and `current_user` for [Eldr](https://github.com/eldr-rb/eldr) apps and Rack apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eldr-sessions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eldr-sessions
+
+## Usage
+
+Eldr::Sessions is designed to be included in a Eldr app or Rack app. It has two dependencies;
+
+1. Session access via `env['rack.session']`
+2. A configuration object with a `session_id` and `user_model` accessor.
+
+If you use it in a Eldr app these two things are already available and you only need to set a session_id.
+
+Use it an Eldr::App like this:
+
+```ruby
+class App < Eldr::App
+  include Eldr::Sessions
+
+  use Rack::Session::Cookie, secret: 'sessions_secret'
+  set :session_id, 'sessionsRawesome'
+
+  get '/greeting' do
+    if current_user
+      Rack::Response.new "Hello #{current_user.name}!"
+    else
+      Rack::Response.new('Login First!', 401)
+    end
+  end
+
+  post '/login' do
+    user = User.authenticate(params['email'], params['password'])
+    set_current_user user
+    Rack::Response.new('Logged In!')
+  end
+end
+```
+
+See [examples/app.ru](https://github.com/eldr-rb/eldr-sessions/tree/master/examples/app.ru) for an example app.
+
+## Contributing
+
+1. Fork. it
+2. Create. your feature branch (git checkout -b cat-evolver)
+3. Commit. your changes (git commit -am 'Add Cat Evolution')
+4. Test. your changes (always be testing)
+5. Push. to the branch (git push origin cat-evolver)
+6. Pull. Request. (for extra points include funny gif and or pun in comments)
+
+To remember this you can use the easy to remember and totally not tongue-in-check initialism: FCCTPP.
+
+I don't want any of these steps to scare you off. If you don't know how to do something or are struggle getting it to work feel free to create a pull request or issue anyway. I'll be happy to help you get your contributions up to code and into the repo!
+
+## License
+
+Licensed under MIT by K-2052.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task :default do
+  Rake::Task['spec'].execute
+end

data/eldr-sessions.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eldr/sessions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'eldr-sessions'
+  spec.version       = Eldr::Sessions::VERSION
+  spec.authors       = ['K-2052']
+  spec.email         = ['k@2052.me']
+  spec.summary       = %q{Session helpers for the Eldr ruby framework.}
+  spec.description   = %q{Session helpers for the Eldr ruby framework}
+  spec.homepage      = 'https://github.com/eldr-rb/eldr-sessions'
+  spec.license       = 'MIT'
+
+  spec.required_rubygems_version = '~> 2.0'
+  spec.required_ruby_version     = '>= 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'eldr', '~> 0.0'
+
+  spec.add_development_dependency 'bundler',      '~> 1.7'
+  spec.add_development_dependency 'rake',         '10.4.2'
+  spec.add_development_dependency 'rspec',        '3.1.0'
+  spec.add_development_dependency 'rubocop',      '0.28.0'
+  spec.add_development_dependency 'rack-test',    '~> 0.6'
+  spec.add_development_dependency 'coveralls',    '~> 0.7'
+  spec.add_development_dependency 'bson_ext',     '1.11.1'
+  spec.add_development_dependency 'mongo_mapper', '0.13.1'
+end

data/examples/app.ru

@@ -0,0 +1,38 @@
+require 'eldr'
+require 'mongo_mapper'
+require_relative '../lib/eldr/sessions'
+
+MongoMapper.setup({'test' => {'uri' => 'mongodb://localhost:27017/eldr_sessions'}}, 'test')
+
+class User
+  include MongoMapper::Document
+  key :name,  String
+  key :email, String
+
+  def self.authenticate(email, password)
+    find_by_email(email)
+  end
+end
+
+class App < Eldr::App
+  include Eldr::Sessions
+
+  use Rack::Session::Cookie, secret: 'sessions_secret'
+  set :session_id, 'sessionsRawesome'
+
+  get '/greeting' do
+    if current_user
+      Rack::Response.new "Hello #{current_user.name}!"
+    else
+      Rack::Response.new('Login First!', 401)
+    end
+  end
+
+  post '/login' do
+    user = User.authenticate(params['email'], params['password'])
+    set_current_user user
+    Rack::Response.new('Logged In!')
+  end
+end
+
+run App

data/lib/eldr-sessions.rb

@@ -0,0 +1 @@
+require_relative 'eldr/sessions'

data/lib/eldr/sessions.rb

@@ -0,0 +1,37 @@
+module Eldr
+  module Sessions
+    def session
+      env['rack.session']
+    end
+
+    def session_id
+      configuration.session_id ||= ENV['SESSION_ID']
+      raise StandardError, 'Set a session id!' unless configuration.session_id
+      configuration.session_id
+    end
+
+    def user_model_obj
+      @_user_model_obj ||= configuration.user_model.constantize unless configuration.user_model.nil?
+      @_user_model_obj ||= 'User'.constantize if defined?('User')
+    end
+
+    def login_from_session
+      return nil unless session
+      user_model_obj.find_by_id(session[session_id]) if user_model_obj
+    end
+
+    def current_user
+      @current_user ||= login_from_session
+    end
+
+    def current_user=(user)
+      session[session_id] = user ? user.id : nil
+      @current_user = user
+    end
+    alias_method :set_current_user, :current_user=
+
+    def signed_in?
+      !current_user.nil?
+    end
+  end
+end

data/lib/eldr/sessions/version.rb

@@ -0,0 +1,5 @@
+module Eldr
+  module Sessions
+    VERSION = '0.0.1'
+  end
+end

data/spec/app_spec.rb

@@ -0,0 +1,30 @@
+describe 'App' do
+  let(:app) do
+    path = File.expand_path('../examples/app.ru', File.dirname(__FILE__))
+    Rack::Builder.parse_file(path).first
+  end
+
+  let(:rt) do
+    Rack::Test::Session.new(app)
+  end
+
+  describe 'GET /greeting' do
+    context 'when not logged in' do
+      it 'askes you to login' do
+        response = rt.get '/greeting'
+        expect(response.status).to eq(401)
+        expect(response.body).to eq('Login First!')
+      end
+    end
+
+    context 'POST /login' do
+      it 'logins a user' do
+        user = User.create(email: 'bob@email.com', name: 'Bob')
+        rt.post '/login', {email: user.email}
+        response = rt.get '/greeting'
+        expect(response.status).to eq(200)
+        expect(response.body).to eq("Hello #{user.name}!")
+      end
+    end
+  end
+end

data/spec/sessions_spec.rb

@@ -0,0 +1,73 @@
+class TestApp
+  include Eldr::Sessions
+  attr_accessor :env, :configuration
+
+  def initialize
+    @configuration = Eldr::Configuration.new
+  end
+
+  def call(env)
+    @env = env
+  end
+end
+
+describe Eldr::Sessions do
+  let(:app) { TestApp.new }
+
+  let(:env) do
+    Rack::MockRequest.env_for('/', {:method => :get, 'rack.session' => {'cats' => 'bob'}})
+  end
+
+  describe '#session' do
+    it 'returns the session data' do
+      app.call(env)
+      expect(app.session['cats']).to eq('bob')
+    end
+  end
+
+  describe '#session_id' do
+    context 'when there is a session_id' do
+      it 'returns the session_id' do
+        app.configuration.session_id = 'sessionsRAwesome'
+        expect(app.session_id).to eq('sessionsRAwesome')
+      end
+    end
+
+    context 'when there is no set session_id' do
+      it 'throws an error' do
+        app.configuration.session_id = nil
+        expect { app.session_id }.to raise_error
+      end
+    end
+  end
+
+  describe '#user_model_obj' do
+    context 'when there is a user_model set on configuration' do
+      it 'returns it' do
+        Bob = Class.new()
+        app.configuration.user_model = 'Bob'
+        expect(app.user_model_obj).to eq Bob
+        app.configuration.user_model = nil
+      end
+    end
+
+    context 'when there is no user_model set on configuration' do
+      it 'returns the default' do
+        expect(app.user_model_obj).to eq User
+      end
+    end
+  end
+
+  describe '#login_from_session' do
+    context 'when there is a set user' do
+      it 'returns that user' do
+        app.configuration.session_id = 'sessionsRAwesome'
+        app.call(env)
+
+        user = User.create(name: 'bob')
+        app.set_current_user user
+        expect(app.login_from_session).to eq user
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+if ENV['COVERALLS_REPO_TOKEN']
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'rack/test'
+require 'rack'
+
+# Hardcode an instance into a global because rack-test likes to get too clever
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: eldr-sessions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- K-2052
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eldr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+description: Session helpers for the Eldr ruby framework
+email:
+- k@2052.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- eldr-sessions.gemspec
+- examples/app.ru
+- lib/eldr-sessions.rb
+- lib/eldr/sessions.rb
+- lib/eldr/sessions/version.rb
+- spec/app_spec.rb
+- spec/sessions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/eldr-rb/eldr-sessions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Session helpers for the Eldr ruby framework.
+test_files:
+- spec/app_spec.rb
+- spec/sessions_spec.rb
+- spec/spec_helper.rb
+has_rdoc: