refcode 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 420403fbddbdbbfe612045ab19119651a54f8740
-  data.tar.gz: 41307cc055dfbea7997fc7e66f20dffbcf94ff9a
+  metadata.gz: b45526e91ab90f8b69e43976b600a8bbfa1dbdc0
+  data.tar.gz: f580b982c0f61c0021f77b53f0f607047569ebdb
 SHA512:
-  metadata.gz: b3fd63ca01f994071ac81ab8545f1880433a661806d73aa81797aeb83fa4763ea7f636777926f823b2df1115df90a3ab463c0c6a74424cceef958274d2095284
-  data.tar.gz: 172f2f19bc9a3d6f02c75adc665bda99f4a12f5c6edbf825e4c4845cfd42de3fc88e9da06f215fbcfa862b54daa58a640bddf6eb4d50b291988e4a11dc2c270f
+  metadata.gz: 21d4ebf71a2fb58ebf43068289ae42b80646b78f8bb8fdbdd05be8ac0e0778f044d21bf466b04f0cd640cef75ae14cff2828dacfecbea19eec5d67180ab8e0fe
+  data.tar.gz: 25d0b08552e8e4f4c84080f084bd78d3ae89914aa380c9b81434b6993ee653f264b77961394d586615e213f6bbd262dab56f718cdf5f7d621020b8a5db527760

data/README.md

@@ -1,13 +1,12 @@
 # Refcode
 
-Currently a standalone gem for converting arbitrary Ruby objects into encrypted,
-URL-safe strings. The strings can be simply decrypted later to be used by your
+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
+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 applications! It was designed to power a simple referral
-link tracking system.
+for critically sensitive data!
 
 ## Implementation
 
@@ -33,41 +32,50 @@ Or install it yourself as:
 
 ## Usage
 
-Refcode can be used in two ways. Most simply, you can use the `Refcode::Encoder` class directly.
+RefCode can be used in two ways. Most simply, you can use the `Refcode::Encoder` class directly.
 
-    encoder = Refcode::Encoder.new do |e|
-      e.secret = "a long crunchy secret"
-      e.salt = "some salt"
-    end
+```ruby
+encoder = Refcode::Encoder.new do |e|
+  e.secret = "a long crunchy secret"
+  e.salt = "some salt"
+end
 
-    something = OpenStruct.new(channel: 'facebook', action: 'message', user_id: 43765)
-    encoded_param = encoder.encode something
+something = OpenStruct.new(channel: 'facebook', action: 'message', user_id: 43765)
+encoded_param = encoder.encode something
 
-    # in some future request:
+# in some future request:
 
-    something = encoder.decode params[:encoded_param]
-    puts something.channel # 'facebook'
+something = encoder.decode params[:encoded_param]
+puts something.channel #=> 'facebook'
+```
 
 For added convenience when using Refcode with an ORM such as ActiveRecord, a module called `Refcode::Encodable` is also provided.
 
-    class Job < ActiveRecord::Base
-      include Refcode::Encodable
-      has_refcode secret: 'a long crunchy secret', salt: :id
-    end
+```ruby
+class Job < ActiveRecord::Base
+  include Refcode::Encodable
+  has_refcode secret: 'a long crunchy secret', salt: :id
+end
 
-    # the salt option of the has_refcode method can accept a proc/lambda, string
-    # or a symbol representing an existing method on the class (id in this case)
+# the salt option of the has_refcode method can accept a proc/lambda, string
+# or a symbol representing an existing method on the class (id in this case)
 
-    # in some controller code:
+# in some controller code:
 
-    @job = Job.find params[:id]
-    referral_code = @job.generate_refcode channel: 'facebook', action: 'message', user_id: 43765
+@job = Job.find params[:id]
+referral_code = @job.generate_refcode channel: 'facebook', action: 'message', user_id: 43765
 
-    # and in another action:
+# and in another action:
 
-    @job = Job.find params[:id]
-    referral_data = @job.parse_refcode params[:encoded_param]
+@job = Job.find params[:id]
+referral_data = @job.parse_refcode params[:encoded_param]
+```
 
+## Features for 1.0
+
+- ~~Encodable mixin~~
+- ~~Better exception handling~~
+- More complete tests against encoding non-core ruby class values
 
 ## Contributing
 

