devise_imprintable 0.0.2

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise_imprintable.gemspec
+gemspec
+
+group :test do
+  gem 'rails'
+  platforms :jruby do
+    gem 'activerecord-jdbcsqlite3-adapter'
+  end
+
+  platforms :ruby do
+    gem "sqlite3", "~> 1.3.4"
+  end
+
+  gem 'activerecord', '~> 3.0'
+  gem "capybara", "~> 1.1.0"
+  gem 'shoulda', '~> 2.11.3'
+  gem 'mocha', '~> 0.9.9'
+  gem 'factory_girl_rails', '~> 1.2'
+  gem 'rspec-rails', '~> 2.6.0'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Sergey Efremov
+
+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,54 @@
+# Devise Imprintable
+
+It adds support to [devise](http://github.com/plataformatec/devise) for track time and ip for first user sign in.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devise_imprintable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install devise_imprintable
+
+When you are done, you are ready to add DeviseImprintable to any of your Devise models using the following generator:
+
+    rails generate devise_imprintable Model
+
+Or just add fields to your model:
+
+    class DeviseInvitableAddToUsers < ActiveRecord::Migration
+      def up
+        change_table :users do |t|
+          t.datetime   :first_sign_in_at
+          t.string     :first_sign_in_ip
+        end
+      end
+
+      def down
+        change_table :users do |t|
+          t.remove :first_sign_ip, :first_sign_in_at
+        end
+      end
+    end   
+
+and add imprintable to your model:
+  
+    class User < ActiveRecord::Base
+      devise :database_authenticatable, :registerable, :imprintable
+
+      ...
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake/testtask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run tests for all ORMs.'
+task :default => :test
+
+
+desc 'Run Devise unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/devise_imprintable.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/devise_imprintable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sergey Efremov"]
+  gem.email         = ["efremov.sergey@gmail.com"]
+  gem.description   = %q{An imprintable strategy for Devise}
+  gem.summary       = %q{It adds support to devise for track time and ip for first user sign in.}
+  gem.homepage      = "https://github.com/EvilFaeton/devise_imprintable"
+
+  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.name          = "devise_imprintable"
+  gem.require_paths = ["lib"]
+  gem.version       = DeviseImprintable::VERSION
+
+  gem.required_ruby_version     = '>= 1.8.6'
+  gem.required_rubygems_version = '>= 1.3.6'
+
+  gem.add_development_dependency('bundler', '>= 1.1.0')
+
+  {
+    'railties' => '~> 3.0',
+    'devise'   => '>= 2.1.0'
+  }.each do |lib, version|
+    gem.add_runtime_dependency(lib, *version)
+  end
+end

data/lib/devise_imprintable/hook.rb

@@ -0,0 +1,5 @@
+Warden::Manager.after_set_user :except => :fetch do |record, warden, options|
+  if record.respond_to?(:update_imprintable_fields!) && warden.authenticated?(options[:scope]) && !warden.request.env['devise.skip_imprintable']
+    record.update_imprintable_fields!(warden.request)
+  end
+end

data/lib/devise_imprintable/model.rb

@@ -0,0 +1,12 @@
+module Devise 
+  module Models
+    module Imprintable
+      def update_imprintable_fields!(request)
+        self.first_sign_in_at = self.first_sign_in_at || Time.now
+        self.first_sign_in_ip = self.first_sign_in_ip || request.remote_ip
+        save(:validate => false) or raise "Devise imprintable could not save #{inspect}." \
+          "Please make sure a model using imprintable can be saved at sign in."
+      end
+    end
+  end
+end

data/lib/devise_imprintable/version.rb

@@ -0,0 +1,3 @@
+module DeviseImprintable
+  VERSION = "0.0.2"
+end

data/lib/devise_imprintable.rb

@@ -0,0 +1,14 @@
+require "devise"
+
+require "devise_imprintable/version"
+require "devise_imprintable/model"
+require "devise_imprintable/hook"
+
+module DeviseImprintable
+  
+end
+
+
+Devise.with_options :model => true do |d|
+  d.add_module :imprintable
+end

data/lib/generators/active_record/devise_imprintable_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class DeviseImprintableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_devise_migration
+        migration_template "migration.rb", "db/migrate/devise_imprintable_add_to_#{table_name}"
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,14 @@
+class DeviseInvitableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def up
+    change_table :<%= table_name %> do |t|
+      t.datetime   :first_sign_in_at
+      t.string     :first_sign_in_ip
+    end
+  end
+
+  def down
+    change_table :<%= table_name %> do |t|
+      t.remove :first_sign_ip, :first_sign_in_at
+    end
+  end
+end

data/lib/generators/devise_imprintable/devise_imprintable_generator.rb

@@ -0,0 +1,17 @@
+module DeviseImprintable
+  module Generators
+    class DeviseImprintableGenerator < Rails::Generators::NamedBase
+      namespace "devise_imprintable"
+
+      desc "Add :imprintable directive in the given model. Also generate migration for ActiveRecord"
+
+
+      def inject_devise_invitable_content
+        path = File.join("app", "models", "#{file_path}.rb")
+        inject_into_file(path, "imprintable, :", :after => "devise :") if File.exists?(path)
+      end
+
+      hook_for :orm
+    end
+  end
+end

data/test/integration/inventable_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+require 'integration_tests_helper'
+
+class InvitationTest < ActionDispatch::IntegrationTest
+  def teardown
+    Capybara.reset_sessions!
+  end
+
+  test 'should have empty fields by default' do
+    user = create_full_user
+    assert_equal user.first_sign_in_at, nil
+    assert_equal user.first_sign_in_ip, nil
+  end
+
+  test 'should have not rewrite fields after they filled' do
+    time_stamp = 1.year.ago
+    user = create_full_user({:first_sign_in_at => time_stamp, :first_sign_in_ip => '127.0.0.1'})
+    sign_in_as_user user
+    user.reload
+    assert_equal user.first_sign_in_at, time_stamp
+    assert_equal user.first_sign_in_ip, '127.0.0.1'
+  end
+
+  test 'should fill first sign fields on first sign in' do
+    new_time = 2.seconds.from_now
+    Time.stubs(:now).returns(new_time)
+    user = create_full_user
+    sign_in_as_user user
+    user.reload
+    assert_equal user.first_sign_in_at, new_time
+    assert_equal user.first_sign_in_ip, '127.0.0.1'
+  end
+
+end

data/test/integration_tests_helper.rb

@@ -0,0 +1,51 @@
+class ActionController::IntegrationTest
+
+  def warden
+    request.env['warden']
+  end
+  
+  def create_full_user(options = {})
+    @user ||= begin
+      user = User.create!({
+        :username              => 'usertest',
+        :email                 => 'fulluser@test.com',
+        :password              => '123456',
+        :password_confirmation => '123456',
+        :created_at            => Time.now.utc
+        }.merge(options)
+      )
+
+      user.confirm!
+      user
+    end
+  end
+
+  def sign_in_as_user(user = nil)
+    user ||= create_full_user
+    resource_name = user.class.name.underscore
+    visit send("new_#{resource_name}_session_path")
+    fill_in "#{resource_name}_email", :with => user.email
+    fill_in "#{resource_name}_password", :with => user.password
+    click_button 'Sign in'
+  end
+
+  # Fix assert_redirect_to in integration sessions because they don't take into
+  # account Middleware redirects.
+  #
+  def assert_redirected_to(url)
+    assert [301, 302].include?(@integration_session.status),
+           "Expected status to be 301 or 302, got #{@integration_session.status}"
+
+    url = prepend_ho
+    st(url)
+    location = prepend_host(@integration_session.headers["Location"])
+    assert_equal url, location
+  end
+
+  protected
+
+    def prepend_host(url)
+      url = "http://#{request.host}#{url}" if url[0] == ?/
+      url
+    end
+end

data/test/orm/active_record.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.logger = Logger.new(nil)
+
+ActiveRecord::Migrator.migrate(File.expand_path("../../rails_app/db/migrate/", __FILE__))

data/test/rails_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+RailsApp::Application.load_tasks

data/test/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/rails_app/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/test/rails_app/app/controllers/users_controller.rb

@@ -0,0 +1,12 @@
+class UsersController < ApplicationController
+  before_filter :authenticate_user!
+
+  def index
+    user_session[:cart] = "Cart"
+  end
+
+  def expire
+    user_session['last_request_at'] = 31.minutes.ago.utc
+    render :text => 'User will be expired on next request'
+  end
+end

data/test/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/rails_app/app/models/user.rb

@@ -0,0 +1,32 @@
+class User < PARENT_MODEL_CLASS
+  if DEVISE_ORM == :mongoid
+    include Mongoid::Document
+
+    ## Database authenticatable
+    field :email,              :type => String, :null => false, :default => ""
+    field :encrypted_password, :type => String, :null => false, :default => ""
+
+    ## Recoverable
+    field :reset_password_token,   :type => String
+    field :reset_password_sent_at, :type => Time
+
+    ## Confirmable
+    field :confirmation_token,   :type => String
+    field :confirmed_at,         :type => Time
+    field :confirmation_sent_at, :type => Time
+    field :unconfirmed_email,    :type => String # Only if using reconfirmable
+
+    ## Imprintable
+    field :first_sign_in_ip,       :type => String
+    field :first_sign_in_at,       :type => Time
+
+
+    field :username
+    attr_accessible :username, :email, :password, :password_confirmation, :remember_me
+  end
+
+  devise :database_authenticatable, :registerable, :validatable, :confirmable, :imprintable, :recoverable
+
+  attr_accessible :email, :username, :password, :password_confirmation, :first_sign_in_at, :first_sign_in_ip
+
+end

data/test/rails_app/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsApp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= content_tag :p, flash[:notice], :id => 'notice' unless flash[:notice].blank? %>
+<%= content_tag :p, flash[:alert], :id => 'alert' unless flash[:alert].blank? %>
+<%= yield %>
+
+</body>
+</html>

data/test/rails_app/app/views/users/invitations/new.html.erb

@@ -0,0 +1,15 @@
+<h2>Send an invitation</h2>
+
+<%= form_for resource, :as => resource_name, :url => invitation_path(resource_name), :html => { :method => :post } do |f| %>
+  <%= devise_error_messages! %>
+  
+  <p><%= f.label :username %></p>
+  <p><%= f.text_field :username %></p>
+  
+  <p><%= f.label :email %></p>
+  <p><%= f.text_field :email %></p>
+  
+  <p><%= f.submit "Send an invitation" %></p>
+<% end %>
+
+<%= link_to "Home", after_sign_in_path_for(resource_name) %><br />

data/test/rails_app/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(:default, DEVISE_ORM) if defined?(Bundler)
+
+begin
+  require "#{DEVISE_ORM}/railtie"
+rescue LoadError
+end
+PARENT_MODEL_CLASS = DEVISE_ORM == :active_record ? ActiveRecord::Base : Object
+
+require "devise"
+require "devise_imprintable"
+
+module RailsApp
+  class Application < Rails::Application
+    config.filter_parameters << :password
+    config.action_mailer.default_url_options = { :host => "localhost:3000" }
+  end
+end

data/test/rails_app/config/boot.rb

@@ -0,0 +1,11 @@
+unless defined?(DEVISE_ORM)
+  DEVISE_ORM = (ENV["DEVISE_ORM"] || :active_record).to_sym
+end
+
+begin
+  require File.expand_path("../../../../.bundle/environment", __FILE__)
+rescue LoadError
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup :default, :test, DEVISE_ORM
+end

data/test/rails_app/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+RailsApp::Application.initialize!

data/test/rails_app/config/environments/development.rb

@@ -0,0 +1,25 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/rails_app/config/environments/production.rb

@@ -0,0 +1,49 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/rails_app/config/environments/test.rb

@@ -0,0 +1,35 @@
+RailsApp::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+Rails.backtrace_cleaner.remove_silencers!