gocardless_pro 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0679426d50fd7a646344adfbe02b150edec3f19a
-  data.tar.gz: 326eb4aba24167005218f2cc4b3cdc787afaef11
+  metadata.gz: 336757aa0c2b6a8259d999fff9b6c47b08a81ac9
+  data.tar.gz: 8a9254232e7c5b5df0f3ff1cd4ee31a3a0e5c8ab
 SHA512:
-  metadata.gz: 107065812a3eb12360a3dc8e10b3920f04886277fb9671079b224d70489a7373773691170ce46401660679b2b2b43c04cc59279e59ee1d4665684d30c58b365d
-  data.tar.gz: 03ead3f29fe550c6b33883f53bbeb2d6dcdc0d8ec6795462c4d6d7aa3aafc7019c13159c430ac4904672b93e107dbbb23628f4317fc2da2d01a0566c09f92cea
+  metadata.gz: d06593be915e27b49c3a227492380e92d81b5461a6dc16c4ab094d3c45640bf8405a036890e0cb98ef1194533f05bc74ea92a2c2ac9fdcd07726b0423a09818d
+  data.tar.gz: 6d515b60b723a53c24145fdd55c75fb0de95ab6618977e2055e612ca76da8178e8a570d5da66590ae6793bb7c750ee9389dc3629bfb186b774a4ce8e2a1d69bf

data/README.md

@@ -114,7 +114,16 @@ The error has the following methods to allow you to access the information from
 - `#request_id`
 - `#errors`
 
