devise_approvable 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6ee7a4c4b50dbb8c69b5f55a2920eac5e5d5c64
+  data.tar.gz: ff50c8cd9811d6219464551e92a56e7bb53eb281
+SHA512:
+  metadata.gz: ec15da36a1e2d754b58eaabbd6e081b90d9baf040ba38c0d2fe538ebbc9ace11868732113cc3f3d91e4e93b4073063fce6e236d5c8d9227aa9ff69f233cfc1f8
+  data.tar.gz: 0d4cbc97f16bad9f156515661939fd5758c3503d4dafdc7b34ec5daadfab5a841e70770692fe440f17ca0870e7a68a58190ba2cad5e189387474ac92b54ecf33

data/Gemfile

@@ -0,0 +1,14 @@
+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.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.4.1)
+    highline (1.7.1)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.2)
+    jwt (1.4.1)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/README

@@ -0,0 +1,5 @@
+An approvable module. This includes all confirmable functions as approval should happen before confirmation.
+
+Workflow:
+
+Admin email should be added to the configuration. When user signs up admin receives email with link to approve user. Admin clicks link with token. User is approved. Confirmation email gets sent to user. User clicks confirmation link. Profit.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "devise_approvable"
+  gem.homepage = "http://github.com/eggie5/devise-approvable"
+  gem.license = "MIT"
+  gem.summary = %Q{Oh so perfect}
+  gem.description = %Q{adds feature to devise}
+  gem.email = "eggie5@gmail.com"
+  gem.authors = ["Alex Egg"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "devise-approvable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/app/controllers/approvals_controller.rb

@@ -0,0 +1,14 @@
+class Devise::ApprovalsController < DeviseController
+  # GET /resource/confirmation?confirmation_token=abcdef
+  def show
+    self.resource = resource_class.approve_by_token(params[:approval_token])
+    yield resource if block_given?
+
+    if resource.errors.empty?
+      set_flash_message(:notice, :approved) if is_flashing_format?
+      respond_with_navigational(resource){ redirect_to after_approval_path_for(resource_name, resource) }
+    else
+      respond_with_navigational(resource.errors, status: :unprocessable_entity){ render :new }
+    end
+  end
+end

data/app/views/devise/approvals/new.html.erb

@@ -0,0 +1,16 @@
+<h2>Dev Account Approval</h2>
+
+<%= form_for(resource, as: resource_name, url: approval_path(resource_name), html: { method: :post }) do |f| %>
+  <%= devise_error_messages! %>
+
+  <div class="field">
+    <%= f.label :email %><br />
+    <%= f.email_field :email, autofocus: true, value: (resource.pending_reconfirmation? ? resource.unconfirmed_email : resource.email) %> 
+  </div>
+
+  <div class="actions">
+    <%= f.submit "Resend confirmation instructions" %>
+  </div>
+<% end %>
+
+<%= render "devise/shared/links" %>

data/config/initializers/devise.rb

@@ -0,0 +1,110 @@
+require 'devise/approvable_mailer'
+# Use this hook to configure devise mailer, warden hooks and so forth. The first
+# four configuration values can also be set straight in your models.
+Devise.setup do |config|
+  # Configure the e-mail address which will be shown in DeviseMailer.
+  config.mailer_sender = "support@yoursite.ca" # .CA because clearly you're Canadian
+  config.approval_recepient = "admin@yourcandaiansite.ca"
+  
+  # Configure the content type of DeviseMailer mails (defaults to text/html")
+  # config.mailer_content_type = "text/plain"
+
+  # ==> Configuration for :authenticatable
+  # Invoke `rake secret` and use the printed value to setup a pepper to generate
+  # the encrypted password. By default no pepper is used.
+  # config.pepper = "rake secret output"
+
+  # Configure how many times you want the password is reencrypted. Default is 10.
+  # config.stretches = 10
+
+  # Define which will be the encryption algorithm. Supported algorithms are :sha1
+  # (default), :sha512 and :bcrypt. Devise also supports encryptors from others
+  # authentication tools as :clearance_sha1, :authlogic_sha512 (then you should set
+  # stretches above to 20 for default behavior) and :restful_authentication_sha1
+  # (then you should set stretches to 10, and copy REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha1
+
+  # Configure which keys are used when authenticating an user. By default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating an user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # config.authentication_keys = [ :email ]
+
+  # The realm used in Http Basic Authentication
+  # config.http_authentication_realm = "Application"
+
+  # ==> Configuration for :confirmable
+  # The time you want give to your user to confirm his account. During this time
+  # he will be able to access your application without confirming. Default is nil.
+  # config.confirm_within = 2.days
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again.
+  # config.timeout_in = 10.minutes
+
+  # ==> Configuration for :lockable
+  # Number of authentication tries before locking an account.
+  # config.maximum_attempts = 20
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Reanables login after a certain ammount of time (see :unlock_in below)
+  # :both  = enables both strategies
+  # config.unlock_strategy = :both
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> General configuration
+  # Load and configure the ORM. Supports :active_record (default), :mongo_mapper
+  # (requires mongo_ext installed) and :data_mapper (experimental).
+  # require 'devise/orm/mongo_mapper'
+  # config.orm = :mongo_mapper
+
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "sessions/users/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = true
+
+  # By default, devise detects the role accessed based on the url. So whenever
+  # accessing "/users/sign_in", it knows you are accessing an User. This makes
+  # routes as "/sign_in" not possible, unless you tell Devise to use the default
+  # scope, setting true below.
+  config.use_default_scope = true
+
+  # Configure the default scope used by Devise. By default it's the first devise
+  # role declared in your routes.
+  config.default_scope = :user
+
+  # If you want to use other strategies, that are not (yet) supported by Devise,
+  # you can configure them inside the config.warden block. The example below
+  # allows you to setup OAuth, using http://github.com/roman/warden_oauth
+  #
+  # config.warden do |manager|
+  #   manager.oauth(:twitter) do |twitter|
+  #     twitter.consumer_secret = <YOUR CONSUMER SECRET>
+  #     twitter.consumer_key  = <YOUR CONSUMER KEY>
+  #     twitter.options :site => 'http://twitter.com'
+  #   end
+  #   manager.default_strategies.unshift :twitter_oauth
+  # end
+
+  # Configure default_url_options if you are using dynamic segments in :path_prefix
+  # for devise_for.
+  # config.default_url_options do
+  #   { :locale => I18n.locale }
+  # end
+  
+  config.add_module(:approvable, :model => 'devise/approvable')
+  config.add_module(:approvable_email, :model => 'devise/approvable_mailer')
+end

data/devise-approvable.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: devise-approvable 0.3.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "devise_approvable"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Alex Egg"]
+  s.date = "2015-04-06"
+  s.description = "adds feature to devise"
+  s.email = "eggie5@gmail.com"
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "app/controllers/approvals_controller.rb",
+    "app/views/devise/approvals/new.html.erb",
+    "config/initializers/devise.rb",
+    "devise-approvable.gemspec",
+    "lib/approvable_mailer.rb",
+    "lib/devise_approvable.rb",
+    "lib/devise_approvable/mailer.rb",
+    "lib/devise_approvable/model.rb",
+    "lib/devise_approvable/routes.rb",
+    "lib/devise_approvable/version.rb",
+    "test/approvable_test.rb",
+    "views/devise_mailer/approval_instructions.html.erb"
+  ]
+  s.homepage = "http://github.com/eggie5/devise-approvable"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.1"
+  s.summary = "Oh so perfect"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/approvable_mailer.rb

