mangopay 3.0.25 → 3.0.26

data/lib/mangopay/hook.rb

@@ -1,9 +1,9 @@
-module MangoPay
-
-  # See http://docs.mangopay.com/api-references/notifications/
-  class Hook < Resource
-    include HTTPCalls::Create
-    include HTTPCalls::Update
-    include HTTPCalls::Fetch
-  end
-end
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/notifications/
+  class Hook < Resource
+    include HTTPCalls::Create
+    include HTTPCalls::Update
+    include HTTPCalls::Fetch
+  end
+end

data/lib/mangopay/http_calls.rb

@@ -1,85 +1,85 @@
-module MangoPay
-  module HTTPCalls
-    module Create
-      module ClassMethods
-
-        def create(params, id = nil, idempotency_key = nil)
-          # LEGACY SUPPORT FOR OLD SIGNATURE: def create(*id, params)
-          if !params.is_a?(Hash) && id.is_a?(Hash)
-            temp = params
-            params = id
-            id = temp
-          end
-          MangoPay.request(:post, url(id), params, {}, idempotency_key)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-
-    module Update
-      module ClassMethods
-        def update(id = nil, params = {})
-          MangoPay.request(:put, url(id), params)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-
-    module Fetch
-      module ClassMethods
-
-        # - Fetching _single_entity_ by +id+:
-        # 
-        #   MangoPay::User.fetch("user-id") # => {"FirstName"=>"Mango", "LastName"=>"Pay", ...}
-        # 
-        # - or fetching _multiple_entities_ with _optional_ +filters+ hash,
-        #   including _pagination_ and _sorting_ params
-        #   +page+, +per_page+, +sort+ (see http://docs.mangopay.com/api-references/pagination/):
-        #   
-        #   MangoPay::User.fetch() # => [{...}, ...]: list of user data hashes (10 per page by default)
-        #   MangoPay::User.fetch({'page' => 2, 'per_page' => 3}) # => list of 3 hashes from 2nd page
-        #   MangoPay::BankAccount.fetch(user_id, {'sort' => 'CreationDate:desc'}) # => bank accounts by user, sorting by date descending (with default pagination)
-        #   MangoPay::BankAccount.fetch(user_id, {'sort' => 'CreationDate:desc', 'page' => 2, 'per_page' => 3}) # both sorting and pagination params provided
-        # 
-        # - For paginated queries the +filters+ param will be supplemented by +total_pages+ and +total_items+ info:
-        #   
-        #   MangoPay::User.fetch(filter = {'page' => 2, 'per_page' => 3})
-        #   filter # => {"page"=>2, "per_page"=>3, "total_pages"=>1969, "total_items"=>5905}
-        #
-        def fetch(id_or_filters = nil)
-          id, filters = HTTPCalls::Fetch.parse_id_or_filters(id_or_filters)
-          response = MangoPay.request(:get, url(id), {}, filters)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-
-      def self.parse_id_or_filters(id_or_filters = nil)
-        id_or_filters.is_a?(Hash) ? [nil, id_or_filters] : [id_or_filters, {}]
-      end
-    end
-
-    module Refund
-      module ClassMethods
-
-        # See http://docs.mangopay.com/api-references/refund/%E2%80%A2-refund-a-pay-in/
-        # See http://docs.mangopay.com/api-references/refund/%E2%80%A2-refund-a-transfer/
-        def refund(id = nil, params = {}, idempotency_key = nil)
-          MangoPay.request(:post, url(id) + '/refunds', params, {}, idempotency_key)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
-    end
-  end
-end
+module MangoPay
+  module HTTPCalls
+    module Create
+      module ClassMethods
+
+        def create(params, id = nil, idempotency_key = nil)
+          # LEGACY SUPPORT FOR OLD SIGNATURE: def create(*id, params)
+          if !params.is_a?(Hash) && id.is_a?(Hash)
+            temp = params
+            params = id
+            id = temp
+          end
+          MangoPay.request(:post, url(id), params, {}, idempotency_key)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module Update
+      module ClassMethods
+        def update(id = nil, params = {})
+          MangoPay.request(:put, url(id), params)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module Fetch
+      module ClassMethods
+
+        # - Fetching _single_entity_ by +id+:
+        # 
+        #   MangoPay::User.fetch("user-id") # => {"FirstName"=>"Mango", "LastName"=>"Pay", ...}
+        # 
+        # - or fetching _multiple_entities_ with _optional_ +filters+ hash,
+        #   including _pagination_ and _sorting_ params
+        #   +page+, +per_page+, +sort+ (see http://docs.mangopay.com/api-references/pagination/):
+        #   
+        #   MangoPay::User.fetch() # => [{...}, ...]: list of user data hashes (10 per page by default)
+        #   MangoPay::User.fetch({'page' => 2, 'per_page' => 3}) # => list of 3 hashes from 2nd page
+        #   MangoPay::BankAccount.fetch(user_id, {'sort' => 'CreationDate:desc'}) # => bank accounts by user, sorting by date descending (with default pagination)
+        #   MangoPay::BankAccount.fetch(user_id, {'sort' => 'CreationDate:desc', 'page' => 2, 'per_page' => 3}) # both sorting and pagination params provided
+        # 
+        # - For paginated queries the +filters+ param will be supplemented by +total_pages+ and +total_items+ info:
+        #   
+        #   MangoPay::User.fetch(filter = {'page' => 2, 'per_page' => 3})
+        #   filter # => {"page"=>2, "per_page"=>3, "total_pages"=>1969, "total_items"=>5905}
+        #
+        def fetch(id_or_filters = nil)
+          id, filters = HTTPCalls::Fetch.parse_id_or_filters(id_or_filters)
+          response = MangoPay.request(:get, url(id), {}, filters)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def self.parse_id_or_filters(id_or_filters = nil)
+        id_or_filters.is_a?(Hash) ? [nil, id_or_filters] : [id_or_filters, {}]
+      end
+    end
+
+    module Refund
+      module ClassMethods
+
+        # See http://docs.mangopay.com/api-references/refund/%E2%80%A2-refund-a-pay-in/
+        # See http://docs.mangopay.com/api-references/refund/%E2%80%A2-refund-a-transfer/
+        def refund(id = nil, params = {}, idempotency_key = nil)
+          MangoPay.request(:post, url(id) + '/refunds', params, {}, idempotency_key)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/mangopay/json.rb

