hash_ids 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6a52af0beb9680c0df6cae64443acf7a40dbd9c
+  data.tar.gz: 04f672bc36f6772d3a723de505d05113de90af2f
+SHA512:
+  metadata.gz: 0cf493b119e120d849e9b15a078b0a80d928efcc103952b574f8130ce0ca01bb8b7a390a68077cacec06c62fe1ab06f585ea80b6532f02a58cf417bfed87091f
+  data.tar.gz: 9a7fc89a22e818526965983db2b59547d425e51f4fb955ab76ae11a943e6de236078078228f227205a4266906c8c618dc22bb0574e9f3d274e0c0b27894dd806

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'hashids'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 kemingcao
+
+MIT License
+
+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,31 @@
+# HashIds
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_ids'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_ids
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hash_ids/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/hash_ids.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_ids/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_ids"
+  spec.version       = HashIds::VERSION
+  spec.authors       = ["kemingcao"]
+  spec.email         = ["keming.cao@gmail.com"]
+  spec.summary       = %q{Obfuscate id like a foodie.}
+  spec.description   = %q{Obfuscate id on your record.}
+  spec.homepage      = "https://github.com/kemingcao/hash_ids"
+  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 'hashids', '~> 1.0'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hash_ids/configuration.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+module HashIds
+  class Configuration
+    attr_accessor :salt, :min_hash_length, :alphabet
+
+    def initialize
+      @min_hash_length = 16
+      @alphabet        = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'
+      @salt            = @alphabet
+    end
+  end
+end

data/lib/hash_ids/obfuscate.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+module HashIds
+  module Obfuscate    
+    def hash_as_id
+      extend ClassMethods
+      include InstanceMethods
+    end
+
+    module ClassMethods
+
+      def super_able? args
+        primary_key.nil? || 
+        default_scopes.any? ||
+        columns_hash.include?(inheritance_column) ||
+        args.first.kind_of?(Hash)
+      end
+
+      def find(*args)
+        return super if args.first.kind_of?(Symbol)
+        return super if block_given? || super_able?(args)
+
+        scope = args
+        if scope.kind_of?(Array)
+          scope.map! do |id|
+            hash_ids?(id) ? hash_ids_decode(id).first : id
+          end
+          scope.reject &:nil?
+        end
+        super(scope)
+      end
+
+      def hash_ids_encode ids
+        HashIds::hasher.encode ids
+      end
+
+      def hash_ids_decode ids
+        HashIds::hasher.decode ids
+      end
+
+      def hash_ids? ids
+        ids = ids || ''
+        ds = HashIds::hasher.decode ids.to_s
+        return true unless ds.empty?
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        if self.id
+          self.class.hash_ids_encode self.id
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/hash_ids/version.rb

@@ -0,0 +1,3 @@
+module HashIds
+  VERSION = "0.0.2"
+end

data/lib/hash_ids.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+require "hashids"
+require "hash_ids/version"
+require "hash_ids/obfuscate"
+require "hash_ids/configuration"
+
+module HashIds
+  include Obfuscate
+  attr_reader :hasher
+
+  class << self
+    def config
+      # 
+      # salt = secret salt
+      # min_hash_length = hash length
+      # alphabet = default is a..z + A..Z + 0..9
+      # 
+      @config ||= Configuration.new
+      yield @config if block_given?
+      @config
+    end
+
+    def hasher
+      @hasher ||= Hashids.new config.salt, config.min_hash_length, config.alphabet
+    end
+  end
+
+end
+
+ActiveRecord::Base.extend HashIds

data/spec/hash_ids_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+class Foodie < ActiveRecord::Base
+  extend HashIds
+  hash_as_id
+
+  attr_reader :id
+  def id
+    @id ||= Random.new.rand 10000
+  end
+end
+
+describe HashIds do
+
+  it 'has a version number' do
+    expect(HashIds::VERSION).not_to be nil
+  end
+
+  before :all do
+    @chars    = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'
+
+    @salt     = @chars.split('').sample(10).join('')
+    @min_hash_length = Random.new.rand 2...20
+    @alphabet = @chars.split('').sample(18).join('')
+
+    HashIds.config do |c|
+      c.salt = @salt
+      c.min_hash_length = @min_hash_length
+      c.alphabet = @alphabet
+    end
+
+    @foodie = Foodie.new
+  end
+
+
+  describe 'HashIds config and hasher' do
+    it 'test config' do
+      expect(HashIds.config.salt).to eq @salt
+      expect(HashIds.config.min_hash_length).to eq @min_hash_length
+      expect(HashIds.config.alphabet).to eq @alphabet
+    end
+
+    it 'test hasher' do
+      expect(HashIds.hasher).not_to be nil
+    end
+  end
+
+  describe 'test hasher' do
+    it 'to_parmas' do
+      expect(@foodie.to_param).not_to be nil
+      expect(@foodie.to_param).to eq @foodie.hash_ids_encode(@foodie.id)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hash_ids'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: hash_ids
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- kemingcao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Obfuscate id on your record.
+email:
+- keming.cao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_ids.gemspec
+- lib/hash_ids.rb
+- lib/hash_ids/configuration.rb
+- lib/hash_ids/obfuscate.rb
+- lib/hash_ids/version.rb
+- spec/hash_ids_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kemingcao/hash_ids
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Obfuscate id like a foodie.
+test_files:
+- spec/hash_ids_spec.rb
+- spec/spec_helper.rb