gocardless_pro 0.3.0 → 1.0.0

data/lib/gocardless_pro/services/payments_service.rb

@@ -14,9 +14,9 @@ module GoCardlessPro
       #
       # This
       # fails with a `mandate_is_inactive` error if the linked
-      # [mandate](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates)
-      # is cancelled. Payments can be created against `pending_submission` mandates,
-      # but they will not be submitted until the mandate becomes active.
+      # [mandate](#core-endpoints-mandates) is cancelled. Payments can be created
+      # against `pending_submission` mandates, but they will not be submitted until
+      # the mandate becomes active.
       # Example URL: /payments
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -28,12 +28,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Payment.new(unenvelope_body(response.body))
+        Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your payments.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # payments.
       # Example URL: /payments
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -41,7 +40,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Payment
         )
@@ -63,7 +62,7 @@ module GoCardlessPro
       # Retrieves the details of a single existing payment.
       # Example URL: /payments/:identity
       #
-      # @param identity       # Unique identifier, beginning with "PM"
+      # @param identity       # Unique identifier, beginning with "PM".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/payments/:identity',           'identity' => identity)
@@ -71,13 +70,13 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Payment.new(unenvelope_body(response.body))
+        Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
       # Updates a payment object. This accepts only the metadata parameter.
       # Example URL: /payments/:identity
       #
-      # @param identity       # Unique identifier, beginning with "PM"
+      # @param identity       # Unique identifier, beginning with "PM".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/payments/:identity',           'identity' => identity)
@@ -88,7 +87,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::Payment.new(unenvelope_body(response.body))
+        Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
       # Cancels the payment if it has not already been submitted to the banks. Any
@@ -99,7 +98,7 @@ module GoCardlessPro
       # the payment's status is `pending_submission`.
       # Example URL: /payments/:identity/actions/cancel
       #
-      # @param identity       # Unique identifier, beginning with "PM"
+      # @param identity       # Unique identifier, beginning with "PM".
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/payments/:identity/actions/cancel',           'identity' => identity)
@@ -110,7 +109,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Payment.new(unenvelope_body(response.body))
+        Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
       # <a name="retry_failed"></a>Retries a failed payment if the underlying mandate
@@ -127,7 +126,7 @@ module GoCardlessPro
       # times.
       # Example URL: /payments/:identity/actions/retry
       #
-      # @param identity       # Unique identifier, beginning with "PM"
+      # @param identity       # Unique identifier, beginning with "PM".
       # @param options [Hash] parameters as a hash, under a params key.
       def retry(identity, options = {})
         path = sub_url('/payments/:identity/actions/retry',           'identity' => identity)
@@ -138,7 +137,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Payment.new(unenvelope_body(response.body))
+        Resources::Payment.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/payouts_service.rb

@@ -10,9 +10,8 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Payout endpoints
     class PayoutsService < BaseService
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your payouts.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # payouts.
       # Example URL: /payouts
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -20,7 +19,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Payout
         )
@@ -44,7 +43,7 @@ module GoCardlessPro
       # guide](#events-fetching-events-for-a-payout).
       # Example URL: /payouts/:identity
       #
-      # @param identity       # Unique identifier, beginning with "PO"
+      # @param identity       # Unique identifier, beginning with "PO".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/payouts/:identity',           'identity' => identity)
@@ -52,7 +51,7 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Payout.new(unenvelope_body(response.body))
+        Resources::Payout.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -23,7 +23,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::RedirectFlow.new(unenvelope_body(response.body))
+        Resources::RedirectFlow.new(unenvelope_body(response.body), response)
       end
 
       # Returns all details about a single redirect flow
@@ -37,24 +37,20 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::RedirectFlow.new(unenvelope_body(response.body))
+        Resources::RedirectFlow.new(unenvelope_body(response.body), response)
       end
 
-      # This creates a
-      # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers),
-      # [customer bank
-      # account](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customer-bank-accounts),
-      # and
-      # [mandate](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates)
-      # using the details supplied by your customer and returns the ID of the created
-      # mandate.
+      # This creates a [customer](#core-endpoints-customers), [customer bank
+      # account](#core-endpoints-customer-bank-accounts), and
+      # [mandate](#core-endpoints-mandates) using the details supplied by your
+      # customer and returns the ID of the created mandate.
       #
