params_extractor 0.1.1 → 0.2.0

data/README.md

@@ -5,6 +5,9 @@ Used to encode or decode a URL params. This is useful for sending out encrypted
 ## Getting started example
 
 ```ruby
+	Params::Crypter.off! # turn encryption off (is on by default) - global setting
+	Params::Crypter.on! # turn encryption back on - global setting
+
 	# singleton Crypter shared between Encoder and Decoder (uses 'gibberish' gem)
 	# Recommended: load password from a DB table, YAML file or similar
 
@@ -33,6 +36,14 @@ Used to encode or decode a URL params. This is useful for sending out encrypted
 	# retrieve param values from hash
 	id 		= hash[:id].to_i
 	name 	= hash[:name]
+
+	# set crypter on/off for individual encoder or decoder
+
+	# turn off for encoder
+	encoder = Params::Encoder.new "a=7", :crypter => false
+
+	# turn off for decoder
+	decoder = Params::Decoder.new token, :crypter => false
 ```
 
 Look at the specs for more on usage. 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/params/base.rb

@@ -0,0 +1,19 @@
+module Params
+  module Base
+    def use_crypter?
+      crypter? || Params::Crypter.on?
+    end
+
+    def crypter?
+      !(@crypter == false)
+    end
+
+    def crypter_off!
+      @crypter = false
+    end
+
+    def crypter_on!
+      @crypter = true
+    end
+  end
+end

data/lib/params/crypter.rb

@@ -5,21 +5,49 @@ module Params
 	class Crypter
 		include Singleton
 
-		def self.password
-			Params::Crypter.instance.password
-		end
-		
-		def self.password= pass
-			Params::Crypter.instance.password = pass
+		class << self
+			def on!
+				@on = true
+			end
+
+			def off!
+				@on = false
+			end
+
+			def on?
+				!(@on == false)
+			end
+
+			def off?
+				!on?
+			end
+
+			def password
+				Params::Crypter.instance.password
+			end
+			
+			def password= pass
+				Params::Crypter.instance.password = pass
+			end
 		end
 
 		attr_writer :password
 
+		def on?
+			Params::Crypter.on?
+		end
+
+		def off?
+			Params::Crypter.off?
+		end
+
 		def encrypt data
+			return data if off?
 			cipher.enc data
 		end
 
 		def decrypt data
+			return data if off?
 			cipher.dec data
 		end
 

data/lib/params/decoder.rb

@@ -1,12 +1,19 @@
 module Params
-	class Decoder
+	class Decoder 
+		include Params::Base
+		
 		attr_reader :params, :hash
 
-		def initialize params
-			raise "No profile params" if !params || params.empty?
-			@params = params
-		end
+		def initialize *args
+			raise "Decoder needs params to encode" if !args || args.empty?
+			args = args.flatten
+			options 	= args.last
+			if options.kind_of? Hash			
+				@crypter 	= options.delete(:crypter) if options				
+			end
 
+			@params = args.first
+		end
 
 		# fx decoder.as_hash['a'] returns value of a
 		def as_hash mode = :str			
@@ -21,7 +28,7 @@ module Params
 
 		# decode in reverse order!
 		def decoded
-			@decoded ||= crypter.decrypt decoded_params
+			@decoded ||= use_crypter? ? crypter.decrypt(decoded_params) : decoded_params
 		end
 
 		protected
@@ -31,7 +38,7 @@ module Params
 		end
 
 		def crypter
-			Crypter.instance
+			Crypter.instance if crypter?
 		end		
 	end
 end

data/lib/params/encoder.rb

@@ -1,14 +1,22 @@
 module Params
 	class Encoder
+		include Params::Base
+
 		attr_reader :params
 
-		def initialize params
-			raise "No profile params" if !params || params.empty?
-			@params = case params
+		def initialize *args
+			raise "Encoder needs params to encode" if !args || args.empty?
+			args = args.flatten
+			options = args.last 
+			if options.kind_of? Hash				
+				@crypter = options.delete(:crypter)
+			end
+			arg = args.first
+			@params = case arg
 			when Hash
-				create_from params
+				create_from arg
 			when String
-				params
+				arg
 			else
 				raise "Must be a Hash or String, was #{arg}"
 			end
@@ -16,7 +24,7 @@ module Params
 
 		# encode after encryption to ensure Base64 compatibility in link
 		def encoded
-			@encoded ||= Base64.encode64 encrypted_params
+			@encoded ||= use_crypter? ? Base64.encode64(encrypted_params) : Base64.encode64(params)
 		end
 
 		protected
@@ -34,7 +42,7 @@ module Params
 		end		
 
 		def crypter
-			Crypter.instance
+			Crypter.instance if crypter?
 		end
 	end
 end

data/lib/params_extractor.rb

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

