devise_date_restrictable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8e7bdcb5d131667ce1606ceff520840e41d0d2f
+  data.tar.gz: ed13b406d6044280fe46e737e15f6ec0979972b9
+SHA512:
+  metadata.gz: 43c0c1db641ce4b175d9cb98ef51016b47a06f8fb65569cb0d7b0d2a9322fdf87015fd939dd82bd5f092163ccf4e570a4fd5d21054d2cbec3bc53554a960e9c2
+  data.tar.gz: 3366256cf7c11522b25468940d675bf6591dceb501203c416e51bc9fbaabc693fb083abfc126fe8583aa685500daf82720876ba6ae627b90db25ad4a4843e066

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Defaults for all files
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jon Pearse
+
+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.textile

@@ -0,0 +1,42 @@
+h1. Devise Date Restrictable
+
+This is a module for "Devise":https://github.com/plataformatec/devise that allows a user account to be restricted by date range.
+
+h2. Installation + Setup
+
+Add the following line to your application’s Gemfile:
+
+<pre><code>gem 'devise_date_restrictable'</code></pre>
+
+And then run @bundle install@.
+
+Next, you will need to generate an ActiveRecord migration and run that migration.
+
+<pre><code>$ rails generate devise_date_restrictable --model MODEL
+rake db:migrate</code></pre>
+
+Finally, add @:date_restrictable@ to the devise line of your model, for instance:
+
+<pre><code>devise :database_authenticatable, :registerable, :recoverable, :rememberable, :trackable, :date_restrictable</code></pre>
+
+h2. Usage
+
+This gem adds two @DATE@ fields to your account model: @valid_from@ and @valid_until@. One or both may be specified in order to restrict an account’s ability to log in.
+If neither is specified, the user will be able to log in without restriction.
+
+Note that dates are _inclusive_: that is, setting an account to be valid *from* 2017-05-28 means they will be able to log in from midnight on 2017-05-28. Similarly, setting an account to be valid *until* 2017-05-27 means they will be able to log in until 23.59.59 on that date.
+At this time, all restrictions are based on server time—no provision has been made, as yet, for different timezones.
+
+h2. To-do
+
+This has been fairly quickly bashed together for use within a project, therefore isn’t perhaps as polished as it might be. At some point, I might get around to implementing some of the following:
+
+* add support for timezones
+* add helper methods to the account object to facilitate easier management (eg. @user.set_valid_for(3.years)@, and the like)
+* support for better messaging
+
+h2. Version History
+
+h3. 0.0.1 _(May 28th, 2017)_
+
+* initial release

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  devise:
+    failure:
+      user:
+        account_date_restricted: "Your account is not currently active: please contact an administrator for more information"

data/devise_date_restrictable.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/devise_date_restrictable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = "Jon Pearse"
+  gem.email         = "jon@jonpearse.net"
+  gem.description   = "This allows a Devise user’s validity to be restricted by a date range. This allows administrators to set up accounts that are valid to-, or from-, or between specific dates."
+  gem.summary       = "Devise plugin to restrict access based on a date range."
+  gem.homepage      = "https://github.com/jonpearse/devise_date_restrictable"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.name          = "devise_date_restrictable"
+  gem.require_paths = ["lib"]
+  gem.version       = DeviseDateRestrictable::VERSION
+
+  gem.add_dependency('devise', [">= 4.0.0"])
+  gem.add_dependency('rails', [">= 5.0.0"])
+end

data/lib/devise_date_restrictable/active_record.rb

@@ -0,0 +1,36 @@
+module Devise
+  module Models
+    module DateRestrictable
+      extend  ActiveSupport::Concern
+
+      def date_restricted?
+        now = Date.today
+
+        puts now.inspect
+        puts valid_from.nil?.inspect
+        puts valid_until.nil?.inspect
+
+        !((valid_from.nil? or now >= valid_from) and (valid_until.nil? or now <= valid_until))
+      end
+
+      def self.required_fields(klass)
+        attributes = []
+        attributes << :valid_from
+        attributes << :valid_until
+        attributes
+      end
+
+      def access_locked?
+        date_restricted?
+      end
+
+      def active_for_authentication?
+        super && !date_restricted?
+      end
+
+      def inactive_message
+        date_restricted? ? :account_date_restricted : super
+      end
+    end
+  end
+end

data/lib/devise_date_restrictable/rails.rb

@@ -0,0 +1,5 @@
+module DeviseDateRestrictable
+  class Engine < ::Rails::Engine
+
+  end
+end

data/lib/devise_date_restrictable/version.rb

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

data/lib/devise_date_restrictable.rb

@@ -0,0 +1,11 @@
+require "devise_date_restrictable/version"
+require "devise_date_restrictable/rails"
+
+unless defined?(Devise)
+  require 'devise'
+end
+
+Devise.add_module :date_restrictable, model: 'devise_date_restrictable/active_record'
+
+module DeviseDateRestrictable
+end

data/lib/generators/devise_date_restrictable/devise_date_restrictable_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/migration'
+
+class DeviseDateRestrictableGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @_devise_source_root ||= File.expand_path("../templates", __FILE__)
+  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 :model, type: :string, default: 'User'
+
+  desc "Generates a migration to add required fields to devise account model."
+  def invoke_migration
+
+    model_name = options['model']
+    @model_name = model_name.camelize.singularize
+
+    if columns_exist?
+      say "* Date restrictable columns already seem to exist on @{model_name}"
+    else
+      migration_template 'migration.rb', "db/migrate/devise_add_#{model_name.downcase}_date_restriction_fields.rb"
+    end
+
+    puts "Make sure to add :date_restrictable to the devise line of your #{@model_name} model file."
+  end
+
+  protected
+
+  def columns_exist?
+    @model_name.constantize.column_names.include?("valid_from") and @model_name.constantize.column_names.include?("valid_until")
+  end
+end

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

@@ -0,0 +1,6 @@
+class DeviseAdd<%= @model_name.camelize.singularize %>DateRestrictionFields < ActiveRecord::Migration
+ def change
+  add_column :<%=@model_name.tableize%>, :valid_from, :date
+  add_column :<%=@model_name.tableize%>, :valid_until, :date
+ end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: devise_date_restrictable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Pearse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: This allows a Devise user’s validity to be restricted by a date range.
+  This allows administrators to set up accounts that are valid to-, or from-, or between
+  specific dates.
+email: jon@jonpearse.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- Gemfile
+- LICENSE
+- README.textile
+- config/locales/en.yml
+- devise_date_restrictable.gemspec
+- lib/devise_date_restrictable.rb
+- lib/devise_date_restrictable/active_record.rb
+- lib/devise_date_restrictable/rails.rb
+- lib/devise_date_restrictable/version.rb
+- lib/generators/devise_date_restrictable/devise_date_restrictable_generator.rb
+- lib/generators/devise_date_restrictable/templates/migration.rb
+homepage: https://github.com/jonpearse/devise_date_restrictable
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Devise plugin to restrict access based on a date range.
+test_files: []