multipass 1.1.4 → 1.2.1

data/.gitignore

@@ -1 +1,2 @@
 .rake_tasks
+pkg

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 1
-:minor: 1
-:patch: 4
+:minor: 2
+:patch: 1
 :build: 

data/lib/multipass.rb

@@ -1,24 +1,36 @@
 require 'time'
+require 'ezcrypto'
 
 class MultiPass
   class Invalid < StandardError
-    @@message = "The MultiPass token is invalid."
+    class << self
+      attr_accessor :message
+    end
+    self.message = "The MultiPass token is invalid."
+
+    attr_reader :data, :json, :options
+
+    def initialize(data = nil, json = nil, options = nil)
+      @data    = data
+      @json    = json
+      @options = options
+    end
 
     def message
-      @@message
+      self.class.message
     end
 
     alias to_s message
   end
 
   class ExpiredError < Invalid
-    @@message = "The MultiPass token has expired."
+    self.message = "The MultiPass token has expired."
   end
   class JSONError < Invalid
-    @@message = "The decrypted MultiPass token is not valid JSON."
+    self.message = "The decrypted MultiPass token is not valid JSON."
   end
   class DecryptError < Invalid
-    @@message = "The MultiPass token was not able to be decrypted."
+    self.message = "The MultiPass token was not able to be decrypted."
   end
 
   def self.encode(site_key, api_key, options = {})
@@ -29,15 +41,19 @@ class MultiPass
     new(site_key, api_key).decode(data)
   end
 
-  def initialize(site_key, api_key)
+  # options:
+  #   :url_safe => true
+  def initialize(site_key, api_key, options = {})
     @site_key   = site_key
     @api_key    = api_key
-    if !Object.const_defined?(:EzCrypto)
-      require 'ezcrypto'
-    end
+    @url_safe   = !options.key?(:url_safe) || options[:url_safe]
     @crypto_key = EzCrypto::Key.with_password(@site_key, @api_key)
   end
 
+  def url_safe?
+    !!@url_safe
+  end
+
   # Encrypts the given hash into a multipass string.
   def encode(options = {})
     options[:expires] = case options[:expires]
@@ -45,22 +61,23 @@ class MultiPass
       when Time, DateTime, Date then options[:expires].to_s
       else options[:expires].to_s
     end
-    @crypto_key.encrypt64(options.to_json)
+    self.class.encode_64 @crypto_key.encrypt(options.to_json), @url_safe
   end
 
   # Decrypts the given multipass string and parses it as JSON.  Then, it checks
   # for a valid expiration date.
   def decode(data)
-    json = @crypto_key.decrypt64(data)
+    json = options = nil
+    json = @crypto_key.decrypt(self.class.decode_64(data, @url_safe))
     
     if json.nil?
-      raise MultiPass::DecryptError
+      raise MultiPass::DecryptError.new(data)
     end
 
-    options = decode_json(json)
+    options = decode_json(data, json)
     
     if !options.is_a?(Hash)
-      raise MultiPass::JSONError
+      raise MultiPass::JSONError.new(data, json, options)
     end
 
     options.keys.each do |key|
@@ -68,29 +85,55 @@ class MultiPass
     end
 
     if options[:expires].nil? || Time.now.utc > Time.parse(options[:expires])
-      raise MultiPass::ExpiredError
+      raise MultiPass::ExpiredError.new(data, json, options)
     end
 
     options
   rescue CipherError
-    raise MultiPass::DecryptError
+    raise MultiPass::DecryptError.new(data, json, options)
   end
 
   CipherError = OpenSSL.const_defined?(:CipherError) ? OpenSSL::CipherError : OpenSSL::Cipher::CipherError
 
-private
   if Object.const_defined?(:ActiveSupport)
-    def decode_json(s)
+    include ActiveSupport::Base64
+  else
+    require 'base64'
+  end
+
+  def self.encode_64(s, url_safe = true)
+    b = Base64.encode64(s)
+    b.gsub! /\n/, ''
+    if url_safe
+      b.tr!    '+', '-'
+      b.tr!    '/', '_'
+      b.chomp! '='
+    end
+    b
+  end
+
+  def self.decode_64(s, url_safe = true)
+    if url_safe
+      s = s.dup
+      s.tr! '-', '+'
+      s.tr! '_', '/'
+      s << '='
+    end
+    Base64.decode64(s)
+  end
+
+  if Object.const_defined?(:ActiveSupport)
+    def decode_json(data, s)
       ActiveSupport::JSON.decode(s)
     rescue ActiveSupport::JSON::ParseError
-      raise MultiPass::JSONError
+      raise MultiPass::JSONError.new(data, s)
     end
   else
     require 'json'
-    def decode_json(s)
+    def decode_json(data, s)
       JSON.parse(s)
     rescue JSON::ParserError
-      raise MultiPass::JSONError
+      raise MultiPass::JSONError.new(data, s)
     end
   end
 end