data/params_extractor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "params_extractor"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   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.date = "2012-05-07"
   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 = [
@@ -25,18 +25,23 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "lib/params/base.rb",
     "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/decoder_ex.rb",
+    "spec/encoder_ex.rb",
+    "spec/params_extractor/crypter_spec.rb",
+    "spec/params_extractor/decoder_spec.rb",
+    "spec/params_extractor/encoder_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.rubygems_version = "1.8.24"
   s.summary = "Package and unpackage URL params as encrypted tokens"
 
   if s.respond_to? :specification_version then

data/spec/decoder_ex.rb

@@ -0,0 +1,9 @@
+shared_examples 'a decoder' do
+  specify { subject.decoded.should_not == data}
+
+  specify do 
+    subject.as_hash.should == decoded_data
+  end
+
+  specify { subject.as_hash(:sym).should == data }
+end

data/spec/encoder_ex.rb

@@ -0,0 +1,3 @@
+shared_examples 'an encoder' do
+  specify { subject.encoded.should_not == data }
+end

data/spec/params_extractor/crypter_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Params::Crypter do
+  subject { crypter }
+
+  let(:params) do
+    {}
+  end
+
+  let(:crypter) { Params::Crypter.instance }
+  let(:data)    { "a=5&b=7" }
+
+  before do
+    Params::Crypter.password = "secret"
+  end
+
+  describe 'on?' do
+    specify { subject.on?.should be_true }
+  end
+
+  describe 'off?' do
+    specify { subject.off?.should be_false }
+  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
+
+  context 'Global Crypter turned off' do
+    before do
+      Params::Crypter.off!
+    end
+
+    specify { subject.encrypt(data).should == data }
+
+    describe 'on?' do
+      specify { subject.on?.should be_false }
+    end
+
+    describe 'off?' do
+      specify { subject.off?.should be_true }
+    end
+
+    describe 'turn crypter back on' do
+      before :each do
+        Params::Crypter.on!
+      end
+
+      describe 'on?' do
+        specify { subject.on?.should be_true }
+      end
+
+      describe 'off?' do
+        specify { subject.off?.should be_false }
+      end
+
+      specify { subject.encrypt(data).should_not == data }
+    end
+  end 
+end

data/spec/params_extractor/decoder_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'decoder_ex'
+
+describe Params::Decoder do
+  subject { decoder }
+  
+  let(:params) do
+    {}
+  end
+
+  let(:encoder) { Params::Encoder.new data, params }
+  let(:decoder) { Params::Decoder.new encoded }
+  let(:encoded) do
+    encoder.encoded
+  end
+
+  let(:data) do 
+    {:id => '7', :name => 'kris'}
+  end
+
+  let(:decoded_data) do
+    {'id' => '7', 'name' => 'kris'}
+  end
+
+  # before do
+  #   Params::Crypter.on!
+  # end
+
+  describe 'crypter?' do
+    specify { subject.crypter?.should be_true }
+  end
+
+  describe 'use_crypter?' do
+    specify { subject.use_crypter?.should be_true }
+  end
+
+  describe 'decode' do  
+    it_behaves_like 'a decoder'
+  end
+
+  context 'Global Crypter turned off' do
+    before :each do
+      Params::Crypter.off!
+    end
+
+    describe 'decode' do
+      it_behaves_like 'a decoder'
+    end   
+  end
+
+  context 'Decoder crypter turned off' do
+    let(:params) do
+      {:crypter => false}
+    end
+
+    describe 'decode' do
+      it_behaves_like 'a decoder'
+    end
+  end 
+
+  context 'Decoder crypter turned off after init' do
+    before :each do
+      subject.crypter_off!
+    end
+
+    describe 'crypter?' do
+      specify { subject.crypter?.should be_false }
+    end
+
+    describe 'decode' do
+      it_behaves_like 'a decoder'
+    end
+  end 
+
+  context 'Decoder crypter turned back on after init' do
+    let(:params) do
+      {:crypter => false}
+    end
+
+    before :each do
+      subject.crypter_on!
+    end
+
+    describe 'crypter?' do
+      specify { subject.crypter?.should be_true }
+    end
+
+    describe 'decode' do
+      it_behaves_like 'a decoder'
+    end
+  end 
+
+end

data/spec/params_extractor/encoder_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'encoder_ex'
+
+describe Params::Encoder do
+  subject { encoder }
+
+  let(:params) do
+    {}
+  end
+
+  let(:data) do 
+    {:id => 7, :name => 'kris'}
+  end
+
+  let(:encoder) { Params::Encoder.new data, params }
+
+  # before do
+  #   Params::Crypter.on!
+  # end
+
+  describe 'crypter?' do
+    specify { subject.crypter?.should be_true }
+  end
+
+  describe 'use_crypter?' do
+    specify { subject.use_crypter?.should be_true }
+  end
+
+  describe 'encode' do
+    specify { subject.encoded.should_not == data }
+  end
+
+  context 'Global Crypter turned off' do
+    before do
+      Params::Crypter.off!
+    end
+
+    it_behaves_like 'an encoder'
+  end
+
+  context 'Encoder crypter turned off' do
+    let(:params) do
+      {:crypter => false}
+    end
+
+    it_behaves_like 'an encoder'
+  end 
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: params_extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gibberish
@@ -124,12 +124,17 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- lib/params/base.rb
 - 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/decoder_ex.rb
+- spec/encoder_ex.rb
+- spec/params_extractor/crypter_spec.rb
+- spec/params_extractor/decoder_spec.rb
+- spec/params_extractor/encoder_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kristianmandrup/params_extractor
 licenses:
@@ -146,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2391327292111278477
+      hash: -448216205111061566
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Package and unpackage URL params as encrypted tokens

data/spec/params_extractor_spec.rb

@@ -1,64 +0,0 @@
-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