shixian-obfuscate_id 0.0.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bcc6f131223ef9242a8fa8d178f0b68cd18bc8162fec42beb8f4c1d882dc82c
-  data.tar.gz: 9d027504730f30e9f31ac9f189fcb4042c6ede6ef46c245056f7479bd13038dd
+  metadata.gz: 15717dfa4ebf50eb21ef397773901bcbd9c5e74fabe86310c91228608b4b488e
+  data.tar.gz: 5f63523142b284c2526e649fbe38d5188f02042657711d33d44d0ad4ee05597a
 SHA512:
-  metadata.gz: f1969580fb9f72ed2604dcb557e0d93f43422730f5c5f8210261db653b07346f028b5fc8d1de4ae738c1b1948ae71c0b154e98dc7983486fe15809e86e72cd32
-  data.tar.gz: a9f7e2181dffcd42417cf058522dccb0b25b3fe80324eed117ae9ad0e55ff41cc9cc2d91259994429a09c54e1530e5d7b51d142329bacec03435db5126d4b53a
+  metadata.gz: 2bb8d1b5f753e780314d858d6c44e4d94563929d98af8b81066e322a790f49cd3871a00fc452ef68b490e34d27cbcdd3e74c34b9908f8bda46e173e4ee0e597e
+  data.tar.gz: 3323ef77de6b948c028317e2d9c8c0e6e5a20452444ee0aac086e16224c9d3d9ee9ff7cf71765f1ff974da50f6fce5d59f81a1b84911e64a8e5169092b97f31f

data/README.md

@@ -13,7 +13,7 @@ obfuscate_id turns a URL like this:
 into something like:
 
     http://example.com/users/2356513904
-    
+
 Sequential ActiveRecord ids become non-sequential, random looking, numeric ids.
 
     # post 7000
@@ -22,7 +22,7 @@ Sequential ActiveRecord ids become non-sequential, random looking, numeric ids.
     http://example.com/posts/7107163820
     # post 7002
     http://example.com/posts/3296163828
-       
+
 ## Why would you want this?
 
 If your site is scaling well, you might not want to leak that you are getting 50 new posts a minute.
@@ -33,7 +33,7 @@ Every website has a third user, but that third user doesn't have to know he is t
 
 ## Features
 
-* Extreemly simple. A single line of code in the model turns it on.
+* Extremely simple. A single line of code in the model turns it on.
 * Transforms normal seqential ids into random-looking ten digit numerical strings.
 * Gently masks resource ids while retaining a cleaner look than using an encrypted hash.
 * No database changes or migrations are needed.  The record is still stored in the database with its original id.
@@ -52,7 +52,7 @@ Run bundler.
 
 ## Usage
 
-In your model, add a single line.  
+In your model, add a single line.
 
     class Post < ActiveRecord::Base
       obfuscate_id
@@ -81,6 +81,12 @@ ActiveRecord reverses this obfuscated id back to the plain id before building th
 * This is not security.  obfuscate_id was created to lightly mask record id numbers for the casual user.  If you need to really secure your database ids (hint, you probably don't), you need to use real encryption like AES.
 * To properly generate obfuscated urls, make sure you trigger the model's `to_param` method by passing in the whole object rather than just the id; do this: `post_path(@post)` not this: `post_path(@post.id)`.
 
+## Versions
+
+This is tested with Rails 4.2.0.  For other versions of Rails, please see [the releases](https://github.com/namick/obfuscate_id/releases).
+
+If you are trying to get it to work with a different version of rails that is not tested, let me know in [the issues](https://github.com/namick/obfuscate_id/issues)
+
 ## Development
 
 To run the tests, first clone the repo and run bundler:
@@ -89,12 +95,6 @@ To run the tests, first clone the repo and run bundler:
     cd obfuscate_id
     bundle install
 
-Change to the dummy rails app and load the test database
-
-    cd spec/dummy
-    bundle exec rake db:test:load
-    cd -
-
 Run the tests
 
     bundle exec rspec spec

data/lib/obfuscate_id/version.rb

@@ -1,3 +1,3 @@
 module ObfuscateId
-  VERSION = "0.0.4"
+  VERSION = "0.2.0"
 end

data/lib/obfuscate_id.rb

@@ -1,9 +1,8 @@
 module ObfuscateId
-
   def obfuscate_id(options = {})
     require 'scatter_swap'
 
-    extend ClassMethods 
+    extend ClassMethods
     include InstanceMethods
     cattr_accessor :obfuscate_id_spin
     self.obfuscate_id_spin = (options[:spin] || obfuscate_id_default_spin)
@@ -17,7 +16,6 @@ module ObfuscateId
     ScatterSwap.reverse_hash(id, spin)
   end
 
-
   module ClassMethods
     def find(*args)
       scope = args.slice!(0)
@@ -44,13 +42,13 @@ module ObfuscateId
     # This makes it easy to drop obfuscate_id onto any model
     # and produce different obfuscated ids for different models
     def obfuscate_id_default_spin
-      alphabet = Array("a".."z") 
+      alphabet = Array("a".."z")
       number = name.split("").collect do |char|
         alphabet.index(char)
       end
+
       number.shift(12).join.to_i
     end
-
   end
 
   module InstanceMethods
@@ -58,11 +56,24 @@ module ObfuscateId
       ObfuscateId.hide(self.id, self.class.obfuscate_id_spin)
     end
 
-    # As ActiveRecord::Persistence#reload uses self.id
-    # reload without deobfuscating
+    # Override ActiveRecord::Persistence#reload
+    # passing in an options flag with { no_obfuscated_id: true }
     def reload(options = nil)
-      options = (options || {}).merge(:no_obfuscated_id => true)
-      super(options)
+      options = (options || {}).merge(no_obfuscated_id: true)
+
+      clear_aggregation_cache
+      clear_association_cache
+
+      fresh_object =
+        if options && options[:lock]
+          self.class.unscoped { self.class.lock(options[:lock]).find(id, options) }
+        else
+          self.class.unscoped { self.class.find(id, options) }
+        end
+
+      @attributes = fresh_object.instance_variable_get('@attributes')
+      @new_record = false
+      self
     end
 
     def deobfuscate_id(obfuscated_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shixian-obfuscate_id
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Amick
@@ -28,16 +28,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: launchy
+  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: Make your ActiveRecord IDs non-obvious
 email:
 - github@nathanamick.com