signed_json 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -10,16 +10,14 @@ GEM
     diff-lcs (1.1.2)
     json (1.4.6)
     rake (0.8.7)
-    rspec (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
-      rspec-mocks (~> 2.0.1)
-    rspec-core (2.0.1)
-    rspec-expectations (2.0.1)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.1)
-      rspec-core (~> 2.0.1)
-      rspec-expectations (~> 2.0.1)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
 
 PLATFORMS
   ruby
@@ -27,5 +25,5 @@ PLATFORMS
 DEPENDENCIES
   json
   rake
-  rspec (~> 2.0)
+  rspec (~> 2.1)
   signed_json!

data/README.md

@@ -17,7 +17,7 @@ Use.
     ### encode ###
     s.encode 'a string'
     s.encode ['an', 'array']
-    s.encode { :a => 'hash' }
+    s.encode :a => 'hash'
 
     ### decode ###
     s.decode '["da7555389d05e04a3367b84aed401cafbbecfe3d","example"]'
@@ -43,6 +43,8 @@ Rails already has a nice signed cookie implementation, but because [`ActiveSuppo
 
 `SignedJson::Signer`, on the other hand, can easily be implemented in other languages, allowing for signed cookies shared between same-domain web applications, for example.
 
+Note that the JSON-encoding must be consistent across implementations.  For example in Python, separators=(',',':') must be specified to eliminate whitespace which would invalidate the HMAC digest.
+
 
   [1]: http://en.wikipedia.org/wiki/HMAC
   [2]: http://ruby-doc.org/ruby-1.9/classes/OpenSSL/HMAC.html
@@ -75,6 +77,13 @@ RSpec speaks for the Ruby implementation:
     Finished in 0.0186 seconds
     9 examples, 0 failures
 
+Tested against:
+
+    ruby 1.9.2p0 (2010-08-18 revision 29036) [x86_64-linux]
+    rubinius 1.1.0 (1.8.7 release 2010-09-23 JI) [x86_64-unknown-linux-gnu]
+    ruby 1.8.7 (2010-08-16 patchlevel 302) [x86_64-linux]
+    jruby 1.5.3 (ruby 1.8.7 patchlevel 249) (2010-09-28 7ca06d7) (Java HotSpot(TM) 64-Bit Server VM 1.6.0_22) [amd64-java]
+
 
 Meh.
 ----

data/Rakefile

@@ -1,6 +1,9 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
+desc "Run all tests"
+task :default => :spec
+
 desc "Run specs"
 task :spec do
   system 'bundle exec rspec --color --format documentation spec/*_spec.rb'

data/lib/signed_json/version.rb

@@ -1,3 +1,3 @@
 module SignedJson
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/signed_json.rb

@@ -19,10 +19,13 @@ module SignedJson
       data
     end
 
+    # Generates an HMAC digest for the JSON representation of the given input.
+    # JSON generation must be consistent across platforms.
+    # e.g. in Python, specify separators=(',',':') to eliminate whitespace.
     def digest_for(input)
-      # ActiveSupport::MessageVerifier does this, probably for a good reason.
-      require 'openssl' unless defined?(OpenSSL)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@digest).new, @secret, input.to_json)
+      require 'openssl' unless defined?(OpenSSL) # from ActiveSupport::MessageVerifier
+      digest = OpenSSL::Digest.const_get(@digest).new
+      OpenSSL::HMAC.hexdigest(digest, @secret, input.to_json)
     end
 
     private

data/signed_json.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Paul Annesley"]
   s.email       = ["paul@annesley.cc"]
   s.homepage    = "http://github.com/pda/signed_json"
-  s.summary     = %q{Encodes and decodes JSON-encodable data into and from a signed JSON string.}
+  s.summary     = %q{Encodes and decodes data to a JSON string signed with OpenSSL HMAC. Great for signed cookies.}
 
   s.rubyforge_project = "signed_json"
 
@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency('json')
 
-  s.add_development_dependency('rspec', ['~> 2.0'])
+  s.add_development_dependency('rspec', ['~> 2.1'])
   s.add_development_dependency('rake')
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Paul Annesley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-04 00:00:00 +11:00
+date: 2010-12-06 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,8 +40,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 0
-        version: "2.0"
+        - 1
+        version: "2.1"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -109,6 +109,6 @@ rubyforge_project: signed_json
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Encodes and decodes JSON-encodable data into and from a signed JSON string.
+summary: Encodes and decodes data to a JSON string signed with OpenSSL HMAC. Great for signed cookies.
 test_files: []