data/lib/refcode.rb

@@ -3,5 +3,6 @@ require 'yaml'
 require 'base64url'
 require 'encryptor'
 require 'refcode/version'
+require 'refcode/errors'
 require 'refcode/encoder'
 require 'refcode/encodable'

data/lib/refcode/encodable.rb

@@ -7,11 +7,12 @@ module Refcode
     end
 
     def generate_refcode val
-      raise 'You must call the has_refcode method in your class definition' unless self.class.refcode_options
+      check_refcode_options!
       encoder.encode val
     end
 
     def parse_refcode code
+      check_refcode_options!
       encoder.decode code
     end
 
@@ -29,10 +30,11 @@ 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
+          r.salt = salt_option.call self
         elsif salt_option.is_a? Symbol
           r.salt = self.send salt_option
         else
@@ -42,6 +44,10 @@ module Refcode
       end
     end
 
+    def check_refcode_options!
+      raise RefcodeInitException.new('You must call the has_refcode method in your class definition') unless self.class.refcode_options
+    end
+
   end
 
 end

data/lib/refcode/encoder.rb

@@ -23,7 +23,7 @@ module Refcode
       Encryptor.decrypt(:value => val, :key => @secret, :salt => @salt, :iv => iv)
     end
     def iv
-      [@secret, @salt].join
+      [@secret, @salt, 42].join
     end
 
   end

data/lib/refcode/errors.rb

@@ -0,0 +1,6 @@
+module Refcode
+
+  class RefcodeInitException < Exception
+  end
+
+end

data/lib/refcode/version.rb

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

data/test/refcode_encodable_test.rb

@@ -0,0 +1,74 @@
+require 'ostruct'
+require 'test/unit'
+require File.join(File.dirname(__FILE__),"..","lib","refcode.rb")
+
+class RefcodeEncodableTest < Test::Unit::TestCase
+
+  SECRET = "a short tidy secret, but not too short!"
+
+  class BareEncodableObject < OpenStruct
+    include Refcode::Encodable
+  end
+  class EncodableObjectSymbol < BareEncodableObject
+    has_refcode :secret => SECRET, :salt => :record_id
+  end
+  class EncodableObjectString < BareEncodableObject
+    has_refcode :secret => SECRET, :salt => "123 abc xyz"
+  end
+  class EncodableObjectSaltyLambda < BareEncodableObject
+    has_refcode :secret => SECRET, :salt => lambda { |me| "#{me.record_id}-42" }
+  end
+
+  def test_should_raise_argument_error_if_generate_refcode_called_without_val
+    assert_raise ArgumentError do
+      encodable_object.generate_refcode
+    end
+  end
+
+  def test_should_raise_error_if_refcode_methods_called_before_has_refcode
+    [:generate_refcode, :parse_refcode].each do |m|
+      assert_raise Refcode::RefcodeInitException do
+        obj = BareEncodableObject.new :some => 'value'
+        obj.send m, "bogus value"
+      end
+    end
+  end
+
+  def test_should_raise_argument_error_if_has_refcode_called_without_correct_options
+    assert_raise ArgumentError do
+      obj = BareEncodableObject.new :some => 'value'
+      obj.class.has_refcode :whatever => 'wrong'
+    end
+  end
+
+  def test_should_raise_an_error_if_salt_is_empty
+    encodable_object.record_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)
+    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)
+    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)
+  end
+
+  private
+
+  def encodable_object
+    @encodable_object ||= EncodableObjectSymbol.new :name => 'Unimportant Value', :record_id => 381598
+  end
+
+end

data/test/refcode_encoder_test.rb