@@ -1,14 +1,14 @@
-# We can use MultiJson directly , why do we even have this module ?
-module MangoPay
-  module JSON
-    class << self
-      def dump(*args)
-        MultiJson.dump(*args)
-      end
-
-      def load(*args)
-        MultiJson.load(*args)
-      end
-    end
-  end
-end
+# We can use MultiJson directly , why do we even have this module ?
+module MangoPay
+  module JSON
+    class << self
+      def dump(*args)
+        MultiJson.dump(*args)
+      end
+
+      def load(*args)
+        MultiJson.load(*args)
+      end
+    end
+  end
+end

data/lib/mangopay/kyc_document.rb

@@ -1,70 +1,70 @@
-require 'base64'
-
-module MangoPay
-
-  # See http://docs.mangopay.com/api-references/kyc/documents/
-  class KycDocument < Resource
-    class << self
-      def create(user_id, params, idempotency_key = nil)
-        MangoPay.request(:post, url(user_id), params, {}, idempotency_key)
-      end
-
-      def update(user_id, document_id, params = {})
-        MangoPay.request(:put, url(user_id, document_id), params)
-      end
-
-      # Fetches the KYC document belonging to the given +user_id+, with the given +document_id+.
-      def fetch(user_id, document_id)
-        url = (user_id) ? url(user_id, document_id) : "#{MangoPay.api_path}/KYC/documents/#{CGI.escape(document_id.to_s)}"
-        MangoPay.request(:get, url)
-      end
-
-      # Fetches list of KYC documents:
-      # - for the particular user if +user_id+ is provided (not nil)
-      # - or for all users 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. 'IDENTITY_PROOF') and +Status+ (e.g. 'VALIDATED')
-      # - +BeforeDate+ (timestamp): filters documents with CreationDate _before_ this date
-      # - +AfterDate+ (timestamp): filters documents with CreationDate _after_ this date
-      #
-      def fetch_all(user_id = nil, filters = {})
-        url = (user_id) ? url(user_id) : "#{MangoPay.api_path}/KYC/documents"
-        MangoPay.request(:get, url, {}, filters)
-      end
-
-      # Adds the file page (attachment) to the given document.
-      # 
-      # See http://docs.mangopay.com/api-references/kyc/pages/ :
-      # - Document have to be in 'CREATED' Status
-      # - You can create as many pages as needed
-      # - Change Status to 'VALIDATION_ASKED' to submit KYC 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_page(user_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
-          MangoPay.request(:post, url(user_id, document_id) + '/pages', {'File' => file_content_base64}, {}, idempotency_key)
-        rescue ResponseError => ex
-          raise ex unless ex.code == '204'
-        end
-      end
-
-      def url(user_id, document_id = nil)
-        if document_id
-          "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/KYC/documents/#{CGI.escape(document_id.to_s)}"
-        else
-          "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/KYC/documents"
-        end
-      end
-    end
-  end
-end
+require 'base64'
+
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/kyc/documents/
+  class KycDocument < Resource
+    class << self
+      def create(user_id, params, idempotency_key = nil)
+        MangoPay.request(:post, url(user_id), params, {}, idempotency_key)
+      end
+
+      def update(user_id, document_id, params = {})
+        MangoPay.request(:put, url(user_id, document_id), params)
+      end
+
+      # Fetches the KYC document belonging to the given +user_id+, with the given +document_id+.
+      def fetch(user_id, document_id)
+        url = (user_id) ? url(user_id, document_id) : "#{MangoPay.api_path}/KYC/documents/#{CGI.escape(document_id.to_s)}"
+        MangoPay.request(:get, url)
+      end
+
+      # Fetches list of KYC documents:
+      # - for the particular user if +user_id+ is provided (not nil)
+      # - or for all users 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. 'IDENTITY_PROOF') and +Status+ (e.g. 'VALIDATED')
+      # - +BeforeDate+ (timestamp): filters documents with CreationDate _before_ this date
+      # - +AfterDate+ (timestamp): filters documents with CreationDate _after_ this date
+      #
+      def fetch_all(user_id = nil, filters = {})
+        url = (user_id) ? url(user_id) : "#{MangoPay.api_path}/KYC/documents"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      # Adds the file page (attachment) to the given document.
+      # 
+      # See http://docs.mangopay.com/api-references/kyc/pages/ :
+      # - Document have to be in 'CREATED' Status
+      # - You can create as many pages as needed
+      # - Change Status to 'VALIDATION_ASKED' to submit KYC 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_page(user_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
+          MangoPay.request(:post, url(user_id, document_id) + '/pages', {'File' => file_content_base64}, {}, idempotency_key)
+        rescue ResponseError => ex
+          raise ex unless ex.code == '204'
+        end
+      end
+
+      def url(user_id, document_id = nil)
+        if document_id
+          "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/KYC/documents/#{CGI.escape(document_id.to_s)}"
+        else
+          "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/KYC/documents"
+        end
+      end
+    end
+  end
+end