-      # This will return a `redirect_flow_incomplete` error if your
-      # customer has not yet been redirected back to your site, and a
-      # `redirect_flow_already_completed` error if your integration has already
-      # completed this flow. It will return a `bad_request` error if the
-      # `session_token` differs to the one supplied when the redirect flow was
-      # created.
+      # This will return a
+      # `redirect_flow_incomplete` error if your customer has not yet been redirected
+      # back to your site, and a `redirect_flow_already_completed` error if your
+      # integration has already completed this flow. It will return a `bad_request`
+      # error if the `session_token` differs to the one supplied when the redirect
+      # flow was created.
       # Example URL: /redirect_flows/:identity/actions/complete
       #
       # @param identity       # Unique identifier, beginning with "RE".
@@ -68,7 +64,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::RedirectFlow.new(unenvelope_body(response.body))
+        Resources::RedirectFlow.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/refunds_service.rb

@@ -18,18 +18,16 @@ module GoCardlessPro
       # name="number_of_refunds_exceeded"></a>
       #
       # - `refund_payment_invalid_state`
-      # error if the linked
-      # [payment](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments)
-      # isn't either `confirmed` or `paid_out`.
+      # error if the linked [payment](#core-endpoints-payments) isn't either
+      # `confirmed` or `paid_out`.
       #
-      # -
-      # `total_amount_confirmation_invalid` if the confirmation amount doesn't match
-      # the total amount refunded for the payment. This safeguard is there to prevent
-      # two processes from creating refunds without awareness of each other.
+      # - `total_amount_confirmation_invalid` if the
+      # confirmation amount doesn't match the total amount refunded for the payment.
+      # This safeguard is there to prevent two processes from creating refunds without
+      # awareness of each other.
       #
-      # -
-      # `number_of_refunds_exceeded` if five or more refunds have already been created
-      # against the payment.
+      # - `number_of_refunds_exceeded` if five or more
+      # refunds have already been created against the payment.
       #
       # Example URL: /refunds
       # @param options [Hash] parameters as a hash, under a params key.
@@ -42,12 +40,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Refund.new(unenvelope_body(response.body))
+        Resources::Refund.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your refunds.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # refunds.
       # Example URL: /refunds
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -55,7 +52,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Refund
         )
@@ -77,7 +74,7 @@ module GoCardlessPro
       # Retrieves all details for a single refund
       # Example URL: /refunds/:identity
       #
-      # @param identity       # Unique identifier, beginning with "RF"
+      # @param identity       # Unique identifier, beginning with "RF".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/refunds/:identity',           'identity' => identity)
@@ -85,13 +82,13 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Refund.new(unenvelope_body(response.body))
+        Resources::Refund.new(unenvelope_body(response.body), response)
       end
 
       # Updates a refund object.
       # Example URL: /refunds/:identity
       #
-      # @param identity       # Unique identifier, beginning with "RF"
+      # @param identity       # Unique identifier, beginning with "RF".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/refunds/:identity',           'identity' => identity)
@@ -102,7 +99,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::Refund.new(unenvelope_body(response.body))
+        Resources::Refund.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -22,12 +22,11 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Subscription.new(unenvelope_body(response.body))
+        Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
-      # Returns a
-      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
-      # list of your subscriptions.
+      # Returns a [cursor-paginated](#overview-cursor-pagination) list of your
+      # subscriptions.
       # Example URL: /subscriptions
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -35,7 +34,7 @@ module GoCardlessPro
 
         response = make_request(:get, path, options)
         ListResponse.new(
-          raw_response: response,
+          response: response,
           unenveloped_body: unenvelope_body(response.body),
           resource_class: Resources::Subscription
         )
@@ -57,7 +56,7 @@ module GoCardlessPro
       # Retrieves the details of a single subscription.
       # Example URL: /subscriptions/:identity
       #
