devise_suspendable 0.6.0 → 0.6.1

data/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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.rdoc

@@ -6,21 +6,15 @@ When an account is suspended the date and time of suspension is recorded, as wel
 == 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
-
 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
-
 3. Run the migration
   rake db:migrate
-
 4. Mark the model as suspendable
-
-    class User < ActiveRecord::Base
-
-      devise ..., :activatable, :suspendable
-
-      ...
-    end
+  class User < ActiveRecord::Base
+    devise ..., :activatable, :suspendable
+    ...
+  end
 
 == Notes
 - :suspendable depends on :activatable
@@ -35,11 +29,6 @@ When an account is suspended the date and time of suspension is recorded, as wel
 * [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

data/Rakefile

@@ -15,11 +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{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.summary = %Q{Devise user account suspension module}
+  gem.description = %Q{Has a user left the organisation? Or maybe the account created was bogus? Remove access for a user with a click of a button}
   gem.email = "kelkar.amol@gmail.com"
-  gem.authors = ["Amol Kelkar"]
+  gem.authors = ["Amol Kelkar", "Josh Kalderimis"]
   # 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)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
@@ -48,4 +47,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title = "devise_suspendable #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.6.1

data/devise_suspendable.gemspec

@@ -0,0 +1,81 @@
+# 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.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Amol Kelkar", "Josh Kalderimis"]
+  s.date = %q{2011-04-27}
+  s.description = %q{Has a user left the organisation? Or maybe the account created was bogus? Remove access for a user with a click of a button}
+  s.email = %q{kelkar.amol@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "devise_suspendable.gemspec",
+    "lib/devise_suspendable.rb",
+    "lib/devise_suspendable/model.rb",
+    "lib/devise_suspendable/rails.rb",
+    "lib/generators/devise_suspendable/.DS_Store",
+    "lib/generators/devise_suspendable/devise_suspendable_generator.rb",
+    "lib/generators/devise_suspendable/templates/.DS_Store",
+    "lib/generators/devise_suspendable/templates/migration.rb",
+    "rails/init.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{Devise user account suspension module}
+  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
+

data/lib/devise_suspendable.rb

@@ -8,4 +8,4 @@ Devise.add_module :suspendable, :model => 'devise_suspendable/model'
 module DeviseSuspendable
 end
 
-require 'devise_suspendable/rails'
+require 'devise_suspendable/rails'

data/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

data/lib/devise_suspendable/rails.rb

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

data/lib/generators/devise_suspendable/devise_suspendable_generator.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

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

@@ -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

data/rails/init.rb

@@ -0,0 +1 @@
+require 'devise_suspendable'

metadata

@@ -2,10 +2,11 @@
 name: devise_suspendable
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors: 
 - Amol Kelkar
+- Josh Kalderimis
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -90,9 +91,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id007
-description: |-
-  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.
+description: Has a user left the organisation? Or maybe the account created was bogus? Remove access for a user with a click of a button
 email: kelkar.amol@gmail.com
 executables: []
 
@@ -105,11 +104,21 @@ files:
 - .document
 - .rspec
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- devise_suspendable.gemspec
 - lib/devise_suspendable.rb
+- lib/devise_suspendable/model.rb
+- lib/devise_suspendable/rails.rb
+- lib/generators/devise_suspendable/.DS_Store
+- lib/generators/devise_suspendable/devise_suspendable_generator.rb
+- lib/generators/devise_suspendable/templates/.DS_Store
+- lib/generators/devise_suspendable/templates/migration.rb
+- rails/init.rb
 - spec/devise_suspendable_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -126,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -736303433424034158
+      hash: 2894843038137255541
       segments: 
       - 0
       version: "0"
@@ -142,7 +151,7 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Device module that provides a simple clean way to suspend an account
+summary: Devise user account suspension module
 test_files: 
 - spec/devise_suspendable_spec.rb
 - spec/spec_helper.rb