token_master 1.0.1 → 1.1.0

data/dummy/config/puma.rb

@@ -0,0 +1,47 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum, this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
+end

data/dummy/config/secrets.yml

@@ -0,0 +1,9 @@
+
+development:
+  secret_key_base: 62d2af1b89d9201a6703a7a7bc291769aba42f4402daef34a2bb589dbd8ea88ed00e30c7f694e1512f9e7c331022bfd90f4574172642eca7f6d5daabb14c5042
+
+test:
+  secret_key_base: 3e0200862ceb79910a614e3691d733a1971d061d13949db0273794708146c6073032ec3f6ccfc0c902f04efe2c9c0960fbea2226cf3c7f4acb08d91576f11bdb
+
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/dummy/db/migrate/20170505170857_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration[5.0]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+      t.string :password_digest
+
+      t.timestamps
+    end
+  end
+end

data/dummy/db/migrate/20170505171217_add_confirm_tokenable_to_users.rb

@@ -0,0 +1,26 @@
+class AddConfirmTokenableToUsers < ActiveRecord::Migration[5.0]
+  def change
+  
+    add_column :users, :confirm_token, :string, default: nil
+    add_column :users, :confirm_created_at, :timestamp, default: nil
+    add_column :users, :confirm_sent_at, :timestamp, default: nil
+    add_column :users, :confirm_completed_at, :timestamp, default: nil
+
+    add_index :users, :confirm_token
+  
+    add_column :users, :reset_token, :string, default: nil
+    add_column :users, :reset_created_at, :timestamp, default: nil
+    add_column :users, :reset_sent_at, :timestamp, default: nil
+    add_column :users, :reset_completed_at, :timestamp, default: nil
+
+    add_index :users, :reset_token
+  
+    add_column :users, :invite_token, :string, default: nil
+    add_column :users, :invite_created_at, :timestamp, default: nil
+    add_column :users, :invite_sent_at, :timestamp, default: nil
+    add_column :users, :invite_completed_at, :timestamp, default: nil
+
+    add_index :users, :invite_token
+  
+  end
+end

data/dummy/db/schema.rb

@@ -0,0 +1,41 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20170505171217) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "users", force: :cascade do |t|
+    t.string   "name"
+    t.string   "email"
+    t.string   "password_digest"
+    t.datetime "created_at",           null: false
+    t.datetime "updated_at",           null: false
+    t.string   "confirm_token"
+    t.datetime "confirm_created_at"
+    t.datetime "confirm_sent_at"
+    t.datetime "confirm_completed_at"
+    t.string   "reset_token"
+    t.datetime "reset_created_at"
+    t.datetime "reset_sent_at"
+    t.datetime "reset_completed_at"
+    t.string   "invite_token"
+    t.datetime "invite_created_at"
+    t.datetime "invite_sent_at"
+    t.datetime "invite_completed_at"
+    t.index ["confirm_token"], name: "index_users_on_confirm_token", using: :btree
+    t.index ["invite_token"], name: "index_users_on_invite_token", using: :btree
+    t.index ["reset_token"], name: "index_users_on_reset_token", using: :btree
+  end
+
+end

data/dummy/db/seeds.rb

@@ -0,0 +1,14 @@
+## CREATE USERS
+puts 'creating users...'
+num_users = 10
+users = []
+num_users.times do
+  users << {
+    name: Faker::Name.name,
+    email: Faker::Internet.email,
+    password: 'password',
+    password_confirmation: 'password'
+  }
+end
+User.create!(users)
+puts "#{num_users} users created"

data/dummy/spec/factories/users.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :user do
+    sequence(:email) { |n| "user_#{n}@example.com"}
+    password 'password'
+    password_confirmation 'password'
+    name { Faker::Name.name }
+  end
+end

data/dummy/spec/models/user_spec.rb

@@ -0,0 +1,12 @@
+require 'rails_helper'
+
+RSpec.describe User, :type => :model do
+  subject { build(:user) }
+
+  it { is_expected.to be_valid }
+
+  it { is_expected.to validate_presence_of :name }
+  it { is_expected.to validate_presence_of :email }
+
+  it { expect(subject.send_email).to eq('sent an email') }
+end

data/dummy/spec/rails_helper.rb

@@ -0,0 +1,54 @@
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+require 'shoulda/matchers'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+  config.include Shoulda::Matchers
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end
+
+Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }

data/dummy/spec/spec_helper.rb

@@ -0,0 +1,85 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/dummy/spec/support/factory_bot.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/dummy/spec/support/shoulda_matchers.rb

@@ -0,0 +1,6 @@
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

data/lib/token_master/core.rb

@@ -92,6 +92,20 @@ module TokenMaster
         model.save(validate: false)
       end
 
