mangopay-v4 4.0.0

data/lib/mangopay/common/log_provider.rb

@@ -0,0 +1,34 @@
+require_relative '../util/custom_logger'
+require_relative '../util/void_logger'
+require_relative '../util/custom_formatter'
+
+module MangoPay
+
+  # Provides logger objects.
+  class LogProvider
+
+    ENABLE_LOGGING = true
+    ENABLE_HTTP_LOGGING = true
+
+    class << self
+
+      def provide(context)
+        if needs_http_logger(context) && ENABLE_HTTP_LOGGING\
+          || !(needs_http_logger(context) && ENABLE_LOGGING)
+          logger = CustomLogger.new(STDOUT)
+          logger.progname = context.name
+          logger.formatter = CustomFormatter.new
+          logger
+        else
+          VoidLogger.new
+        end
+      end
+
+      private
+
+      def needs_http_logger(context)
+        context.name =~ /HttpClient/ || context.name =~ /Jsonifier/
+      end
+    end
+  end
+end

data/lib/mangopay/common/rate_limit_interval.rb

@@ -0,0 +1,17 @@
+require_relative '../util/enum'
+
+module MangoPay
+
+  # MangoPay API rate limit reset times enumeration
+  class RateLimitInterval
+    extend Enum
+
+    FIFTEEN_MIN = value 'FIFTEEN_MINUTES'
+
+    THIRTY_MIN = value 'THIRTY_MINUTE'
+
+    HOUR = value 'HOUR'
+
+    DAY = value 'DAY'
+  end
+end

data/lib/mangopay/common/read_only_fields.rb

@@ -0,0 +1,27 @@
+module MangoPay
+
+  # Assures that no fields which are considered read-only
+  # remain in a hash meant to be sent as a request body.
+  module ReadOnlyFields
+
+    @read_only_fields = %w[
+      CreationDate
+    ]
+
+    class << self
+
+      # Checks whether any of the fields marked as read-only
+      # are present in the given hash. Removes those which are.
+      #
+      # @param +hash+ [Hash] hash to check for read-only fields
+      # @return [Hash] the given hash minus any read-only fields
+      #
+      # noinspection RubyResolve
+      def remove_from!(hash)
+        @read_only_fields.each do |field|
+          hash.delete field
+        end
+      end
+    end
+  end
+end

data/lib/mangopay/common/response_error.rb

@@ -0,0 +1,61 @@
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/response-codes-rules/
+  # and http://docs.mangopay.com/api-references/error-codes/
+  #
+  # Thrown from any MangoPay API call whenever
+  # it returns response with HTTP code != 200.
+  # Check @details hash for further info.
+  #
+  # Two example exceptions with details:
+  #
+  # * <MangoPay::ResponseError:
+  #   One or several required parameters are missing or incorrect. [...]
+  #   Email: The Email field is required.>
+  # {"Message"=>"One or several required parameters are missing or incorrect.
+  #   An incorrect resource ID also raises this kind of error.",
+  #  "Type"=>"param_error",
+  #  "Id"=>"66936e92-3f21-4a35-b6cf-f1d17c2fb6e5",
+  #  "Date"=>1409047252.0,
+  #  "errors"=>{"Email"=>"The Email field is required."},
+  #  "Code"=>"400",
+  #  "Url"=>"/v2/sdk-unit-tests/users/natural"}
+  #
+  # * <MangoPay::ResponseError: Internal Server Error>
+  # {"Message"=>"Internal Server Error",
+  #  "Type"=>"other",
+  #  "Id"=>"7bdc5c6f-2000-4cd3-96f3-2a3fcb746f07",
+  #  "Date"=>1409047251.0,
+  #  "errors"=>nil,
+  #  "Code"=>"500",
+  #  "Url"=>"/v2/sdk-unit-tests/payins/3380640/refunds"}
+  class ResponseError < StandardError
+
+    attr_reader :request_url, :code, :details
+
+    def initialize(request_url, code, details)
+      @request_url = request_url
+      @code = code
+      @details = details
+      super(message) if message
+    end
+
+    def type
+      @details['Type'] if @details
+    end
+
+    def errors
+      @details['errors'] if @details
+    end
+
+    def message
+      return @message if @message
+      msg = @details ? @details['Message'] : ''
+      if errors && errors.is_a?(Hash)
+        msg += errors.sort.map { |k, v| "\n#{k}: #{v}" }.join
+      end
+      @message = msg || "#{@code} #{@details['error']}"
+    end
+
+  end
+end

data/lib/mangopay/common/sort_direction.rb

@@ -0,0 +1,15 @@
+require_relative '../../../lib/mangopay/util/enum'
+
+module MangoPay
+
+  # Enumeration of sorting directions available for sorting API response results
+  class SortDirection
+    extend Enum
+
+    # Ascending sort direction
+    ASC = value 'ASC'
+
+    # Descending sort direction
+    DESC = value 'DESC'
+  end
+end

data/lib/mangopay/common/sort_field.rb

@@ -0,0 +1,13 @@
+require_relative '../../../lib/mangopay/util/enum'
+
+module MangoPay
+
+  # Available fields by which to sort API response results
+  class SortField
+    extend Enum
+
+    CREATION_DATE = value 'CreationDate'
+
+    DATE = value 'Date'
+  end
+end

data/lib/mangopay/common/template_url_options.rb

@@ -0,0 +1,9 @@
+require_relative 'jsonifier'
+
+
+class TemplateUrlOptions
+  include MangoPay::Jsonifier
+
+  # [String] URL to a SSL page
+  attr_accessor :payline
+end

data/lib/mangopay/configuration.rb

@@ -0,0 +1,39 @@
+module MangoPay
+
+  # Top-level configuration details
+  class Configuration
+
+    # [true/false] True if the sandbox environment should be used
+    attr_accessor :preproduction
+
+    # [String] Root URL to use for requests
+    attr_accessor :root_url
+
+    # [String] Your client ID
+    attr_accessor :client_id
+
+    # [String] Your client passphrase
+    attr_accessor :client_passphrase
+
+    # [String] Path to directory in which to store authorization token
+    #          If nil, tokens will be stored in-memory.
+    attr_accessor :temp_dir
+
+    # [String] Path for logging file
+    attr_accessor :log_dir
+
+    # [Integer] Number of milliseconds after which to timeout requests
+    attr_accessor :http_timeout
+
+    def initialize
+      self.preproduction = true
+      self.http_timeout = 10_000
+    end
+
+    def api_version
+      'v2.01'
+    end
+
+    alias preproduction? preproduction
+  end
+end

data/lib/mangopay/environment.rb

@@ -0,0 +1,66 @@
+require_relative 'common/log_provider'
+require_relative 'common/rate_limit_interval'
+
+module MangoPay
+
+  # Holds environment-specific configuration and data.
+  # Allows for multiple client handling and configuration
+  # from within the same application.
+  class Environment
+    LOG = LogProvider.provide(self)
+
+    # [Symbol] Its identification symbol
+    attr_reader :id
+
+    # [Configuration] Its MangoPay configuration details
+    attr_accessor :configuration
+
+    # [Hash] Counts of the requests sent to the API per time interval
+    attr_accessor :rate_limit_count
+
+    # [Hash] Number of remaining possible calls to be made per time interval
+    attr_accessor :rate_limit_remaining
+
+    # [Hash] UNIX times at which counts will be reset per time interval
+    attr_accessor :rate_limit_reset
+
+    def initialize(id)
+      @id = id
+      @rate_limit_count = {}
+      @rate_limit_remaining = {}
+      @rate_limit_reset = {}
+    end
+
+    # Updates the rate limit data based on headers from API.
+    #
+    # noinspection RubyResolve
+    def update_rate_limits(rate_limits)
+      rate_limits['x-ratelimit'].each.with_index do |count, index|
+        @rate_limit_count[time_interval(index)] = count
+      end
+      rate_limits['x-ratelimit-remaining'].each.with_index do |remain, index|
+        @rate_limit_remaining[time_interval(index)] = remain
+      end
+      rate_limits['x-ratelimit-reset'].each.with_index do |reset, index|
+        @rate_limit_reset[time_interval(index)] = reset
+      end
+    end
+
+    # Asserts the time interval corresponding to each index
+    # of the values returned in API headers.
+    def time_interval(index)
+      case index
+      when 0
+        RateLimitInterval::FIFTEEN_MIN
+      when 1
+        RateLimitInterval::THIRTY_MIN
+      when 2
+        RateLimitInterval::HOUR
+      when 3
+        RateLimitInterval::DAY
+      else
+        LOG.warn 'Unexpected rate limit time interval count'
+      end
+    end
+  end
+end

