has_tokenable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9031526dff08471220b84d58ed37738fa3f70760c9ab1769ef450449e395e7bf
+  data.tar.gz: d00ec6c32f4aec5e802801340d51e193600d4b29a806242bef23761a553b74ab
+SHA512:
+  metadata.gz: e2c151f14038955e82d34faed45541ab7496c7a58203b3f72ffdb9af2626c48645811ce231da110363e10e65a1cbaabae5c10c792792f52cf5a3d798e34bbc7e
+  data.tar.gz: cf06d4088ba210c159e58cf5bf05be2f8527cc73b31f183e9b40a1d8cb39f83521d45d706a510c8d50c6947f8cb8b39ff30e51f2a0241d2d95c05c9538a3013f

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2019 Carlos Montalvo.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,129 @@
+Identify your active records with random tokens when you don't want your users to see a sequential ID.
+
+
+------------------------------------------------------------------------------
+Installation
+------------------------------------------------------------------------------
+
+Add has_tokenable to your Gemfile like so:
+
+```ruby
+gem 'has_tokenable', '~> 0.1.0'
+```
+
+Now run `bundle install` and you're good to go!
+
+
+------------------------------------------------------------------------------
+Usage
+------------------------------------------------------------------------------
+
+First, add a token to your model's table with a migration:
+
+```ruby
+# Upgrade and existing table
+class AddTokenToItems < ActiveRecord::Migration
+  add_column :items, :token, :string
+end
+
+# Add to a new table
+class CreateItems < ActiveRecord::Migration
+  def change
+    create_table :items do |t|
+      t.token
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end
+```
+
+
+Now make sure your model knows to use it's token by calling `has_tokenable`
+
+```ruby
+class Item < ActiveRecord::Base
+  has_tokenable  
+end
+```
+
+That's basically it! Your Items will now know to use their token as their identifier.
+
+Try it out in your `rails console`
+
+```ruby
+@item = Item.create(name: "Tokenz!")
+#<Item id: 1, token: "B5OvJvy6B2_DZg", name: "Tokenz!", created_at: "2020-01-26 20:17:13", updated_at: "2020-01-26 20:17:13">
+@item.to_param
+# B5OvJvy6B2_DZg
+@item == Item.find("B5OvJvy6B2_DZg")
+# true
+```
+
+
+------------------------------------------------------------------------------
+Options
+------------------------------------------------------------------------------
+
+You can customize has_tokenable by setting a few options. Here's the defaults:
+
+```ruby
+{
+  prefix:             nil, # if nil use first letter of class name
+  length:             10,
+  param_name:         'token',
+  method_random:      'urlsafe_base64' #method random urlsafe_base64 hex alphanumeric random_number uuid
+}
+```
+
+
+Options can be set globally by overwriting the `HasTokenable.default_token_options`
+
+```ruby
+# config/initializers/has_tokenable.rb
+
+# for one option
+HasTokenable.default_token_options[:prefix] = "OMG"
+
+# for multiple options
+HasTokenable.default_token_options.merge!(
+  method_random:      'alphanumeric',
+  length:         8
+)
+```
+
+Options can also be set on a per-class level:
+
+```ruby
+class List < ActiveRecord::Base
+  has_tokenable prefix: "LI", length: 10
+end
+
+class Item < ActiveRecord::Base
+  has_tokenable prefix: "ITM"
+end
+```
+
+
+------------------------------------------------------------------------------
+Demo
+------------------------------------------------------------------------------
+
+Try out the demo to get a real clear idea of what has_tokenable does.
+
+```bash
+git clone git://github.com/CarlangasGO/has_tokenable.git
+cd has_tokenable
+bundle install
+rails s
+```
+
+Now open your browser to [http://localhost:3000](http://localhost:3000)
+
+
+------------------------------------------------------------------------------
+License
+------------------------------------------------------------------------------
+
+Copyright (c) 2019 - 2020, released under the New BSD License All rights reserved.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test' << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/has_tokenable.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_tokenable/version"
+
+Gem::Specification.new do |s|
+
+  s.name        = %q{has_tokenable}
+  s.version     = HasTokenable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Carlos Montalvo"]
+  s.email       = ["carlosmontalvo@zetanova.com"]
+  s.homepage    = "https://github.com/CarlangasGO/has_tokenable"
+  s.summary     = %q{Identifies your active records with a random token.}
+  s.description = %q{Identifies your active records with a random token. For more information, please see the documentation.}
+  s.license     = "BSD-2-Clause"
+  s.metadata    = { "source_code_uri" => "https://github.com/CarlangasGO/has_tokenable" }
+
+  
+  s.files         = `git ls-files`.split("\n")
+ 
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+
+  s.require_paths = ["lib"]
+
+  s.add_dependency('activerecord',  '~> 4')
+  s.add_dependency('activesupport', '~> 4')
+
+  s.add_development_dependency('rails',           '~> 4')
+  s.add_development_dependency('sqlite3',         '~> 1.3')
+
+end

data/lib/has_tokenable/concern.rb

@@ -0,0 +1,77 @@
+module HasTokenable
+  module Concern
+
+    METHODS = %w(urlsafe_base64 hex alphanumeric random_number uuid).freeze
+
+    def self.included(base)
+      base.send(:extend,  ClassMethods)
+      base.send(:include, InstanceMethods)
+      base.class_eval do
+        validates :token, presence: true, uniqueness: true
+        before_validation :generate_token, on: :create, if: proc{|record| record.token.nil? }
+      end
+    end
+
+    module ClassMethods
+
+      def method_random=(value)
+        values = value.is_a?(Array) ? value : [value]
+        values.map! { |v| v.to_s }
+  
+        raise ArgumentError.new('Method is not supported') if (values - METHODS).size > 0
+        values
+      end
+
+      # Default options as well as an overwrite point so you can assign different defaults to different models
+      def default_token_options
+        @default_token_options ||= begin
+          options = HasTokenable.default_token_options
+          options[:prefix] ||= self.name[0, 1]
+          options
+        end
+      end
+
+      def generate_method(options)
+        args = [ options[:method_random], options[:length].to_i ]
+  
+        args.slice!(-1) if options[:method_random] == 'uuid'
+
+        SecureRandom.send(*args)
+      end
+
+      # Generates a unique token based on the options
+      def generate_unique_token
+        record, options = true, @has_tokenable_options
+        conditions = {}
+
+        token = loop do
+          random_token = self.generate_method(options)
+
+          conditions[options[:param_name].to_sym] = random_token
+
+          break random_token unless self.exists?(conditions)
+        end
+
+        token
+      end
+
+    end # ClassMethods
+
+    module InstanceMethods
+
+      # Returns the resource's token
+      def to_param
+        self.send(self.class.has_tokenable_options[:param_name])
+      end
+
+    private
+
+      def generate_token
+        self.token = self.class.generate_unique_token
+      end
+
+    end # InstanceMethods
+
+  end # Concern
+
+end # HasTokenable

data/lib/has_tokenable/finder_methods.rb

@@ -0,0 +1,44 @@
+module HasTokenable
+  module FinderMethods
+
+    # Find by token ensuring case sensitivity
+    def find_by_case_sensitive_token(token)
+      return if token.nil?
+      where("#{token_with_table_name} = ?", token).first
+    end
+
+    # Find by token
+    def find_by_token(token)
+      return if token.nil?
+      send(:find_by_case_sensitive_token , token)
+    end
+
+    # Find by token and raise error if no record is found
+    def find_by_token!(token)
+      record = find_by_token(token)
+      raise ActiveRecord::RecordNotFound, "Could not find #{self.name} with token #{token.inspect}" if record.nil?
+      record
+    end
+
+    # Find by token if the first param looks like a token, otherwise use super
+    def find(*args)
+      if args[0].is_a?(String) && args[0].length == has_tokenable_options[:length]
+        record = find_by_token(args[0])
+      end
+      record || super(*args)
+    end
+
+    def find!(*args)
+      record = find(*args)
+      raise ActiveRecord::RecordNotFound if record.nil?
+      record
+    end
+
+  private
+
+    def token_with_table_name
+      "#{table_name}.#{has_tokenable_options[:param_name]}"
+    end
+
+  end
+end

data/lib/has_tokenable/table_definition.rb

@@ -0,0 +1,15 @@
+require 'active_record/connection_adapters/abstract/schema_definitions'
+
+module HasTokenable
+  module TableDefinition
+
+    def token(*args)
+      options = { length: HasTokenable.default_token_options[:length] }.merge(args.extract_options!)
+      puts "opeiont: #{options}"
+      column(:token, :string, options.merge(nil: false))
+    end
+
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, HasTokenable::TableDefinition)

