remember_me 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a42680f6177ae0ca5cc01c7811058949a2ed7095
+  data.tar.gz: 250d11dc425905c81dcd9c108b68633620906631
+SHA512:
+  metadata.gz: c942be2252b30de128c564e7d74a9dab48bad605be679ae9991fe41e6f1b2a9ed07d1d1506b70bcf88fab4841c2c2e4fd73766c285d9c555856f4b8f2eefbcfa
+  data.tar.gz: 9bfb468798bf19a50f2744afaab404c1c35d49e7e68656606fcd38b442748279bb8a5dde3e873fb16f7d02193d8d49840f9fc6ea7413bef868018224f2d31062

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+before_install:
+  - gem update bundler
+
+script:
+  - bundle exec rake spec
+
+notifications:
+  email:
+    recipients:
+    - linyows@gmail.com
+    on_success: change
+    on_failure: always
+  irc:
+    on_success: change
+    on_failure: always
+    channels:
+      - "irc.freenode.org#linyows"

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 linyows
+
+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,92 @@
+RememberMe
+==========
+
+[![Gem Version](https://badge.fury.io/rb/remember_me.png)][gem]
+[![Build Status](https://secure.travis-ci.org/linyows/remember_me.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/linyows/remember_me.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/linyows/remember_me.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/linyows/remember_me/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/remember_me
+[travis]: http://travis-ci.org/linyows/remember_me
+[gemnasium]: https://gemnasium.com/linyows/remember_me
+[codeclimate]: https://codeclimate.com/github/linyows/remember_me
+[coveralls]: https://coveralls.io/r/linyows/remember_me
+
+RememberMe is a simple remember-me login solution on Rails.
+Manages generating and clearing a token for remembering the user from a saved cookie.
+
+![RememberMe](http://www.movieposterdb.com/posters/10_04/2010/1403981/l_1403981_94a56aed.jpg)
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'remember_me'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install remember_me
+
+Usage
+-----
+
+controllers/application_controller.rb:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include RememberMe::Controller
+end
+```
+
+models/user.rb:
+
+```ruby
+class User
+  include RememberMe::Model
+end
+```
+
+controllers/sessions_controller.rb:
+
+```ruby
+class SessionsController < ApplicationController
+  def create
+    # ... authenticated ...
+
+    self.current_user = @user
+    remember_me(current_user) if remember_me?
+
+    redirect_to root_path, notice: 'Success'
+  end
+
+  def destroy
+    forget_me(current_user)
+    self.current_user = nil
+    redirect_to login_path, notice: 'Success'
+  end
+```
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Author
+------
+
+- [linyows](https://github.com/linyows)
+
+License
+-------
+
+MIT

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/remember_me.rb

@@ -0,0 +1,2 @@
+require "remember_me/model"
+require "remember_me/controller"

data/lib/remember_me/controller.rb

@@ -0,0 +1,48 @@
+module RememberMe
+  module Controller
+    def cookie_values
+      Rails.configuration.session_options.slice(:path, :domain, :secure)
+    end
+
+    def remember_me?
+      params.has_key?(:remember_me) && params[:remember_me]
+    end
+
+    def scope_of(resource)
+      resource.class.to_s.underscore
+    end
+
+    def remember_me(resource)
+      resource.remember_me!
+      cookies.signed[remember_key(scope_of resource)] = remember_cookie_values(resource)
+    end
+
+    def forget_me(resource)
+      resource.forget_me!
+      cookies.delete remember_key(scope_of resource), forget_cookie_values(resource)
+    end
+
+    def remember_cookie_values(resource)
+      options = { httponly: true }
+      options.merge!(forget_cookie_values(resource))
+      options.merge!(
+        value: resource.class.serialize_into_cookie(resource),
+        expires: resource.remember_expires_at
+      )
+    end
+
+    def forget_cookie_values(resource)
+      cookie_values.merge!(resource.rememberable_options)
+    end
+
+    def remember_key(scope)
+      # remember_token_for_user
+      :"_rtf#{scope}"
+    end
+
+    def remember(scope)
+      cookie = cookies.signed[remember_key(scope)]
+      "#{scope.classify}".constantize.serialize_from_cookie(*cookie) if cookie
+    end
+  end
+end

data/lib/remember_me/model.rb

@@ -0,0 +1,53 @@
+module RememberMe
+  module Model
+    extend ::ActiveSupport::Concern
+
+    included { field :remember_created_at, type: Time } if defined?(Mongoid)
+
+    def remember_me!
+      self.remember_created_at = Time.now.utc
+      save(validate: false) if self.changed?
+    end
+
+    def forget_me!
+      return if self.remember_created_at.nil?
+      self.remember_created_at = nil
+      save(validate: false)
+    end
+
+    def remember_expired?
+      remember_created_at.nil? || (remember_expires_at <= Time.now.utc)
+    end
+
+    def remember_expires_at
+      remember_created_at + self.class.remember_for
+    end
+
+    def rememberable_options
+      self.class.rememberable_options
+    end
+
+    def rememberable_value
+      Digest::SHA1.hexdigest "#{self.id}"
+    end
+
+    module ClassMethods
+      def serialize_into_cookie(record)
+        [record.id, record.rememberable_value]
+      end
+
+      def serialize_from_cookie(id, remember_token)
+        record = where(id: id).first
+        record if record && record.rememberable_value == remember_token && !record.remember_expired?
+      end
+
+      def rememberable_options
+        {}
+      end
+
+      def remember_for
+        2.weeks
+      end
+    end
+  end
+end

data/lib/remember_me/version.rb

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

data/remember_me.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remember_me/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'remember_me'
+  spec.version       = RememberMe::VERSION
+  spec.authors       = ['linyows']
+  spec.email         = ['linyows@gmail.com']
+  spec.description   = %q{Manages generating and clearing a token for remembering the user from a saved cookie.}
+  spec.summary       = %q{RememberMe is a simple remember-me login solution on Rails.}
+  spec.homepage      = 'https://github.com/linyows/remember_me'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+
+  spec.add_dependency 'rails', '>= 3.2'
+  spec.add_dependency 'mongoid', '>= 3'
+end

data/spec/helper.rb

@@ -0,0 +1,17 @@
+if ENV["CI"]
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start
+end
+
+require 'active_support/concern'
+require 'active_record'
+require 'mongoid'
+require 'remember_me'
+require 'rspec'
+

data/spec/model_spec.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+describe RememberMe::Model do
+  before :all do
+    class User
+      include Mongoid::Document
+      include RememberMe::Model
+      def save(arg = {})
+        true
+      end
+    end
+    @model = User.new
+  end
+
+  it { expect(@model.fields.has_key? 'remember_created_at').to be_true }
+  it { expect(@model.fields['remember_created_at'].options[:type]).to eq Time }
+  it { expect(@model.respond_to? :remember_me!).to be_true }
+
+  describe '#remember_me!' do
+    before { @model.remember_me! }
+    it { expect(@model.remember_created_at.class).to eq Time }
+  end
+
+  describe '#forget_me!' do
+    it { expect(@model.respond_to? :forget_me!).to be_true }
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: remember_me
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- linyows
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Manages generating and clearing a token for remembering the user from
+  a saved cookie.
+email:
+- linyows@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/remember_me.rb
+- lib/remember_me/controller.rb
+- lib/remember_me/model.rb
+- lib/remember_me/version.rb
+- remember_me.gemspec
+- spec/helper.rb
+- spec/model_spec.rb
+homepage: https://github.com/linyows/remember_me
+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.0.0
+signing_key: 
+specification_version: 4
+summary: RememberMe is a simple remember-me login solution on Rails.
+test_files:
+- spec/helper.rb
+- spec/model_spec.rb