data/lib/mangopay/legal_user.rb

@@ -1,15 +1,15 @@
-module MangoPay
-
-  # See http://docs.mangopay.com/api-references/users/legal-users/
-  # See also parent class MangoPay::User
-  class LegalUser < User
-
-    def self.url(id = nil)
-      if id
-        "#{MangoPay.api_path}/users/legal/#{CGI.escape(id.to_s)}"
-      else
-        "#{MangoPay.api_path}/users/legal"
-      end
-    end
-  end
-end
+module MangoPay
+
+  # See http://docs.mangopay.com/api-references/users/legal-users/
+  # See also parent class MangoPay::User
+  class LegalUser < User
+
+    def self.url(id = nil)
+      if id
+        "#{MangoPay.api_path}/users/legal/#{CGI.escape(id.to_s)}"
+      else
+        "#{MangoPay.api_path}/users/legal"
+      end
+    end
+  end
+end

data/lib/mangopay/mandate.rb

@@ -1,32 +1,32 @@
-module MangoPay
-
-  # See https://docs.mangopay.com/api-references/mandates/
-  class Mandate < Resource
-    include HTTPCalls::Fetch
-
-    class << self
-
-      # +params+: hash; see https://docs.mangopay.com/api-references/mandates/
-      def create(params, idempotency_key = nil)
-        url = "#{MangoPay.api_path}/mandates/directdebit/web"
-        MangoPay.request(:post, url, params, {}, idempotency_key)
-      end
-
-      def cancel(id)
-        url = "#{MangoPay.api_path}/mandates/#{id}/cancel"
-        MangoPay.request(:put, url)
-      end
-
-      def fetch_for_user(user_id, filters = {})
-        url = "#{MangoPay.api_path}/users/#{user_id}/mandates"
-        MangoPay.request(:get, url, {}, filters)
-      end
-
-      def fetch_for_user_bank_account(user_id, bank_account_id, filters = {})
-        url = "#{MangoPay.api_path}/users/#{user_id}/bankaccounts/#{bank_account_id}/mandates"
-        MangoPay.request(:get, url, {}, filters)
-      end
-
-    end
-  end
-end
+module MangoPay
+
+  # See https://docs.mangopay.com/api-references/mandates/
+  class Mandate < Resource
+    include HTTPCalls::Fetch
+
+    class << self
+
+      # +params+: hash; see https://docs.mangopay.com/api-references/mandates/
+      def create(params, idempotency_key = nil)
+        url = "#{MangoPay.api_path}/mandates/directdebit/web"
+        MangoPay.request(:post, url, params, {}, idempotency_key)
+      end
+
+      def cancel(id)
+        url = "#{MangoPay.api_path}/mandates/#{id}/cancel"
+        MangoPay.request(:put, url)
+      end
+
+      def fetch_for_user(user_id, filters = {})
+        url = "#{MangoPay.api_path}/users/#{user_id}/mandates"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+      def fetch_for_user_bank_account(user_id, bank_account_id, filters = {})
+        url = "#{MangoPay.api_path}/users/#{user_id}/bankaccounts/#{bank_account_id}/mandates"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
+    end
+  end
+end