mangopay 3.0.30 → 3.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c038a492f0096820e24da22def17585dc1b5a13aa58eca6d18820bba16607bb
-  data.tar.gz: db6237ec1d2c88f544e975d6edc0b13944a5fdb202089e08ce2984a56176f966
+  metadata.gz: cb254e350875d634519586fc4e451a4c83148886522287f266ed1306131235b4
+  data.tar.gz: ef04474a28bf48dbef09cb20cf48375fdac3183546d30631b1f443aa0f9f21b8
 SHA512:
-  metadata.gz: 63fe20ad687cfbb42d4e31f7d7cf0c65b66e87e82487489d0e4bfd45486e30e99360a6c0396dc38ec44f1a7a1652b5bdb8c423b88b586e30c556efb824c5d637
-  data.tar.gz: c9f7cbe0843ccaf8153b2741d5da3587a3d6bf83f25884f342c1a60233b55101b0ed840c67214ceb3e7a48a4b31ee5bd08f455cf2317031aba63efa6a7c8887f
+  metadata.gz: c8ddc8e015f6ffe95c3947f063a2736a9863b19cf24a02d389fa00d9b9f623c27e083468e7c6eb9d2fcde31a974d3cb73da2674e76b09f53a14b80aaf6c59ca4
+  data.tar.gz: 49ce455ede60281e5c6b430c2c722d7c0c0f3abcc15204beaedd8c3954621d8f0057f05493ebd47df84f02cb91ea0d63db4e247b984f28091edcb525326b7158

data/.travis.yml

@@ -1,6 +1,11 @@
 language: ruby
 rvm:
-- 2.0.0
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
 script: bundle exec rspec
 deploy:
   provider: rubygems

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## [Unreleased]
+ - New v4 SDK version (available as a beta version here: https://rubygems.org/gems/mangopay-v4) - will be shortly merged on master.
+ 
+## [3.0.34] - 2020-06-25
+### Added
+- This SDK is now GooglePay-ready ! Feel free to ask our lovely support for more infos about its activation.
+- `UBODeclaration` is now directly available through its ID.
+- If a bankwire is done from a UK bankaccount on one of your `BankingAlias`, you could find its `AccountNumber` on `GET /payins/` response
+- You can now send a `Culture` parameter for Paypal PayIns. Thanks to it, payment page can be displayed in various languages.
+
+### Changed
+- `PAYLINEV2`value for Payin Web has been added on `TemplateURLOptions` object. You now should use it instead of `PAYLINE` for page customization.
+
+### Fixed
+- Missing filters parameters have been added
+- You can now send headers in update requests
+- Loggers have been enhanced
+
+## [3.0.33] - 2019-09-23
+### Added
+- ApplePay `Payin` functions are now available. More info about activation to come in the following weeks...  
+### Changed
+- GET EMoney method now supports year and month parameters. More info on our [docs](https://docs.mangopay.com/endpoints/v2.01/user-emoney#e895_view-a-users-emoney)
+
+## [v3.0.32] - 2019-06-19
+### Added
+- New UBO Declaration system (more info [here](https://docs.mangopay.com/endpoints/v2.01/ubo-declarations#e1024_the-ubo-declaration-object))
+### Changed
+- Paypal buyer account email that has been used is now available for Payin Paypal
+- Your `HeadquartersPhoneNumber` can now be updated for your client account directly from our API
+### BREAKING
+- `APIKey` is now replacing `passphrase` property for credentials. You must update it by updating to 3.0.32 SDK version and upper ones.
+
+
+ 

data/README.md

@@ -4,7 +4,7 @@ The gem for interacting with the version 2 of the Mangopay API.
 See the [API documentation](http://docs.mangopay.com/api-references/)
 for more details on the API.
 
-Tested on the following versions of Ruby: 1.9.2, 1.9.3, 2.0.0
+Tested on the following versions of Ruby: 1.9.2, 1.9.3, 2.0.0 and 2.x up to 2.5
 
 ## NEWS
 
@@ -37,7 +37,7 @@ require 'mangopay'
 MangoPay.configure do |c|
   c.preproduction = true
   c.client_id = 'YOUR_CLIENT_ID'
-  c.client_passphrase = 'YOUR_CLIENT_PASSWORD'
+  c.client_apiKey = 'YOUR_CLIENT_API_KEY'
   c.log_file = File.join('mypath', 'mangopay.log')
   c.http_timeout = 10000
 end
@@ -96,13 +96,13 @@ Along with each request, the rate limiting headers are automatically updated in
   MangoPay.ratelimit
 
   {
-    :limit=>["74", "74", "75", "908"], 
-    :remaining=>["2226", "4426", "8725", "104692"], 
+    :limit=>["74", "74", "75", "908"],
+    :remaining=>["2226", "4426", "8725", "104692"],
     :reset=>["1495615620", "1495616520", "1495618320", "1495701060"]
   }
 ```
 
-Read more about rate limiting on [our documetiation](https://docs.mangopay.com/guide/rate-limiting).
+Read more about rate limiting on [our documentation](https://docs.mangopay.com/guide/rate-limiting).
 
 ### Log requests and responses
 You can easily enable logs by setting the ```log_file``` configuration option (see the section **configuration** above). If you don't want logs, remove the ```log_file``` line.

data/lib/generators/mangopay/install_generator.rb

@@ -17,7 +17,7 @@ module Mangopay
           client = client_id_valid?
           remove_file 'config/initializers/mangopay.rb'
           @client_id = client_id
-          @client_passphrase = client['Passphrase']
+          @client_apiKey = client['APIKey']
           template 'mangopay.rb.erb', 'config/initializers/mangopay.rb'
         rescue => e
           puts e.message

data/lib/generators/templates/mangopay.rb.erb

@@ -1,5 +1,5 @@
 MangoPay.configure do |c|
   c.preproduction = <%= options[:preproduction] %>
   c.client_id = '<%= @client_id %>'
-  c.client_passphrase = '<%= @client_passphrase %>'
+  c.client_apiKey = '<%= @client_apiKey %>'
 end

data/lib/mangopay.rb

@@ -41,14 +41,16 @@ module MangoPay
   autoload :BankingAliases, 'mangopay/bankingaliases'
   autoload :BankingAliasesIBAN, 'mangopay/bankingaliases_iban'
   autoload :UboDeclaration, 'mangopay/ubo_declaration'
+  autoload :Ubo, 'mangopay/ubo'
 
   # temporary
   autoload :Temp, 'mangopay/temp'
 
   class Configuration
     attr_accessor :preproduction, :root_url,
-                  :client_id, :client_passphrase,
-                  :temp_dir, :log_file, :http_timeout
+                  :client_id, :client_apiKey,
+                  :temp_dir, :log_file, :http_timeout,
+                  :logger
 
     def preproduction
       @preproduction || false
@@ -157,7 +159,7 @@ module MangoPay
           limit: res['x-ratelimit'].split(", "),
           remaining: res['x-ratelimit-remaining'].split(", "),
           reset: res['x-ratelimit-reset'].split(", ")
-        } 
+        }
       end
 
       data
@@ -203,10 +205,10 @@ module MangoPay
     end
 
     def do_request(http, req, uri)
-      if configuration.log_file.nil?
-        do_request_without_log(http, req)
-      else
+      if logs_required?
         do_request_with_log(http, req, uri)
+      else
+        do_request_without_log(http, req)
       end
     end
 
@@ -235,15 +237,23 @@ module MangoPay
     end
 
     def logger
-      raise NotImplementedError if configuration.log_file.nil?
-      if @logger.nil?
+      raise NotImplementedError unless logs_required?
+      return @logger if @logger
+
+      if !configuration.logger.nil?
+        @logger = configuration.logger
+      elsif !configuration.log_file.nil?
         @logger = Logger.new(configuration.log_file)
-        @logger.formatter = proc do |severity, datetime, progname, msg|
+        @logger.formatter = proc do |_, _, _, msg|
           "#{msg}\n"
         end
       end
+
       @logger
     end
 
+    def logs_required?
+      !configuration.log_file.nil? || !configuration.logger.nil?
+    end
   end
 end

data/lib/mangopay/authorization_token.rb

@@ -19,7 +19,7 @@ module MangoPay
           if token.nil? || token['timestamp'].nil? || token['timestamp'] <= Time.now || token['environment_key'] != env_key
             token = MangoPay.request(:post, "/#{MangoPay.version_code}/oauth/token", {}, {}, {}, Proc.new do |req|
               cfg = MangoPay.configuration
-              req.basic_auth cfg.client_id, cfg.client_passphrase
+              req.basic_auth cfg.client_id, cfg.client_apiKey
               req.body = 'grant_type=client_credentials'
               req.add_field('Content-Type', 'application/x-www-form-urlencoded')
             end)
@@ -32,7 +32,7 @@ module MangoPay
 
         def get_environment_key_for_token
           cfg = MangoPay.configuration
-          key = "#{cfg.root_url}|#{cfg.client_id}|#{cfg.client_passphrase}"
+          key = "#{cfg.root_url}|#{cfg.client_id}|#{cfg.client_apiKey}"
           key = Digest::MD5.hexdigest(key)
           key
         end

data/lib/mangopay/bank_account.rb

@@ -26,6 +26,17 @@ module MangoPay
         MangoPay.request(:put, url(user_id, bank_account_id), params)
       end
 
+      # Fetches list of transactions belonging to given +bank_account_id+.
+      #
+      # Optional +filters+ is a hash accepting following keys:
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+      # - +ResultCode+: string representing the transaction result
+      def transactions(bank_account_id, filters = {})
+        url = "#{MangoPay.api_path}/bankaccounts/#{bank_account_id}/transactions"
+        MangoPay.request(:get, url, {}, filters)
+      end
+
       def url(user_id, bank_account_id = nil)
         if bank_account_id
           "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/bankaccounts/#{CGI.escape(bank_account_id.to_s)}"

data/lib/mangopay/card.rb

@@ -17,9 +17,24 @@ module MangoPay
         MangoPay.request(:get, fingerprint_url(fingerprint), {}, filters)
       end
 
+      # Retrieves a list of transactions belonging to given +card_id+.
+      #
+      # Optional +filters+ is a hash accepting following keys:
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+      # - +ResultCode+: string representing the transaction result
+      def transactions(card_id, filters = {})
+        url = url(card_id) + '/transactions'
+        MangoPay.request(:get, url, {}, filters)
+      end
+
       def fingerprint_url(fingerprint)
         "#{MangoPay.api_path}/cards/fingerprints/#{fingerprint}"
       end
+
+      def get_pre_authorizations(card_id, filters = {})
+        MangoPay.request(:get, "#{MangoPay.api_path}/cards/#{card_id}/preauthorizations")
+      end
     end
   end
 end

data/lib/mangopay/filter_parameters.rb

@@ -13,7 +13,12 @@ module MangoPay
 
     def self.response(body)
       return '' if body.to_s.empty?
-      body = JSON.load(body)
+
+      begin
+        body = JSON.load(body)
+      rescue MultiJson::LoadError => e
+        return body
+      end
       filter_hash(body, res_confidential_params)
       JSON.dump(body)
     end

data/lib/mangopay/http_calls.rb

@@ -21,8 +21,8 @@ module MangoPay
 
     module Update
       module ClassMethods
-        def update(id = nil, params = {})
-          MangoPay.request(:put, url(id), params)
+        def update(id = nil, params = {}, idempotency_key = nil)
+          MangoPay.request(:put, url(id), params, {}, idempotency_key)
         end
       end
 
@@ -35,20 +35,20 @@ module MangoPay
       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}
         #

data/lib/mangopay/legal_user.rb

@@ -13,14 +13,6 @@ module MangoPay
     end
 
     class << self
-
-      # Create a UBO declaration.
-      # @param +user_id+ ID of the legal user owning the declaration
-      # @param +ubo_declaration+ Object containing UBO declaration data
-      # @return Newly-created UBO declaration entity data
-      def create_ubo_declaration(user_id, ubo_declaration)
-        MangoPay.request(:post, "#{url(user_id)}/ubodeclarations", ubo_declaration)
-      end
     end
   end
 end

data/lib/mangopay/mandate.rb

@@ -27,6 +27,16 @@ module MangoPay
         MangoPay.request(:get, url, {}, filters)
       end
 
+      # Fetches list of transactions belonging to given +mandate_id+.
+      #
+      # Optional +filters+ is a hash accepting following keys:
+      # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+      # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+      # - +ResultCode+: string representing the transaction result
+      def transactions(mandate_id, filters = {})
+        url = url(mandate_id) + '/transactions'
+        MangoPay.request(:get, url, {}, filters)
+      end
     end
   end
 end

data/lib/mangopay/pay_in.rb

@@ -5,6 +5,17 @@ module MangoPay
     include HTTPCalls::Fetch
     include HTTPCalls::Refund
 
+    # Fetches list of refunds belonging to the given +pay_in_id+.
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.refunds(pay_in_id, filters = {})
+      url = url(pay_in_id) + '/refunds'
+      MangoPay.request(:get, url, {}, filters)
+    end
+
     module Card
 
       # See http://docs.mangopay.com/api-references/payins/payins-card-web/
@@ -95,5 +106,25 @@ module MangoPay
 
     end
 
+    module ApplePay
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/applepay/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+    end
+
+    module GooglePay
+      class Direct < Resource
+        include HTTPCalls::Create
+
+        def self.url(*)
+          "#{MangoPay.api_path}/payins/googlepay/#{CGI.escape(class_name.downcase)}"
+        end
+      end
+    end
+
   end
 end

data/lib/mangopay/pay_out.rb

@@ -2,6 +2,17 @@ module MangoPay
   class PayOut < Resource
     include HTTPCalls::Fetch
 
+    # Fetches list of refunds belonging to the given +pay_out_id+.
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.refunds(pay_out_id, filters = {})
+      url = url(pay_out_id) + '/refunds'
+      MangoPay.request(:get, url, {}, filters)
+    end
+
     # See http://docs.mangopay.com/api-references/pay-out-bank-wire/
     class BankWire < Resource
       include HTTPCalls::Create

data/lib/mangopay/refund.rb

@@ -3,5 +3,16 @@ module MangoPay
   # See http://docs.mangopay.com/api-references/refund/
   class Refund < Resource
     include HTTPCalls::Fetch
+
+    # Fetches list of refunds belonging to given +repudiation_id+
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.of_repudiation(repudiation_id, filters = {})
+      url = "#{MangoPay.api_path}/repudiations/#{repudiation_id}/refunds"
+      MangoPay.request(:get, url, {}, filters)
+    end
   end
 end

data/lib/mangopay/transfer.rb

@@ -5,5 +5,16 @@ module MangoPay
     include HTTPCalls::Create
     include HTTPCalls::Fetch
     include HTTPCalls::Refund
+
+    # Fetches list of refunds belonging to given +transfer_id+.
+    #
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
+    # - +Status+: TransactionStatus {CREATED, SUCCEEDED, FAILED}
+    # - +ResultCode+: string representing the transaction result
+    def self.refunds(transfer_id, filters = {})
+      url = url(transfer_id) + '/refunds'
+      MangoPay.request(:get, url, {}, filters)
+    end
   end
 end

data/lib/mangopay/ubo.rb

@@ -0,0 +1,26 @@
+module MangoPay
+  # Provides API methods for the UBO entity.
+  class Ubo < Resource
+    class << self
+      def url(user_id, ubo_declaration_id, id = nil)
+        if id
+          "#{MangoPay.api_path}/users/#{user_id}/kyc/ubodeclarations/#{ubo_declaration_id}/ubos/#{id}"
+        else
+          "#{MangoPay.api_path}/users/#{user_id}/kyc/ubodeclarations/#{ubo_declaration_id}/ubos"
+        end
+      end
+
+      def create(user_id, ubo_declaration_id, params)
+        MangoPay.request(:post, url(user_id, ubo_declaration_id), params)
+      end
+
+      def fetch(user_id, ubo_declaration_id, ubo_id)
+        MangoPay.request(:get, url(user_id, ubo_declaration_id, ubo_id))
+      end
+
+      def update(user_id, ubo_declaration_id, ubo_id, params)
+        MangoPay.request(:put, url(user_id, ubo_declaration_id, ubo_id), params)
+      end
+    end
+  end
+end