mangopay 3.0.31 → 3.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73c15899898b7b234b4acf3ce46155a7a206bd629b5ef98d682e6125d3c5cd52
-  data.tar.gz: f2e564568a12d93c36eb1fc42b70c21b6cf5753c18810b5cef5d28e8f1e1ae93
+  metadata.gz: 8cd7631afb582279a222aeb5c81d6f8a507e47bc7a0a6e23e171f34c9e519034
+  data.tar.gz: 472287e318eb7470c7020a09a889e9b9d630c98db2c095c7a8dd628cdffab223
 SHA512:
-  metadata.gz: df581e3dd8afa4312a20388604c2b1f907908898e92d26db4cd3bab264e5ac11ea2a2448cccac73b55054fcdb68bbed07b58bff7e5ab99996dd0a378fce3d819
-  data.tar.gz: 48e91bdd987927f105cd7fea1ef4863211b78e1f2728106cd0ab2618049db67988cd6d445e542ece17915c829a4c29f88995e05d480434e712fb40cb9ceecbea
+  metadata.gz: 8748baa780499d4881d9f9a8c9abcbaf5c804a5b9f5bbe78821bc79ea6e26773b40dbb056f6e459ab238e06f21328d87688db12e84cb6a78afb25f6b94f4f818
+  data.tar.gz: 4e0360de8ff724d8ea0c22796fd719235e5effeea7cce897c6d0a177ebc9589b59d70846d7d7fa18257ce91447fa3bce6789a6dd0856795128ca1f45e69698b7

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,39 @@
+## [3.0.36] - 2020-08-28
+- Forces TLS version to 1.2
+
+## [3.0.35] - 2020-08-24
+- Improvement to Net::ReadTimeout handling
+- "User-agent" format in the headers changed, aligned to other assets 👤
+ 
+## [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
@@ -133,13 +135,15 @@ module MangoPay
         headers['Idempotency-Key'] = headers_or_idempotency_key if headers_or_idempotency_key != nil
       end
 
-      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, :read_timeout => configuration.http_timeout) do |http|
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true, :read_timeout => configuration.http_timeout, ssl_version: :TLSv1_2) do |http|
         req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
         req.body = JSON.dump(params)
         before_request_proc.call(req) if before_request_proc
         do_request(http, req, uri)
       end
 
+      raise MangoPay::ResponseError.new(uri, '408', {'Message' => 'Request Timeout'}) if res.nil?
+
       # decode json data
       data = res.body.to_s.empty? ? {} : JSON.load(res.body.to_s)
 
@@ -157,7 +161,7 @@ module MangoPay
           limit: res['x-ratelimit'].split(", "),
           remaining: res['x-ratelimit-remaining'].split(", "),
           reset: res['x-ratelimit-reset'].split(", ")
-        } 
+        }
       end
 
       data
@@ -191,7 +195,7 @@ module MangoPay
     def request_headers
       auth_token = AuthorizationToken::Manager.get_token
       headers = {
-          'User-Agent' => "MANGOPAY V2 RubyBindings/#{VERSION}",
+          'User-Agent' => "MangoPay V2 SDK Ruby Bindings #{VERSION}",
           'Authorization' => "#{auth_token['token_type']} #{auth_token['access_token']}",
           'Content-Type' => 'application/json'
       }
@@ -203,10 +207,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
 
@@ -215,12 +219,23 @@ module MangoPay
       params = FilterParameters.request(req.body)
       line = "[#{Time.now.iso8601}] #{req.method.upcase} \"#{uri.to_s}\" #{params}"
       begin
-        time = Benchmark.realtime { res = do_request_without_log(http, req) }
+        time = Benchmark.realtime {
+          begin
+            res = do_request_without_log(http, req)
+          rescue Net::ReadTimeout
+            res = nil
+          end
+        }
         res
       ensure
-        params = FilterParameters.response(res.body)
         line = "#{log_severity(res)} #{line}"