-      # @param identity       # Unique identifier, beginning with "SB"
+      # @param identity       # Unique identifier, beginning with "SB".
       # @param options [Hash] parameters as a hash, under a params key.
       def get(identity, options = {})
         path = sub_url('/subscriptions/:identity',           'identity' => identity)
@@ -65,13 +64,13 @@ module GoCardlessPro
         response = make_request(:get, path, options)
 
         return if response.body.nil?
-        Resources::Subscription.new(unenvelope_body(response.body))
+        Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
       # Updates a subscription object.
       # Example URL: /subscriptions/:identity
       #
-      # @param identity       # Unique identifier, beginning with "SB"
+      # @param identity       # Unique identifier, beginning with "SB".
       # @param options [Hash] parameters as a hash, under a params key.
       def update(identity, options = {})
         path = sub_url('/subscriptions/:identity',           'identity' => identity)
@@ -82,7 +81,7 @@ module GoCardlessPro
         response = make_request(:put, path, options)
 
         return if response.body.nil?
-        Resources::Subscription.new(unenvelope_body(response.body))
+        Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
       # Immediately cancels a subscription; no more payments will be created under it.
@@ -93,7 +92,7 @@ module GoCardlessPro
       # error if the subscription is already cancelled or finished.
       # Example URL: /subscriptions/:identity/actions/cancel
       #
-      # @param identity       # Unique identifier, beginning with "SB"
+      # @param identity       # Unique identifier, beginning with "SB".
       # @param options [Hash] parameters as a hash, under a params key.
       def cancel(identity, options = {})
         path = sub_url('/subscriptions/:identity/actions/cancel',           'identity' => identity)
@@ -104,7 +103,7 @@ module GoCardlessPro
         response = make_request(:post, path, options)
 
         return if response.body.nil?
-        Resources::Subscription.new(unenvelope_body(response.body))
+        Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

data/spec/api_response_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'json'
+
+describe GoCardlessPro::ApiResponse do
+  describe "wrapping a Faraday response" do
+    let(:content_type) { 'application/json' }
+
+    let(:stubbed) do
+      Faraday::Adapter::Test::Stubs.new do |stub|
+        stub.get('/testing') do |env|
+          [200, { 'Content-Type' => content_type}, { test: true }.to_json]
+        end
+      end
+    end
+    let(:test) { Faraday.new { |builder| builder.adapter :test, stubbed } }
+    subject(:api_response) do
+      described_class.new(
+        GoCardlessPro::Response.new(test.get('/testing'))
+      )
+    end
+
+    specify { expect(api_response.status_code).to eql(200) }
+    specify do
+      expect(api_response.headers).to eql('Content-Type' => content_type)
+    end
+    specify { expect(api_response.body).to eql("test" => true) }
+  end
+end

data/spec/resources/bank_details_lookup_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::BankDetailsLookup do
+  describe "initialising" do
+    let(:data) do
+      {
+      
+        
+          "available_debit_schemes" => "available_debit_schemes-input",
+        
+      
+        
+          "bank_name" => "bank_name-input",
+        
+      
+      }
+    end
+
+    it "can be initialized from an uneveloped response" do
+      resource = described_class.new(data)
+      
+       
+       expect(resource.available_debit_schemes).to eq("available_debit_schemes-input")
+       
+       
+       
+       expect(resource.bank_name).to eq("bank_name-input")
+       
+       
+    end
+
+    describe "#to_h" do
+      it "returns a hash representing the resource" do
+        expect(described_class.new(data).to_h).to eq(data)
+      end
+    end
+  end
+end
+

data/spec/resources/creditor_spec.rb

@@ -40,8 +40,6 @@ describe GoCardlessPro::Resources::Creditor do
           
             "default_gbp_payout_account" => "default_gbp_payout_account-input",
           
-            "logo" => "logo-input",
-          
         },
         
       
@@ -97,8 +95,6 @@ describe GoCardlessPro::Resources::Creditor do
          
            expect(resource.links.default_gbp_payout_account).to eq("default_gbp_payout_account-input")
          
-           expect(resource.links.logo).to eq("logo-input")
-