refcode 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b45526e91ab90f8b69e43976b600a8bbfa1dbdc0
-  data.tar.gz: f580b982c0f61c0021f77b53f0f607047569ebdb
+  metadata.gz: 9a685e0c98a5089405fa727a02f854ffc2f27a05
+  data.tar.gz: e44c013ab75a304dabcd4c3c41693dd71eda05f0
 SHA512:
-  metadata.gz: 21d4ebf71a2fb58ebf43068289ae42b80646b78f8bb8fdbdd05be8ac0e0778f044d21bf466b04f0cd640cef75ae14cff2828dacfecbea19eec5d67180ab8e0fe
-  data.tar.gz: 25d0b08552e8e4f4c84080f084bd78d3ae89914aa380c9b81434b6993ee653f264b77961394d586615e213f6bbd262dab56f718cdf5f7d621020b8a5db527760
+  metadata.gz: 6cf38bfc747e4fa7a387f7f4e72f5b9d3aa5b788de1944becbb9aa01366f27669efecf66307c42165ea5b2b949114351595210ec8c3145795a4211c899b1ad79
+  data.tar.gz: cebc83c94a985bc14a89ac551d9f38d93f0484086500ffcd83b8f0f4f901aa46093d600b768d7eae3bfb39831687a49acb3c00ff8a22f4adc7005eac89cb12f0

data/README.md

@@ -1,12 +1,14 @@
-# Refcode
+# RefCode
 
-A ruby gem for converting arbitrary Ruby objects into encrypted,
-URL-safe strings. The strings can be easily decrypted later for use in your
-application.
+A ruby gem for converting arbitrary Ruby objects into encrypted, URL-safe strings. The strings can be easily decrypted later for use in your application.
 
-RefCode was conceived as a way to attach referral data to tracking links. Encryption
-makes it unlikely that the links will be tampered with. Still, it is not recommended
-for critically sensitive data!
+RefCode was conceived as a way to attach referral data to tracking links. Encryption makes it unlikely that the links will be tampered with. Still, it is not recommended for sensitive data!
+
+## Why would you want this?
+
+Lets say your app needs to track activity around certain pages that are shared among your users. Using RefCode, you can generate URLs pointing to these pages that are meant to be shared across various channels (email, facebook, etc). These links can carry a small amount of encoded data as part of the URL that will guarantee that any events you track due to visits to these links can make use of this extra encoded data. The data might include, for example, which user originally shared the link and on which channel she did so.
+
+A secondary feature offered by the `Refcode::Encodable` mixin is the ability to guarantee that a given code works only for one (or more) specific page. For example, by using a unique value for the `salt` option that is tied to a single record, the generated code cannot be used with any other record. See the usage example below for a demonstration of this.
 
 ## Implementation
 

data/lib/refcode/encodable.rb

@@ -31,15 +31,8 @@ module Refcode
     def encoder
       Refcode::Encoder.new do |r|
         check_refcode_options!
-        r.secret = self.class.refcode_options[:secret]
-        salt_option = self.class.refcode_options[:salt]
-        if salt_option.respond_to? :call
-          r.salt = salt_option.call self
-        elsif salt_option.is_a? Symbol
-          r.salt = self.send salt_option
-        else
-          r.salt = salt_option
-        end
+        r.secret = get_option_value(self.class.refcode_options[:secret])
+        r.salt = get_option_value(self.class.refcode_options[:salt])
         raise "Value for salt is nil (#{salt_option} given)" if r.salt.nil?
       end
     end
@@ -48,6 +41,16 @@ module Refcode
       raise RefcodeInitException.new('You must call the has_refcode method in your class definition') unless self.class.refcode_options
     end
 
+    def get_option_value option
+      if option.respond_to? :call
+        option.call self
+      elsif option.is_a? Symbol
+        self.send option
+      else
+        option
+      end
+    end
+
   end
 
 end

data/lib/refcode/encoder.rb

@@ -13,6 +13,10 @@ module Refcode
     def decode val
       YAML.load(decrypt(Base64URL.decode(val)))
     end
+    def secret= secret
+      secret = secret * 2 until secret.size >= 32
+      @secret = secret
+    end
 
     private
 

data/lib/refcode/version.rb

@@ -1,3 +1,3 @@
 module Refcode
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/refcode_encodable_test.rb

@@ -5,23 +5,34 @@ require File.join(File.dirname(__FILE__),"..","lib","refcode.rb")
 class RefcodeEncodableTest < Test::Unit::TestCase
 
   SECRET = "a short tidy secret, but not too short!"