+### Using the OAuth API
+
+The API includes [OAuth](https://developer.gocardless.com/pro/2015-07-06/#guides-oauth) functionality, which allows you to work with other users' GoCardless accounts. Once a user approves you, you can use the GoCardless API on their behalf and receive their webhooks.
+
+OAuth simply provides a means by which you obtain an access token - once you have this access token, you can use this gem as usual.
+
+We recommend using the [oauth2](https://github.com/intridea/oauth2) gem to handle the authorisation process and gain a token. For an example of this in action, see our [open-source OAuth demo app](https://github.com/gocardless/oauth-demo/blob/master/app.rb#L46).
+
 ## Supporting Ruby < 2.0.0
+
 The client only supports Ruby >= 2.0.0 out of the box due to our use of
 Enumerable::Lazy for lazy loading of paginated API resources.
 

data/lib/gocardless_pro/resources/bank_details_lookup.rb

@@ -17,6 +17,8 @@ module GoCardlessPro
       attr_reader :available_debit_schemes
 
       attr_reader :bank_name
+
+      attr_reader :bic
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
       def initialize(object, response = nil)
@@ -24,6 +26,7 @@ module GoCardlessPro
 
         @available_debit_schemes = object['available_debit_schemes']
         @bank_name = object['bank_name']
+        @bic = object['bic']
         @response = response
       end
 

data/lib/gocardless_pro/resources/creditor.rb

@@ -65,6 +65,9 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(default_eur_payout_account default_gbp_payout_account )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
@@ -73,7 +76,7 @@ module GoCardlessPro
             default_gbp_payout_account: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/creditor_bank_account.rb

@@ -12,15 +12,15 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Creditor Bank Accounts hold the bank details of a
-    # [creditor](#core-endpoints-creditor). These are the bank accounts which your
-    # [payouts](#core-endpoints-payouts) will be sent to.
+    # [creditor](#whitelabel-partner-endpoints-creditors). These are the bank
+    # accounts which your [payouts](#core-endpoints-payouts) will be sent to.
     #
-    # Note that
-    # creditor bank accounts must be unique, and so you will encounter a
-    # `bank_account_exists` error if you try to create a duplicate bank account.
-    # You may wish to handle this by updating the existing record instead, the ID
-    # of which will be provided as `links[creditor_bank_account]` in the error
-    # response.
+    #
+    # Note that creditor bank accounts must be unique, and so you will
+    # encounter a `bank_account_exists` error if you try to create a duplicate
+    # bank account. You may wish to handle this by updating the existing record
+    # instead, the ID of which will be provided as `links[creditor_bank_account]`
+    # in the error response.
     # Represents an instance of a creditor_bank_account resource returned from the API
     class CreditorBankAccount
       attr_reader :account_holder_name
@@ -64,13 +64,16 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(creditor )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
             creditor: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/customer_bank_account.rb

@@ -64,13 +64,16 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(customer )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
             customer: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/event.rb

@@ -48,6 +48,9 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(mandate new_customer_bank_account parent_event payment payout previous_customer_bank_account refund subscription )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
@@ -68,7 +71,7 @@ module GoCardlessPro
             subscription: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/mandate.rb

@@ -53,6 +53,9 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(creditor customer_bank_account )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
@@ -61,7 +64,7 @@ module GoCardlessPro
             customer_bank_account: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/mandate_pdf.rb

@@ -12,7 +12,7 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Mandate PDFs allow you to easily display [scheme-rules
-    # compliant](#ui-compliance-requirements) Direct Debit mandates to your
+    # compliant](#appendix-compliance-requirements) Direct Debit mandates to your
     # customers.
     # Represents an instance of a mandate_pdf resource returned from the API
     class MandatePdf

data/lib/gocardless_pro/resources/payment.rb

@@ -13,11 +13,11 @@ module GoCardlessPro
   module Resources
     # Payment objects represent payments from a
     # [customer](#core-endpoints-customers) to a
-    # [creditor](#core-endpoints-creditors), taken against a Direct Debit
-    # [mandate](#core-endpoints-mandates).
+    # [creditor](#whitelabel-partner-endpoints-creditors), taken against a Direct
+    # Debit [mandate](#core-endpoints-mandates).
     #
-    # GoCardless will notify you via
-    # a [webhook](#webhooks) whenever the state of a payment changes.
+    # GoCardless will notify
+    # you via a [webhook](#webhooks) whenever the state of a payment changes.
     # Represents an instance of a payment resource returned from the API
     class Payment
       attr_reader :amount
@@ -64,6 +64,9 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(creditor mandate payout subscription )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
@@ -76,7 +79,7 @@ module GoCardlessPro
             subscription: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/payout.rb

@@ -12,9 +12,10 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Payouts represent transfers from GoCardless to a
-    # [creditor](#core-endpoints-creditors). Each payout contains the funds
-    # collected from one or many [payments](#core-endpoints-payments). Payouts are
-    # created automatically after a payment has been successfully collected.
+    # [creditor](#whitelabel-partner-endpoints-creditors). Each payout contains
+    # the funds collected from one or many [payments](#core-endpoints-payments).
+    # Payouts are created automatically after a payment has been successfully
+    # collected.
     # Represents an instance of a payout resource returned from the API
     class Payout
       attr_reader :amount
@@ -49,6 +50,9 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(creditor creditor_bank_account )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
@@ -57,7 +61,7 @@ module GoCardlessPro
             creditor_bank_account: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -80,15 +80,22 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(creditor customer customer_bank_account mandate )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
             creditor: '',
 
+            customer: '',
+
+            customer_bank_account: '',
+
             mandate: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/refund.rb

@@ -53,13 +53,16 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(payment )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
             payment: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/subscription.rb

@@ -141,13 +141,16 @@ module GoCardlessPro
 
       # return the links that the resource has
       def links
+        valid_link_keys = %w(mandate )
+        valid_links = @links.select { |key, _| valid_link_keys.include?(key) }
+
         Struct.new(
           *{
 
             mandate: ''
 
           }.keys.sort
-        ).new(*@links.sort.map(&:last))
+        ).new(*valid_links.sort.map(&:last))
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/services/payouts_service.rb

@@ -40,7 +40,7 @@ module GoCardlessPro
 
       # Retrieves the details of a single payout. For an example of how to reconcile
       # the transactions in a payout, see [this
-      # guide](#events-fetching-events-for-a-payout).
+      # guide](#events-reconciling-payouts-with-events).
       # Example URL: /payouts/:identity
       #
       # @param identity       # Unique identifier, beginning with "PO".

data/lib/gocardless_pro/version.rb

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

data/spec/resources/bank_details_lookup_spec.rb

@@ -13,10 +13,14 @@ describe GoCardlessPro::Resources::BankDetailsLookup do
           "bank_name" => "bank_name-input",
         
       
+        
+          "bic" => "bic-input",
+        
+      
       }
     end
 
-    it "can be initialized from an uneveloped response" do
+    it "can be initialized from an unenveloped response" do
       resource = described_class.new(data)
       
        
@@ -27,8 +31,19 @@ describe GoCardlessPro::Resources::BankDetailsLookup do
        expect(resource.bank_name).to eq("bank_name-input")
        
        
+       
+       expect(resource.bic).to eq("bic-input")
+       
+       
+    end
+
+    it "can handle new attributes without erroring" do
+      data["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
     end
 
+    
+
     describe "#to_h" do
       it "returns a hash representing the resource" do
         expect(described_class.new(data).to_h).to eq(data)

data/spec/resources/creditor_bank_account_spec.rb

@@ -52,7 +52,7 @@ describe GoCardlessPro::Resources::CreditorBankAccount do
       }
     end
 
-    it "can be initialized from an uneveloped response" do
+    it "can be initialized from an unenveloped response" do
       resource = described_class.new(data)
       
        
@@ -99,6 +99,18 @@ describe GoCardlessPro::Resources::CreditorBankAccount do
        
     end
 
+    it "can handle new attributes without erroring" do
+      data["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
+    end
+
+    
+    it "can handle new link attributes without erroring" do
+      data["links"]["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
+    end
+    
+
     describe "#to_h" do
       it "returns a hash representing the resource" do
         expect(described_class.new(data).to_h).to eq(data)

data/spec/resources/creditor_spec.rb

@@ -58,7 +58,7 @@ describe GoCardlessPro::Resources::Creditor do
       }
     end
 
-    it "can be initialized from an uneveloped response" do
+    it "can be initialized from an unenveloped response" do
       resource = described_class.new(data)
       
        
@@ -111,6 +111,18 @@ describe GoCardlessPro::Resources::Creditor do
        
     end
 
+    it "can handle new attributes without erroring" do
+      data["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
+    end
+
+    
+    it "can handle new link attributes without erroring" do
+      data["links"]["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
+    end
+    
+
     describe "#to_h" do
       it "returns a hash representing the resource" do
         expect(described_class.new(data).to_h).to eq(data)

data/spec/resources/customer_bank_account_spec.rb

@@ -52,7 +52,7 @@ describe GoCardlessPro::Resources::CustomerBankAccount do
       }
     end
 
-    it "can be initialized from an uneveloped response" do
+    it "can be initialized from an unenveloped response" do
       resource = described_class.new(data)
       
        
@@ -99,6 +99,18 @@ describe GoCardlessPro::Resources::CustomerBankAccount do
        
     end
 
+    it "can handle new attributes without erroring" do
+      data["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
+    end
+
+    
+    it "can handle new link attributes without erroring" do
+      data["links"]["foo"] = "bar"
+      expect { described_class.new(data) }.to_not raise_error
+    end
+    
+
     describe "#to_h" do
       it "returns a hash representing the resource" do
         expect(described_class.new(data).to_h).to eq(data)