@@ -0,0 +1,11 @@
+Devise.module_eval {
+  mattr_accessor :approval_recepient
+  @@approval_recepient = nil
+}
+
+DeviseMailer.module_eval {
+  def approval_instructions(record)
+    setup_mail(record, :approval_instructions)
+    recipients    Devise.approval_recepient
+  end
+}

data/lib/devise_approvable/mailer.rb

@@ -0,0 +1,11 @@
+require 'devise/version'
+
+module DeviseInvitable
+  module Mailer
+
+    def approval_instructions(record, token, opts={})
+      @token = token
+      devise_mail(record, :approval_instructions, opts)
+    end
+  end
+end

data/lib/devise_approvable/model.rb

@@ -0,0 +1,95 @@
+module Devise
+  module Models
+    module Approvable
+
+      def self.included(base)
+        puts "Devise::Models::Approvable module injected into #{self.class} class"
+
+        base.class_eval do
+          extend ClassMethods
+
+          before_create :generate_approval_token, :if => :approval_required?
+          after_create  :send_approval_instructions, :unless => :approved?
+        end
+      end
+
+      #override
+      def active_for_authentication? 
+          super && approved? 
+      end 
+
+      #override
+      def inactive_message 
+        if !approved? 
+          :not_approved 
+        else 
+          super # Use whatever other message 
+        end 
+      end
+
+
+      def approve!
+        self.approved_at = Time.now.utc
+        self.approval_token = nil
+        save(:validate => false)
+      end
+
+      # Verifies whether a user is confirmed or not
+      def approved?
+        !!self.approved_at
+      end
+
+      def skip_approval!
+        self.approved_at = Time.now.utc
+        @skip_approval = true
+      end
+      
+      # Send approval instructions by email
+      def send_approval_instructions
+        unless @raw_approval_token
+          generate_approval_token!
+        end
+        
+        opts = { to: "dev-approvals@curbcall.com" }
+        send_devise_notification(:approval_instructions, @raw_approval_token, opts)
+      end
+      
+
+      protected
+        def approval_required?
+          !@skip_approval
+        end
+
+        def generate_approval_token!
+          generate_approval_token && save(validate: false)
+        end
+
+        def generate_approval_token
+          raw, enc = Devise.token_generator.generate(self.class, :approval_token)
+          @raw_approval_token   = raw
+          self.approval_token   = enc
+          self.approval_sent_at = Time.now.utc
+        end
+
+      module ClassMethods
+        # Find a user by its approvable token and try to approve it.
+        # If no user is found, returns a new user with an error.
+        # If the user is already approved, create an error for the user
+        # Options must have the approval_token
+        def approve_by_token(approval_token)
+          original_token     = approval_token
+          approval_token = Devise.token_generator.digest(self, :approval_token, approval_token)
+
+          approvable = find_or_initialize_with_error_by(:approval_token, approval_token)
+          approvable.approve! if approvable.persisted?
+          approvable.approval_token = original_token
+          approvable
+        end
+              
+        Devise::Models.config(self, :approver_class)
+      end
+    end
+  end
+end
+
+# Devise.add_module :approvable, :model => 'approvable'