+  CODE_CONTENT = {:channel => 'email', :action => 'forward', :user_id => 14325, :unique_hash => 'f'}
 
   class BareEncodableObject < OpenStruct
     include Refcode::Encodable
   end
-  class EncodableObjectSymbol < BareEncodableObject
-    has_refcode :secret => SECRET, :salt => :record_id
+  class EncodableObjectSaltSymbol < BareEncodableObject
+    has_refcode :secret => SECRET, :salt => :user_id
   end
-  class EncodableObjectString < BareEncodableObject
+  class EncodableObjectSaltString < BareEncodableObject
     has_refcode :secret => SECRET, :salt => "123 abc xyz"
   end
-  class EncodableObjectSaltyLambda < BareEncodableObject
-    has_refcode :secret => SECRET, :salt => lambda { |me| "#{me.record_id}-42" }
+  class EncodableObjectSaltLambda < BareEncodableObject
+    has_refcode :secret => SECRET, :salt => lambda { |me| "#{me.user_id}-42" }
+  end
+  class EncodableObjectSecretSymbol < BareEncodableObject
+    has_refcode :secret => :unique_hash, :salt => :user_id
+  end
+  class EncodableObjectSecretString < BareEncodableObject
+    has_refcode :secret => SECRET, :salt => "123 abc xyz"
+  end
+  class EncodableObjectSecretLambda < BareEncodableObject
+    has_refcode :secret => lambda { |me| me.channel*20 }, :salt => "aaa"
   end
 
   def test_should_raise_argument_error_if_generate_refcode_called_without_val
     assert_raise ArgumentError do
-      encodable_object.generate_refcode
+      obj = EncodableObjectSaltString.new CODE_CONTENT
+      obj.generate_refcode
     end
   end
 
@@ -42,33 +53,51 @@ class RefcodeEncodableTest < Test::Unit::TestCase
   end
 
   def test_should_raise_an_error_if_salt_is_empty
-    encodable_object.record_id = nil
+    obj = EncodableObjectSaltSymbol.new CODE_CONTENT
+    obj.user_id = nil
     assert_raise RuntimeError do
-      referral_code_content = { :channel => 'email', :action => 'forward', :user_id => 14325 }
-      code = encodable_object.generate_refcode referral_code_content
-      assert_equal referral_code_content, encodable_object.parse_refcode(code)
+      code = obj.generate_refcode CODE_CONTENT
+      assert_equal CODE_CONTENT, obj.parse_refcode(code)
     end
   end
 
   def test_should_work_with_different_salt_options
-    [EncodableObjectSaltyLambda, EncodableObjectString].each do |klass|
-      referral_code_content = { :channel => 'email', :action => 'forward', :user_id => 14325 }
-      obj = klass.new referral_code_content
-      code = obj.generate_refcode referral_code_content
-      assert_equal referral_code_content, obj.parse_refcode(code)
+    with_all_fixtures do |klass|
+      obj = klass.new CODE_CONTENT
+      code = obj.generate_refcode CODE_CONTENT
+      assert_equal CODE_CONTENT, obj.parse_refcode(code)
     end
   end
 
-  def test_encodable_against_hash
-    referral_code_content = { :channel => 'email', :action => 'forward', :user_id => 14325 }
-    code = encodable_object.generate_refcode referral_code_content
-    assert_equal referral_code_content, encodable_object.parse_refcode(code)
+  def test_should_work_with_different_secret_options
+    with_all_fixtures do |klass|
+      obj = klass.new CODE_CONTENT
+      code = obj.generate_refcode CODE_CONTENT
+      assert_equal CODE_CONTENT, obj.parse_refcode(code)
+    end
+  end
+
+  def test_should_adjust_key_length_to_satisfy_encryption_algorithm
+    content = CODE_CONTENT
+    content[:unique_hash] = "x"
+    obj = EncodableObjectSecretSymbol.new content
+    code = obj.generate_refcode content
+    assert_equal content, obj.parse_refcode(code)
   end
 
   private
 
-  def encodable_object
-    @encodable_object ||= EncodableObjectSymbol.new :name => 'Unimportant Value', :record_id => 381598
+  def with_all_fixtures
+    [
+      EncodableObjectSaltLambda,
+      EncodableObjectSaltString,
+      EncodableObjectSaltSymbol,
+      EncodableObjectSecretLambda,
+      EncodableObjectSecretString,
+      EncodableObjectSecretSymbol
+    ].each do |klass|
+      yield klass
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refcode
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jordan Sitkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64url