chargify2 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/chargify2.gemspec

@@ -0,0 +1,105 @@
+# 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 = %q{chargify2}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Klett"]
+  s.date = %q{2011-04-20}
+  s.description = %q{}
+  s.email = %q{michael@webadvocate.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "chargify2.gemspec",
+    "lib/chargify2.rb",
+    "lib/chargify2/client.rb",
+    "lib/chargify2/direct.rb",
+    "lib/chargify2/representations/call.rb",
+    "lib/chargify2/resource.rb",
+    "lib/chargify2/resources/call_resource.rb",
+    "lib/chargify2/utils.rb",
+    "spec/call_resource_spec.rb",
+    "spec/client_spec.rb",
+    "spec/direct_response_parameters_spec.rb",
+    "spec/direct_secure_parameters_spec.rb",
+    "spec/direct_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/spec_helper_methods.rb"
+  ]
+  s.homepage = %q{http://github.com/chargify/chargify2}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Chargify API V2 Ruby Wrapper}
+  s.test_files = [
+    "spec/call_resource_spec.rb",
+    "spec/client_spec.rb",
+    "spec/direct_response_parameters_spec.rb",
+    "spec/direct_secure_parameters_spec.rb",
+    "spec/direct_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/spec_helper_methods.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<hashery>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<hashery>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<capybara>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<hashery>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<capybara>, [">= 0"])
+  end
+end
+

data/lib/chargify2/direct.rb

@@ -11,8 +11,8 @@ module Chargify2
       SecureParameters.new(params, client)
     end
 
-    def result(params = {})
-      Result.new(params, client)
+    def response_parameters(params = {})
+      ResponseParameters.new(params, client)
     end
 
     def self.signature(message, secret)
@@ -90,14 +90,16 @@ module Chargify2
         end
         
         unless api_id && secret && api_id.to_s.length > 0 && secret.to_s.length > 0
-          # raise ArgumentError
+          raise ArgumentError.new("SecureParameters require connection to a Client - was one given?")
         end
       end
     end
     
-    # There is no need to instantiate a Result instance directly.  Use Direct#results instead.
-    class Result
+    # There is no need to instantiate a ResponseParameters instance directly.  Use Direct#response_parameters instead.
+    class ResponseParameters
       attr_reader :api_id
+      attr_reader :timestamp
+      attr_reader :nonce
       attr_reader :status_code
       attr_reader :result_code
       attr_reader :call_id
@@ -111,13 +113,17 @@ module Chargify2
         @secret       = client.api_secret
 
         @status_code  = args[:status_code]
+        @timestamp    = args[:timestamp]
+        @nonce        = args[:nonce]
         @result_code  = args[:result_code]
         @call_id      = args[:call_id]
         @signature    = args[:signature]
+        
+        validate_args
       end
       
       def verified?
-        message = "#{api_id}#{status_code}#{result_code}#{call_id}"
+        message = "#{api_id}#{timestamp}#{nonce}#{status_code}#{result_code}#{call_id}"
         Direct.signature(message, secret) == signature
       end
       
@@ -128,8 +134,8 @@ module Chargify2
       private
       
       def validate_args
-        if data && !data.is_a?(Hash)
-          raise ArgumentError.new("The 'data' must be provided as a Hash (you passed a #{data.class})")
+        unless api_id && secret && api_id.to_s.length > 0 && secret.to_s.length > 0
+          raise ArgumentError.new("ResponseParameters require connection to a Client - was one given?")
         end
       end
     end

data/lib/chargify2/resource.rb

@@ -45,7 +45,7 @@ module Chargify2
     
     def self.read(id, query = {})
       response = get("#{uri}/#{id}", :query => query.empty? ? nil : query)
-      response_hash = response.parsed_response[representation.to_s.downcase.split('::').last] || {}
+      response_hash = response[representation.to_s.downcase.split('::').last] || {}
       representation.new(response_hash.symbolize_keys)
     end
     

data/spec/direct_response_parameters_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module Chargify2
+  describe Direct::ResponseParameters do
+    let(:client) { Client.new(valid_client_credentials) }
+    
+    it "raises an argument error if it could not get an api_id and secret from the passed client" do
+      lambda {
+        Direct::SecureParameters.new({}, OpenCascade.new)
+      }.should raise_error(ArgumentError)
+    end
+    
+    describe "#verified?" do
+      before(:each) do
+        @api_id = valid_client_credentials[:api_id]
+        @timestamp = '1303245326'
+        @nonce = @api_id
+        @status_code = '200'
+        @result_code = '2000'
+        @call_id = 'blah'
+        
+        # Used the generator here: http://hash.online-convert.com/sha1-generator
+        # ... with message: "1c016050-498a-012e-91b1-005056a216ab13032453261c016050-498a-012e-91b1-005056a216ab2002000blah"
+        # ... and secret: "p5lxQ804MYtwZecFWNOT"
+        # ... to get: "cfce3418f5fc4454a309fe01c918b90916d6c36a"
+        @signature = "cfce3418f5fc4454a309fe01c918b90916d6c36a"
+      end
+
+      it "returns true when all of the expected params are present and the signature matches the calculated signature" do
+        rp = Direct::ResponseParameters.new({
+          'api_id' => @api_id,
+          'timestamp' => @timestamp,
+          'nonce' => @nonce,
+          'status_code' => @status_code,
+          'result_code' => @result_code,
+          'call_id' => @call_id,
+          'signature' => @signature
+        }, client)
+        
+        rp.verified?.should be_true
+      end
+      
+      it "returns false when the calculated signature of the result params is different from the received signature" do
+        rp = Direct::ResponseParameters.new({
+          'api_id' => @api_id,
+          'timestamp' => @timestamp,
+          'nonce' => @nonce,
+          'status_code' => @status_code,
+          'result_code' => @result_code,
+          'call_id' => @call_id,
+          'signature' => 'foo'
+        }, client)
+        
+        rp.verified?.should be_false
+      end
+      
+      it "returns false when the calculated signature is correct but the api_id does not match the client's" do
+        other_client_credentials = valid_client_credentials.merge(:api_id => '1')
+        other_client = Client.new(other_client_credentials)
+
+        rp = Direct::ResponseParameters.new({
+          'api_id' => @api_id,
+          'timestamp' => @timestamp,
+          'nonce' => @nonce,
+          'status_code' => @status_code,
+          'result_code' => @result_code,
+          'call_id' => @call_id,
+          'signature' => @signature
+        }, other_client)
+        
+        rp.verified?.should be_false
+      end
+    end
+  end
+end

data/spec/direct_secure_parameters_spec.rb

@@ -12,7 +12,7 @@ module Chargify2
     
     it "raises an argument error if it could not get an api_id and secret from the passed client" do
       lambda {
-        Direct::SecureParameters.new({'data' => 'string'}, OpenCascade.new)
+        Direct::SecureParameters.new({}, OpenCascade.new)
       }.should raise_error(ArgumentError)
     end
     

data/spec/direct_spec.rb

@@ -59,73 +59,11 @@ module Chargify2
       end
     end
 
-    describe "#result" do
+    describe "#response_parameters" do
       let(:direct) { Direct.new(client) }
       
-      it "generates a new Result instance given a hash of result params" do
-        direct.result({}).should be_a(Direct::Result)
-      end
-    end
-    
-    describe Direct::Result do
-      describe "#verified?" do
-        it "returns true when the calculated signature of the result params matches the received signature" do
-          api_id = '1c016050-498a-012e-91b1-005056a216ab'
-          status_code = '200'
-          result_code = '2000'
-          call_id = '1234'
-          
-          # Used the generator here: http://hash.online-convert.com/sha1-generator
-          # ... with message: "1c016050-498a-012e-91b1-005056a216ab20020001234"
-          # ... and secret: "p5lxQ804MYtwZecFWNOT"
-          # ... to get: "9d1b9139d6c49720faa0b2b6207c95060e6695d4"
-          signature = "9d1b9139d6c49720faa0b2b6207c95060e6695d4"
-          
-          r = Direct::Result.new({
-            'api_id' => api_id,
-            'status_code' => status_code,
-            'result_code' => result_code,
-            'call_id' => call_id,
-            'signature' => signature}, client)
-          
-          r.verified?.should be_true
-        end
-        
-        it "returns false when the calculated signature of the result params is different from the received signature" do
-          r = Direct::Result.new({
-            'api_id' => client.api_id,
-            'status_code' => '2',
-            'result_code' => '3',
-            'call_id' => '4',
-            'signature' => '5'}, client)
-          
-          r.verified?.should be_false
-        end
-        
-        it "returns false when the calculated signature is correct but the api_id does not match the client's'" do
-          api_id = '1c016050-498a-012e-91b1-005056a216ab'
-          status_code = '200'
-          result_code = '2000'
-          call_id = '1234'
-          
-          # Used the generator here: http://hash.online-convert.com/sha1-generator
-          # ... with message: "1c016050-498a-012e-91b1-005056a216ab20020001234"
-          # ... and secret: "p5lxQ804MYtwZecFWNOT"
-          # ... to get: "9d1b9139d6c49720faa0b2b6207c95060e6695d4"
-          signature = "9d1b9139d6c49720faa0b2b6207c95060e6695d4"
-
-          client_credentials = valid_client_credentials
-          client_credentials[:api_id] = '1234'
-          different_client = Client.new(client_credentials)
-          r = Direct::Result.new({
-            'api_id' => api_id,
-            'status_code' => status_code,
-            'result_code' => result_code,
-            'call_id' => call_id,
-            'signature' => signature}, different_client)
-          
-          r.verified?.should be_false
-        end
+      it "generates a new ResponseParameters instance given a hash of response params" do
+        direct.response_parameters({}).should be_a(Direct::ResponseParameters)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chargify2
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Klett
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 -04:00
+date: 2011-04-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -212,6 +212,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- chargify2.gemspec
 - lib/chargify2.rb
 - lib/chargify2/client.rb
 - lib/chargify2/direct.rb
@@ -221,6 +222,7 @@ files:
 - lib/chargify2/utils.rb
 - spec/call_resource_spec.rb
 - spec/client_spec.rb
+- spec/direct_response_parameters_spec.rb
 - spec/direct_secure_parameters_spec.rb
 - spec/direct_spec.rb
 - spec/spec_helper.rb
@@ -262,6 +264,7 @@ summary: Chargify API V2 Ruby Wrapper
 test_files: 
 - spec/call_resource_spec.rb
 - spec/client_spec.rb
+- spec/direct_response_parameters_spec.rb
 - spec/direct_secure_parameters_spec.rb
 - spec/direct_spec.rb
 - spec/spec_helper.rb