gocardless-pro 0.1.0

data/lib/gocardless-pro/api_service.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+require 'base64'
+
+module GoCardless
+  # GoCardless Enterprise API
+  class ApiService
+    # Initialize an APIService
+    #
+    # @param url [String] the URL to make requests to
+    # @param key [String] the API Key ID to use
+    # @param secret [String] the API key secret to use
+    # @param options [Hash] additional options to use when creating the service
+    def initialize(url, key, secret, options = {})
+      @url = url
+      root_url, @path_prefix = unpack_url(url)
+      http_adapter = options[:http_adapter] || [:net_http]
+      @connection = Faraday.new(url: root_url) do |faraday|
+        faraday.adapter(*http_adapter)
+      end
+
+      @headers = options[:default_headers] || {}
+      @headers['Authorization'] = 'Basic ' + Base64.strict_encode64("#{key}:#{secret}")
+    end
+
+    # Make a request to the API
+    #
+    # @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
+    # @param custom_headers [Hash] a hash of custom headers to use in the request
+    def make_request(method, path, options = {}, custom_headers = {})
+      fail ArgumentError, 'options must be a hash' unless options.is_a?(Hash)
+      Request.new(@connection, method, @path_prefix + path, options, @headers.merge(custom_headers)).request
+    end
+
+    # inspect the API Service
+    def inspect
+      url = URI.parse(@url)
+      url.password = 'REDACTED' unless url.password.nil?
+      "#<GoCardless::Client url=\"#{url}\">"
+    end
+    alias_method :to_s, :inspect
+
+    private
+
+    def unpack_url(url)
+      path = URI.parse(url).path
+      [URI.join(url).to_s, path == '/' ? '' : path]
+    end
+  end
+end

data/lib/gocardless-pro/error.rb

@@ -0,0 +1,42 @@
+module GoCardless
+  # A class to represent an API Error
+  class Error < StandardError
+    attr_reader :error
+
+    # intialize a new error
+    #  @param error the error from the API
+    def initialize(error)
+      @error = error
+    end
+
+    # access the documentation_url from the response
+    def documentation_url
+      @error['documentation_url']
+    end
+
+    # access the message from the response
+    def message
+      @error['message']
+    end
+
+    # access the type from the response
+    def type
+      @error['type']
+    end
+
+    # access the code from the response
+    def code
+      @error['code']
+    end
+
+    # access the request_id from the response
+    def request_id
+      @error['request_id']
+    end
+
+    # access the errors from the response
+    def errors
+      @error['errors']
+    end
+  end
+end

data/lib/gocardless-pro/error/gocardless_error.rb

@@ -0,0 +1,5 @@
+module GoCardless
+  # Thrown when the API returns a GoCardlessError
+  class GoCardlessError < Error
+  end
+end

data/lib/gocardless-pro/error/invalid_api_usage_error.rb

@@ -0,0 +1,5 @@
+module GoCardless
+  # Thrown when the API returns an invalid usage error
+  class InvalidApiUsageError < Error
+  end
+end

data/lib/gocardless-pro/error/invalid_state_error.rb

@@ -0,0 +1,5 @@
+module GoCardless
+  # Thrown when the API returns an invalid state error
+  class InvalidStateError < Error
+  end
+end

data/lib/gocardless-pro/error/validation_error.rb

@@ -0,0 +1,5 @@
+module GoCardless
+  # Thrown when the API returns a validation error
+  class ValidationError < Error
+  end
+end

data/lib/gocardless-pro/list_response.rb

@@ -0,0 +1,34 @@
+module GoCardless
+  # Wraps a response from an API LIST endpoint
+  class ListResponse
+    include Enumerable
+
+    # Initialize a list response
+    # @param options [Hash]
+    # @option option :raw_response the raw API response
+    # @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)
+      @resource_class = options.fetch(:resource_class)
+      @unenveloped_body = options.fetch(:unenveloped_body)
+
+      @items = @unenveloped_body.map { |item| @resource_class.new(item) }
+    end
+
+    # iterate over all the response items
+    def each(&block)
+      @items.each(&block)
+    end
+
+    # return the before cursor for paginating
+    def before
+      @raw_response.body[:meta][:cursors][:before]
+    end
+
+    # return the after cursor for paginating
+    def after
+      @raw_response.body[:meta][:cursors][:after]
+    end
+  end
+end

data/lib/gocardless-pro/paginator.rb

@@ -0,0 +1,37 @@
+module GoCardless
+  # A class that can take an API LIST query and auto paginate through results
+  class Paginator
+    # initialize a paginator
+    # @param options [Hash]
+    # @option options :service the service class to use to make requests to
+    # @option options :path the path to make the request to
+    # @option options :options additional options to send with the requests
+    def initialize(options = {})
+      @service = options.fetch(:service)
+      @path = options.fetch(:path)
+      @options = options.fetch(:options)
+    end
+
+    # Get a lazy enumerable for listing data from the API
+    def enumerator
+      response = get_initial_response
+      Enumerator.new do |yielder|
+        loop do
+          items = @service.unenvelope_body(response.body)
+          items.each { |item| yielder << item }
+
+          after_cursor = response.meta['cursors']['after']
+          break if after_cursor.nil?
+
+          response = @service.make_request(:get, @path, @options.merge(after: after_cursor))
+        end
+      end.lazy
+    end
+
+    private
+
+    def get_initial_response
+      @initial_response ||= @service.make_request(:get, @path, @options)
+    end
+  end
+end

data/lib/gocardless-pro/request.rb

@@ -0,0 +1,69 @@
+module GoCardless
+  # A class that wraps an API request
+  class Request
+    # Initialize a request class, which makes calls to the API
+    # @param connection
+    # @param method [Symbol] the method to make the request with
+    # @param path [String] the path to make the request to
+    # @param options [hash] options for the request
+    # @param headers [hash] headers to send with the request
+    def initialize(connection, method, path, options, headers)
+      @connection = connection
+      @method = method
+      @path = path
+      @headers = headers || {}
+      @envelope_name = options.delete(:envelope_key)
+      @given_options = options
+
+      @request_body = request_body
+
+      if @request_body.is_a?(Hash)
+        @request_body = @request_body.to_json
+        @headers['Content-Type'] ||= 'application/json'
+      end
+    end
+
+    # Make the request and wrap it in a Response object
+    def request
+      Response.new(make_request)
+    end
+
+    # Make the API request
+    def make_request
+      @connection.send(@method) do |request|
+        request.url @path
+        request.body = @request_body
+        request.params = request_query
+        request.headers.merge!(@headers)
+      end
+    end
+
+    # Fetch the body to send with the request
+    def request_body
+      if @method == :get
+        nil
+      elsif @method == :post || @method == :put
+        @given_options
+      else
+        fail "unknown method #{@method}"
+      end
+    end
+
+    # Get the query params to send with the request
+    def request_query
+      if @method == :get
+        @given_options
+      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/api_key.rb

@@ -0,0 +1,62 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # <a name="api_key_not_active"></a>API keys are designed to be used by any
+    # integrations you build. You should generate a key and then use it to make
+    # requests to the API and set the webhook URL for that integration. They do
+    # not expire, but can be disabled.
+    # Represents an instance of a api_key resource returned from the API
+    class ApiKey
+      attr_reader :created_at
+
+      attr_reader :enabled
+
+      attr_reader :id
+
+      attr_reader :key
+
+      attr_reader :name
+
+      attr_reader :webhook_url
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @created_at = object['created_at']
+        @enabled = object['enabled']
+        @id = object['id']
+        @key = object['key']
+        @links = object['links']
+        @name = object['name']
+        @webhook_url = object['webhook_url']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            role: ''
+
+          }.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/creditor.rb

@@ -0,0 +1,83 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Each [payment](https://developer.gocardless.com/pro/#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.
+    #
+    #
+    # 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
+
+      attr_reader :address_line2
+
+      attr_reader :address_line3
+
+      attr_reader :city
+
+      attr_reader :country_code
+
+      attr_reader :created_at
+
+      attr_reader :id
+
+      attr_reader :name
+
+      attr_reader :postal_code
+
+      attr_reader :region
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @address_line1 = object['address_line1']
+        @address_line2 = object['address_line2']
+        @address_line3 = object['address_line3']
+        @city = object['city']
+        @country_code = object['country_code']
+        @created_at = object['created_at']
+        @id = object['id']
+        @links = object['links']
+        @name = object['name']
+        @postal_code = object['postal_code']
+        @region = object['region']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            default_eur_payout_account: '',
+
+            default_gbp_payout_account: '',
+
+            logo: ''
+
+          }.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/creditor_bank_account.rb

@@ -0,0 +1,78 @@
+
+
+# encoding: utf-8
+#
+# WARNING: Do not edit by hand, this file was generated by Crank:
+#
+#   https://github.com/gocardless/crank
+#
+require 'uri'
+
+module GoCardless
+  # 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/#api-endpoints-creditor).
+    # These are the bank accounts which your
+    # [payouts](https://developer.gocardless.com/pro/#api-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.
+    # Represents an instance of a creditor_bank_account resource returned from the API
+    class CreditorBankAccount
+      attr_reader :account_holder_name
+
+      attr_reader :account_number_ending
+
+      attr_reader :bank_name
+
+      attr_reader :country_code
+
+      attr_reader :created_at
+
+      attr_reader :currency
+
+      attr_reader :enabled
+
+      attr_reader :id
+
+      attr_reader :metadata
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @account_holder_name = object['account_holder_name']
+        @account_number_ending = object['account_number_ending']
+        @bank_name = object['bank_name']
+        @country_code = object['country_code']
+        @created_at = object['created_at']
+        @currency = object['currency']
+        @enabled = object['enabled']
+        @id = object['id']
+        @links = object['links']
+        @metadata = object['metadata']
+      end
+
+      # return the links that the resource has
+      def links
+        Struct.new(
+          *{
+
+            creditor: ''
+
+          }.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