data/lib/has_tokenable/version.rb

@@ -0,0 +1,3 @@
+module HasTokenable
+  VERSION = "0.1.0"
+end

data/lib/has_tokenable.rb

@@ -0,0 +1,31 @@
+require 'has_tokenable/concern'
+require 'has_tokenable/finder_methods'
+require 'has_tokenable/table_definition'
+
+module HasTokenable
+
+  module ActiveRecordTie
+
+    def has_tokenable(options={})
+      self.send(:include, HasTokenable::Concern)
+      @has_tokenable_options ||= HasTokenable.default_token_options.merge(options)
+    end
+
+    def has_tokenable_options
+      @has_tokenable_options ||= HasTokenable.default_token_options
+    end
+  end
+
+  def self.default_token_options
+    @default_token_options ||= {
+      :prefix             => nil, # if nil use first letter of class name
+      :length             => 10,
+      :param_name         => 'token',
+      :method_random      => 'urlsafe_base64'
+    }
+  end
+
+end
+
+ActiveRecord::Base.send(:extend, HasTokenable::ActiveRecordTie)
+ActiveRecord::Base.send(:extend, HasTokenable::FinderMethods)

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: has_tokenable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carlos Montalvo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Identifies your active records with a random token. For more information,
+  please see the documentation.
+email:
+- carlosmontalvo@zetanova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_tokenable.gemspec
+- lib/has_tokenable.rb
+- lib/has_tokenable/concern.rb
+- lib/has_tokenable/finder_methods.rb
+- lib/has_tokenable/table_definition.rb
+- lib/has_tokenable/version.rb
+homepage: https://github.com/CarlangasGO/has_tokenable
+licenses:
+- BSD-2-Clause
+metadata:
+  source_code_uri: https://github.com/CarlangasGO/has_tokenable
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Identifies your active records with a random token.
+test_files: []