gocardless_pro 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc56592c0c41639dd981845de276d9634b423c9c
-  data.tar.gz: 54d4dd9ed407bb39e3ce73de1fe0acfab24d3b61
+  metadata.gz: 0679426d50fd7a646344adfbe02b150edec3f19a
+  data.tar.gz: 326eb4aba24167005218f2cc4b3cdc787afaef11
 SHA512:
-  metadata.gz: 48da3d84a089b8b8de211e397c21bdb8c4c495c743b22286a90f975a2858be91469f80e0d14be88efeb29592f4829ac69a371177daae2a918d7374bb85b5297b
-  data.tar.gz: c328b8e0cd31285c2979c80bf79854e65b672352d3f7fdc3c0df4f655de32f91a34cdbab950a164fccc5974ef1859790578919eafe210ff0a207b0e2ecb0a137
+  metadata.gz: 107065812a3eb12360a3dc8e10b3920f04886277fb9671079b224d70489a7373773691170ce46401660679b2b2b43c04cc59279e59ee1d4665684d30c58b365d
+  data.tar.gz: 03ead3f29fe550c6b33883f53bbeb2d6dcdc0d8ec6795462c4d6d7aa3aafc7019c13159c430ac4904672b93e107dbbb23628f4317fc2da2d01a0566c09f92cea

data/README.md

@@ -1,11 +1,8 @@
 # Ruby Client for GoCardless Pro API
 