data/lib/devise_approvable/routes.rb

@@ -0,0 +1,9 @@
+module ActionDispatch::Routing
+  class Mapper
+
+  protected
+    def devise_approval(mapping, controllers) 
+      resource :approval, only: [:new, :create, :show], path: mapping.path_names[:approval], controller: controllers[:approvals]
+    end
+
+  end

data/lib/devise_approvable/version.rb

@@ -0,0 +1,3 @@
+module DeviseApprovable
+  VERSION = '1.4.2'
+end

data/lib/devise_approvable.rb

@@ -0,0 +1,16 @@
+p "Loading Devise Approvable"
+
+module DeviseApprovable
+  autoload :Mailer, 'devise_approvable/mailer'
+end
+
+require 'devise'
+require 'devise_approvable/routes'
+# require 'devise_approvable/rails'
+
+module Devise
+  mattr_accessor :admin_email
+  @@admin_email = "admin@curbcall.com"
+end
+
+Devise.add_module :approvable, :controller => :approvals, :model => 'devise_approvable/model', :route => {:approval => [nil, :new, :accept, :show]}

data/views/devise_mailer/approval_instructions.html.erb

@@ -0,0 +1,11 @@
+<p>Someone has registered for a membership.</p>
+
+<p>Details:
+<%= "<br />First Name: #{@resource.first_name}" if !@resource.first_name.nil? %>
+<%= "<br />Last Name: #{@resource.last_name}" if !@resource.last_name.nil? %>
+<%= "<br />E-Mail: #{@resource.email}" if !@resource.email.nil? %>
+<%= "<br />Phone Number: #{@resource.phone}" if !@resource.phone.nil? %>
+<%= "<br />Bio: #{@resource.bio}" if !@resource.bio.nil? %>
+
+<p>If you would like to approve this person click the following link. Clicking the link will approve the new user and send the user a confirmation email.</p>
+<p><%= link_to "Approve account for #{@resource.email} #{approvals_url(@resource.approval_token)}", approvals_url(@resource.approval_token) %></p>

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: devise_approvable
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Alex Egg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: adds feature to devise
+email: eggie5@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- VERSION
+- app/controllers/approvals_controller.rb
+- app/views/devise/approvals/new.html.erb
+- config/initializers/devise.rb
+- devise-approvable.gemspec
+- lib/approvable_mailer.rb
+- lib/devise_approvable.rb
+- lib/devise_approvable/mailer.rb
+- lib/devise_approvable/model.rb
+- lib/devise_approvable/routes.rb
+- lib/devise_approvable/version.rb
+- test/approvable_test.rb
+- views/devise_mailer/approval_instructions.html.erb
+homepage: http://github.com/eggie5/devise-approvable
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Oh so perfect
+test_files: []