mangopay 3.0.25 → 3.0.26

data/lib/mangopay/dispute.rb

@@ -1,130 +1,130 @@
-require 'base64'
-
-module MangoPay
-
-  # See https://docs.mangopay.com/api-references/disputes/disputes/
-  class Dispute < Resource
-    include HTTPCalls::Fetch
-    include HTTPCalls::Update
-    class << self
-
-      def close(dispute_id)
-        url = url(dispute_id) + "/close/"
-        MangoPay.request(:put, url)
-      end
-
-      # +contested_funds+: Money hash
-      # see 'Contest' section @ https://docs.mangopay.com/api-references/disputes/disputes/
-      def contest(dispute_id, contested_funds)
-        url = url(dispute_id) + "/submit/"
-        MangoPay.request(:put, url, {ContestedFunds: contested_funds})
-      end
-
-      def resubmit(dispute_id)
-        url = url(dispute_id) + "/submit/"
-        MangoPay.request(:put, url)
-      end
-
-      def transactions(dispute_id, filters = {})
-        url = url(dispute_id) + "/transactions/"
-        MangoPay.request(:get, url, {}, filters)
-      end
-
-      def fetch_for_user(user_id, filters = {})
-        url = "#{MangoPay.api_path}/users/#{user_id}/disputes"
-        MangoPay.request(:get, url, {}, filters)
-      end
-
-      def fetch_for_wallet(wallet_id, filters = {})
-        url = "#{MangoPay.api_path}/wallets/#{wallet_id}/disputes"
-        MangoPay.request(:get, url, {}, filters)
-      end
-      
-      #####################################################
-      # repudiations / settlement transfers
-      #####################################################
-
-      # see https://docs.mangopay.com/api-references/disputes/repudiations/
-      def fetch_repudiation(repudiation_id)
-        url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}"
-        MangoPay.request(:get, url)
-      end
-
-      # +params+: hash; see https://docs.mangopay.com/api-references/disputes/settlement-transfers/
-      def create_settlement_transfer(repudiation_id, params, idempotency_key = nil)
-        url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}/settlementtransfer/"
-        MangoPay.request(:post, url, params, {}, idempotency_key)
-      end
-
-      # see https://docs.mangopay.com/api-references/disputes/settlement-transfers/
-      def fetch_settlement_transfer(transfer_id)
-        url = "#{MangoPay.api_path}/settlements/#{transfer_id}"
-        MangoPay.request(:get, url)
-      end
-      
-      #####################################################
-      # documents
-      #####################################################
-
-      # +params+: hash; see https://docs.mangopay.com/api-references/disputes/dispute-documents/
-      def create_document(dispute_id, params, idempotency_key = nil)
-        url = url(dispute_id) + "/documents/"
-        MangoPay.request(:post, url, params, {}, idempotency_key)
-      end
-
-      def fetch_document(document_id)
-        url = "#{MangoPay.api_path}/dispute-documents/#{document_id}"
-        MangoPay.request(:get, url)
-      end
-
-      # +params+: hash; see 'Edit' section @ https://docs.mangopay.com/api-references/disputes/dispute-documents/
-      def update_document(dispute_id, document_id, params)
-        url = url(dispute_id) + "/documents/#{document_id}"
-        MangoPay.request(:put, url, params)
-      end
-
-      # Fetches list of dispute documents:
-      # - for the particular dispute if +dispute_id+ is provided (not nil)
-      # - or for all disputes otherwise.
-      # 
-      # Optional +filters+ is a hash accepting following keys:
-      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      # - filters such as +Type+ (e.g. 'REFUND_PROOF') and +Status+ (e.g. 'VALIDATED')
-      # - +BeforeDate+ (timestamp): filters documents with CreationDate _before_ this date
-      # - +AfterDate+ (timestamp): filters documents with CreationDate _after_ this date
-      # 
-      # See https://docs.mangopay.com/api-references/disputes/dispute-documents/
-      #
-      def fetch_documents(dispute_id = nil, filters = {})
-        url = (dispute_id) ? url(dispute_id) + "/documents/" : "#{MangoPay.api_path}/dispute-documents/"
-        MangoPay.request(:get, url, {}, filters)
-      end
-
-      # Adds the file page (attachment) to the given document.
-      # 
-      # See https://docs.mangopay.com/api-references/disputes/dispute-document-pages/ :
-      # - Document have to be in 'CREATED' Status
-      # - You can create as many pages as needed
-      # - Change Status to 'VALIDATION_ASKED' to submit dispute documents
-      # 
-      # The file_content_base64 param may be:
-      # - Base64 encoded file content
-      # - or nil: in this case pass the file path in the next param
-      #
-      def create_document_page(dispute_id, document_id, file_content_base64, file_path = nil, idempotency_key = nil)
-        if file_content_base64.nil? && !file_path.nil?
-          bts = File.open(file_path, 'rb') { |f| f.read }
-          file_content_base64 = Base64.encode64(bts)
-        end
-        # normally it returns 204 HTTP code on success
-        begin
-          url = url(dispute_id) + "/documents/#{document_id}/pages"
-          MangoPay.request(:post, url, {'File' => file_content_base64}, {}, idempotency_key)
-        rescue ResponseError => ex
-          raise ex unless ex.code == '204'
-        end
-      end
-
-    end
-  end
-end
+require 'base64'
+
+module MangoPay
+
+  # See https://docs.mangopay.com/api-references/disputes/disputes/
+  class Dispute < Resource
+    include HTTPCalls::Fetch
+    include HTTPCalls::Update
+    class << self
+
+      def close(dispute_id)
+        url = url(dispute_id) + "/close/"
+        MangoPay.request(:put, url)
+      end
+
+      # +contested_funds+: Money hash
+      # see 'Contest' section @ https://docs.mangopay.com/api-references/disputes/disputes/
+      def contest(dispute_id, contested_funds)
+        url = url(dispute_id) + "/submit/"
+        MangoPay.request(:put, url, {ContestedFunds: contested_funds})
+      end
+
+      def resubmit(dispute_id)
+        url = url(dispute_id) + "/submit/"
+        MangoPay.request(:put, url)
+      end
+
+      def transactions(dispute_id, filters = {})
+        url = url(dispute_id) + "/transactions/"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      def fetch_for_user(user_id, filters = {})
+        url = "#{MangoPay.api_path}/users/#{user_id}/disputes"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      def fetch_for_wallet(wallet_id, filters = {})
+        url = "#{MangoPay.api_path}/wallets/#{wallet_id}/disputes"
+        MangoPay.request(:get, url, {}, filters)
+      end
+      
+      #####################################################
+      # repudiations / settlement transfers
+      #####################################################
+
+      # see https://docs.mangopay.com/api-references/disputes/repudiations/
+      def fetch_repudiation(repudiation_id)
+        url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}"
+        MangoPay.request(:get, url)
+      end
+
+      # +params+: hash; see https://docs.mangopay.com/api-references/disputes/settlement-transfers/
+      def create_settlement_transfer(repudiation_id, params, idempotency_key = nil)
+        url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}/settlementtransfer/"
+        MangoPay.request(:post, url, params, {}, idempotency_key)
+      end
+
+      # see https://docs.mangopay.com/api-references/disputes/settlement-transfers/
+      def fetch_settlement_transfer(transfer_id)
+        url = "#{MangoPay.api_path}/settlements/#{transfer_id}"
+        MangoPay.request(:get, url)
+      end
+      
+      #####################################################
+      # documents
+      #####################################################
+
+      # +params+: hash; see https://docs.mangopay.com/api-references/disputes/dispute-documents/
+      def create_document(dispute_id, params, idempotency_key = nil)
+        url = url(dispute_id) + "/documents/"
+        MangoPay.request(:post, url, params, {}, idempotency_key)
+      end
+
+      def fetch_document(document_id)
+        url = "#{MangoPay.api_path}/dispute-documents/#{document_id}"
+        MangoPay.request(:get, url)
+      end
+
+      # +params+: hash; see 'Edit' section @ https://docs.mangopay.com/api-references/disputes/dispute-documents/
+      def update_document(dispute_id, document_id, params)
+        url = url(dispute_id) + "/documents/#{document_id}"
+        MangoPay.request(:put, url, params)
+      end
+
+      # Fetches list of dispute documents:
+      # - for the particular dispute if +dispute_id+ is provided (not nil)
+      # - or for all disputes otherwise.
+      # 
+      # Optional +filters+ is a hash accepting following keys:
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - filters such as +Type+ (e.g. 'REFUND_PROOF') and +Status+ (e.g. 'VALIDATED')
+      # - +BeforeDate+ (timestamp): filters documents with CreationDate _before_ this date
+      # - +AfterDate+ (timestamp): filters documents with CreationDate _after_ this date
+      # 
+      # See https://docs.mangopay.com/api-references/disputes/dispute-documents/
+      #
+      def fetch_documents(dispute_id = nil, filters = {})
+        url = (dispute_id) ? url(dispute_id) + "/documents/" : "#{MangoPay.api_path}/dispute-documents/"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      # Adds the file page (attachment) to the given document.
+      # 
+      # See https://docs.mangopay.com/api-references/disputes/dispute-document-pages/ :
+      # - Document have to be in 'CREATED' Status
+      # - You can create as many pages as needed
+      # - Change Status to 'VALIDATION_ASKED' to submit dispute documents
+      # 
+      # The file_content_base64 param may be:
+      # - Base64 encoded file content
+      # - or nil: in this case pass the file path in the next param
+      #
+      def create_document_page(dispute_id, document_id, file_content_base64, file_path = nil, idempotency_key = nil)
+        if file_content_base64.nil? && !file_path.nil?
+          bts = File.open(file_path, 'rb') { |f| f.read }
+          file_content_base64 = Base64.encode64(bts)
+        end
+        # normally it returns 204 HTTP code on success
+        begin
+          url = url(dispute_id) + "/documents/#{document_id}/pages"
+          MangoPay.request(:post, url, {'File' => file_content_base64}, {}, idempotency_key)
+        rescue ResponseError => ex
+          raise ex unless ex.code == '204'
+        end
+      end
+
+    end
+  end
+end

