has_secure_uuid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbf5ec6244c537e9bbc2fcf9354d60b6e3f8682c8925c4b58eced5082951c5dd
+  data.tar.gz: 7cc9b0b833ec9fdba4172054e3834ccd1a29ed42d10b90add8194bae13d89205
+SHA512:
+  metadata.gz: 9e4416d7f7f2eb7e5cb73bc54269deffba876475e307291082b3025dcddfdc10ee5b85fce1c182e6a27520f2e5718e80fdd8fc2abbfc9eb130be3f4b75e39723
+  data.tar.gz: 1be6c18712a3e3c4816f01112d4ad6a2fc371b90dfaddc4c1b24c153de92b1479da5bd672920bdb20d870107c10ec9faeda21acc76e3117ec43eaab415e686c0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_secure_uuid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sander Tuin
+
+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,80 @@
+# HasSecureUuid
+
+HasSecureUuid provides an easy way to generate uniques random uuid's for any model in ruby on rails. **SecureRandom::uuid** is used to generate the unique id's, so collisions are highly unlikely.
+
+**Note** If you're worried about possible collissions, there's a way to generate a race condition in the database in the same way that [validates_uniqueness_of](http://api.rubyonrails.org/classes/ActiveRecord/Validations/ClassMethods.html) can. You're encouraged to add an unique index in the database to deal with this even more unlikely scenario.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_secure_uuid'
+
+And then run:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_secure_uuid
+
+## Setting your Model
+
+The first step is to generate a migration in order to add the token key field.
+
+```ruby
+rails g migration AddidentifierToUsers identifier:string
+=>
+   invoke  active_record
+   create    db/migrate/20150424010931_add_identifier_to_users.rb
+```
+
+Then run `rake db:migrate` in order to update users table in the database. The next step is to add `has_secure_uuid`
+ to the model:
+```ruby
+# Schema: User(identifier:string, uuid:string)
+class User < ActiveRecord::Base
+  has_secure_uuid
+end
+
+user = User.new
+user.save
+user.identifier # => "6c3d256c-aaa7-443a-a16b-75a99ecde277"
+user.regenerate_identifier # => true
+```
+
+To use a custom column to store the uuid field you can specify the column_name option. See example above (e.g: uuid):
+
+```ruby
+# Schema: User(identifier:string, uuid:string)
+class User < ActiveRecord::Base
+  has_secure_uuid :uuid
+end
+
+user = User.new
+user.save
+user.uuid # => "6c3d256c-aaa7-443a-a16b-75a99ecde277"
+user.regenerate_uuid # => true
+```
+
+## Running tests
+
+Running
+
+```shell
+$ rake test
+```
+
+Should return
+
+```shell
+3 runs, 5 assertions, 0 failures, 0 errors, 0 skips
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/sndrgrdn/has_secure_uuid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :test do
+  Dir.chdir('test')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '../lib'
+  t.libs << '../test'
+  t.test_files = FileList['*_test.rb']
+  t.verbose = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'has_secure_uuid'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/has_secure_uuid.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_secure_uuid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'has_secure_uuid'
+  spec.version       = HasSecureUuid::VERSION
+  spec.authors       = ['Sander Tuin']
+  spec.email         = ['sandergarden@gmail.com']
+  spec.summary       = 'Create uniques random uuids for any model in ruby on rails.'
+  spec.description   = 'HasSecureUuid provides you an easily way to generate random uuids for any model in ruby on rails. **SecureRandom::uuid** is used to generate a unique uuid, so collisions are highly unlikely.'
+  spec.homepage      = 'https://github.com/sndrgrdn/has_secure_uuid'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/has_secure_uuid.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module ActiveRecord
+  module SecureUuid
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Example using has_secure_uuid
+      #
+      #   # Schema: User(identifier:string, uuid:string)
+      #   class User < ActiveRecord::Base
+      #     has_secure_uuid
+      #     has_secure_uuid :uuid
+      #   end
+      #
+      #   user = User.new
+      #   user.save
+      #   user.identifier # => "93712506-fe9e-4ae9-a713-53c67cd9bccc"
+      #   user.uuid # => "245f9ae1-9f8d-4a0e-817d-8ba3e4d663c1"
+      #   user.regenerate_identifier # => true
+      #   user.regenerate_uuid # => true
+      #
+      # Note that it's still possible to generate a race condition in the database in the same way that
+      # <tt>validates_uniqueness_of</tt> can. You're encouraged to add a unique index in the database to deal
+      # with this even more unlikely scenario.
+      def has_secure_uuid(attribute = :identifier)
+        # Load securerandom only when has_secure_token is used.
+        define_method("regenerate_#{attribute}") do
+          update_attributes attribute => self.class.generate_unique_uuid
+        end
+        before_create do
+          send("#{attribute}=", self.class.generate_unique_uuid) unless send("#{attribute}?")
+        end
+      end
+
+      def generate_unique_uuid
+        SecureRandom.uuid
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::SecureUuid)

data/lib/has_secure_uuid/version.rb

@@ -0,0 +1,3 @@
+module HasSecureUuid
+  VERSION = '0.1.0'.freeze
+end

data/test/has_secure_uuid_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class SecureUuidTest < MiniTest::Test
+  def setup
+    @user = User.new
+  end
+
+  def test_uuid_values_are_generated_for_specified_attributes_and_persisted_on_save
+    @user.save
+    refute_nil @user.identifier
+    refute_nil @user.uuid
+  end
+
+  def test_regenerating_the_secure_uuid
+    @user.save
+    old_identifier = @user.identifier
+    old_uuid = @user.uuid
+    @user.regenerate_identifier
+    @user.regenerate_uuid
+
+    refute_equal @user.identifier, old_identifier
+    refute_equal @user.uuid, old_uuid
+  end
+
+  def test_uuid_value_not_overwritten_when_present
+    @user.identifier = '6c3d256c-aaa7-443a-a16b-75a99ecde277'
+    @user.save
+
+    assert_equal @user.identifier, '6c3d256c-aaa7-443a-a16b-75a99ecde277'
+  end
+end

data/test/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  has_secure_uuid
+  has_secure_uuid :uuid
+end

data/test/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(version: 1) do
+  create_table :users do |t|
+    t.string :identifier
+    t.string :uuid
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require 'rubygems'
+require 'has_secure_uuid'
+require 'minitest/autorun'
+require 'minitest/unit'
+
+Dir['models/*.rb'].each { |file| require file }
+
+def assert_not_nil(exp, msg = nil)
+  msg = message(msg) { "<#{mu_pp(exp)}> expected to not be nil" }
+  assert(!exp.nil?, msg)
+end
+
+DB_FILE = 'tmp/test_db'.freeze
+FileUtils.mkdir_p File.dirname(DB_FILE)
+FileUtils.rm_f DB_FILE
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: DB_FILE
+
+load 'schema.rb'

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: has_secure_uuid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sander Tuin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rake
+  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: sqlite3
+  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: HasSecureUuid provides you an easily way to generate random uuids for
+  any model in ruby on rails. **SecureRandom::uuid** is used to generate a unique
+  uuid, so collisions are highly unlikely.
+email:
+- sandergarden@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_secure_uuid.gemspec
+- lib/has_secure_uuid.rb
+- lib/has_secure_uuid/version.rb
+- test/has_secure_uuid_test.rb
+- test/models/user.rb
+- test/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/sndrgrdn/has_secure_uuid
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Create uniques random uuids for any model in ruby on rails.
+test_files:
+- test/has_secure_uuid_test.rb
+- test/models/user.rb
+- test/schema.rb
+- test/test_helper.rb