cloak_id 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4702a69506e1c0ccc4888a32e69b04161161e20e
-  data.tar.gz: 4701111cd4ec15d847ca64421f54d2862bfb9fef
+  metadata.gz: c32322be1c62ab6c319e8f2680de05a8f5a87193
+  data.tar.gz: 2e597ed6a16a5712487ba3b129e9ef215fbbffde
 SHA512:
-  metadata.gz: daf77844a7c971e5920a567f9dc4d2b1d698e56e16289f8fcf0806d8fe86d9c0cc77e78d06c14018b8ca60f8980c87966cddfb31a62c2aea9897bf287b9f727c
-  data.tar.gz: 5aad2b8a0b8fef298dd5eb6bc79d8acb418e19c9b2c35a053a65006b626b351cbca31bcb9ca857e842e998906b83fab2b3c8c03985bc6abc4b03832fb31e35a0
+  metadata.gz: 166e418c9ee29a51f57b6fa30e368548171ee9c3619cf17b987366ddb851758c524aa2bc3bd0f06ccfacbea2e66a9af670d019f1c29934d9fcfe67f8338295b9
+  data.tar.gz: fad96e4260637382c71e078acebee64a05b9578071a08a811c833202fd203e6ada1a54e47a84c045582f5533c221af4c7904cfdd6f4bf615d9b6c54db800adc3

data/README.md

@@ -59,7 +59,7 @@ The logic behind the transformation is to use a prime number to generate a simpl
 That newly obscured hash is then encoded as a string, to further hide its meaning.  This will happen when generating forms
 from ActiveRecords (when using the entire object or the to_param call), as well as when encoding the object in JSON format.
 
-
+The obfuscation techinque is largely based on the one used by the Python Project "opaque_id" (https://github.com/marekweb/opaque-id) by Marek Z., and released under the MIT License.
 ## Customizing your cloaking
 
 The cloak_id method call takes an option hash that controls how the cloaking occurs:

data/lib/cloak_id.rb

@@ -121,6 +121,27 @@ module CloakId
         super arg
       end
     end
+
+    ## Extends the ability of the class to handle the exists? method when we pass in a cloaked id.  This change will
+    ## work when passed in as a single argument as well as if it is part of a hash.   The method is not (currently)
+    ## smart enough to handle array based arguments
+    def exists?(arg)
+      arg_is_cloaked_id = is_cloaked_id? arg
+      if arg_is_cloaked_id
+        decloked_id = decloak_id_for_class(arg)
+        super decloked_id
+      elsif arg.is_a? Hash
+        if (arg[:id].nil? == false and is_cloaked_id? arg[:id])
+          copied_hash = arg.clone
+          copied_hash[:id] = decloak_id_for_class copied_hash[:id]
+          super copied_hash
+        else
+          super arg   # is a hash but not a cloaked it
+        end
+      else
+        super arg
+      end
+    end
   end
 end
 

data/lib/cloak_id/cloak_id_encoder.rb

@@ -7,6 +7,8 @@ module CloakId
 
     cattr_accessor :cloak_id_default_key
 
+    ## The twiddle and cloak methods are based on Marek Z.'s "Opaque Id" code (https://github.com/marekweb/opaque-id)
+
     # Basic hashing function to go back and forth between a hashed value.
     def self.twiddle(val,key)
       hashed = (key ^ val) * TWIDDLE_PRIME
@@ -56,4 +58,4 @@ module CloakId
       self.cloak(intermediate_id,key)
     end
   end
-end
+end

data/lib/cloak_id/version.rb

@@ -1,3 +1,3 @@
 module CloakId
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/cloak_id/cloak_id_spec.rb

@@ -89,4 +89,29 @@ describe CloakId do
     expect(TestModel.find([model.id, model_2.id])).to eql [model,model_2]
     expect(TestModel.find([model.cloaked_id, model_2.cloaked_id])).to eql [model,model_2]
   end
+
+  it 'should return true for items that exist and false for those that don\'t when exists? is called' do
+     model = TestModel.create
+
+    expect(TestModel.exists?(model.cloaked_id)).to be_true
+    expect(TestModel.exists?("#{model.cloaked_id}XX")).to be_false
+  end
+
+  it 'should be able to handle the "exists" clause in hash queries as well as alone' do
+    model = TestModel.create
+
+    expect(TestModel.exists?(id:model.cloaked_id)).to be_true
+    expect(TestModel.exists?(id:"#{model.cloaked_id}XX")).to be_false
+  end
+
+  it 'should still handle cases for both hashes and "normal" exists? calls when we use the non cloaked id' do
+    model = TestModel.create
+
+    expect(TestModel.exists?(model.id)).to be_true
+    expect(TestModel.exists?(model.id+3)).to be_false
+
+    expect(TestModel.exists?(id:model.id)).to be_true
+    expect(TestModel.exists?(id:(model.id+3))).to be_false
+
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloak_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Elle L.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-04 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails