refcode 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e758644ad3263ebb08c54c505b606c310ba5a88a
+  data.tar.gz: 5eef6a2ba89fa9dc55922ee1ea6fe54488155c72
+SHA512:
+  metadata.gz: aa418e724d2bc68c26e7fb06ce6758d8ab2aa04d96aa5b3aaadaf5981750ab8e428706016d15d0c543ddd0f88b38807f8f91ab2fcd209839ee60263c853b36c5
+  data.tar.gz: d098a3bd746a7f4afe3fb4db4240c7ec645b795f8e99e7296d91bd8677bd013203536cb79437a35e6a843947882727caa35c4be16f8b44a469e7c49197915d00

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in refcode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jordan Sitkin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# 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
+application.
+
+Refcode was conceived as a way to attach referral data to tracking links. Encryption
+makes it unlikely that the links can be tampered with.
+
+## Implementation
+
+- **Encryption** using the AES-256-CBC algorithm with https://github.com/attr-encrypted/encryptor which wraps the Ruby OpenSSL library.
+
+- **Base64 encoding** is handled by https://github.com/nojima/base64url which implements a slight tweak to the standard Base64 algorithm to create URL-safe strings.
+
+- **Serialization** with YAML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'refcode'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install refcode
+
+## Usage
+
+    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
+
+    # in some future request...
+
+    something = encoder.decode params[:encoded_param]
+    puts something.channel # 'facebook'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.warning = true
+  test.verbose = true
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/lib/refcode/version.rb

@@ -0,0 +1,3 @@
+module Refcode
+  VERSION = "0.0.1"
+end

data/lib/refcode.rb

@@ -0,0 +1,41 @@
+require 'uri'
+require 'yaml'
+require 'base64url'
+require 'encryptor'
+require 'refcode/version'
+
+module Refcode
+
+  class Encoder
+
+    attr_accessor :secret, :salt
+
+    def initialize
+      yield self if block_given?
+    end
+
+    def encode val
+      Base64URL.encode(encrypt(YAML.dump(val)))
+    end
+
+    def decode val
+      YAML.load(decrypt(Base64URL.decode(val)))
+    end
+
+    def encrypt val
+      Encryptor.encrypt(:value => val, :key => @secret, :salt => @salt, :iv => iv)
+    end
+
+    def decrypt val
+      Encryptor.decrypt(:value => val, :key => @secret, :salt => @salt, :iv => iv)
+    end
+
+    private
+
+    def iv
+      [@secret, @salt].join
+    end
+
+  end
+
+end

data/refcode.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'refcode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "refcode"
+  spec.version       = Refcode::VERSION
+  spec.authors       = ["Jordan Sitkin"]
+  spec.email         = ["jordan@fiftyfootfoghorn.com"]
+  spec.description   = %q{Encrypts and encodes values into URL friendly strings}
+  spec.summary       = %q{Hide sensitive data in plain sight, right in your URL}
+  spec.homepage      = "http://github.com/dustMason/refcode"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "base64url", "~> 1.0"
+  spec.add_runtime_dependency "encryptor", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/refcode_test.rb

@@ -0,0 +1,42 @@
+require 'ostruct'
+require 'test/unit'
+require File.join(File.dirname(__FILE__),"..","lib","refcode.rb")
+
+class RefcodeTest < 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

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: refcode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Sitkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64url
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: encryptor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Encrypts and encodes values into URL friendly strings
+email:
+- jordan@fiftyfootfoghorn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/refcode.rb
+- lib/refcode/version.rb
+- refcode.gemspec
+- test/refcode_test.rb
+homepage: http://github.com/dustMason/refcode
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Hide sensitive data in plain sight, right in your URL
+test_files:
+- test/refcode_test.rb