gocardless-pro 0.1.0

data/lib/gocardless-pro/resources/user.rb

@@ -0,0 +1,60 @@
+
+
+# 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
+    #
+    # Represents an instance of a user resource returned from the API
+    class User
+      attr_reader :created_at
+
+      attr_reader :email
+
+      attr_reader :enabled
+
+      attr_reader :family_name
+
+      attr_reader :given_name
+
+      attr_reader :id
+
+      # initialize a resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object)
+        @object = object
+
+        @created_at = object['created_at']
+        @email = object['email']
+        @enabled = object['enabled']
+        @family_name = object['family_name']
+        @given_name = object['given_name']
+        @id = object['id']
+        @links = object['links']
+      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/response.rb

@@ -0,0 +1,77 @@
+module GoCardless
+  # 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).with_indifferent_access
+    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: GoCardless::ValidationError,
+        gocardless: GoCardless::GoCardlessError,
+        invalid_api_usage: GoCardless::InvalidApiUsageError,
+        invalid_state: GoCardless::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/api_key_service.rb

@@ -0,0 +1,130 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the ApiKey endpoints
+    class ApiKeyService < BaseService
+      # Creates a new API key.
+      # Example URL: /api_keys
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/api_keys'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::ApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your API keys.
+      # Example URL: /api_keys
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/api_keys'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::ApiKey
+        )
+      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: '/api_keys',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing API key.
+      # Example URL: /api_keys/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "AK"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/api_keys/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::ApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Updates an API key. Only the `name` and `webhook_url` fields are supported.
+      # Example URL: /api_keys/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "AK"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/api_keys/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::ApiKey.new(unenvelope_body(response.body))
+      end
+
+      # Disables an API key. Once disabled, the API key will not be usable to
+      # authenticate any requests, and its `webhook_url` will not receive any more
+      # events.
+      # Example URL: /api_keys/:identity/actions/disable
+      #
+      # @param identity       # Unique identifier, beginning with "AK"
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def disable(identity, options = {}, custom_headers = {})
+        path = sub_url('/api_keys/:identity/actions/disable',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::ApiKey.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
+        'api_keys'
+      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

data/lib/gocardless-pro/services/base_service.rb

@@ -0,0 +1,29 @@
+module GoCardless
+  # 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 [GoCardless::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
+      # @param custom_headers [Hash] a hash of custom headers to use in the request
+      def make_request(method, path, options = {}, custom_headers = {})
+        @api_service.make_request(method, path, options.merge(envelope_key: envelope_key), custom_headers)
+      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_account_service.rb

@@ -0,0 +1,122 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the CreditorBankAccount endpoints
+    class CreditorBankAccountService < BaseService
+      # Creates a new creditor bank account object.
+      #
+      # Bank account details may be
+      # supplied using the IBAN (international bank account number) or [local
+      # details](#ui-compliance-local-bank-details).
+      # Example URL: /creditor_bank_accounts
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/creditor_bank_accounts'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::CreditorBankAccount.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your creditor bank accounts.
+      # Example URL: /creditor_bank_accounts
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/creditor_bank_accounts'
+
+        response = make_request(:get, path, options, custom_headers)
+        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
+        ).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. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/creditor_bank_accounts/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        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. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def disable(identity, options = {}, custom_headers = {})
+        path = sub_url('/creditor_bank_accounts/:identity/actions/disable',           'identity' => identity)
+
+        new_options = {}
+        new_options['data'] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        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

data/lib/gocardless-pro/services/creditor_service.rb

@@ -0,0 +1,112 @@
+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 GoCardless
+  module Services
+    # Service for making requests to the Creditor endpoints
+    class CreditorService < BaseService
+      # Creates a new creditor.
+      # Example URL: /creditors
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def create(options = {}, custom_headers = {})
+        path = '/creditors'
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:post, path, options, custom_headers)
+
+        Resources::Creditor.new(unenvelope_body(response.body))
+      end
+
+      # Returns a
+      # [cursor-paginated](https://developer.gocardless.com/pro/#overview-cursor-pagination)
+      # list of your creditors.
+      # Example URL: /creditors
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def list(options = {}, custom_headers = {})
+        path = '/creditors'
+
+        response = make_request(:get, path, options, custom_headers)
+        ListResponse.new(
+          raw_response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Creditor
+        )
+      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: '/creditors',
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of an existing creditor.
+      # Example URL: /creditors/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "CR".
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def get(identity, options = {}, custom_headers = {})
+        path = sub_url('/creditors/:identity',           'identity' => identity)
+
+        response = make_request(:get, path, options, custom_headers)
+
+        Resources::Creditor.new(unenvelope_body(response.body))
+      end
+
+      # Updates a creditor object. Supports all of the fields supported when creating
+      # a creditor.
+      # Example URL: /creditors/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "CR".
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Else, they will be the body of the request.
+      def update(identity, options = {}, custom_headers = {})
+        path = sub_url('/creditors/:identity',           'identity' => identity)
+
+        new_options = {}
+        new_options[envelope_key] = options
+        options = new_options
+        response = make_request(:put, path, options, custom_headers)
+
+        Resources::Creditor.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
+        'creditors'
+      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