-- [YARD Docs](http://gocardless.github.io/pro-client-ruby/)
 - [GoCardless Pro API Docs](https://developer.gocardless.com/pro/)
 - [RubyGems](https://rubygems.org/gems/gocardless_pro)
 
-This client is still in beta and is subject to change. Until a stable major version is released you should expect breaking changes.
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -21,17 +18,17 @@ require 'gocardless_pro'
 ## Usage Examples
 
 - In the case of a single response, the client will return you an instance of the resource
-- In the case of list responses, the client will return an instance of `ListResponse`, which is enumerable.
+- In the case of list responses, the client will return an instance of `ListResponse`.
 - You can also call `#all` to get a lazily paginated list of resource that will deal with making extra API requests to paginate through all the data
 
 ### Initialising the client
 
 The client is initialised with an Access Token.
-You can also pass in `environment` as `:sandbox` to make requests to the sandbox environment rather than the live one.
+You can also pass in `environment` as `:sandbox` to make requests to the sandbox environment rather than production.
 
 ```rb
 @client = GoCardlessPro::Client.new(
-  token: ENV["GOCARDLESS_TOKEN"]
+  access_token: ENV["GOCARDLESS_TOKEN"]
 )
 ```
 
@@ -71,6 +68,12 @@ As with list, the last argument can be an options hash, with any URL parameters
 @client.customers.get(customers_id, params: { limit: 200 })
 ```
 
+Both individual resource and `ListResponse` instances provide an `api_response` method, which lets you access the following properties of the request:
+
+- `status`
+- `headers`
+- `body`
+
 ### POST/PUT Requests
 
 For POST and PUT requests you need to pass in the body in under the `params` key:
@@ -91,32 +94,14 @@ As with GET requests, if any parameters are required they come first:
 @client.customers.update(customer_id, {...})
 ```
 
-### Custom Headers
-
-If you need to pass in a custom header to an endpoint, you can pass in a `headers` object to the options hash:
-
-```rb
-@client.helpers.mandate({
-  params: {
-    account_number: 200000,
-    ...
-  },
-  headers: {
-    'Accept': 'application/pdf'
-  }
-})
-```
-
-There are very few endpoints in the API that require custom headers. Currently, the only ones that do are [helpers](https://developer.gocardless.com/pro/#api-endpoints-helpers).
-
 ### Handling failures
 
-When an API returns an error, the client __will raise__ an error that corresponds to the type of error. All errors subclass `GoCardless::Error`. There are four errors that could be thrown:
+When an API returns an error, the client __will raise__ an error that corresponds to the type of error. All errors subclass `GoCardlessPro::Error`. There are four errors that could be thrown:
 
-- `GoCardless::GoCardlessError`
-- `GoCardless::InvalidApiUsageError`
-- `GoCardless::InvalidStateError`
-- `GoCardless::ValidationError`
+- `GoCardlessPro::GoCardlessError`
+- `GoCardlessPro::InvalidApiUsageError`
+- `GoCardlessPro::InvalidStateError`
+- `GoCardlessPro::ValidationError`
 
 These errors are fully documented in the [API documentation](https://developer.gocardless.com/pro/#overview-errors).
 

data/lib/gocardless_pro.rb

@@ -33,6 +33,10 @@ require_relative 'gocardless_pro/error/invalid_state_error'
 require_relative 'gocardless_pro/paginator'
 require_relative 'gocardless_pro/request'
 require_relative 'gocardless_pro/response'
+require_relative 'gocardless_pro/api_response'
+
+require_relative 'gocardless_pro/resources/bank_details_lookup'
+require_relative 'gocardless_pro/services/bank_details_lookups_service'
 
 require_relative 'gocardless_pro/resources/creditor'
 require_relative 'gocardless_pro/services/creditors_service'
@@ -49,12 +53,12 @@ require_relative 'gocardless_pro/services/customer_bank_accounts_service'
 require_relative 'gocardless_pro/resources/event'
 require_relative 'gocardless_pro/services/events_service'
 
-require_relative 'gocardless_pro/resources/helper'
-require_relative 'gocardless_pro/services/helpers_service'
-
 require_relative 'gocardless_pro/resources/mandate'
 require_relative 'gocardless_pro/services/mandates_service'
 
+require_relative 'gocardless_pro/resources/mandate_pdf'
+require_relative 'gocardless_pro/services/mandate_pdfs_service'
+
 require_relative 'gocardless_pro/resources/payment'
 require_relative 'gocardless_pro/services/payments_service'
 

data/lib/gocardless_pro/api_response.rb

@@ -0,0 +1,14 @@
+module GoCardlessPro
+  # wraps a faraday response object with some accessors
+  class ApiResponse
+    extend Forwardable
+
+    def initialize(response)
+      @response = response
+    end
+
+    def_delegator :@response, :headers
+    def_delegator :@response, :body
+    def_delegator :@response, :status_code
+  end
+end

data/lib/gocardless_pro/client.rb

@@ -3,6 +3,11 @@ module GoCardlessPro
   class Client
     extend Forwardable
 
+    # Access to the service for bank_details_lookup to make API calls
+    def bank_details_lookups
+      @bank_details_lookups ||= Services::BankDetailsLookupsService.new(@api_service)
+    end
+
     # Access to the service for creditor to make API calls
     def creditors
       @creditors ||= Services::CreditorsService.new(@api_service)
@@ -28,16 +33,16 @@ module GoCardlessPro
       @events ||= Services::EventsService.new(@api_service)
     end
 
-    # Access to the service for helper to make API calls
-    def helpers
-      @helpers ||= Services::HelpersService.new(@api_service)
-    end
-
     # Access to the service for mandate to make API calls
     def mandates
       @mandates ||= Services::MandatesService.new(@api_service)
     end
 
+    # Access to the service for mandate_pdf to make API calls
+    def mandate_pdfs
+      @mandate_pdfs ||= Services::MandatePdfsService.new(@api_service)
+    end
+
     # Access to the service for payment to make API calls
     def payments
       @payments ||= Services::PaymentsService.new(@api_service)
@@ -108,7 +113,7 @@ module GoCardlessPro
     def default_options
       {
         default_headers: {
-          'GoCardless-Version' => '2015-04-29',
+          'GoCardless-Version' => '2015-07-06',
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json'
         }
@@ -121,14 +126,21 @@ module GoCardlessPro
           gem_name = 'gocardless_pro'
           gem_info = "#{gem_name}"
           gem_info += "/v#{ GoCardlessPro::VERSION}" if defined?(GoCardlessPro::VERSION)
+
           ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
+
           ruby_version = RUBY_VERSION
-          ruby_version += " p#{RUBY_PATCHLEVEL}" if defined?(RUBY_PATCHLEVEL)
-          comment = ["#{ruby_engine} #{ruby_version}"]
-          comment << "gocardless_pro v#{ GoCardlessPro::VERSION}"
-          comment << "faraday v#{Faraday::VERSION}"
-          comment << RUBY_PLATFORM if defined?(RUBY_PLATFORM)
-          "#{gem_info} (#{comment.join('; ')})"
+          ruby_version += "p#{RUBY_PATCHLEVEL}" if defined?(RUBY_PATCHLEVEL)
+
+          interpreter_version = defined?(JRUBY_VERSION) ? JRUBY_VERSION : RUBY_VERSION
+
+          comment = [
+            "#{ruby_engine}/#{ruby_version}",
+            "#{RUBY_ENGINE}/#{interpreter_version}",
+            "#{RUBY_PLATFORM}"
+          ]
+          comment << "faraday/#{Faraday::VERSION}"
+          "#{gem_info} #{comment.join(' ')}"
         end
     end
   end

data/lib/gocardless_pro/list_response.rb

@@ -9,21 +9,25 @@ module GoCardlessPro
     # @option option :resource_class the class for the resource returned by the API
     # @option option :unenveloped_body the parsed response from the API
     def initialize(options = {})
-      @raw_response = options.fetch(:raw_response)
+      @response = options.fetch(:response)
       @resource_class = options.fetch(:resource_class)
       @unenveloped_body = options.fetch(:unenveloped_body)
 
       @records = @unenveloped_body.map { |item| @resource_class.new(item) }
     end
 
+    def api_response
+      @api_response ||= ApiResponse.new(@response)
+    end
+
     # return the before cursor for paginating
     def before
-      @raw_response.body['meta']['cursors']['before']
+      @response.body['meta']['cursors']['before']
     end
 
     # return the after cursor for paginating
     def after
-      @raw_response.body['meta']['cursors']['after']
+      @response.body['meta']['cursors']['after']
     end
   end
 end

data/lib/gocardless_pro/request.rb

@@ -42,10 +42,10 @@ module GoCardlessPro
     def request_body
       if @method == :get
         nil
-      elsif @method == :post || @method == :put
+      elsif [:post, :put, :delete].include?(@method)
         @given_options.fetch(:params, {})
       else
-        fail "unknown method #{@method}"
+        fail "Unknown request method #{@method}"
       end
     end
 
@@ -53,17 +53,9 @@ module GoCardlessPro
     def request_query
       if @method == :get
         @given_options.fetch(:params, {})
-      elsif @method == :post || @method == :put
-        {}
       else
-        fail "unknown method #{@method}"
+        {}
       end
     end
-
-    private
-
-    def options
-      { headers: @headers, body: @body, query: @query }
-    end
   end
 end

data/lib/gocardless_pro/resources/{helper.rb → bank_details_lookup.rb}

@@ -11,13 +11,24 @@ require 'uri'
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
-    #
-    # Represents an instance of a helper resource returned from the API
-    class Helper
+    # Look up the name and reachability of a bank.
+    # Represents an instance of a bank_details_lookup resource returned from the API
+    class BankDetailsLookup
+      attr_reader :available_debit_schemes
+
+      attr_reader :bank_name
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
+
+        @available_debit_schemes = object['available_debit_schemes']
+        @bank_name = object['bank_name']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/creditor.rb

@@ -11,16 +11,14 @@ require 'uri'
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
-    # Each
-    # [payment](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments)
-    # taken through the API is linked to a "creditor", to whom the payment is then
-    # paid out. In most cases your organisation will have a single "creditor", but
-    # the API also supports collecting payments on behalf of others.
+    # Each [payment](#core-endpoints-payments) taken through the API is linked to
+    # a "creditor", to whom the payment is then paid out. In most cases your
+    # organisation will have a single "creditor", but the API also supports
+    # collecting payments on behalf of others.
     #
-    #
-    # Please get in touch if you wish to use this endpoint. Currently, for Anti
-    # Money Laundering reasons, any creditors you add must be directly related to
-    # your organisation.
+    # Please get in touch if you
+    # wish to use this endpoint. Currently, for Anti Money Laundering reasons, any
+    # creditors you add must be directly related to your organisation.
     # Represents an instance of a creditor resource returned from the API
     class Creditor
       attr_reader :address_line1
@@ -44,7 +42,7 @@ module GoCardlessPro
       attr_reader :region
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @address_line1 = object['address_line1']
@@ -58,6 +56,11 @@ module GoCardlessPro
         @name = object['name']
         @postal_code = object['postal_code']
         @region = object['region']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has
@@ -67,9 +70,7 @@ module GoCardlessPro
 
             default_eur_payout_account: '',
 
-            default_gbp_payout_account: '',
-
-            logo: ''
+            default_gbp_payout_account: ''
 
           }.keys.sort
         ).new(*@links.sort.map(&:last))

data/lib/gocardless_pro/resources/creditor_bank_account.rb

@@ -12,16 +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](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-creditor).
-    # These are the bank accounts which your
-    # [payouts](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payouts)
-    # will be sent to.
+    # [creditor](#core-endpoints-creditor). 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
@@ -43,7 +42,7 @@ module GoCardlessPro
       attr_reader :metadata
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @account_holder_name = object['account_holder_name']
@@ -56,6 +55,11 @@ module GoCardlessPro
         @id = object['id']
         @links = object['links']
         @metadata = object['metadata']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/resources/customer.rb

@@ -13,9 +13,8 @@ module GoCardlessPro
   module Resources
     # Customer objects hold the contact details for a customer. A customer can
     # have several [customer bank
-    # accounts](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customer-bank-accounts),
-    # which in turn can have several Direct Debit
-    # [mandates](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates).
+    # accounts](#core-endpoints-customer-bank-accounts), which in turn can have
+    # several Direct Debit [mandates](#core-endpoints-mandates).
     # Represents an instance of a customer resource returned from the API
     class Customer
       attr_reader :address_line1
@@ -47,7 +46,7 @@ module GoCardlessPro
       attr_reader :region
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @address_line1 = object['address_line1']
@@ -64,6 +63,11 @@ module GoCardlessPro
         @metadata = object['metadata']
         @postal_code = object['postal_code']
         @region = object['region']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # Provides the resource as a hash of all it's readable attributes

data/lib/gocardless_pro/resources/customer_bank_account.rb

@@ -12,18 +12,15 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Customer Bank Accounts hold the bank details of a
-    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers).
-    # They always belong to a
-    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers),
-    # and may be linked to several Direct Debit
-    # [mandates](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates).
-
-    #  #
-    # Note that customer 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[customer_bank_account] in
-    # the error response.
+    # [customer](#core-endpoints-customers). They always belong to a
+    # [customer](#core-endpoints-customers), and may be linked to several Direct
+    # Debit [mandates](#core-endpoints-mandates).
+    #
+    # Note that customer 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[customer_bank_account] in the error response.
     # Represents an instance of a customer_bank_account resource returned from the API
     class CustomerBankAccount
       attr_reader :account_holder_name
@@ -45,7 +42,7 @@ module GoCardlessPro
       attr_reader :metadata
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @account_holder_name = object['account_holder_name']
@@ -58,6 +55,11 @@ module GoCardlessPro
         @id = object['id']
         @links = object['links']
         @metadata = object['metadata']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has