mangopay-v4 4.0.0

data/lib/mangopay/api/service/mandates.rb

@@ -0,0 +1,142 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +Mandate+ entity
+  module Mandates
+    class << self
+      include UriProvider
+
+      # Creates a new mandate entity.
+      #
+      # +Mandate+ properties:
+      # * Required
+      #   * bank_account_id
+      #   * culture
+      #   * return_url
+      # * Optional
+      #   * tag
+      #
+      # @param +mandate+ [Mandate] model object of mandate to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [Mandate] the newly-created Mandate entity object
+      def create(mandate, id_key = nil)
+        uri = provide_uri(:create_mandate)
+        response = HttpClient.post(uri, mandate, id_key)
+        parse response
+      end
+
+      # Retrieves a mandate entity.
+      #
+      # @param +id+ [String] ID of the mandate to retrieve
+      # @return [Mandate] the requested Mandate entity object
+      def get(id)
+        uri = provide_uri(:get_mandate, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Cancels a mandate.
+      #
+      # @param +id+ [String] ID of the mandate to cancel
+      # @return [Mandate] the updated Mandate entity object
+      def cancel(id)
+        uri = provide_uri(:cancel_mandate, id)
+        response = HttpClient.put(uri)
+        parse response
+      end
+
+      # Retrieves mandate entity pages. Allows configuration
+      # of paging and sorting parameters by yielding a filtering
+      # object to a provided block. When no filters are specified,
+      # will retrieve the first page of 10 newest results.
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      #
+      # @return [Array] array of hashed mandate entities corresponding
+      # to provided filters
+      def all
+        uri = provide_uri(:get_mandates)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of mandate entities belonging to a certain user.
+      # Allows configuration of paging and sorting parameters by yielding
+      # a filtering object to a provided block. When no filters are
+      # specified, will retrieve the first page of 10 newest results
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      #
+      # @param +id+ [String] ID of the user whose mandates to retrieve
+      # @return [Array] array of hashed mandate entities corresponding
+      # to provided filters
+      def of_user(id)
+        uri = provide_uri(:get_users_mandates, id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      # Retrieves pages of mandate entities belonging to a certain bank account.
+      # Allows configuration of paging and sorting parameters by yielding
+      # a filtering object to a provided block. When no filters are
+      # specified, will retrieve the first page of 10 newest results
+      #
+      # Allowed +FilterRequest+ params:
+      # * page
+      # * per_page
+      # * sort_field and sort_direction
+      # * before_date
+      # * after_date
+      #
+      # @param +user_id+ [String] ID of the user owning the bank account
+      # @param +account_id+ [String] ID of the bank account whose mandates
+      # to retrieve
+      # @return [Array] array of hashed mandate entities corresponding
+      # to provided filters
+      def of_bank_account(user_id, account_id)
+        uri = provide_uri(:get_accounts_mandates, user_id, account_id)
+        filter_request = nil
+        yield filter_request = FilterRequest.new if block_given?
+        results = HttpClient.get(uri, filter_request)
+        parse_results results
+      end
+
+      private
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # Mandate entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed Mandate entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # Mandate entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [Mandate] corresponding Mandate entity object
+      def parse(response)
+        MangoModel::Mandate.new.dejsonify response
+      end
+    end
+  end
+end

data/lib/mangopay/api/service/oauth_tokens.rb

@@ -0,0 +1,25 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates for OAuth authentication.
+  module OAuthTokens
+    class << self
+      include UriProvider
+
+      # Creates a new configuration-specific authorization token.
+      #
+      # @param +mangopay_config+ The MangoPay environment configuration
+      def create(mangopay_config)
+        uri = provide_uri(:create_token)
+        HttpClient.post_raw(uri) do |request|
+          config = mangopay_config
+          request.basic_auth config.client_id, config.client_passphrase
+          request.body = 'grant_type=client_credentials'
+          request.add_field('Content-Type',
+                            'application/x-www-form-urlencoded')
+        end
+      end
+    end
+  end
+end

data/lib/mangopay/api/service/pay_ins.rb

@@ -0,0 +1,260 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +PayIn+ entity
+  module PayIns
+    class << self
+      include UriProvider
+
+      # Creates a new pay-in entity of +PaymentType::CARD+
+      # and +ExecutionType::WEB+.
+      #
+      # +CardWebPayIn+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * fees
+      #   * return_url
+      #   * credited_wallet_id
+      #   * card_type
+      #   * culture
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #   * secure_mode
+      #   * template_url_options
+      #   * statement_descriptor
+      #
+      # @param +pay_in+ [CardWebPayIn] the pay-in data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [CardWebPayIn] the newly-created pay-in entity object
+      def create_card_web(pay_in, id_key = nil)
+        uri = provide_uri(:create_card_web_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Creates a new pay-in entity of +PaymentType::CARD+
+      # and +ExecutionType::DIRECT+.
+      #
+      # +CardDirectPayIn+ properties:
+      # * Required
+      #   * author_id
+      #   * credited_wallet_id
+      #   * debited_funds
+      #   * fees
+      #   * secure_mode_return_url
+      #   * card_id
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #   * secure_mode
+      #   * statement_descriptor
+      #
+      # @param +pay_in+ [CardDirectPayIn] the pay-in data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [CardDirectPayIn] the newly-created pay-in entity object
+      def create_card_direct(pay_in, id_key = nil)
+        uri = provide_uri(:create_card_direct_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Creates a new pay-in entity of +PaymentType::PREAUTHORIZED+
+      # and +ExecutionType::DIRECT+
+      #
+      # +CardPreAuthorizedPayIn+ properties:
+      # * Required
+      #   * author_id
+      #   * credited_wallet_id
+      #   * debited_funds
+      #   * fees
+      #   * preauthorization_id
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #
+      # @param +pay_in+ [CardPreAuthorizedPayIn] the pay-in data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [CardPreAuthorizedPayIn] the newly-created pay-in entity object
+      def create_card_pre_authorized(pay_in, id_key = nil)
+        uri = provide_uri(:create_card_pre_authorized_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Creates a new pay-in entity of +PaymentType::BANK_WIRE+
+      # and +ExecutionType::DIRECT+.
+      #
+      # +BankWireDirectPayIn+ properties:
+      # * Required
+      #   * author_id
+      #   * credited_wallet_id
+      #   * declared_debited_funds
+      #   * declared_fees
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #
+      # @param +pay_in+ [BankWireDirectPayIn] the pay-in data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [BankWireDirectPayIn] the newly-created pay-in entity object
+      def create_bank_wire_direct(pay_in, id_key = nil)
+        uri = provide_uri(:create_bank_wire_direct_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Creates a new pay-in entity of +PaymentType::BANK_WIRE+
+      # and +ExecutionType::DIRECT+. This method can be used
+      # to add funds to the environment's client's wallets.
+      #
+      # +BankWireDirectPayIn+ properties:
+      # * Required
+      #   * credited_wallet_id
+      #   * declared_debited_funds
+      #   * declared_fees
+      # * Optional
+      #   * tag
+      #
+      # @param +pay_in+ [BankWireDirectPayIn] the pay-in data model object
+      # Note: The ID field must contain one of the automatically-generated
+      # ClientWallet IDs specific to the current environment's client
+      # (+FUNDS_TYPE+ _ +CURRENCY+ - FEES_EUR, CREDIT_USD etc.)
+      # @param +id_key+ [String] idempotency key for future response replication
+      def create_client_bank_wire_direct(pay_in, id_key = nil)
+        uri = provide_uri(:create_client_bank_wire_direct_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Creates a new pay-in entity of +PaymentType::DIRECT_DEBIT+
+      # and +ExecutionType::WEB+.
+      #
+      # +DirectDebitWebPayIn+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * fees
+      #   * return_url
+      #   * credited_wallet_id
+      #   * direct_debit_type
+      #   * culture
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #   * secure_mode
+      #   * template_url_options
+      #
+      # @param +pay_in+ [DirectDebitWebPayIn] the pay-in data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [DirectDebitWebPayIn] the newly-created pay-in entity object
+      def create_direct_debit_web(pay_in, id_key = nil)
+        uri = provide_uri(:create_direct_debit_web_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Creates a new pay-in entity of +PaymentType::DIRECT_DEBIT+
+      # and +ExecutionType::DIRECT+.
+      #
+      # +DirectDebitDirectPayIn+ properties:
+      # * Required
+      #   * author_id
+      #   * credited_wallet_id
+      #   * debited_funds
+      #   * fees
+      #   * mandate_id
+      # * Optional
+      #   * tag
+      #   * credited_user_id
+      #   * statement_descriptor
+      #
+      # @param +pay_in+ [DirectDebitDirectPayIn] the pay-in data model object
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [DirectDebitDirectPayIn] the newly-created pay-in entity object
+      def create_direct_debit_direct(pay_in, id_key = nil)
+        uri = provide_uri(:create_direct_debit_direct_pay_in)
+        response = HttpClient.post(uri, pay_in, id_key)
+        parse response
+      end
+
+      # Retrieves a pay-in entity.
+      #
+      # @param +id+ [String] ID of the pay-in to be retrieved
+      # @return [PayIn] the requested entity object
+      def get(id)
+        uri = provide_uri(:get_pay_in, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      # Retrieves a detailed view of details concerning the
+      # card used to process a Web payment.
+      #
+      # @param +pay_in_id+ [String] ID of the Card Web Pay-In entity
+      # for which to retrieve extended details view
+      # @return [PayInWebExtendedView] Object containing extended
+      # details about the card
+      def extended_card_view(pay_in_id)
+        uri = provide_uri(:get_extended_card_view, pay_in_id)
+        response = HttpClient.get(uri)
+        parse_card_view response
+      end
+
+      private
+
+      # Parses an array of JSON-originating hashes into the corresponding
+      # PayIn entity objects.
+      #
+      # @param +results+ [Array] JSON-originating data hashes
+      # @return [Array] parsed PayIn entity objects
+      def parse_results(results)
+        results.collect do |entity|
+          parse entity
+        end
+      end
+
+      # Parses a JSON-originating hash into the corresponding
+      # PayIn entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [PayIn] corresponding PayIn entity object
+      def parse(response)
+        type = pay_in_type(response)
+        type.new.dejsonify response
+      end
+
+      # Asserts the type of pay-in represented by a hash
+      #
+      # @param +hash+ [Hash] source hash
+      # @return [Class] type of pay-in represented by the hash
+      def pay_in_type(hash)
+        if hash['PaymentType'] == MangoModel::PayInPaymentType::CARD.to_s\
+          && hash['ExecutionType'] == MangoModel::PayInExecutionType::WEB.to_s
+          MangoModel::CardWebPayIn
+        elsif hash['PaymentType'] == MangoModel::PayInPaymentType::CARD.to_s\
+          && hash['ExecutionType'] == MangoModel::PayInExecutionType::DIRECT.to_s
+          MangoModel::CardDirectPayIn
+        elsif hash['PaymentType'] == MangoModel::PayInPaymentType::PREAUTHORIZED.to_s\
+          && hash['ExecutionType'] == MangoModel::PayInExecutionType::DIRECT.to_s
+          MangoModel::CardPreAuthorizedPayIn
+        elsif hash['PaymentType'] == MangoModel::PayInPaymentType::BANK_WIRE.to_s\
+        && hash['ExecutionType'] == MangoModel::PayInExecutionType::DIRECT.to_s
+          MangoModel::BankWireDirectPayIn
+        elsif hash['PaymentType'] == MangoModel::PayInPaymentType::DIRECT_DEBIT.to_s\
+        && hash['ExecutionType'] == MangoModel::PayInExecutionType::WEB.to_s
+          MangoModel::DirectDebitWebPayIn
+        elsif hash['PaymentType'] == MangoModel::PayInPaymentType::DIRECT_DEBIT.to_s\
+        && hash['ExecutionType'] == MangoModel::PayInExecutionType::DIRECT.to_s
+          MangoModel::DirectDebitDirectPayIn
+        end
+      end
+
+      def parse_card_view(response)
+        MangoModel::PayInWebExtendedView.new.dejsonify response
+      end
+    end
+  end
+end

data/lib/mangopay/api/service/pay_outs.rb

@@ -0,0 +1,54 @@
+require_relative '../uri_provider'
+
+module MangoApi
+
+  # Provides API method delegates concerning the +PayOut+ entity
+  module PayOuts
+    class << self
+      include UriProvider
+
+      # Creates a new pay-out entity.
+      #
+      # +PayOut+ properties:
+      # * Required
+      #   * author_id
+      #   * debited_funds
+      #   * fees
+      #   * bank_account_id
+      #   * debited_wallet_id
+      # * Optional
+      #   * tag
+      #   * bank_wire_ref
+      #
+      # @param +pay_out+ [PayOut] model object of the pay-out to be created
+      # @param +id_key+ [String] idempotency key for future response replication
+      # @return [PayOut] the newly-created PayOut entity object
+      def create(pay_out, id_key = nil)
+        uri = provide_uri(:create_pay_out)
+        response = HttpClient.post(uri, pay_out, id_key)
+        parse response
+      end
+
+      # Retrieves a pay-out entity.
+      #
+      # @param +id+ [String] ID of the pay-out to retrieve
+      # @return [PayOut] the requested PayOut entity object
+      def get(id)
+        uri = provide_uri(:get_pay_out, id)
+        response = HttpClient.get(uri)
+        parse response
+      end
+
+      private
+
+      # Parses a JSON-originating hash into the corresponding
+      # PayOut entity object.
+      #
+      # @param +response+ [Hash] JSON-originating data hash
+      # @return [PayOut] corresponding PayOut entity object
+      def parse(response)
+        MangoModel::PayOut.new.dejsonify response
+      end
+    end
+  end
+end