gocardless_pro 0.3.0 → 1.0.0

data/lib/gocardless_pro/resources/event.rb

@@ -29,7 +29,7 @@ module GoCardlessPro
       attr_reader :resource_type
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @action = object['action']
@@ -39,6 +39,11 @@ module GoCardlessPro
         @links = object['links']
         @metadata = object['metadata']
         @resource_type = object['resource_type']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/resources/mandate.rb

@@ -12,12 +12,10 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Mandates represent the Direct Debit mandate with a
-    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers).
-
-    #  #
-    # GoCardless will notify you via a
-    # [webhook](https://developer.gocardless.com/pro/2015-04-29/#webhooks)
-    # whenever the status of a mandate changes.
+    # [customer](#core-endpoints-customers).
+    #
+    # GoCardless will notify you
+    # via a [webhook](#webhooks) whenever the status of a mandate changes.
     # Represents an instance of a mandate resource returned from the API
     class Mandate
       attr_reader :created_at
@@ -35,7 +33,7 @@ module GoCardlessPro
       attr_reader :status
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @created_at = object['created_at']
@@ -46,6 +44,11 @@ module GoCardlessPro
         @reference = object['reference']
         @scheme = object['scheme']
         @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/resources/mandate_pdf.rb

@@ -0,0 +1,42 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+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
+    # customers.
+    # Represents an instance of a mandate_pdf resource returned from the API
+    class MandatePdf
+      attr_reader :expires_at
+
+      attr_reader :url
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @expires_at = object['expires_at']
+        @url = object['url']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the resource as a hash of all it's readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payment.rb

@@ -12,16 +12,12 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Payment objects represent payments from a
-    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers)
-    # to a
-    # [creditor](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-creditors),
-    # taken against a Direct Debit
-    # [mandate](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-mandates).
-
-    #  #
-    # GoCardless will notify you via a
-    # [webhook](https://developer.gocardless.com/pro/2015-04-29/#webhooks)
-    # whenever the state of a payment changes.
+    # [customer](#core-endpoints-customers) to a
+    # [creditor](#core-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.
     # Represents an instance of a payment resource returned from the API
     class Payment
       attr_reader :amount
@@ -45,7 +41,7 @@ module GoCardlessPro
       attr_reader :status
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @amount = object['amount']
@@ -59,6 +55,11 @@ module GoCardlessPro
         @metadata = object['metadata']
         @reference = object['reference']
         @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/resources/payout.rb

@@ -12,11 +12,9 @@ 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](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-creditors).
-    # Each payout contains the funds collected from one or many
-    # [payments](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments).
-    # Payouts are created automatically after a payment has been successfully
-    # collected.
+    # [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.
     # Represents an instance of a payout resource returned from the API
     class Payout
       attr_reader :amount
@@ -32,7 +30,7 @@ module GoCardlessPro
       attr_reader :status
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @amount = object['amount']
@@ -42,6 +40,11 @@ module GoCardlessPro
         @links = object['links']
         @reference = object['reference']
         @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -11,14 +11,15 @@ require 'uri'
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
-    # Redirect flows enable you to use GoCardless Pro's secure payment pages to
-    # set up mandates with your customers.
+    # Redirect flows enable you to use GoCardless Pro's [hosted payment
+    # pages](https://pay-sandbox.gocardless.com/AL000000AKFPFF) to set up mandates
+    # with your customers. These pages are fully compliant and have been
+    # translated into Dutch, French, German, Italian, Portuguese and Spanish.
     #
-    # The overall flow is:
     #
+    # The overall flow is:
     #
-    # 1. You
-    # [create](https://developer.gocardless.com/pro/2015-04-29/#create-a-redirect-flow)
+    # 1. You [create](#create-a-redirect-flow)
     # a redirect flow for your customer, and redirect them to the returned
     # redirect url, e.g. `https://pay.gocardless.com/flow/RE123`.
     #
@@ -28,32 +29,20 @@ module GoCardlessPro
     # back to your `success_redirect_url` with `redirect_flow_id=RE123` in the
     # querystring.
     #
-    # 3. You
-    # [complete](https://developer.gocardless.com/pro/2015-04-29/#complete-a-redirect-flow)
-    # the redirect flow, which 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),
-    # and returns the ID of the mandate. You may wish to create a
-    # [subscription](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-subscriptions)
-    # or
-    # [payment](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments)
-    # at this point.
-    #
-    # It is recommended that you link the redirect flow to
-    # your user object as soon as it is created, and attach the created resources
-    # to that user in the complete step.
+    # 3. You [complete](#complete-a-redirect-flow) the
+    # redirect flow, which creates a [customer](#core-endpoints-customers),
+    # [customer bank account](#core-endpoints-customer-bank-accounts), and
+    # [mandate](#core-endpoints-mandates), and returns the ID of the mandate. You
+    # may wish to create a [subscription](#core-endpoints-subscriptions) or
+    # [payment](#core-endpoints-payments) at this point.
     #
-    # Redirect flows expire 30 minutes
-    # after they are first created. You cannot
-    # [complete](https://developer.gocardless.com/pro/2015-04-29/#complete-a-redirect-flow)
-    # an expired redirect flow.
+    # It is
+    # recommended that you link the redirect flow to your user object as soon as
+    # it is created, and attach the created resources to that user in the complete
+    # step.
     #
-    # [View an example
-    # integration](https://pay-sandbox.gocardless.com/AL000000AKFPFF) that uses
-    # redirect flows.
+    # Redirect flows expire 30 minutes after they are first
+    # created. You cannot complete an expired redirect flow.
     # Represents an instance of a redirect_flow resource returned from the API
     class RedirectFlow
       attr_reader :created_at
@@ -71,7 +60,7 @@ module GoCardlessPro
       attr_reader :success_redirect_url
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @created_at = object['created_at']
@@ -82,6 +71,11 @@ module GoCardlessPro
         @scheme = object['scheme']
         @session_token = object['session_token']
         @success_redirect_url = object['success_redirect_url']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/resources/refund.rb

@@ -12,21 +12,16 @@ module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
     # Refund objects represent (partial) refunds of a
-    # [payment](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payment)
-    # back to the
-    # [customer](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-customers).
-
-    #  #
-    # The API allows you to create, show, list and update your refunds.
-
-    # #
-    # GoCardless will notify you via a
-    # [webhook](https://developer.gocardless.com/pro/2015-04-29/#webhooks)
-    # whenever a refund is created, and will update the `amount_refunded` property
-    # of the payment.
+    # [payment](#core-endpoints-payment) back to the
+    # [customer](#core-endpoints-customers).
+    #
+    # GoCardless will notify you
+    # via a [webhook](#webhooks) whenever a refund is created, and will update the
+    # `amount_refunded` property of the payment.
     #
-    # _Note:_ A payment that has been (partially)
-    # refunded can still receive a late failure or chargeback from the banks.
+    # _Note:_ A payment that
+    # has been (partially) refunded can still receive a late failure or chargeback
+    # from the banks.
     # Represents an instance of a refund resource returned from the API
     class Refund
       attr_reader :amount
@@ -40,7 +35,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
 
         @amount = object['amount']
@@ -49,6 +44,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/subscription.rb

@@ -11,27 +11,26 @@ require 'uri'
 module GoCardlessPro
   # A module containing classes for each of the resources in the GC Api
   module Resources
-    # Subscriptions create
-    # [payments](https://developer.gocardless.com/pro/2015-04-29/#api-endpoints-payments)
-    # according to a schedule.
+    # Subscriptions create [payments](#core-endpoints-payments) according to a
+    # schedule.
     #
     # #### Recurrence Rules
     #
-    # The
-    # following rules apply when specifying recurrence:
-    # - The first payment
-    # must be charged within 1 year.
-    # - When neither `month` nor `day_of_month`
-    # are present, the subscription will recur from the `start_at` based on the
-    # `interval_unit`.
-    # - If `month` or `day_of_month` are present, the
-    # recurrence rules will be applied from the `start_at`, and the following
-    # validations apply:
+    # The following rules apply
+    # when specifying recurrence:
+    # - The first payment must be charged within 1
+    # year.
+    # - When neither `month` nor `day_of_month` are present, the
+    # subscription will recur from the `start_date` based on the `interval_unit`.
+
+    #  # - If `month` or `day_of_month` are present, the recurrence rules will be
+    # applied from the `start_date`, and the following validations apply:
     #
-    # | interval_unit   | month
-    #                   | day_of_month                            |
-    # |
-    # :-------------- | :--------------------------------------------- |
+    #
+    # | interval_unit   | month                                          |
+    # day_of_month                            |
+    # | :-------------- |
+    # :--------------------------------------------- |
     # :-------------------------------------- |
     # | yearly          | optional
     # (required if `day_of_month` provided) | optional (required if `month`
@@ -90,7 +89,7 @@ module GoCardlessPro
 
       attr_reader :day_of_month
 
-      attr_reader :end_at
+      attr_reader :end_date
 
       attr_reader :id
 
@@ -106,14 +105,14 @@ module GoCardlessPro
 
       attr_reader :payment_reference
 
-      attr_reader :start_at
+      attr_reader :start_date
 
       attr_reader :status
 
       attr_reader :upcoming_payments
       # initialize a resource instance
       # @param object [Hash] an object returned from the API
-      def initialize(object)
+      def initialize(object, response = nil)
         @object = object
 
         @amount = object['amount']
@@ -121,7 +120,7 @@ module GoCardlessPro
         @created_at = object['created_at']
         @currency = object['currency']
         @day_of_month = object['day_of_month']
-        @end_at = object['end_at']
+        @end_date = object['end_date']
         @id = object['id']
         @interval = object['interval']
         @interval_unit = object['interval_unit']
@@ -130,9 +129,14 @@ module GoCardlessPro
         @month = object['month']
         @name = object['name']
         @payment_reference = object['payment_reference']
-        @start_at = object['start_at']
+        @start_date = object['start_date']
         @status = object['status']
         @upcoming_payments = object['upcoming_payments']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
       end
 
       # return the links that the resource has

data/lib/gocardless_pro/response.rb

@@ -1,6 +1,11 @@
 module GoCardlessPro
   # A class to wrap an API response
   class Response
+    extend Forwardable
+
+    def_delegator :@response, :headers
+    def_delegator :@response, :status, :status_code
+
     # Initialize a response instance
     # @param response an API response
     def initialize(response)

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -0,0 +1,55 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the BankDetailsLookup endpoints
+    class BankDetailsLookupsService < BaseService
+      # Performs a bank details lookup.
+      #
+      # Bank account details may be supplied
+      # using [local details](#appendix-local-bank-details) or an IBAN.
+      # Example URL: /bank_details_lookups
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/bank_details_lookups'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::BankDetailsLookup.new(unenvelope_body(response.body), response)
+      end
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      private
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'bank_details_lookups'
+      end
+
+      # take a URL with placeholder params and substitute them out for the acutal value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", value)
+        end
+      end
+    end
+  end
+end