authentication 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in authentication.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    authentication (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  authentication!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fujimura Daisuke
+
+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,21 @@
+# Authentication [<img src="https://secure.travis-ci.org/fujimura/authentication.png"/>](http://travis-ci.org/fujimura/authentication) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fujimura/authentication)
+
+## Minimalist authentication library for Ruby
+
+## How to use
+
+See an [example](https://github.com/fujimura/authentication-rails-example) or [spec](https://github.com/fujimura/authentication/blob/master/spec/authentication_spec.rb)
+
+## Requirements
+
+* Included class should have a method called `find_current_user` which returns the user object.
+* Included class should have a method called `session` method which returns Hash-like object.
+
+## Side-effects
+
+* ```session[:current_user_id]``` in included module will be changed.
+* ```@current_user``` in included module will be changed.
+
+## Goal
+
+The goal of this library is to provide standard authorization mechanism for web application with minimal dependency by short and concise code which can be understand easily.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/authentication.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authentication/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "authentication"
+  gem.version       = Authentication::VERSION
+  gem.authors       = ["Fujimura Daisuke"]
+  gem.email         = ["me@fujimuradaisuke.com"]
+  gem.description   = %q{Minimalist authentication library for Ruby}
+  gem.summary        = %q{Minimalist authentication library for Ruby}
+  gem.homepage      = "https://github.com/fujimura/authentication"
+
+  gem.rubyforge_project = "authentication"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/authentication.rb

@@ -0,0 +1,45 @@
+require "authentication/version"
+
+module Authentication
+
+  class Unauthenticated < StandardError; end
+
+  # Log in with given object.
+  #
+  # @param [Object] user The object you want to store as `current_user`.
+  def login!(user)
+    raise Unauthenticated unless user
+    @current_user = user
+    session[:current_user_id] = user.id
+  end
+
+  # Return current_user.
+  # If it does not exist, returns nil.
+  #
+  # @return [Object] The object stored as user or nil
+  def current_user
+    @current_user ||= find_current_user
+  end
+
+  # Return id of given current_user.
+  # If it does not exist, returns nil.
+  #
+  # @return [Object] The id of object stored as user or nil
+  def current_user_id
+    session[:current_user_id]
+  end
+
+  # Return current_user exists or not.
+  #
+  # @return [Boolean]
+  def logged_in?
+    not current_user.nil?
+  end
+
+  # Delete current_user from database and session.
+  #
+  def logout!
+    return unless current_user
+    @current_user = session[:current_user_id] = nil
+  end
+end

data/lib/authentication/version.rb

@@ -0,0 +1,3 @@
+module Authentication
+  VERSION = "0.0.1"
+end

data/spec/lib/authentication_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+class Controller
+  include Authentication
+  attr_accessor :session
+
+  def initialize
+    self.session = {}
+  end
+
+  def find_current_user success = true
+    if session[:current_user_id]
+      true
+    else
+      nil
+    end
+  end
+end
+
+class User
+  def initialize(attributes)
+    @attributes = attributes
+  end
+  def id
+    @attributes[:id]
+  end
+end
+
+describe Authentication do
+  let(:controller) { Controller.new }
+  let(:user)       { User.new(id: 300) }
+
+  describe '#login!' do
+    context 'with nil' do
+      it "should raise Unauthenticated" do
+        expect do
+          controller.login! nil
+        end.to raise_error Authentication::Unauthenticated
+      end
+    end
+  end
+
+  describe '#current_user' do
+    context 'when logged in' do
+      it "should return user" do
+        controller.login! user
+        controller.current_user.should == user
+      end
+    end
+    context 'when not logged in' do
+      it "should call #find_current_user and return its result" do
+        controller.should_receive(:find_current_user).and_return "something"
+        controller.current_user.should == "something"
+      end
+    end
+  end
+
+  describe '#current_user_id' do
+    context 'when logged in' do
+      it "should return user_id" do
+        controller.login! user
+        controller.current_user_id.should == user.id
+      end
+    end
+    context 'when not logged in' do
+      it "should return nil" do
+        controller.current_user_id.should == nil
+      end
+    end
+  end
+
+  describe '#logged_in?' do
+    context 'when logged in' do
+      it "should return true" do
+        controller.login! user
+        controller.logged_in?.should == true
+      end
+    end
+  end
+
+  describe '#logout!' do
+    context 'when logged in' do
+      it "should set current_user to nil" do
+        controller.login! user
+        controller.logout!
+        controller.current_user.should == nil
+        controller.session[:current_user_id].should == nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require File.expand_path(__FILE__ + './../../lib/authentication')
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: authentication
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fujimura Daisuke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minimalist authentication library for Ruby
+email:
+- me@fujimuradaisuke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- authentication.gemspec
+- lib/authentication.rb
+- lib/authentication/version.rb
+- spec/lib/authentication_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fujimura/authentication
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: authentication
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Minimalist authentication library for Ruby
+test_files:
+- spec/lib/authentication_spec.rb
+- spec/spec_helper.rb
+has_rdoc: