Fixed active? method logic

Now a real gem on rubygems.org
Basic tests

Author: Amol Kelkar

Gemfile

@@ -1,12 +1,11 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem 'rails', ">= 3.0.4"
+gem 'warden'
+gem 'devise'
+
 group :development do
-  gem "rspec", "~> 2.3.0"
+  gem "rspec"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"

Gemfile.lock

@@ -0,0 +1,100 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.9)
+    bcrypt-ruby (2.1.4)
+    builder (2.1.2)
+    devise (1.3.3)
+      bcrypt-ruby (~> 2.1.2)
+      orm_adapter (~> 0.0.3)
+      warden (~> 1.0.3)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    orm_adapter (0.0.4)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+    warden (1.0.3)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  devise
+  jeweler (~> 1.5.2)
+  rails (>= 3.0.4)
+  rcov
+  rspec
+  warden

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Amol Kelkar
+Copyright (c) 2010, 2011 Josh Kalderimis, Amol Kelkar
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.rdoc

@@ -1,19 +1,51 @@
 = devise_suspendable
 
-Description goes here.
+devise_suspendable is a simple module which uses the [Devise](http://github.com/plataformatec/devise) authentication framework Activatable module hooks to provide a simple clean way to suspend an account.
+When an account is suspended the date and time of suspension is recorded, as well as an optional reason, for easy reference.
 
-== Contributing to devise_suspendable
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+== Setup
+(Assumes that you have devise already setup and your device models, e.g. User, are already created)
+1. Add `gem devise_suspendable` in your Gemfile
 
-== Copyright
+2. Create a migration to update each of your device model(s), e.g. User, that you want to be suspendable
+  rails g devise_suspendable User
 
-Copyright (c) 2011 Amol Kelkar. See LICENSE.txt for
-further details.
+3. Run the migration
+  rake db:migrate
 
+4. Mark the model as suspendable
+
+    class User < ActiveRecord::Base
+
+      devise ..., :activatable, :suspendable
+
+      ...
+    end
+
+== Notes
+- :suspendable depends on :activatable
+
+- This plugin is similar to Lockable and can be used along side it, as long as Lockable is using token or timeouts as the unlock strategy. Lockable is great for failed login tracking, and subsequent locking, suspendable is best for manual account suspension
+
+- Maintaining your active users is part and parcel of running a web app
+
+
+== References
+
+* [Devise](http://github.com/plataformatec/devise)
+* [Warden](http://github.com/hassox/warden)
+
+
+== TODO
+
+- tests, tests, tests
+
+== Thanks to
+* Josh Kalderimis for most of core logic for this gem
+* devise_lastseenable[https://github.com/ctide/devise_lastseenable] for essentially operating as the base for this gem
+* Jeweler[https://github.com/technicalpickles/jeweler] for making it dead simple to write this gem
+
+
+Released under the MIT license
+
+Copyright (c) 2010, 2011 Josh Kalderimis, Amol Kelkar

Rakefile

@@ -15,9 +15,10 @@ Jeweler::Tasks.new do |gem|
   gem.name = "devise_suspendable"
   gem.homepage = "http://github.com/amolk/devise_suspendable"
   gem.license = "MIT"
-  gem.summary = %Q{TODO: one-line summary of your gem}
-  gem.description = %Q{TODO: longer description of your gem}
-  gem.email = "amol@kingofweb.com"
+  gem.summary = %Q{Device module that provides a simple clean way to suspend an account}
+  gem.description = %Q{Devise-Suspendable is a simple module which uses the [Devise](http://github.com/plataformatec/devise) authentication framework Activatable module hooks to provide a simple clean way to suspend an account.
+  When an account is suspended the date and time of suspension is recorded, as well as an optional reason, for easy reference.}
+  gem.email = "kelkar.amol@gmail.com"
   gem.authors = ["Amol Kelkar"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)

devise_suspendable.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{devise_suspendable}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Amol Kelkar"]
+  s.date = %q{2011-04-27}
+  s.description = %q{Devise-Suspendable is a simple module which uses the [Devise](http://github.com/plataformatec/devise) authentication framework Activatable module hooks to provide a simple clean way to suspend an account.
+  When an account is suspended the date and time of suspension is recorded, as well as an optional reason, for easy reference.}
+  s.email = %q{kelkar.amol@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/devise_suspendable.rb",
+    "spec/devise_suspendable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/amolk/devise_suspendable}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Device module that provides a simple clean way to suspend an account}
+  s.test_files = [
+    "spec/devise_suspendable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.4"])
+      s.add_runtime_dependency(%q<warden>, [">= 0"])
+      s.add_runtime_dependency(%q<devise>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3.0.4"])
+      s.add_dependency(%q<warden>, [">= 0"])
+      s.add_dependency(%q<devise>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3.0.4"])
+    s.add_dependency(%q<warden>, [">= 0"])
+    s.add_dependency(%q<devise>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

lib/devise_suspendable.rb

@@ -0,0 +1,11 @@
+unless defined?(Devise)
+  require 'devise'
+end
+require 'devise_suspendable'
+
+Devise.add_module :suspendable, :model => 'devise_suspendable/model'
+
+module DeviseSuspendable
+end
+
+require 'devise_suspendable/rails'

lib/devise_suspendable/model.rb

@@ -0,0 +1,53 @@
+module Devise
+  module Models
+    # Suspendable Module, responsible for manual deactivation of a user account.
+    #
+    # Examples:
+    #
+    #    User.find(1).suspend!('Left the company')
+    #
+    module Suspendable
+      def self.included(base)
+        base.class_eval do
+          validates_length_of :suspension_reason, :maximum => 250
+
+          # basic sanitization
+          before_validation do |acc|
+            acc.suspension_reason.strip! if acc.suspension_reason
+            acc.suspension_reason = nil  if acc.suspension_reason.blank?
+            acc.suspension_reason = nil  if acc.suspended_at.blank?
+          end
+        end
+      end
+
+      def suspended?
+        self.suspended_at?
+      end
+
+      def suspend!(reason = nil)
+        return if suspended?
+        self.suspended_at = Time.zone.now
+        self.suspension_reason = reason
+        self.save(:validate => false)
+      end
+
+      def unsuspend!
+        return if !suspended?
+        self.suspended_at = nil
+        self.suspension_reason = nil
+        self.save(:validate => false) if self.changed?
+      end
+
+      # override Activatable
+      def active?
+        super && !suspended?
+      end
+      
+      # Overwrites invalid_message from Devise::Models::Authenticatable to define
+      # the correct reason for blocking the sign in.
+      def inactive_message
+        suspended? ? :suspended : super
+      end
+    end
+  end
+end

lib/devise_suspendable/rails.rb

@@ -0,0 +1,6 @@
+require 'devise_suspendable'
+
+module DeviseSuspendable
+  class Engine < ::Rails::Engine
+  end
+end

lib/devise_suspendable/version.rb

@@ -0,0 +1,31 @@
+require 'rails/generators/migration'
+
+class DeviseSuspendableGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_devise_source_root ||= File.expand_path("../templates", __FILE__)
+  end
+
+  def self.orm_has_migration?
+    Rails::Generators.options[:rails][:orm] == :active_record
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  class_option :orm
+  class_option :migration, :type => :boolean, :default => orm_has_migration?
+
+
+  def create_migration_file
+    migration_template 'migration.rb', "db/migrate/devise_add_suspendable_#{name.downcase}.rb"
+  end
+
+  protected
+end

lib/generators/devise_suspendable/.DS_Store

@@ -0,0 +1,11 @@
+class DeviseAddSuspendable<%= table_name.camelize.singularize %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :suspended_at,      :datetime,  :null => true, :default => nil
+    add_column :<%= table_name %>, :suspension_reason, :string,    :null => true, :default => nil
+  end
+  
+  def self.down
+    remove_column :<%= table_name %>, :suspended_at
+    remove_column :<%= table_name %>, :suspension_reason
+  end
+end

lib/generators/devise_suspendable/devise_suspendable_generator.rb

@@ -1,7 +1,32 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.dirname(__FILE__) + '/spec_helper'
 
 describe "DeviseSuspendable" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  it 'cannot run tests here' do
+    pending "copy this file to your project as /spec/models/suspendable_user_spec.rb and run as part of your project's specs. The spec code depends on FactoryGirl gem and a valid :user factory defined."
   end
+  
+  it 'is not in suspended state when created fresh' do
+    user = Factory(:user)
+    user.should_not be_suspended
+    user.should be_active 
+  end
+
+  it 'can be suspended' do
+    user = Factory(:user)
+    user.suspend!("has too many 'family members'")
+    user.should be_suspended
+    user.should_not be_active 
+  end
+
+  it 'can be unsuspended' do
+    user = Factory(:user, :suspended_at => 1.day.ago)
+    user.should be_suspended
+    user.should_not be_active 
+    
+    user.unsuspend!
+
+    user.should_not be_suspended
+    user.should be_active 
+  end
+
 end