data/multipass.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{multipass}
-  s.version = "1.1.4"
+  s.version = "1.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["rick"]
-  s.date = %q{2009-12-17}
+  s.date = %q{2010-01-01}
   s.email = %q{technoweenie@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",

data/test/multipass_test.rb

@@ -1,28 +1,15 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 require 'rubygems'
 require 'test/unit'
-require 'ezcrypto'
 require 'multipass'
+#require 'active_support'
 
-class MultiPassTest < Test::Unit::TestCase
-  def setup
-    @date   = Time.now + 1234
-    @input  = {:expires => @date, :email => 'ricky@bobby.com'}
-    @output = @input.merge(:expires => @input[:expires].to_s)
-    @key    = EzCrypto::Key.with_password('example', 'abc')
-    @mp     = MultiPass.new('example', 'abc')
-  end
-
+module MultiPassTests
   def test_encodes_multipass
-    expected = @key.encrypt64(@output.to_json)
+    expected = MultiPass.encode_64(@key.encrypt(@output.to_json), @mp.url_safe?)
     assert_equal expected, @mp.encode(@input)
   end
 
-  def test_encodes_multipass_with_class_method
-    expected = @key.encrypt64(@output.to_json)
-    assert_equal expected, MultiPass.encode('example', 'abc', @input)
-  end
-
   def test_decodes_multipass
     encoded = @mp.encode(@input)
     assert_equal @input, @mp.decode(encoded)
@@ -54,4 +41,97 @@ class MultiPassTest < Test::Unit::TestCase
       @mp.decode(encrypted)
     end
   end
+end
+
+class StandardMultiPassTest < Test::Unit::TestCase
+  include MultiPassTests
+
+  def setup
+    @date   = Time.now + 1234
+    @input  = {:expires => @date, :email => 'ricky@bobby.com'}
+    @output = @input.merge(:expires => @input[:expires].to_s)
+    @key    = EzCrypto::Key.with_password('example', 'abc')
+    @mp     = MultiPass.new('example', 'abc', :url_safe => false)
+  end
+end
+
+class UrlSafeMultiPassTest < Test::Unit::TestCase
+  include MultiPassTests
+
+  def test_encodes_multipass_with_class_method
+    expected = MultiPass.encode_64(@key.encrypt(@output.to_json), @mp.url_safe?)
+    assert_equal expected, MultiPass.encode('example', 'abc', @input)
+  end
+
+  def setup
+    @date   = Time.now + 1234
+    @input  = {:expires => @date, :email => 'ricky@bobby.com'}
+    @output = @input.merge(:expires => @input[:expires].to_s)
+    @key    = EzCrypto::Key.with_password('example', 'abc')
+    @mp     = MultiPass.new('example', 'abc', :url_safe => true)
+  end
+end
+
+class ErrorTest < Test::Unit::TestCase
+  def setup
+    @key = EzCrypto::Key.with_password('example', 'abc')
+    @mp  = MultiPass.new('example', 'abc')
+  end
+
+  def test_decrypt_error_stores_data
+    begin
+      @mp.decode 'abc'
+    rescue MultiPass::DecryptError => e
+      assert_equal 'abc', e.data
+    end
+  end
+
+  def test_json_error_stores_data
+    begin
+      data = @key.encrypt64("abc")
+      @mp.decode data
+    rescue MultiPass::JSONError => e
+      assert_equal data, e.data
+    end
+  end
+
+  def test_json_error_stores_json
+    begin
+      data = @key.encrypt64("{a")
+      @mp.decode data
+    rescue MultiPass::JSONError => e
+      assert_equal "{a", e.json
+    end
+  end
+
+  def test_expiration_error_stores_data
+    begin
+      json = {:expires => Time.now - 5, :email => 'ricky@bobby.com'}.to_json
+      data = @key.encrypt64(json)
+      @mp.decode data
+    rescue MultiPass::ExpiredError => e
+      assert_equal data, e.data
+    end
+  end
+
+  def test_expiration_error_stores_json
+    begin
+      json = {:expires => Time.now - 5, :email => 'ricky@bobby.com'}.to_json
+      data = @key.encrypt64(json)
+      @mp.decode data
+    rescue MultiPass::ExpiredError => e
+      assert_equal json, e.json
+    end
+  end
+
+  def test_expiration_error_stores_options
+    begin
+      opt  = {:expires => (Time.now - 5).to_s, :email => 'ricky@bobby.com'}
+      json = opt.to_json
+      data = @key.encrypt64(json)
+      @mp.decode data
+    rescue MultiPass::ExpiredError => e
+      assert_equal opt, e.options
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: multipass
 version: !ruby/object:Gem::Version 
-  version: 1.1.4
+  version: 1.2.1
 platform: ruby
 authors: 
 - rick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 -08:00
+date: 2010-01-01 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency