devise_account_expireable 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDBmYzVhOWI3Y2UwZWNjN2Q5NDc4MWM1MGI3YmFkYjI4YTYxZjA5Mg==
+  data.tar.gz: !binary |-
+    NTJiMGFmMGRhYzJlMDAwNjhjNDE5YTc4NjZjNzk2MmY5OWY3ODU2Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTA3ODM3MzlmOWM1MDM2ZTIyYzQ5YTZiMDc0YTc3OGEwZDNlZGE4YmJiYzhj
+    NTFmNzM1ZWFiNjY1NmNhZjE3Yjk2MzkzYmI2NGVhMzRkOWYzZTRkNjhmMGMy
+    MDAzMWJhMTJlYWY1Y2JkNzRiNWRlNWVhYWQ5MTU5MjZiYzQ4ODg=
+  data.tar.gz: !binary |-
+    OTNlZTVkOTU2Y2QyMDY5ZWNiNGMxMDgxMGFkZjZhOTdjMTI0NTFiMDVlYzJk
+    OTZhMTlhN2UyMTQwMmIzY2MzMjMwOTFmZjMwNmYyMTQ1MWM0YmE0YzIyNTlj
+    NjM4YmYyZTYyMDkwZTg4NTBhYTQxM2ZkMzg5NjE2YTA2NjZhZDE=

data/README.md

@@ -14,13 +14,65 @@ Or install it yourself as:
 
     $ gem install devise_account_expireable
 
-## Usage
+## Setup and Configuration
 
-1. Install the migration: `rails g devise_account_expireable`
-2. `rake db:migrate`
-3. Add `:account_expireable` to the devise line of you account (User) model.
-`devise :database_authenticatable, :registerable, :recoverable, :rememberable, :trackable, :validatable, :account_expireable`
-4. Add a way through your admin panel of setting the attribute `:expires_at` to a date/time on the account (User) model.
+1. Generate the migration
+
+```
+$ rails g devise_account_expireable`
+```
+
+2. Migrate
+
+```
+$ rake db:migrate
+```
+
+3. Add `:account_expireable` to the devise line of you account (`User`) model.
+
+```ruby
+devise :database_authenticatable, :registerable, :recoverable, :rememberable, :trackable, :validatable, :account_expireable`
+```
+
+4. (Optional) Add a way through your admin panel of setting the attribute `:expires_at` to a date/time (`DateTime`) on the account (`User`) model.
+
+## Expiring and Unexpiring a User account
+
+If you want to expire User u1 now, without immediate persistence to DB:
+
+```ruby
+u1.expire_now
+```
+
+If you want to expire User u1 now, with immediate persistence to DB:
+
+```ruby
+u1.expire_now!
+```
+
+If you want to expire User u1 at a future DateTime (like DateTime.now.end_of_day), without immediate persistence to DB:
+
+```ruby
+u1.expire_at DateTime.now.end_of_day
+```
+
+If you want to expire User u1 at a future DateTime (like DateTime.now.end_of_day), with immediate persistence to DB:
+
+```ruby
+u1.expire_at! DateTime.now.end_of_day
+```
+
+If you want to unexpire User u1 now, without immediate persistence to DB:
+
+```ruby
+u1.unexpire_now
+```
+
+If you want to unexpire User u1 now, with immediate persistence to DB:
+
+```ruby
+u1.unexpire_now!
+```
 
 ## Contributing
 

data/devise_account_expireable.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/devise_account_expireable/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Justin McNally"]
-  gem.email         = ["justin@kohactive.com"]
+  gem.authors       = ["Justin McNally", "Brendten Eickstaedt"]
+  gem.email         = ["justin@kohactive.com", "brendten@brendteneickstaedt.com"]
   gem.description   = %q{Expire a user's account at a certain date}
   gem.summary       = %q{At a certain date make a user's account not work}
   gem.homepage      = ""

data/lib/devise_account_expireable.rb

@@ -1,16 +1,12 @@
 require "devise_account_expireable/version"
 
+require 'devise_account_expireable/rails'
 
 unless defined?(Devise)
   require 'devise'
 end
 
-require 'devise_account_expireable'
-
 Devise.add_module :account_expireable, :model => 'devise_account_expireable/model'
 
-
 module DeviseAccountExpireable
 end
-
-require 'devise_account_expireable/rails'

data/lib/devise_account_expireable/model.rb

@@ -1,10 +1,8 @@
 module Devise
   module Models
-    # Trace information about your user sign in. It tracks the following columns:
+    # Allow for expiration date on Devise resources. Adds attribute:
 
-    # * resource_id
-    # * sign_in_at
-    # * sign_out_at
+    # * expires_at
     
     module AccountExpireable
       extend  ActiveSupport::Concern
@@ -13,16 +11,41 @@ module Devise
         expires_at.present? && expires_at < DateTime.now
       end
 
+      def expire_now
+        expire_at
+      end
+
+      def expire_now!
+        expire_at!
+      end
+
+      def unexpire_now
+        expire_at nil
+      end
+
+      def unexpire_now!
+        expire_at! nil
+      end
+
+      def expire_at(date_time = DateTime.now)
+        self.expires_at = date_time
+      end
 
+      def expire_at!(date_time = DateTime.now)
+        expire_at(date_time)
+        save
+      end
 
       def self.required_fields(klass)
         attributes = []
         attributes << :expires_at
         attributes
       end
+
       def access_locked?
         expired?
       end
+
       def active_for_authentication?
         super && !expired?
       end

data/lib/devise_account_expireable/rails.rb

@@ -1,5 +1,3 @@
-require 'devise_account_expireable'
-
 module DeviseAccountExpireable
   class Engine < ::Rails::Engine
     

data/lib/devise_account_expireable/version.rb

@@ -1,3 +1,3 @@
 module DeviseAccountExpireable
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,20 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: devise_account_expireable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin McNally
+- Brendten Eickstaedt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +21,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +35,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,6 +42,7 @@ dependencies:
 description: Expire a user's account at a certain date
 email:
 - justin@kohactive.com
+- brendten@brendteneickstaedt.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,26 +62,26 @@ files:
 - lib/generators/devise_account_expireable/templates/migration.rb
 homepage: ''
 licenses: []
+metadata: {}
 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: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: At a certain date make a user's account not work
 test_files: []
+has_rdoc: