params_extractor 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem 'gibberish'
+
+group :development do
+  gem "rspec", 			">= 2.8.0"
+  gem "rdoc", 			">= 3.12"
+  gem "bundler", 		">= 1.1.0"
+  gem "jeweler", 		">= 1.8.3"
+  gem "simplecov", 	">= 0.5"
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    gibberish (1.2.0)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    multi_json (1.3.2)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.1.0)
+  gibberish
+  jeweler (>= 1.8.3)
+  rdoc (>= 3.12)
+  rspec (>= 2.8.0)
+  simplecov (>= 0.5)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kristian Mandrup
+
+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 @@
+# Params extractor
+
+Used to encode or decode a URL params. This is useful for sending out encrypted links with token and then unencrypting, decoding and parsing them later when they come back to the app.
+
+## Getting started example
+
+```ruby
+	# singleton Crypter shared between Encoder and Decoder (uses 'gibberish' gem)
+	# Recommended: load password from a DB table, YAML file or similar
+
+	Params::Crypter.password = "my very secret password"
+
+	# encrypt and encode the params
+	params = {:id => 7, :name => 'kris'}
+
+	encoder = Params::Encoder.new(params)
+	encoder.params # => 'id=7&name=kris'  
+
+	encoded_params = encoder.encoded
+
+	email_link = "#{domain}/invite?token=" + encoded_params
+
+	# send link in email or Facebook notification or similar
+
+	# later... someone clicks on the link
+
+	# decrypt and decode the params
+	decoded_params = Params::Decoder.new(params).decoded
+
+	# retrieve hash from param values
+	hash = decoded_params.as_hash(:sym)
+	
+	# retrieve param values from hash
+	id 		= hash[:id].to_i
+	name 	= hash[:name]
+```
+
+Look at the specs for more on usage. 
+
+## Contributing to params_extractor
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Kristian Mandrup. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "params_extractor"
+  gem.homepage = "http://github.com/kristianmandrup/params_extractor"
+  gem.license = "MIT"
+  gem.summary = %Q{Package and unpackage URL params as encrypted tokens}
+  gem.description = %Q{Encode and encrypt prams and leter unencryt and decode them - useful when sending invites with tokens}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "params_extractor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/params/crypter.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+require 'gibberish'
+
+module Params
+	class Crypter
+		include Singleton
+
+		def self.password
+			Params::Crypter.instance.password
+		end
+		
+		def self.password= pass
+			Params::Crypter.instance.password = pass
+		end
+
+		attr_writer :password
+
+		def encrypt data
+			cipher.enc data
+		end
+
+		def decrypt data
+			cipher.dec data
+		end
+
+		protected
+
+		def cipher
+			@cipher ||= Gibberish::AES.new(password)
+		end		
+
+		def password
+			@password ||= 'xyZ1/!2kdi9o_#'
+		end
+	end
+end

data/lib/params/decoder.rb

@@ -0,0 +1,37 @@
+module Params
+	class Decoder
+		attr_reader :params, :hash
+
+		def initialize params
+			raise "No profile params" if !params || params.empty?
+			@params = params
+		end
+
+
+		# fx decoder.as_hash['a'] returns value of a
+		def as_hash mode = :str			
+			@hash ||= Hash[decoded.split('&').collect{|p| p.split("=")}]
+			case mode
+			when :sym
+				Hash[hash.map{ |k, v| [k.to_sym, v] }]
+			else
+				hash
+			end
+		end
+
+		# decode in reverse order!
+		def decoded
+			@decoded ||= crypter.decrypt decoded_params
+		end
+
+		protected
+
+		def decoded_params
+			Base64.decode64(params)
+		end
+
+		def crypter
+			Crypter.instance
+		end		
+	end
+end

data/lib/params/encoder.rb

@@ -0,0 +1,40 @@
+module Params
+	class Encoder
+		attr_reader :params
+
+		def initialize params
+			raise "No profile params" if !params || params.empty?
+			@params = case params
+			when Hash
+				create_from params
+			when String
+				params
+			else
+				raise "Must be a Hash or String, was #{arg}"
+			end
+		end
+
+		# encode after encryption to ensure Base64 compatibility in link
+		def encoded
+			@encoded ||= Base64.encode64 encrypted_params
+		end
+
+		protected
+
+		def encrypted_params
+			crypter.encrypt(params)
+		end
+
+		# {:a => b, :c = 2} -> a=b&c=2
+		def create_from arg
+			@params = arg.inject([]) do |res, hash| 
+				res << [hash.first, hash.last].join('=')
+				res
+			end.join('&')
+		end		
+
+		def crypter
+			Crypter.instance
+		end
+	end
+end

data/lib/params_extractor.rb

@@ -0,0 +1,3 @@
+require 'params/crypter'
+require 'params/encoder'
+require 'params/decoder'

data/params_extractor.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "params_extractor"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2012-04-28"
+  s.description = "Encode and encrypt prams and leter unencryt and decode them - useful when sending invites with tokens"
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/params/crypter.rb",
+    "lib/params/decoder.rb",
+    "lib/params/encoder.rb",
+    "lib/params_extractor.rb",
+    "params_extractor.gemspec",
+    "spec/params_extractor_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/params_extractor"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.22"
+  s.summary = "Package and unpackage URL params as encrypted tokens"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<gibberish>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.5"])
+    else
+      s.add_dependency(%q<gibberish>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<gibberish>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.8.0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.1.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0.5"])
+  end
+end
+

data/spec/params_extractor_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Params::Crypter do
+	subject { crypter }
+
+	let(:crypter) { Params::Crypter.instance }
+	let(:data) 		{ "a=5&b=7" }
+
+	before do
+		Params::Crypter.password = "secret"
+	end
+
+	describe 'encrypt' do
+		specify { subject.encrypt(data).should_not == data }
+	end
+
+	describe 'decrypt' do
+		let(:encrypted) do
+			subject.encrypt(data)
+		end
+	
+		specify { subject.decrypt(encrypted).should == data }
+	end
+end
+
+describe Params::Encoder do
+	subject { encoder }
+
+	let(:data) do 
+		{:id => 7, :name => 'kris'}
+	end
+
+	let(:encoder) { Params::Encoder.new data }
+
+	describe 'encode' do
+		specify { subject.encoded.should_not == data }
+	end
+end
+
+describe Params::Decoder do
+	subject { decoder }
+
+	let(:encoder) { Params::Encoder.new data }
+
+	let(:data) do 
+		{:id => '7', :name => 'kris'}
+	end
+
+	describe 'decode' do
+		let(:encoded) do
+			encoder.encoded
+		end
+
+		let(:decoder) { Params::Decoder.new encoded }
+	
+		specify { subject.decoded.should_not == data}
+
+		specify do 
+			subject.as_hash.should == {'id' => '7', 'name' => 'kris'}
+		end
+
+		specify { subject.as_hash(:sym).should == data }
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'params_extractor'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: params_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gibberish
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Encode and encrypt prams and leter unencryt and decode them - useful
+  when sending invites with tokens
+email: kmandrup@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/params/crypter.rb
+- lib/params/decoder.rb
+- lib/params/encoder.rb
+- lib/params_extractor.rb
+- params_extractor.gemspec
+- spec/params_extractor_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kristianmandrup/params_extractor
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2391327292111278477
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Package and unpackage URL params as encrypted tokens
+test_files: []