+      # Calls set_token! and send_instructions! to generate a new token and send instructions again (accepts a block, such as a mailer method, for sending instructions).<br />Note, any previously generated token for the user will be invalid.
+      # @example Resend Reset Instructions
+      #   user.resend_reset_instruction! { user.send_email } =>
+      #     <User id: 205, name: "John Smith", email: "jsmith@example.com", reset_token: "4ZcHkSJ8kXrV4wl", reset_created_at: 2017-04-25 16:21:54", reset_sent_at: "2017-04-25 16:22:42", reset_completed_at: nil>
+      # @param [Object] model the tokenable model instance
+      # @param [String, Symbol] key  the tokenable action
+      # @param [Integer] token_length the length of the generated token, method will use configuration token_length if not provided otherwise
+      # @raise [NotTokenableError] if the provided Class does not have the correct tokenable column
+      # @return [Object] tokenable model instance
+      def resend_instructions!(model, key, token_length = nil)
+        set_token!(model, key, token_length)
+        send_instructions!(model, key)
+      end
+
       # Provides the status of the tokenable action, whether the action has been completed, the token has been sent, the token is expired, or the token has only been created
       # @param [Object] model the tokenable model instance
       # @param [String, Symbol] key  the tokenable action

data/lib/token_master/model.rb

@@ -24,6 +24,11 @@ module TokenMaster
             TokenMaster::Core.send_instructions!(self, tokenable, &email)
           end
 
+          # Defines a method on the tokenable model instance to generate a new token and send tokenable action instructions again, e.g., `user.resend_confim_instructions!`. Accepts a block with app logic to send instructions.
+          define_method("resend_#{tokenable}_instructions!") do |&email|
+            TokenMaster::Core.resend_instructions!(self, tokenable, &email)
+          end
+
           # Defines a method on the tokenable model instance to retrieve the status of a tokenable action, e.g., `user.confim_status`
           define_method("#{tokenable}_status") do
             TokenMaster::Core.status(self, tokenable)
@@ -35,7 +40,7 @@ module TokenMaster
           end
           # class methods
 
-          # Defines a method on the tokenable model class to completed a tokenable action given a token, e.g., `User.confim_by_token!`. Takes the token and accepts any keyword arguments for `required_params`.
+          # Defines a method on the tokenable model class to complete a tokenable action given a token, e.g., `User.confim_by_token!`. Takes the token and accepts any keyword arguments for `required_params`.
           define_singleton_method("#{tokenable}_by_token!") do |token, **params|
             TokenMaster::Core.do_by_token!(self, tokenable, token, **params)
           end

data/lib/token_master/version.rb

@@ -1,4 +1,4 @@
 module TokenMaster
   # Current version of TokenMaster
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: token_master
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Dave Corwin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".inch.yml"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
@@ -70,6 +71,64 @@ files:
 - Rakefile
 - badge.png
 - badge.svg
+- dummy/.gitignore
+- dummy/Gemfile
+- dummy/Rakefile
+- dummy/app/assets/config/manifest.js
+- dummy/app/assets/images/.keep
+- dummy/app/assets/javascripts/application.js
+- dummy/app/assets/javascripts/cable.js
+- dummy/app/assets/javascripts/channels/.keep
+- dummy/app/assets/stylesheets/application.css
+- dummy/app/channels/application_cable/channel.rb
+- dummy/app/channels/application_cable/connection.rb
+- dummy/app/controllers/application_controller.rb
+- dummy/app/controllers/concerns/.keep
+- dummy/app/helpers/application_helper.rb
+- dummy/app/jobs/application_job.rb
+- dummy/app/mailers/application_mailer.rb
+- dummy/app/models/application_record.rb
+- dummy/app/models/concerns/.keep
+- dummy/app/models/user.rb
+- dummy/app/views/layouts/application.html.erb
+- dummy/app/views/layouts/mailer.html.erb
+- dummy/app/views/layouts/mailer.text.erb
+- dummy/bin/bundle
+- dummy/bin/rails
+- dummy/bin/rake
+- dummy/bin/setup
+- dummy/bin/spring
+- dummy/bin/update
+- dummy/config.ru
+- dummy/config/application.rb
+- dummy/config/boot.rb
+- dummy/config/cable.yml
+- dummy/config/database.yml
+- dummy/config/environment.rb
+- dummy/config/environments/development.rb
+- dummy/config/environments/test.rb
+- dummy/config/initializers/assets.rb
+- dummy/config/initializers/cookies_serializer.rb
+- dummy/config/initializers/filter_parameter_logging.rb
+- dummy/config/initializers/new_framework_defaults.rb
+- dummy/config/initializers/session_store.rb
+- dummy/config/initializers/token_master.rb
+- dummy/config/initializers/wrap_parameters.rb
+- dummy/config/locales/en.yml
+- dummy/config/puma.rb
+- dummy/config/routes.rb
+- dummy/config/secrets.yml
+- dummy/config/spring.rb
+- dummy/db/migrate/20170505170857_create_users.rb
+- dummy/db/migrate/20170505171217_add_confirm_tokenable_to_users.rb
+- dummy/db/schema.rb
+- dummy/db/seeds.rb
+- dummy/spec/factories/users.rb
+- dummy/spec/models/user_spec.rb
+- dummy/spec/rails_helper.rb
+- dummy/spec/spec_helper.rb
+- dummy/spec/support/factory_bot.rb
+- dummy/spec/support/shoulda_matchers.rb
 - lib/generators/rails/templates/migration.rb.erb
 - lib/generators/rails/token_master_generator.rb
 - lib/generators/token_master/install_generator.rb
@@ -103,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Token Master!