hash_ids 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6a52af0beb9680c0df6cae64443acf7a40dbd9c
-  data.tar.gz: 04f672bc36f6772d3a723de505d05113de90af2f
+  metadata.gz: 05bd30a05b5b19148d5c898a0b14e8a24c7539ab
+  data.tar.gz: 353e8a9764a337b298f2bb0a2c8706ff7704a280
 SHA512:
-  metadata.gz: 0cf493b119e120d849e9b15a078b0a80d928efcc103952b574f8130ce0ca01bb8b7a390a68077cacec06c62fe1ab06f585ea80b6532f02a58cf417bfed87091f
-  data.tar.gz: 9a7fc89a22e818526965983db2b59547d425e51f4fb955ab76ae11a943e6de236078078228f227205a4266906c8c618dc22bb0574e9f3d274e0c0b27894dd806
+  metadata.gz: 2423e43afcf34b508464c99ea624267d3dbba9f494e0d3345d9e62c228340dd9c69eae6b7877568d208927edc3dabac11cf9f6f1b3f4ef5efc2a1f687dd6be6f
+  data.tar.gz: b7bd924bbb40bc374852c1a81ee0e2815e662730de3dca302225d3a8e00103e409cb9dd2450a79a61f72e240197afd78ffaf731d37611ba86dbe6c8c2681b980

data/README.md

@@ -1,6 +1,6 @@
 # HashIds
 
-TODO: Write a gem description
+Obfuscate your id in the air
 
 ## Installation
 
@@ -20,7 +20,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+```
+# create config/initializers/hashids.rb
+
+HashIds.config do |config|
+  config.salt = 'secret salt'
+  config.min_hash_length = 12 # id length
+  config.alphabet = 'abcd12345' # random char pool require at least 16 unique characters
+end
+
+# add hash_as_id to model
+
+class User < ActiveRecord::Base
+  hash_as_id
+end
+```
+
+*Notice* please use `user_path(@user)` instead of `user_path(@user.id)`
+
+```
+User.find "qeYay1x5bLKVMk5z"
+  => [#<User id: 2, name: "some guy", created_at: "2015-02-03 07:11:14", updated_at: "2015-02-03 07:11:14">]
+
+User.find 2
+  => [#<User id: 2, name: "some guy", created_at: "2015-02-03 07:11:14", updated_at: "2015-02-03 07:11:14">]
+
+app.user_path(User.last)
+  => "/users/6n9w75n65da8"
+```
+
 
 ## Contributing
 

data/lib/hash_ids/obfuscate.rb

@@ -10,14 +10,14 @@ module HashIds
     module ClassMethods
 
       def super_able? args
-        primary_key.nil? || 
+        primary_key.nil? ||
         default_scopes.any? ||
-        columns_hash.include?(inheritance_column) ||
-        args.first.kind_of?(Hash)
+        args.first.kind_of?(Hash) ||
+        args.first.kind_of?(Symbol) ||
+        columns_hash.include?(inheritance_column)
       end
 
       def find(*args)
-        return super if args.first.kind_of?(Symbol)
         return super if block_given? || super_able?(args)
 
         scope = args
@@ -25,7 +25,7 @@ module HashIds
           scope.map! do |id|
             hash_ids?(id) ? hash_ids_decode(id).first : id
           end
-          scope.reject &:nil?
+          scope = scope.length==1 ? scope.first : scope
         end
         super(scope)
       end

data/lib/hash_ids/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_ids
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - kemingcao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashids