mangopay 3.0.11 → 3.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d1fd05f9cca7749256d14345f39d803570131e
-  data.tar.gz: 7e6a7b0c24c54dcb5e3ebaabdd082bb066308aa0
+  metadata.gz: 57a5f31ff878a4a9988ae5bbbeec2bd486f12c9a
+  data.tar.gz: b6f9ade3a53e81ed24050cda7ed5af6ba44af521
 SHA512:
-  metadata.gz: cba7b0b6b7160be2d3338e644475eb6f29c9303d5d7c2d97aeea90368dd0d39d0d687b36fc0c57aa0fbd189db483a5f9030344f784358177a3c9c131b8426b8d
-  data.tar.gz: 780a87a3ec7a9d9b63f4a760378e6478dbca05d7b05a7948fcc3652d7612501a84d435d477167f4b63d939cb396ff9ad792de0fc3865be3b392b518bef67e32c
+  metadata.gz: f41b043ef15a410cb45269d7f244176d75f10744ad565f2601032e22ea97be59e6d5beddc5fc933f45ce937a6ce80e4302d29e02554c73688645b1d115043017
+  data.tar.gz: 3a32c7cf5bd666e30a54cfb0e789f09b0d09a14b9cdb4d03094b31198f78a566e76925db4c2b3755c5be1067ecd4f6890345efb3a95bc6a300894191e30c4f72

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --profile
+--r spec_helper

data/README.md

@@ -34,6 +34,7 @@ between you and the MangoPay Team.
 ```ruby
 require 'mangopay'
 
+
 # configuration (not required if Rails generator fired as above)
 MangoPay.configure do |c|
   c.preproduction = true
@@ -41,19 +42,44 @@ MangoPay.configure do |c|
   c.client_passphrase = 'YOUR_CLIENT_PASSWORD'
 end
 
+
 # get some user by id
 john = MangoPay::User.fetch(john_id) # => {FirstName"=>"John", "LastName"=>"Doe", ...}
 
+
 # update some of his data
 MangoPay::NaturalUser.update(john_id, {'LastName' => 'CHANGED'}) # => {FirstName"=>"John", "LastName"=>"CHANGED", ...}
 
+
 # get all users (with pagination)
 pagination = {'page' => 1, 'per_page' => 8} # get 1st page, 8 items per page
 users = MangoPay::User.fetch(pagination) # => [{...}, ...]: list of 8 users data hashes
 pagination # => {"page"=>1, "per_page"=>8, "total_pages"=>748, "total_items"=>5978}
 
+
 # get John's bank accounts
 accounts = MangoPay::BankAccount.fetch(john_id) # => [{...}, ...]: list of accounts data hashes (10 per page by default)
+
+
+# errors handling
+begin
+  MangoPay::NaturalUser.create({})
+rescue MangoPay::ResponseError => ex
+
+  ex # => #<MangoPay::ResponseError: One or several required parameters are missing or incorrect. [...] FirstName: The FirstName field is required. LastName: The LastName field is required. Nationality: The Nationality field is required.>
+
+  ex.details # => {
+             #   "Message"=>"One or several required parameters are missing or incorrect. [...]",
+             #   "Type"=>"param_error",
+             #   "Id"=>"5c080105-4da3-467d-820d-0906164e55fe",
+             #   "Date"=>1409048671.0,
+             #   "errors"=>{
+             #     "FirstName"=>"The FirstName field is required.",
+             #     "LastName"=>"The LastName field is required.", ...},
+             #   "Code"=>"400",
+             #   "Url"=>"/v2/.../users/natural"
+             # }
+end
 ```
 
 ### Tests

data/lib/mangopay.rb

@@ -4,139 +4,131 @@ require 'multi_json'
 
 # helpers
 require 'mangopay/version'
-require 'mangopay/json'
 require 'mangopay/errors'
-require 'mangopay/authorization_token'
-
-# resources
-require 'mangopay/http_calls'
-require 'mangopay/resource'
-require 'mangopay/client'
-require 'mangopay/user'
-require 'mangopay/natural_user'
-require 'mangopay/legal_user'
-require 'mangopay/payin'
-require 'mangopay/payout'
-require 'mangopay/transfer'
-require 'mangopay/transaction'
-require 'mangopay/wallet'
-require 'mangopay/bank_account'
-require 'mangopay/card_registration'
-require 'mangopay/preauthorization'
-require 'mangopay/card'
-require 'mangopay/event'
-require 'mangopay/kyc_document'
-require 'mangopay/hook'
-require 'mangopay/refund'
+
 
 module MangoPay
 
+  autoload :HTTPCalls, 'mangopay/http_calls'
+  autoload :Resource, 'mangopay/resource'
+  autoload :Client, 'mangopay/client'
+  autoload :User, 'mangopay/user'
+  autoload :NaturalUser, 'mangopay/natural_user'
+  autoload :LegalUser, 'mangopay/legal_user'
+  autoload :PayIn, 'mangopay/pay_in'
+  autoload :PayOut, 'mangopay/pay_out'
+  autoload :Transfer, 'mangopay/transfer'
+  autoload :Transaction, 'mangopay/transaction'
+  autoload :Wallet, 'mangopay/wallet'
+  autoload :BankAccount, 'mangopay/bank_account'
+  autoload :CardRegistration, 'mangopay/card_registration'
+  autoload :PreAuthorization, 'mangopay/pre_authorization'
+  autoload :Card, 'mangopay/card'
+  autoload :Event, 'mangopay/event'
+  autoload :KycDocument, 'mangopay/kyc_document'
+  autoload :Hook, 'mangopay/hook'
+  autoload :Refund, 'mangopay/refund'
+  autoload :JSON, 'mangopay/json'
+  autoload :AuthorizationToken, 'mangopay/authorization_token'
+
   class Configuration
     attr_accessor :preproduction, :root_url,
-      :client_id, :client_passphrase,
-      :temp_dir
+                  :client_id, :client_passphrase,
+                  :temp_dir
 
     def preproduction
       @preproduction || false
     end
 
     def root_url
-      @root_url || (@preproduction == true  ? "https://api.sandbox.mangopay.com" : "https://api.mangopay.com")
+      @root_url || (@preproduction == true ? "https://api.sandbox.mangopay.com" : "https://api.mangopay.com")
     end
   end
 
   class << self
     attr_accessor :configuration
-  end
-
-  def self.configure
-    self.configuration ||= Configuration.new
-    yield configuration
-  end
 
-  def self.api_uri(url='')
-    URI(configuration.root_url + url)
-  end
-
-  #
-  # - +method+: HTTP method; lowercase symbol, e.g. :get, :post etc.
-  # - +url+: the part after Configuration#root_url
-  # - +params+: hash; entity data for creation, update etc.; will dump it by JSON and assign to Net::HTTPRequest#body
-  # - +filters+: hash; pagination params etc.; will encode it by URI and assign to URI#query
-  # - +headers+: hash; request_headers by default
-  # - +before_request_proc+: optional proc; will call it passing the Net::HTTPRequest instance just before Net::HTTPRequest#request
-  #
-  # Raises MangoPay::ResponseError if response code != 200.
-  #
-  def self.request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
-    uri = api_uri(url)
-    uri.query = URI.encode_www_form(filters) unless filters.empty?
-    
-    res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
-      req = Net::HTTP::const_get(method.capitalize).new(uri.request_uri, headers)
-      req.body = MangoPay::JSON.dump(params)
-      before_request_proc.call(req) if before_request_proc
-      http.request req
+    def api_path
+      "/v2/#{MangoPay.configuration.client_id}"
     end
 
-    # decode json data
-    begin
-      data = MangoPay::JSON.load(res.body.nil? ? '' : res.body)
-    rescue MultiJson::LoadError
-      data = {}
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
     end
 
-############### TEMP!!!! #######################################################
-#pp method, uri.request_uri, params #, filters, headers
-#pp res, data
-#puts
-
-    if (!(res.is_a? Net::HTTPOK))
-      ex = MangoPay::ResponseError.new(uri, res.code, data)
-############## TEMP!!!! ########################################################
-#pp ex, data
-      raise ex
+    def api_uri(url='')
+      URI(configuration.root_url + url)
     end
 
-    # copy pagination info if any
-    ['x-number-of-pages', 'x-number-of-items'].each { |k|
-      filters[k.gsub('x-number-of-', 'total_')] = res[k].to_i if res[k]
-    }
-
-    data
-  end
-
-  private
+    #
+    # - +method+: HTTP method; lowercase symbol, e.g. :get, :post etc.
+    # - +url+: the part after Configuration#root_url
+    # - +params+: hash; entity data for creation, update etc.; will dump it by JSON and assign to Net::HTTPRequest#body
+    # - +filters+: hash; pagination params etc.; will encode it by URI and assign to URI#query
+    # - +headers+: hash; request_headers by default
+    # - +before_request_proc+: optional proc; will call it passing the Net::HTTPRequest instance just before Net::HTTPRequest#request
+    #
+    # Raises MangoPay::ResponseError if response code != 200.
+    #
+    def request(method, url, params={}, filters={}, headers = request_headers, before_request_proc = nil)
+      uri = api_uri(url)
+      uri.query = URI.encode_www_form(filters) unless filters.empty?
+
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) 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
+        http.request req
+      end
+
+      # decode json data
+      data = JSON.load(res.body.to_s) rescue {}
+
+
+      unless res.is_a?(Net::HTTPOK)
+        raise MangoPay::ResponseError.new(uri, res.code, data)
+      end
+
+      # copy pagination info if any
+      ['x-number-of-pages', 'x-number-of-items'].each { |k|
+        filters[k.gsub('x-number-of-', 'total_')] = res[k].to_i if res[k]
+      }
+
+      data
+    end
 
-  def self.user_agent
-    @uname ||= get_uname
+    private
 
-    {
-      bindings_version: MangoPay::VERSION,
-      lang: 'ruby',
-      lang_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
-      platform: RUBY_PLATFORM,
-      uname: @uname
-    }
-  end
+    def user_agent
+      {
+          bindings_version: VERSION,
+          lang: 'ruby',
+          lang_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+          platform: RUBY_PLATFORM,
+          uname: get_uname
+      }
+    end
 
-  def self.get_uname
-    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
-  rescue Errno::ENOMEM
-    'uname lookup failed'
-  end
+    def get_uname
+      `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+    rescue Errno::ENOMEM
+      'uname lookup failed'
+    end
 
-  def self.request_headers
-    auth_token = MangoPay::AuthorizationToken::Manager.get_token
-    headers = {
-      'user_agent' => "MangoPay V2 RubyBindings/#{MangoPay::VERSION}",
-      'Authorization' => "#{auth_token['token_type']} #{auth_token['access_token']}",
-      'Content-Type' => 'application/json'
-    }
-    begin
-      headers.update('x_mangopay_client_user_agent' => MangoPay::JSON.dump(user_agent))
-    rescue => e
-      headers.update('x_mangopay_client_raw_user_agent' => user_agent.inspect, error: "#{e} (#{e.class})")
+    def request_headers
+      auth_token = AuthorizationToken::Manager.get_token
+      headers = {
+          'user_agent' => "MangoPay V2 RubyBindings/#{VERSION}",
+          'Authorization' => "#{auth_token['token_type']} #{auth_token['access_token']}",
+          'Content-Type' => 'application/json'
+      }
+      begin
+        headers.update('x_mangopay_client_user_agent' => JSON.dump(user_agent))
+      rescue => e
+        headers.update('x_mangopay_client_raw_user_agent' => user_agent.inspect, error: "#{e} (#{e.class})")
+      end
     end
+
   end
 end

data/lib/mangopay/bank_account.rb

@@ -1,6 +1,6 @@
 module MangoPay
   class BankAccount < Resource
-    include MangoPay::HTTPCalls::Fetch
+    include HTTPCalls::Fetch
     class << self
       def create(user_id, params)
         type = params.fetch(:Type) { |no_symbol_key| params.fetch('Type') }
@@ -15,15 +15,15 @@ module MangoPay
       # (+page+, +per_page+; see MangoPay::HTTPCalls::Fetch::ClassMethods#fetch)
       #
       def fetch(user_id, bank_account_id_or_filters={})
-        bank_account_id, filters = MangoPay::HTTPCalls::Fetch.parse_id_or_filters(bank_account_id_or_filters)
+        bank_account_id, filters = HTTPCalls::Fetch.parse_id_or_filters(bank_account_id_or_filters)
         MangoPay.request(:get, url(user_id, bank_account_id), {}, filters)
       end
 
       def url(user_id, bank_account_id = nil)
         if bank_account_id
-          "/v2/#{MangoPay.configuration.client_id}/users/#{CGI.escape(user_id.to_s)}/bankaccounts/#{CGI.escape(bank_account_id.to_s)}"
+          "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/bankaccounts/#{CGI.escape(bank_account_id.to_s)}"
         else
-          "/v2/#{MangoPay.configuration.client_id}/users/#{CGI.escape(user_id.to_s)}/bankaccounts"
+          "#{MangoPay.api_path}/users/#{CGI.escape(user_id.to_s)}/bankaccounts"
         end
       end
     end

data/lib/mangopay/card.rb

@@ -1,6 +1,6 @@
 module MangoPay
   class Card < Resource
-    include MangoPay::HTTPCalls::Fetch
-    include MangoPay::HTTPCalls::Update
+    include HTTPCalls::Fetch
+    include HTTPCalls::Update
   end
 end

data/lib/mangopay/card_registration.rb

@@ -1,7 +1,7 @@
 module MangoPay
   class CardRegistration < Resource
-    include MangoPay::HTTPCalls::Create
-    include MangoPay::HTTPCalls::Update
-    include MangoPay::HTTPCalls::Fetch
+    include HTTPCalls::Create
+    include HTTPCalls::Update
+    include HTTPCalls::Fetch
   end
 end

data/lib/mangopay/client.rb

@@ -3,7 +3,7 @@ module MangoPay
 
     def self.create(params)
       MangoPay.request(:post, '/api/clients/', params, {}, {
-        'user_agent' => "MangoPay V2 RubyBindings/#{MangoPay::VERSION}",
+        'user_agent' => "MangoPay V2 RubyBindings/#{VERSION}",
         'Content-Type' => 'application/json'
       })
     end

data/lib/mangopay/errors.rb

@@ -8,17 +8,51 @@ module MangoPay
 
   # 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 message; @details['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,16 +1,16 @@
-module MangoPay
-  class Event < Resource
-
-    # Fetches list of events (PayIns, PayOuts, Transfers).
-    # 
-    # Optional +filters+ is a hash accepting following keys:
-    # - +page+, +per_page+: pagination 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
+  class Event < Resource
+
+    # Fetches list of events (PayIns, PayOuts, Transfers).
+    # 
+    # Optional +filters+ is a hash accepting following keys:
+    # - +page+, +per_page+: pagination 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