token_master 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5790941a8c9d0ec6eacb36b1df7c473acc880c51
+  data.tar.gz: affb3fad61df083f6a9d723b638d55b3d8e8a27b
+SHA512:
+  metadata.gz: 4c88cfdaffea449b8393a25ee549972d4a746328f9b0adf7e25ffe9aaf87be9583d3f7ff0859eba2d7fb272050852f21ff298118456d9b1494eaf83b2b1455dc
+  data.tar.gz: d87767fbaf677e52b5aea2904564e5c7888133e288e747e2071d2c4b4248fc9102a85950a508ffe56b681600759d66a880b06230a7ce2b0e8c6c7d3173871afb

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+.yardoc
+doc

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    token_master (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.1)
+    rake (10.4.2)
+    yard (0.9.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.10.1)
+  rake (~> 10.4.2)
+  token_master!
+  yard
+
+BUNDLED WITH
+   1.14.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 LaunchPad Lab
+
+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.md

@@ -0,0 +1,70 @@
+[![Build Status](https://travis-ci.org/LaunchPadLab/token-master.svg?branch=master)](https://travis-ci.org/LaunchPadLab/token-master)
+
+# token-master
+User management logic using tokens
+
+## Usage
+```
+class User < ApplicationRecord
+  include TokenMaster::Core
+
+  token_master :confirm, :foobar
+end
+```
+
+```
+## For confirm
+
+user = User.confirm_by_token!(token, **kwargs)
+
+token = user.set_confirm_token!
+
+user.send_confirm_instructions!
+
+user.confirm_status
+
+
+## Same for foobar
+
+User.foobar_by_token!(token)
+
+...
+
+```
+
+## Setup
+
+```
+bundle exec rails generate token_master User confirm foobar
+```
+
+This creates a migration file for the following columns:
+```
+    add_column :users, :confirm_token, :string, default: nil
+    add_column :users, :confirm_created_at, :timestamp, default: nil
+    add_column :users, :confirm_completed_at, :timestamp, default: nil
+    add_column :users, :confirm_sent_at, :timestamp, default: nil
+
+    add_index :users, :confirm_token
+
+    add_column :users, :foobar_token, :string, default: nil
+    add_column :users, :foobar_created_at, :timestamp, default: nil
+    add_column :users, :foobar_completed_at, :timestamp, default: nil
+    add_column :users, :foobar_sent_at, :timestamp, default: nil
+
+    add_index :users, :foobar_token
+```
+
+This command also creates or updates the TokenMaster initializer file. The initializer will include methods to add configurations for each tokenable, set to the default configurations. Configurations you can set include:
+
+- Token Lifetime (`:token_lifetime`, takes an integer
+- Reuired Params (`:token_lifetime`), takes an array
+- Token Length(`:token_length`), takes an integer
+
+```
+config.add_tokenable_options :confirm, TokenMaster::Config::DEFAULT_VALUES
+
+## OR
+
+config.add_tokenable_options :reset, token_lifetime: 1, required_params: [:password, :password_confirmation], token_length: 15
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+desc 'Run tests'
+task default: :test

data/lib/generators/rails/templates/migration.rb.erb

@@ -0,0 +1,12 @@
+class <%= "#{migration_name.classify.pluralize}" %> < <%= migration_class_name %>
+  def change
+  <% attributes_names.each do |attribute| %>
+    add_column :<%= name.tableize %>, <%= ":#{attribute}_token" %>, :string, default: nil
+    add_column :<%= name.tableize %>, <%= ":#{attribute}_created_at" %>, :timestamp, default: nil
+    add_column :<%= name.tableize %>, <%= ":#{attribute}_sent_at" %>, :timestamp, default: nil
+    add_column :<%= name.tableize %>, <%= ":#{attribute}_completed_at" %>, :timestamp, default: nil
+
+    add_index :<%= name.tableize %>, <%= ":#{attribute}_token" %>
+  <% end %>
+  end
+end

data/lib/generators/rails/token_master_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/active_record'
+
+module Rails
+  module Generators
+    class TokenMasterGenerator < ActiveRecord::Generators::Base
+      desc 'Creates a TokenMaster migration for the specified model.'
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+      def copy_migration
+        migration_template 'migration.rb.erb', "db/migrate/#{migration_file_name}", migration_version: migration_class_name
+      end
+
+      def migration_name
+        "add_#{attributes_names[0]}_tokenable_to_#{name.underscore.pluralize}"
+      end
+
+      def migration_class_name
+        if Rails::VERSION::MAJOR >= 5
+          "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        else
+          'ActiveRecord::Migration'
+        end
+      end
+
+      def install_generator
+        Rails::Generators.invoke("token_master:install", attributes_names)
+      end
+
+      def migration_file_name
+        "#{migration_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/token_master/install_generator.rb

@@ -0,0 +1,24 @@
+module TokenMaster
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Creates a TokenMaster initializer in your application.'
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def copy_initializer
+        copy_file 'initializer.rb', 'config/initializers/token_master.rb', skip: true
+      end
+
+      def add_options
+        attributes.each do |tokenable|
+          inject_into_file 'config/initializers/token_master.rb', before: 'end' do <<-RUBY
+  config.add_tokenable_options :#{tokenable}, TokenMaster::Config::DEFAULT_VALUES
+          RUBY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/token_master/migration_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/named_base'
+require 'rails/generators/migration'
+
+module TokenMaster
+  module Generators
+    class MigrationGenerator < Rails::Generators::NamedBase
+      namespace 'token_master'
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Generates a migration file for the given model (NAME) with the specified tokenable columns'
+    end
+  end
+end

data/lib/generators/token_master/templates/initializer.rb

@@ -0,0 +1,30 @@
+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:
+
+  # 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
+  # }
+
+  #### METHODS FOR YOUR CONFIGURATION BELOW ###
+end

data/lib/token_master/config.rb

@@ -0,0 +1,41 @@
+module TokenMaster
+  class Config
+    DEFAULT_VALUES = {
+      token_lifetime: 14,
+      required_params: [],
+      token_length: 20
+    }
+
+    attr_accessor :options
+
+    def initialize
+      @options = {}
+    end
+
+    def add_tokenable_options(key, **params)
+      @options[key] = params
+    end
+
+    def get_required_params(key)
+      get_option(key, :required_params)
+    end
+
+    def get_token_lifetime(key)
+      get_option(key, :token_lifetime)
+    end
+
+    def get_token_length(key)
+      get_option(key, :token_length)
+    end
+
+    def options_set?(key)
+      @options.key? key
+    end
+
+    private
+
+    def get_option(key, option)
+      @options.dig(key, option) || DEFAULT_VALUES[option]
+    end
+  end
+end

data/lib/token_master/core.rb

@@ -0,0 +1,168 @@
+require 'token_master/error'
+require 'securerandom'
+
+module TokenMaster
+  # TODO
+  module Core
+    class << self
+      # TODO
+      def do_by_token!(klass, key, token, **params)
+        check_manageable! klass, key
+        token_column = { token_col(key) => token }
+        model = klass.find_by(token_column)
+        check_token_active! model, key
+        check_params! key, params
+
+        model.update!(
+          params.merge(completed_at_col(key) => Time.now)
+        )
+        model
+      end
+
+      # TODO
+      def force_tokenable!(model, key, **params)
+        check_manageable! model.class, key
+        check_params! key, params
+
+        model.update!(
+          params.merge(completed_at_col(key) => Time.now)
+        )
+        model
+      end
+
+      # TODO
+      def set_token!(model, key, token_length = nil)
+        check_manageable! model.class, key
+        check_configs_set! key
+        token_length ||= TokenMaster.config.get_token_length(key.to_sym)
+        token = generate_token token_length
+
+        model.update({
+          token_col(key) => token,
+          created_at_col(key) => Time.now,
+          sent_at_col(key) => nil,
+          completed_at_col(key) => nil
+        })
+        model.save(validate: false)
+        token
+      end
+
+      # TODO
+      def send_instructions!(model, key)
+        check_manageable! model.class, key
+        check_token_set! model, key
+        check_instructions_sent! model, key
+
+        yield if block_given?
+
+        model.update(sent_at_col(key) => Time.now)
+        model.save(validate: false)
+      end
+
+      # TODO
+      def status(model, key)
+        check_manageable! model.class, key
+        return 'completed' if completed?(model, key)
+        return 'sent' if instructions_sent?(model, key)
+        if token_set?(model, key)
+          return 'expired' unless token_active?(model, key)
+          return 'created'
+        end
+        'no token'
+      end
+
+      private
+
+        def token_col(key)
+          "#{key}_token".to_sym
+        end
+
+        def created_at_col(key)
+          "#{key}_created_at".to_sym
+        end
+
+        def sent_at_col(key)
+          "#{key}_sent_at".to_sym
+        end
+
+        def completed_at_col(key)
+          "#{key}_completed_at".to_sym
+        end
+
+        def token_lifetime(key)
+          TokenMaster.config.get_token_lifetime(key.to_sym)
+        end
+
+        def required_params(key)
+          TokenMaster.config.required_params(key.to_sym)
+        end
+
+        def check_manageable!(klass, key)
+          raise NotTokenable, "#{klass} not #{key}able" unless manageable?(klass, key)
+        end
+
+        def manageable?(klass, key)
+          return false unless klass.respond_to? :column_names
+          column_names = klass.column_names
+          %W(
+            #{key}_token
+            #{key}_created_at
+            #{key}_completed_at
+            #{key}_sent_at
+          ).all? { |attr| column_names.include? attr }
+        end
+
+        def check_configs_set!(key)
+          raise NotConfigured, 'You have not set the configurations for this tokenable.' unless TokenMaster.config.options_set?(key.to_sym)
+        end
+
+        def check_params!(key, params)
+          required_params = TokenMaster.config.get_required_params(key.to_sym)
+          raise MissingRequiredParams, 'You did not pass in the required params for this tokenable' unless required_params.all? do |k|
+            params.keys.include? k
+          end
+        end
+
+        def check_token_active!(model, key)
+          raise TokenNotFound, "#{key} token not found" unless model
+          raise TokenCompleted, "#{key} already completed" if completed?(model, key)
+          raise TokenExpired, "#{key} token expired" unless token_active?(model, key)
+        end
+
+        def token_active?(model, key)
+          model.send(token_col(key)) &&
+          model.send(created_at_col(key)) &&
+          Time.now <= (model.send(created_at_col(key)) + ((token_lifetime(key)) * 60 * 60 * 24))
+        end
+
+        def check_instructions_sent!(model, key)
+          raise TokenSent, "#{key} already sent" if instructions_sent?(model, key)
+        end
+
+        def instructions_sent?(model, key)
+          model.send(sent_at_col(key)).present?
+        end
+
+        def token_set?(model, key)
+          model.send(token_col(key)).present?
+        end
+
+        def check_token_set!(model, key)
+          raise TokenNotSet, "#{key}_token not set" unless token_set?(model, key)
+        end
+
+        def completed?(model, key)
+          model.send(completed_at_col(key)).present?
+        end
+
+        def check_completed!(model, key)
+          raise TokenNotCompleted, "#{key} not completed" unless completed?(model, key)
+        end
+
+        def generate_token(length)
+          rlength = (length * 3) / 4
+          SecureRandom.urlsafe_base64(rlength).tr('lIO0', 'sxyz')
+        end
+    end
+  end
+end

data/lib/token_master/error.rb

@@ -0,0 +1,36 @@
+module TokenMaster
+
+  # The base class for all errors raised by TokenMaster
+  class Error < StandardError; end
+
+  # TODO
+  class MissingRequiredParams < Error; end
+
+  # Raised when the attributes for a tokenable do not exist.
+  # This could result from a migration not being run or a spelling error
+  class NotTokenable < Error; end
+
+  # TODO
+  class NotConfigured < Error; end
+
+  # TODO
+  class MissingRequiredParams < Error; end
+
+  # TODO
+  class TokenNotFound < Error; end
+
+  # TODO
+  class TokenCompleted < Error; end
+
+  # TODO
+  class TokenNotCompleted < Error; end
+
+  # TODO
+  class TokenExpired < Error; end
+
+  # TODO
+  class TokenSent < Error; end
+
+  # TODO
+  class TokenNotSet < Error; end
+end

data/lib/token_master/model.rb

@@ -0,0 +1,39 @@
+module TokenMaster
+
+  # TODO
+  module Model
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # TODO
+      def token_master(*tokenables)
+        tokenables.each do |tokenable|
+          # instance methods
+          # TODO
+          define_method("set_#{tokenable}_token!") do
+            TokenMaster::Core.set_token!(self, tokenable)
+          end
+          # TODO
+          define_method("send_#{tokenable}_instructions!") do |email|
+            TokenMaster::Core.send_instructions!(self, tokenable, email)
+          end
+          # TODO
+          define_method("#{tokenable}_status") do
+            TokenMaster::Core.status(self, tokenable)
+          end
+          # TODO
+          define_method("force_#{tokenable}!") do |**params|
+            TokenMaster::Core.force_tokenable!(self, tokenable, **params)
+          end
+          # class methods
+          # TODO
+          define_singleton_method("#{tokenable}_by_token!") do |token, **params|
+            TokenMaster::Core.do_by_token!(self, tokenable, token, **params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/token_master/railtie.rb

@@ -0,0 +1,17 @@
+require 'token_master/model'
+
+module TokenMaster
+  # Automatically include TokenMaster::Model in Rails/ActiveRecord apps.
+  class Railtie < ::Rails::Railtie
+
+    initializer 'token_master.active_record' do
+      ActiveSupport.on_load :active_record do
+        if Rails::VERSION::MAJOR >= 5
+          ::ApplicationRecord.include(TokenMaster::Model)
+        else
+          ::ActiveRecord::Base.include(TokenMaster::Model)
+        end
+      end
+    end
+  end
+end

data/lib/token_master/version.rb

@@ -0,0 +1,3 @@
+module TokenMaster
+  VERSION = '0.0.1'.freeze
+end

data/lib/token_master.rb

@@ -0,0 +1,17 @@
+module TokenMaster
+  def self.config
+    @config ||= TokenMaster::Config.new
+    if block_given?
+      yield @config
+    else
+      @config
+    end
+  end
+end
+
+require 'token_master/config'
+require 'token_master/core'
+require 'token_master/error'
+require 'token_master/model'
+require 'token_master/version'
+require 'token_master/railtie' if defined?(::Rails)

data/token_master.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'token_master/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'token_master'
+  s.version     = TokenMaster::VERSION
+  s.date        = '2017-02-24'
+  s.summary     = 'Token Master!'
+  s.description = 'User management using tokens'
+  s.authors     = ['Dave Corwin', 'Ifat Ribon']
+  s.email       = 'dave@launchpadlab.com'
+  s.homepage    = 'https://github.com/launchpadlab/token-master'
+  s.license     = 'MIT'
+  s.files       = `git ls-files -z`
+                  .split("\x0")
+                  .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
+  s.add_development_dependency 'minitest', '~> 5.10', '>= 5.10.1'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: token_master
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Corwin
+- Ifat Ribon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+description: User management using tokens
+email: dave@launchpadlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails/templates/migration.rb.erb
+- lib/generators/rails/token_master_generator.rb
+- lib/generators/token_master/install_generator.rb
+- lib/generators/token_master/migration_generator.rb
+- lib/generators/token_master/templates/initializer.rb
+- lib/token_master.rb
+- lib/token_master/config.rb
+- lib/token_master/core.rb
+- lib/token_master/error.rb
+- lib/token_master/model.rb
+- lib/token_master/railtie.rb
+- lib/token_master/version.rb
+- token_master.gemspec
+homepage: https://github.com/launchpadlab/token-master
+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.6
+signing_key: 
+specification_version: 4
+summary: Token Master!
+test_files: []