data/lib/mangopay/model/address.rb

@@ -0,0 +1,27 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Represents an address.
+  class Address
+    include MangoPay::Jsonifier
+
+    # [String] First line of its details
+    attr_accessor :address_line1
+
+    # [String] Second line of its details
+    attr_accessor :address_line2
+
+    # [String] Its city
+    attr_accessor :city
+
+    # [String] Its region
+    attr_accessor :region
+
+    # [String] Its postal code
+    attr_accessor :postal_code
+
+    # [CountryIso] Its country
+    attr_accessor :country
+  end
+end

data/lib/mangopay/model/declared_ubo.rb

@@ -0,0 +1,21 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Object that represents validation status of a user declared as UBO
+  class DeclaredUbo
+    include MangoPay::Jsonifier
+
+    # [String] ID of the natural user declared as UBO
+    attr_accessor :user_id
+
+    # [DeclaredUboStatus] Validation status of the user declared as UBO
+    attr_accessor :status
+
+    # [DeclaredUboRefusedReasonType] Reason why the UBO is not validly declared
+    attr_accessor :refused_reason_type
+
+    # [String] Explanation of why the UBO declaration has been refused
+    attr_accessor :refused_reason_message
+  end
+end

data/lib/mangopay/model/dispute_reason.rb

@@ -0,0 +1,15 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Reason of a dispute
+  class DisputeReason
+    include MangoPay::Jsonifier
+
+    # [DisputeReasonType] Type of reason for the dispute
+    attr_accessor :dispute_reason_type
+
+    # [String] Explanation of the dispute reason
+    attr_accessor :dispute_reason_message
+  end
+end

data/lib/mangopay/model/document_page_consult.rb

@@ -0,0 +1,15 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Holds document page viewing data
+  class DocumentPageConsult
+    include MangoPay::Jsonifier
+
+    # [String] URL where this document page can be viewed
+    attr_accessor :url
+
+    # [Integer] Time when the page consult will expire (UNIX timestamp)
+    attr_accessor :expiration_date
+  end
+end

data/lib/mangopay/model/e_money.rb

@@ -0,0 +1,18 @@
+require_relative '../common/jsonifier'
+
+module MangoModel
+
+  # Represents a user's e-money.
+  class EMoney
+    include MangoPay::Jsonifier
+
+    # [String] Its owner's ID
+    attr_accessor :user_id
+
+    # [Money] The amount of money that has been credited to its owner
+    attr_accessor :credited_e_money
+
+    # [Money] The amount of money that has been debited from its owner
+    attr_accessor :debited_e_money
+  end
+end

data/lib/mangopay/model/entity/account/bank_account.rb

@@ -0,0 +1,26 @@
+require_relative '../entity_base'
+require_relative '../../../util/non_instantiable'
+require_relative '../../enum/account_type'
+
+module MangoModel
+
+  # Bank account entity
+  class BankAccount < EntityBase
+    extend NonInstantiable
+
+    # [String] Its owning user's ID
+    attr_accessor :user_id
+
+    # [AccountType] Its type
+    attr_accessor :type
+
+    # [String] Its owner's name
+    attr_accessor :owner_name
+
+    # [Address] Its owner's address
+    attr_accessor :owner_address
+
+    # [true/false] Whether it's active or not
+    attr_accessor :active
+  end
+end

data/lib/mangopay/model/entity/account/ca_bank_account.rb

@@ -0,0 +1,27 @@
+require_relative 'bank_account'
+require_relative '../../enum/account_type'
+require_relative '../../../common/jsonifier'
+
+module MangoModel
+
+  # Bank account of +AccountType::CA+
+  class CaBankAccount < BankAccount
+    include MangoPay::Jsonifier
+
+    # [String] Its institution number (3-4 digits)
+    attr_accessor :institution_number
+
+    # [String] Its account number (max 20 digits)
+    attr_accessor :account_number
+
+    # [String] Its bank's branch code (5 digits)
+    attr_accessor :branch_code
+
+    # [String] Its bank's name (max 50 letters/digits)
+    attr_accessor :bank_name
+
+    def initialize
+      self.type = AccountType::CA
+    end
+  end
+end