@@ -0,0 +1,42 @@
+require 'ostruct'
+require 'test/unit'
+require File.join(File.dirname(__FILE__),"..","lib","refcode.rb")
+
+class RefcodeEncoderTest < Test::Unit::TestCase
+
+  SECRET = "686cb0461769ebed556f56bc88c956bfdf786646ab1920f58201723c557ccbaeb57112fd53302c06475e6e19a176ba617ee284b091d375858cb259e8578c620f"
+  SALT = "dcc74de5efdab0d80b5d763f8a63bef3d37c7453ee45446fbbccd26648af8ca6a112576dafbf5475f3cd7b968703cc9e0682ee45b8b622045cec287908f536e8"
+
+  def test_encoder_against_hash
+    test_hash = { :channel => 'email', :record_id => 49203, :action => 'forward' }
+    assert_equal test_hash, encode_and_decode(test_hash)
+  end
+
+  def test_encoder_against_string
+    test_string = "secret referral data"
+    assert_equal test_string, encode_and_decode(test_string)
+  end
+
+  def test_encoder_against_int
+    assert_equal 4857, encode_and_decode(4857)
+  end
+
+  def test_encoder_against_open_struct
+    test_struct = OpenStruct.new({:test => 42})
+    assert_equal test_struct, encode_and_decode(test_struct)
+  end
+
+  private
+
+  def encoder
+    @encoder ||= Refcode::Encoder.new do |e|
+      e.secret = SECRET
+      e.salt = SALT
+    end
+  end
+
+  def encode_and_decode val
+    encoder.decode(encoder.encode(val))
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refcode
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jordan Sitkin
@@ -81,9 +81,11 @@ files:
 - lib/refcode.rb
 - lib/refcode/encodable.rb
 - lib/refcode/encoder.rb
+- lib/refcode/errors.rb
 - lib/refcode/version.rb
 - refcode.gemspec
-- test/refcode_test.rb
+- test/refcode_encodable_test.rb
+- test/refcode_encoder_test.rb
 homepage: http://github.com/dustMason/refcode
 licenses:
 - MIT
@@ -109,4 +111,5 @@ signing_key:
 specification_version: 4
 summary: Hide sensitive data in plain sight, right in your URL
 test_files:
-- test/refcode_test.rb
+- test/refcode_encodable_test.rb
+- test/refcode_encoder_test.rb

data/test/refcode_test.rb

@@ -1,81 +0,0 @@
-require 'ostruct'
-require 'test/unit'
-require File.join(File.dirname(__FILE__),"..","lib","refcode.rb")
-
-class RefcodeTest < Test::Unit::TestCase
-
-  SECRET = "686cb0461769ebed556f56bc88c956bfdf786646ab1920f58201723c557ccbaeb57112fd53302c06475e6e19a176ba617ee284b091d375858cb259e8578c620f"
-  SALT = "dcc74de5efdab0d80b5d763f8a63bef3d37c7453ee45446fbbccd26648af8ca6a112576dafbf5475f3cd7b968703cc9e0682ee45b8b622045cec287908f536e8"
-
-  class BareEncodableObject < OpenStruct
-    include Refcode::Encodable
-  end
-  class EncodableObject < BareEncodableObject
-    has_refcode :secret => SECRET, :salt => :record_id
-  end
-
-  def test_encoder_against_hash
-    test_hash = { :channel => 'email', :record_id => 49203, :action => 'forward' }
-    assert_equal test_hash, encode_and_decode(test_hash)
-  end
-
-  def test_encoder_against_string
-    test_string = "secret referral data"
-    assert_equal test_string, encode_and_decode(test_string)
-  end
-
-  def test_encoder_against_int
-    assert_equal 4857, encode_and_decode(4857)
-  end
-
-  def test_encoder_against_open_struct
-    test_struct = OpenStruct.new({:test => 42})
-    assert_equal test_struct, encode_and_decode(test_struct)
-  end
-
-  def test_should_raise_argument_error_if_generate_refcode_called_without_val
-    assert_raise ArgumentError do
-      encodable_object.generate_refcode
-    end
-  end
-
-  def test_should_raise_error_if_generate_refcode_called_before_has_refcode
-    assert_raise ArgumentError do
-      obj = BareEncodableObject.new :some => 'value'
-      obj.generate_refcode
-    end
-  end
-
-  def test_should_raise_an_error_if_salt_is_empty
-    encodable_object.record_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)
-    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)
-  end
-
-  private
-
-  def encodable_object
-    @encodable_object ||= EncodableObject.new :name => 'Unimportant Value', :record_id => 381598
-  end
-
-  def encoder
-    @encoder ||= Refcode::Encoder.new do |e|
-      e.secret = SECRET
-      e.salt = SALT
-    end
-  end
-
-  def encode_and_decode val
-    encoder.decode(encoder.encode(val))
-  end
-
-end