-        line += "\n  [#{(time * 1000).round(1)}ms] #{res.code} #{params}\n"
+        if res.nil?
+          params = ''
+          line += "\n  [#{(time * 1000).round(1)}ms] 408 Request Timeout #{params}\n"
+        else
+          params = FilterParameters.response(res.body)
+          line += "\n  [#{(time * 1000).round(1)}ms] #{res.code} #{params}\n"
+        end
         logger.info { line }
       end
     end
@@ -235,15 +250,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/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/pay_in.rb

@@ -106,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/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

data/lib/mangopay/ubo_declaration.rb

@@ -1,19 +1,30 @@
 module MangoPay
-
   # Provides API methods for the UBO declaration entity.
   class UboDeclaration < Resource
-    include HTTPCalls::Fetch
-
     class << self
-
-      def update(id = nil, params = {})
-        declared_ubo_ids = []
-        params['DeclaredUBOs'].each do |ubo|
-          declared_ubo_ids << (ubo.key?('UserId') ? ubo['UserId'] : ubo)
+      def url(user_id, id = nil)
+        if id
+          "#{MangoPay.api_path}/users/#{user_id}/kyc/ubodeclarations/#{id}"
+        else
+          "#{MangoPay.api_path}/users/#{user_id}/kyc/ubodeclarations"
         end
-        params['DeclaredUBOs'] = declared_ubo_ids
-        MangoPay.request(:put, url(id), params)
+      end
+
+      def create(user_id)
+        MangoPay.request(:post, url(user_id))
+      end
+
+      def fetch(user_id, id)
+        MangoPay.request(:get, url(user_id, id))
+      end
+
+      def update(user_id, id, params = {})
+        request_params = {
+            Status: params['Status'],
+            Ubos: params['Ubos']
+        }
+        MangoPay.request(:put, url(user_id, id), request_params)
       end
     end
   end
-end
+end

data/lib/mangopay/user.rb

@@ -12,7 +12,7 @@ module MangoPay
       # Fetches list of wallets belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      def wallets(user_id, filters={})
+      def wallets(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/wallets', {}, filters)
       end
 
@@ -20,14 +20,14 @@ module MangoPay
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params
       # (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      def bank_accounts(user_id, filters={})
+      def bank_accounts(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/bankaccounts', {}, filters)
       end
 
       # Fetches list of cards belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      def cards(user_id, filters={})
+      def cards(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/cards', {}, filters)
       end
 
@@ -35,7 +35,7 @@ module MangoPay
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       # - other keys specific for transactions filtering (see MangoPay::Transaction#fetch)
-      def transactions(user_id, filters={})
+      def transactions(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/transactions', {}, filters)
       end
 
@@ -43,21 +43,25 @@ module MangoPay
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       # - other keys specific for transactions filtering (see MangoPay::Transaction#fetch)
-      def emoney(user_id, filters={})
-        MangoPay.request(:get, url(user_id) + '/emoney', {}, filters)
+      def emoney(user_id, year, month = nil, filters = {})
+        if month
+          MangoPay.request(:get, url(user_id) + "/emoney/#{year}/#{month}", {}, filters)
+        else
+          MangoPay.request(:get, url(user_id) + "/emoney/#{year}", {}, filters)
+        end
       end
 
       # Fetches list of kyc documents belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting following keys:
       # - +page+, +per_page+, +sort+, +BeforeDate+, +AfterDate+, +Status+: pagination and sorting params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      def kyc_documents(user_id, filters={})
+      def kyc_documents(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/KYC/documents', {}, filters)
       end
 
       # Fetches list of pre-authorizations belonging to the given +user_id+.
       # Optional +filters+ is a hash accepting the following keys:
       # - +page+, +per_page+, +sort+, +Status+, +ResultCode+, +PaymentStatus+: pagination and sorting/filtering params (see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
-      def pre_authorizations(user_id, filters={})
+      def pre_authorizations(user_id, filters = {})
         MangoPay.request(:get, url(user_id) + '/preauthorizations', {}, filters)
       end
     end