reset dummy app, minor README update (#45)

README.md

@@ -47,7 +47,7 @@ Does not take over your app, minimal magic, and only if you want it. Token Maste
 Works for APIs, ERB apps and everything in between.
 
 ### Simple
-Only 6 methods and you may not even use them all!
+Only 5 methods and you may not even use them all!
 
 ### Helpful errors
 We take the approach of raising an error whenever anything unexpected happens and provide a specific error with a helpful message to aid your debugging and testing experience.

test/dummy/Gemfile

@@ -12,9 +12,11 @@ gem 'bcrypt', '~> 3.1.7'
 gem 'token_master', path: './../..'
 gem 'faker'
 gem 'pry'
+gem 'factory_girl_rails'
 
 group :development, :test do
   gem 'byebug', platform: :mri
+  gem 'rspec-rails'
 end
 
 group :development do
@@ -23,3 +25,8 @@ group :development do
   # gem 'spring'
   # gem 'spring-watcher-listen', '~> 2.0.0'
 end
+
+group :test do
+  gem 'shoulda-matchers'
+  gem 'rspec-collection_matchers'
+end

test/dummy/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    token_master (0.0.1)
+    token_master (0.1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -50,7 +50,13 @@ GEM
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     debug_inspector (0.0.2)
+    diff-lcs (1.3)
     erubis (2.7.0)
+    factory_girl (4.8.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.8.0)
+      factory_girl (~> 4.8.0)
+      railties (>= 3.0.0)
     faker (1.7.2)
       i18n (~> 0.5)
     ffi (1.9.18)
@@ -108,6 +114,27 @@ GEM
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
       ffi (>= 0.5.0)
+    rspec-collection_matchers (1.1.3)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    shoulda-matchers (3.1.1)
+      activesupport (>= 4.0.0)
     slop (3.6.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
@@ -135,11 +162,15 @@ PLATFORMS
 DEPENDENCIES
   bcrypt (~> 3.1.7)
   byebug
+  factory_girl_rails
   faker
   listen
   pg (~> 0.18)
   pry
   rails (~> 5.0.2)
+  rspec-collection_matchers
+  rspec-rails
+  shoulda-matchers
   token_master!
   web-console (>= 3.3.0)
 

test/dummy/config/initializers/token_master.rb

@@ -1,33 +1,29 @@
 TokenMaster.config do |config|
-  # Set up your configurations for each tokenable using the methods at the bottom of this file.
-  # Examples:
-
-  # 'config.add_tokenable_options :confirm, TokenMaster::Config::DEFAULT_VALUES' results in:
-
-  # config.confirm_options = {
-  #   token_lifetime: 14,
-  #   required_parms: [],
-  #   token_length: 20
-  # }
-
-  # 'config.add_tokenable_options :reset, token_lifetime: 1, required_params: [:password, :password_confirmation], token_length: 15' results in:
+ # Set up your configurations for each tokenable using the methods at the bottom of this file
+  # TokenMaster::Config::DEFAULT_VALUES =
+  #     {
+  #       token_lifetime: 14,
+  #       required_params: [],
+  #       token_length: 20
+  #     }
 
-  # config.reset_options = {
-  #   token_lifetime: 1,
-  #   required_parms: [:password, :password_confirmation],
-  #   token_length: 20
-  # }
-
-  # 'config.add_tokenable_options :foo, token_lifetime: 10, required_params: [:email, token_length: config.DEFAULT_VALUES[:token_length]' results in:
-
-  # config.foo_options = {
-  #   token_lifetime: 10,
-  #   required_parms: [:email],
-  #   token_length: 20
-  # }
+  # Examples:
+  # config.add_tokenable_options :confirm, TokenMaster::Config::DEFAULT_VALUES
+  # config.add_tokenable_options :reset, token_lifetime: 1, required_params: [:password, :password_confirmation], token_length: 15
+  # config.add_tokenable_options :foo, token_lifetime: 10, required_params: [:email, token_length: config.DEFAULT_VALUES[:token_length]
 
   #### METHODS FOR YOUR CONFIGURATION BELOW ###
   config.add_tokenable_options :confirm, TokenMaster::Config::DEFAULT_VALUES
-  config.add_tokenable_options :invite, token_lifetime: 10, required_params: [:password, :password_confirmation], token_length: 15
-  config.add_tokenable_options :reset, token_lifetime: 1, required_params: [:password, :password_confirmation], token_length: 15
+  config.add_tokenable_options :reset,
+    {
+      token_lifetime: 1,
+      required_params: [:password, :password_confirmation],
+      token_length: 20
+    }
+  config.add_tokenable_options :invite,
+    {
+      token_lifetime: 10,
+      required_params: [:password, :password_confirmation],
+      token_length: 20
+    }
 end

test/dummy/db/migrate/20170330162223_add_confirm_tokenable_to_users.rb → test/dummy/db/migrate/20170505171217_add_confirm_tokenable_to_users.rb

@@ -8,19 +8,19 @@ def change
 
     add_index :users, :confirm_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
-
     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

test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20170330162223) do
+ActiveRecord::Schema.define(version: 20170505171217) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -25,14 +25,14 @@
     t.datetime "confirm_created_at"
     t.datetime "confirm_sent_at"
     t.datetime "confirm_completed_at"
-    t.string   "invite_token"
-    t.datetime "invite_created_at"
-    t.datetime "invite_sent_at"
-    t.datetime "invite_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

test/dummy/spec/factories/users.rb

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

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

test/dummy/spec/rails_helper.rb

@@ -0,0 +1,52 @@
+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|
+  # 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 }

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

test/dummy/spec/support/factory_girl.rb

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

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