data/lib/mangopay/errors.rb

@@ -1,61 +1,61 @@
-module MangoPay
-
-  # Generic error superclass for MangoPay specific errors.
-  # Currently never instantiated directly.
-  # Currently only single subclass used.
-  class Error < StandardError
-  end
-
-  # 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 < Error
-
-    attr_reader :request_url, :code, :details
-
-    def initialize(request_url, code, details)
-      @request_url, @code, @details = request_url, code, details
-
-      @details['Code'] = code
-      @details['Url'] = request_url.request_uri
-
-      super(message) if message
-    end
-
-    def type;    @details['Type']; end
-    def errors;  @details['errors']; end
-
-    def message;
-      msg = @details['Message']
-      msg += errors.sort.map {|k,v| " #{k}: #{v}"}.join if (errors && errors.is_a?(Hash))
-      msg
-    end
-
-  end
-end
+module MangoPay
+
+  # Generic error superclass for MangoPay specific errors.
+  # Currently never instantiated directly.
+  # Currently only single subclass used.
+  class Error < StandardError
+  end
+
+  # 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 < Error
+
+    attr_reader :request_url, :code, :details
+
+    def initialize(request_url, code, details)
+      @request_url, @code, @details = request_url, code, details
+
+      @details['Code'] = code
+      @details['Url'] = request_url.request_uri
+
+      super(message) if message
+    end
+
+    def type;    @details['Type']; end
+    def errors;  @details['errors']; end
+
+    def message;
+      msg = @details['Message']
+      msg += errors.sort.map {|k,v| " #{k}: #{v}"}.join if (errors && errors.is_a?(Hash))
+      msg
+    end
+
+  end
+end

data/lib/mangopay/event.rb

@@ -1,18 +1,18 @@
-module MangoPay
-
-  # See http://docs.mangopay.com/api-references/events/
-  class Event < Resource
-
-    # Fetches list of events (PayIns, PayOuts, Transfers).
-    # 
-    # Optional +filters+ is a hash accepting following keys:
-    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-    # - +EventType+: {PAYIN_NORMAL_CREATED, PAYIN_NORMAL_SUCCEEDED, PAYIN_NORMAL_FAILED etc...} (see http://docs.mangopay.com/api-references/events/)
-    # - +BeforeDate+ (timestamp): filters events with Date _before_ this date
-    # - +AfterDate+ (timestamp): filters events with Date _after_ this date
-    #
-    def self.fetch(filters={})
-      MangoPay.request(:get, url(), {}, filters)
-    end
-  end
-end
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/events/
+  class Event < Resource
+
+    # Fetches list of events (PayIns, PayOuts, Transfers).
+    # 
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +EventType+: {PAYIN_NORMAL_CREATED, PAYIN_NORMAL_SUCCEEDED, PAYIN_NORMAL_FAILED etc...} (see http://docs.mangopay.com/api-references/events/)
+    # - +BeforeDate+ (timestamp): filters events with Date _before_ this date
+    # - +AfterDate+ (timestamp): filters events with Date _after_ this date
+    #
+    def self.fetch(filters={})
+      MangoPay.request(:get, url(), {}, filters)
+    end
+  end
+end

data/lib/mangopay/filter_parameters.rb

@@ -1,46 +1,46 @@
-module MangoPay
-  module FilterParameters
-
-    def self.request(body)
-      begin
-        body = JSON.load(body)
-      rescue MultiJson::LoadError => e
-        return body
-      end
-      filter_hash(body, req_confidential_params)
-      JSON.dump(body)
-    end
-
-    def self.response(body)
-      return '' if body.to_s.empty?
-      body = JSON.load(body)
-      filter_hash(body, res_confidential_params)
-      JSON.dump(body)
-    end
-
-    private
-
-    def self.filter_hash(hash, to_filter)
-      hash.each do |k,v|
-        if v.is_a?(Hash)
-          filter_hash(v, to_filter)
-        else
-          hash[k] = '[FILTERED]' if to_filter.include?(k)
-        end
-      end
-    end
-
-    def self.res_confidential_params
-      @@res_confidential_params ||= [
-        'access_token', 'AccessKey', 'IBAN', 'CardRegistrationURL',
-        'PreregistrationData', 'RedirectURL', 'RegistrationData',
-        'SecureModeRedirectUrl'
-      ].freeze
-    end
-
-    def self.req_confidential_params
-      @@req_confidential_params ||= ['File', 'IBAN'].freeze
-    end
-
-  end
-end
+module MangoPay
+  module FilterParameters
+
+    def self.request(body)
+      begin
+        body = JSON.load(body)
+      rescue MultiJson::LoadError => e
+        return body
+      end
+      filter_hash(body, req_confidential_params)
+      JSON.dump(body)
+    end
+
+    def self.response(body)
+      return '' if body.to_s.empty?
+      body = JSON.load(body)
+      filter_hash(body, res_confidential_params)
+      JSON.dump(body)
+    end
+
+    private
+
+    def self.filter_hash(hash, to_filter)
+      hash.each do |k,v|
+        if v.is_a?(Hash)
+          filter_hash(v, to_filter)
+        else
+          hash[k] = '[FILTERED]' if to_filter.include?(k)
+        end
+      end
+    end
+
+    def self.res_confidential_params
+      @@res_confidential_params ||= [
+        'access_token', 'AccessKey', 'IBAN', 'CardRegistrationURL',
+        'PreregistrationData', 'RedirectURL', 'RegistrationData',
+        'SecureModeRedirectUrl'
+      ].freeze
+    end
+
+    def self.req_confidential_params
+      @@req_confidential_params ||= ['File', 'IBAN'].freeze
+    end
+
+  end
+end