gocardless 1.1.1 → 1.2.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.2.0 - June 19, 2012
+
+- Add some extra attributes to resources (e.g. status, merchant's balance, etc)
+- Add a response_params_valid? method to check that resource response data is
+  valid (including signature)
+
 ## 1.1.1 - June 07, 2012
 
 - Fix handling of cancel_uri

data/lib/gocardless/bill.rb

@@ -8,7 +8,8 @@ module GoCardless
                   :source_type,
                   :description,
                   :name,
-                  :plan_id
+                  :plan_id,
+                  :status
 
     # @attribute source_id
     # @return [String] the ID of the bill's source (eg subscription, pre_authorization)

data/lib/gocardless/client.rb

@@ -220,16 +220,7 @@ module GoCardless
     # @param [Hash] params the response parameters returned by the API server
     # @return [Resource] the confirmed resource object
     def confirm_resource(params)
-      # Create a new hash in case is a HashWithIndifferentAccess (keys are
-      # always a String)
-      params = Utils.symbolize_keys(Hash[params])
-      # Only pull out the relevant parameters, other won't be included in the
-      # signature so will cause false negatives
-      keys = [:resource_id, :resource_type, :resource_uri, :state, :signature]
-      params = Hash[params.select { |k,v| keys.include? k }]
-      (keys - [:state]).each do |key|
-        raise ArgumentError, "Parameters missing #{key}" if !params.key?(key)
-      end
+      params = prepare_params(params)
 
       if signature_valid?(params)
         data = {
@@ -254,6 +245,17 @@ module GoCardless
     end
 
 
+    # Check that resource response data includes a valid signature.
+    #
+    # @param [Hash] params the response parameters returned by the API server
+    # @return [Boolean] true when valid, false otherwise
+    def response_params_valid?(params)
+      params = prepare_params(params)
+
+      signature_valid?(params)
+    end
+
+
     # Validates the payload contents of a webhook request.
     #
     # @param [Hash] params the contents of payload of the webhook
@@ -310,6 +312,25 @@ module GoCardless
       params
     end
 
+    # Prepare a Hash of parameters for signing. Presence of required
+    # parameters is checked and the others are discarded.
+    #
+    # @param [Hash] params the parameters to be prepared for signing
+    # @return [Hash] the prepared parameters
+    def prepare_params(params)
+      # Create a new hash in case is a HashWithIndifferentAccess (keys are
+      # always a String)
+      params = Utils.symbolize_keys(Hash[params])
+      # Only pull out the relevant parameters, other won't be included in the
+      # signature so will cause false negatives
+      keys = [:resource_id, :resource_type, :resource_uri, :state, :signature]
+      params = Hash[params.select { |k,v| keys.include? k }]
+      (keys - [:state]).each do |key|
+        raise ArgumentError, "Parameters missing #{key}" if !params.key?(key)
+      end
+      params
+    end
+
     # Check if a hash's :signature is valid
     #
     # @param [Hash] params the parameters to check

data/lib/gocardless/merchant.rb

@@ -2,12 +2,15 @@ module GoCardless
   class Merchant < Resource
     self.endpoint = '/merchants/:id'
 
-    attr_accessor :name
-    attr_accessor :description
-    attr_accessor :email
-    attr_accessor :first_name
-    attr_accessor :last_name
-    date_accessor :created_at
+    attr_accessor :name,
+                  :description,
+                  :email,
+                  :first_name,
+                  :last_name,
+                  :balance,
+                  :pending_balance,
+                  :next_payout_amount
+    date_accessor :created_at, :next_payout_date
 
     def subscriptions(params = {})
       path = "/merchants/#{self.id}/subscriptions"

data/lib/gocardless/pre_authorization.rb

@@ -9,7 +9,10 @@ module GoCardless
                   :interval_unit,
                   :name,
                   :description,
-                  :plan_id
+                  :plan_id,
+                  :status,
+                  :remaining_amount,
+                  :next_interval_start
 
     reference_accessor :merchant_id, :user_id
     date_accessor :expires_at, :created_at

data/lib/gocardless/subscription.rb

@@ -9,11 +9,16 @@ module GoCardless
                    :interval_unit,
                    :name,
                    :description,
-                   :plan_id
+                   :plan_id,
+                   :status,
+                   :setup_fee,
+                   :trial_length,
+                   :trial_unit,
+                   :next_interval_start
 
     reference_accessor :merchant_id, :user_id
 
-    date_accessor :expires_at, :created_at
+    date_accessor :start_at, :expires_at, :created_at
 
 
     def cancel!

data/lib/gocardless/version.rb

@@ -1,3 +1,3 @@
 module GoCardless
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/spec/client_spec.rb

@@ -259,31 +259,6 @@ describe GoCardless::Client do
       }
     end
 
-    [:resource_id, :resource_uri, :resource_type].each do |param|
-      it "fails when :#{param} is missing" do
-        p = @params.tap { |d| d.delete(param) }
-        expect { @client.confirm_resource p }.to raise_exception ArgumentError
-      end
-    end
-
-    it "does not fail when keys are strings in a HashWithIndiferentAccess" do
-      params = {'resource_id' => 1,
-                'resource_uri' => 'a',
-                'resource_type' => 'subscription',
-                'signature' => 'foo'}
-      params_indifferent_access = HashWithIndifferentAccess.new(params)
-      expect { @client.confirm_resource params_indifferent_access }.to_not raise_exception ArgumentError
-    end
-
-    it "rejects other params not required for the signature" do
-      @client.stubs(:request).returns(stub(:parsed => {}))
-      @client.expects(:signature_valid?).returns(true).with(hash) do |hash|
-        !hash.keys.include?(:foo) && !hash.keys.include?('foo')
-      end
-
-      @client.confirm_resource(@client.send(:sign_params, @params).merge('foo' => 'bar'))
-    end
-
     it "doesn't confirm the resource when the signature is invalid" do
       @client.expects(:request).never
       @client.confirm_resource({:signature => 'xxx'}.merge(@params)) rescue nil
@@ -333,6 +308,55 @@ describe GoCardless::Client do
     end
   end
 
+  describe "#response_params_valid?" do
+    before :each do
+      @params = {
+        :resource_id   => '1',
+        :resource_uri  => 'a',
+        :resource_type => 'subscription',
+      }
+    end
+
+    [:resource_id, :resource_uri, :resource_type].each do |param|
+      it "fails when :#{param} is missing" do
+        params = @params.tap { |d| d.delete(param) }
+        expect do
+          @client.response_params_valid? params
+        end.to raise_exception ArgumentError
+      end
+    end
+
+    it "does not fail when keys are strings in a HashWithIndiferentAccess" do
+      params = {'resource_id' => 1,
+                'resource_uri' => 'a',
+                'resource_type' => 'subscription',
+                'signature' => 'foo'}
+      params_indifferent_access = HashWithIndifferentAccess.new(params)
+      expect do
+        @client.response_params_valid? params_indifferent_access
+      end.to_not raise_exception ArgumentError
+    end
+
+    it "rejects other params not required for the signature" do
+      @client.expects(:signature_valid?).returns(true).with(hash) do |hash|
+        !hash.keys.include?(:foo) && !hash.keys.include?('foo')
+      end
+
+      params = @client.send(:sign_params, @params).merge('foo' => 'bar')
+      @client.response_params_valid?(params)
+    end
+
+    it "returns false when the signature is invalid" do
+      params = {:signature => 'xxx'}.merge(@params)
+      @client.response_params_valid?(params).should be_false
+    end
+
+    it "returns true when the signature is valid" do
+      params = @client.send(:sign_params, @params)
+      @client.response_params_valid?(params).should be_true
+    end
+  end
+
   it "#generate_nonce should generate a random string" do
     @client.send(:generate_nonce).should_not == @client.send(:generate_nonce)
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gocardless
 version: !ruby/object:Gem::Version 
-  hash: 4079999309947216651
+  hash: 242951009964279202
   prerelease: 
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Harry Marr
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-07 00:00:00 Z
+date: 2012-06-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth2