gocardless_pro 0.3.0

data/lib/gocardless_pro/resources/refund.rb

@@ -0,0 +1,71 @@
+
+
+# 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
+    # 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.
+    #
+    # _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
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :id
+
+      attr_reader :metadata
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @amount = object['amount']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            payment: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      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/subscription.rb

@@ -0,0 +1,155 @@
+
+
+# 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
+    # Subscriptions create
+    # [payments](https://developer.gocardless.com/pro/2015-04-29/#api-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:
+    #
+    # | interval_unit   | month
+    #                   | day_of_month                            |
+    # |
+    # :-------------- | :--------------------------------------------- |
+    # :-------------------------------------- |
+    # | yearly          | optional
+    # (required if `day_of_month` provided) | optional (required if `month`
+    # provided) |
+    # | monthly         | invalid
+    #       | required                                |
+    # | weekly          |
+    # invalid                                        | invalid
+    #             |
+    #
+    # Examples:
+    #
+    # | interval_unit   | interval   |
+    # month   | day_of_month   | valid?
+    #  |
+    # | :-------------- | :--------- | :------ | :------------- |
+    # :------------------------------------------------- |
+    # | yearly          |
+    # 1          | january | -1             | valid
+    #               |
+    # | yearly          | 1          | march   |
+    #  | invalid - missing `day_of_month`                   |
+    # | monthly
+    #  | 6          |         | 12             | valid
+    #                  |
+    # | monthly         | 6          | august  | 12
+    #     | invalid - `month` must be blank                    |
+    # | weekly
+    #     | 2          |         |                | valid
+    #                     |
+    # | weekly          | 2          | october | 10
+    #        | invalid - `month` and `day_of_month` must be blank |
+    #
+    # ####
+    # Rolling dates
+    #
+    # When a charge date falls on a non-business day, one
+    # of two things will happen:
+    #
+    # - if the recurrence rule specified `-1`
+    # as the `day_of_month`, the charge date will be rolled __backwards__ to the
+    # previous business day (i.e., the last working day of the month).
+    # -
+    # otherwise the charge date will be rolled __forwards__ to the next business
+    # day.
+    #
+    # Represents an instance of a subscription resource returned from the API
+    class Subscription
+      attr_reader :amount
+
+      attr_reader :count
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :day_of_month
+
+      attr_reader :end_at
+
+      attr_reader :id
+
+      attr_reader :interval
+
+      attr_reader :interval_unit
+
+      attr_reader :metadata
+
+      attr_reader :month
+
+      attr_reader :name
+
+      attr_reader :payment_reference
+
+      attr_reader :start_at
+
+      attr_reader :status
+
+      attr_reader :upcoming_payments
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @amount = object['amount']
+        @count = object['count']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @day_of_month = object['day_of_month']
+        @end_at = object['end_at']
+        @id = object['id']
+        @interval = object['interval']
+        @interval_unit = object['interval_unit']
+        @links = object['links']
+        @metadata = object['metadata']
+        @month = object['month']
+        @name = object['name']
+        @payment_reference = object['payment_reference']
+        @start_at = object['start_at']
+        @status = object['status']
+        @upcoming_payments = object['upcoming_payments']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            mandate: ''
+
+          }.keys.sort
+        ).new(*@links.sort.map(&:last))
+      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/response.rb

@@ -0,0 +1,77 @@
+module GoCardlessPro
+  # A class to wrap an API response
+  class Response
+    # Initialize a response instance
+    # @param response an API response
+    def initialize(response)
+      @response = response
+    end
+
+    # Return the body of the API response
+    def body
+      json? ? handle_json : handle_raw
+    end
+
+    # Returns true if the response is JSON
+    def json?
+      content_type = @response.headers['Content-Type'] ||
+                     @response.headers['content-type'] || ''
+      content_type.include?('application/json')
+    end
+
+    # Returns true if the response is an error
+    def error?
+      @response.status >= 400
+    end
+
+    # Returns the meta hash of the response
+    def meta
+      fail ResponseError, 'Cannot fetch meta for non JSON response' unless json?
+
+      json_body.fetch('meta', {})
+    end
+
+    # Returns the limit parameter from the response
+    def limit
+      meta.fetch('limit', nil)
+    end
+
+    private
+
+    def json_body
+      @json_body ||= JSON.parse(@response.body) unless @response.body.empty?
+    end
+
+    def raw_body
+      @response.body
+    end
+
+    def handle_json
+      if error?
+        type = json_body['error']['type']
+        fail(error_class_for_type(type), json_body['error'])
+      else
+        json_body
+      end
+    end
+
+    def error_class_for_type(type)
+      {
+        validation_failed: GoCardlessPro::ValidationError,
+        gocardless: GoCardlessPro::GoCardlessError,
+        invalid_api_usage: GoCardlessPro::InvalidApiUsageError,
+        invalid_state: GoCardlessPro::InvalidStateError
+      }.fetch(type.to_sym)
+    end
+
+    def handle_raw
+      default_raw_message = {
+        'message' => "Something went wrong with this raw request\n" \
+        "status: #{@response.status}\n" \
+        "headers: #{@response.headers}\n" \
+        "body: #{@response.body}"
+      }
+      error? ? fail(ApiError, default_raw_message) : raw_body
+    end
+  end
+end

data/lib/gocardless_pro/services/base_service.rb

@@ -0,0 +1,28 @@
+module GoCardlessPro
+  # Module that contains all services for making requests to the API.
+  module Services
+    # Base Service that all services inherit from.
+    class BaseService
+      # Create a new service instance to make requests against
+      #
+      # @param api_service [GoCardlessPro::ApiService}}] an instance of the ApiService
+      def initialize(api_service)
+        @api_service = api_service
+      end
+
+      # Make a request to the API using the API service instance
+      #
+      # @param method [Symbol] the method to use to make the request
+      # @param path [String] the URL (without the base domain) to make the request to
+      # @param options [Hash] the options hash - either the query parameters for a GET, or the body if POST/PUT
+      def make_request(method, path, options = {})
+        @api_service.make_request(method, path, options.merge(envelope_key: envelope_key))
+      end
+
+      # Get the envelope key for the given service. Children are expected to implement this method.
+      def envelope_key
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb

@@ -0,0 +1,119 @@
+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 CreditorBankAccount endpoints
+    class CreditorBankAccountsService < BaseService
+      # Creates a new creditor bank account object.
+      # Example URL: /creditor_bank_accounts
+      # @param options [Hash] parameters as a hash, under a params key.
+      def create(options = {})
+        path = '/creditor_bank_accounts'
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/2015-04-29/#overview-cursor-pagination)
+      # list of your creditor bank accounts.
+      # Example URL: /creditor_bank_accounts
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/creditor_bank_accounts'
+
+        response = make_request(:get, path, options)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::CreditorBankAccount
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          path: '/creditor_bank_accounts',
+          options: options,
+          resource_class: Resources::CreditorBankAccount
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing creditor bank account.
+      # Example URL: /creditor_bank_accounts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "BA"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/creditor_bank_accounts/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+      end
+
+      # Immediately disables the bank account, no money can be paid out to a disabled
+      # account.
+      #
+      # This will return a `disable_failed` error if the bank account
+      # has already been disabled.
+      #
+      # A disabled bank account can be re-enabled by
+      # creating a new bank account resource with the same details.
+      # Example URL: /creditor_bank_accounts/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "BA"
+      # @param options [Hash] parameters as a hash, under a params key.
+      def disable(identity, options = {})
+        path = sub_url('/creditor_bank_accounts/:identity/actions/disable',           'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+      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
+        'creditor_bank_accounts'
+      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