pingpp 2.0.15 → 2.1.0

data/lib/pingpp.rb

@@ -1,11 +1,13 @@
 # Pingpp Ruby bindings
-# API spec at https://pingxx.com/document/api
+# API spec at https://www.pingxx.com/api
 require 'cgi'
 require 'set'
 require 'openssl'
 require 'rest-client'
 require 'json'
 require 'base64'
+require 'socket'
+require 'rbconfig'
 
 # Version
 require 'pingpp/version'
@@ -15,6 +17,7 @@ require 'pingpp/api_operations/create'
 require 'pingpp/api_operations/update'
 require 'pingpp/api_operations/delete'
 require 'pingpp/api_operations/list'
+require 'pingpp/api_operations/request'
 
 # Resources
 require 'pingpp/util'
@@ -29,6 +32,9 @@ require 'pingpp/event'
 require 'pingpp/transfer'
 require 'pingpp/webhook'
 require 'pingpp/identification'
+require 'pingpp/customs'
+require 'pingpp/batch_refund'
+require 'pingpp/batch_transfer'
 
 # Errors
 require 'pingpp/errors/pingpp_error'
@@ -37,27 +43,45 @@ require 'pingpp/errors/api_connection_error'
 require 'pingpp/errors/invalid_request_error'
 require 'pingpp/errors/authentication_error'
 require 'pingpp/errors/channel_error'
+require 'pingpp/errors/rate_limit_error'
 
 # WxPubOauth
 require 'pingpp/wx_pub_oauth'
 
 module Pingpp
   DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
-  @api_base = 'https://api.pingxx.com'
 
-  @api_version = '2015-10-10'
+  RETRY_EXCEPTIONS = [
+    Errno::ECONNREFUSED,
+    Errno::ECONNRESET,
+    Errno::ETIMEDOUT,
+    RestClient::Conflict,
+    RestClient::RequestTimeout,
+  ].freeze
+
+  @api_base = 'https://api.pingxx.com'
 
-  @ssl_bundle_path  = DEFAULT_CA_BUNDLE_PATH
+  @ca_bundle_path  = DEFAULT_CA_BUNDLE_PATH
   @verify_ssl_certs = true
 
+  @open_timeout = 30
+  @timeout = 80
+
+  @max_network_retries = 0
+  @max_network_retry_delay = 2
+  @initial_network_retry_delay = 0.5
+
   HEADERS_TO_PARSE = [:pingpp_one_version, :pingpp_sdk_version]
 
   class << self
-    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version, :parsed_headers, :private_key, :pub_key
+    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version,
+                  :parsed_headers, :private_key, :pub_key, :app_id, :timeout,
+                  :open_timeout
+    attr_reader :max_network_retry_delay, :initial_network_retry_delay
   end
 
-  def self.api_url(url='')
-    @api_base + url
+  def self.api_url(url='', api_base_url=nil)
+    (api_base_url || @api_base) + url
   end
 
   def self.parse_headers(headers)
@@ -77,7 +101,9 @@ module Pingpp
     end
   end
 
-  def self.request(method, url, api_key, params={}, headers={})
+  def self.request(method, url, api_key, params={}, headers={}, api_base_url=nil)
+    api_base_url = api_base_url || @api_base
+
     unless api_key ||= @api_key
       raise AuthenticationError.new('No API key provided. ' +
         'Set your API key using "Pingpp.api_key = <API-KEY>". ' +
@@ -93,7 +119,7 @@ module Pingpp
 
     if verify_ssl_certs
       request_opts = {:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
-                      :ssl_ca_file => @ssl_bundle_path,
+                      :ssl_ca_file => @ca_bundle_path,
                       :ssl_version => 'TLSv1'}
     else
       request_opts = {:verify_ssl => false,
@@ -107,46 +133,35 @@ module Pingpp
     end
 
     params = Util.objects_to_ids(params)
-    url = api_url(url)
+    url = api_url(url, api_base_url)
 
-    case method.to_s.downcase.to_sym
+    method_sym = method.to_s.downcase.to_sym
+    case method_sym
     when :get, :head, :delete
       # Make params into GET parameters
-      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+      url += "#{URI.parse(url).query ? '&' : '?'}#{Util.encode_parameters(params)}" if params && params.any?
       payload = nil
     else
       payload = JSON.generate(params)
     end
 
-    request_opts.update(:headers => request_headers(api_key, method.to_s.downcase.to_sym, payload).update(headers),
-                        :method => method, :open_timeout => 30,
-                        :payload => payload, :url => url, :timeout => 80)
+    request_opts.update(:headers => request_headers(api_key, method_sym, payload, url).update(headers),
+                        :method => method, :open_timeout => open_timeout,
+                        :payload => payload, :url => url, :timeout => timeout)
 
-    begin
-      response = execute_request(request_opts)
-    rescue SocketError => e
-      handle_restclient_error(e)
-    rescue NoMethodError => e
-      # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        e = APIConnectionError.new('Unexpected HTTP response code')
-        handle_restclient_error(e)
-      else
-        raise
-      end
-    rescue RestClient::ExceptionWithResponse => e
-      if rcode = e.http_code and rbody = e.http_body
-        handle_api_error(rcode, rbody)
-      else
-        handle_restclient_error(e)
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e)
-    end
+    response = execute_request_with_rescues(request_opts, api_base_url)
 
     [parse(response), api_key]
   end
 
+  def self.max_network_retries
+    @max_network_retries
+  end
+
+  def self.max_network_retries=(val)
+    @max_network_retries = val.to_i
+  end
+
   private
 
   def self.user_agent
@@ -159,23 +174,75 @@ module Pingpp
       :lang_version => lang_version,
       :platform => RUBY_PLATFORM,
       :publisher => 'pingpp',
-      :uname => @uname
+      :uname => @uname,
+      :hostname => Socket.gethostname,
+      :engine => defined?(RUBY_ENGINE) ? RUBY_ENGINE : '',
+      :openssl_version => OpenSSL::OPENSSL_VERSION
     }
 
   end
 
   def self.get_uname
-    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
-  rescue Errno::ENOMEM => ex # couldn't create subprocess
+    if File.exist?('/proc/version')
+      File.read('/proc/version').strip
+    else
+      case RbConfig::CONFIG['host_os']
+      when /linux|darwin|bsd|sunos|solaris|cygwin/i
+        _uname_uname
+      when /mswin|mingw/i
+        _uname_ver
+      else
+        "unknown platform"
+      end
+    end
+  end
+
+  def self._uname_uname
+    (`uname -a 2>/dev/null` || '').strip
+  rescue Errno::ENOMEM
     "uname lookup failed"
   end
 
-  def self.uri_encode(params)
-    Util.flatten_params(params).
-      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  def self._uname_ver
+    (`ver` || '').strip
+  rescue Errno::ENOMEM
+    "uname lookup failed"
   end
 
-  def self.request_headers(api_key, method_sym, data=nil)
+  def self.execute_request_with_rescues(request_opts, api_base_url, retry_count = 0)
+    begin
+      response = execute_request(request_opts)
+
+    rescue => e
+      if should_retry?(e, retry_count)
+        retry_count = retry_count + 1
+        sleep sleep_time(retry_count)
+        retry
+      end
+
+      case e
+      when SocketError
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+
+      when RestClient::ExceptionWithResponse
+        if e.response
+          handle_api_error(e.response)
+        else
+          response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+        end
+
+      when RestClient::Exception, Errno::ECONNREFUSED, OpenSSL::SSL::SSLError
+        response = handle_restclient_error(e, request_opts, retry_count, api_base_url)
+
+      else
+        raise
+      end
+    end
+
+    response
+  end
+
+  def self.request_headers(api_key, method_sym, data, url)
     post_or_put = (method_sym == :post or method_sym == :put)
     headers = {
       :user_agent => "Pingpp/v1 RubyBindings/#{Pingpp::VERSION}",
@@ -193,8 +260,17 @@ module Pingpp
                      :error => "#{e} (#{e.class})")
     end
 
-    if post_or_put && private_key && data
-      signature = sign_request(data, private_key)
+    data_to_be_signed = data || ''
+    uri = URI.parse(url)
+    data_to_be_signed += uri.path
+    (!uri.query.nil?) && data_to_be_signed += '?' + uri.query
+
+    request_time = Time.now.to_i.to_s
+    headers.update(:pingplusplus_request_timestamp => request_time)
+    data_to_be_signed += request_time
+
+    if private_key
+      signature = sign_request(data_to_be_signed, private_key)
       headers.update(:pingplusplus_signature => signature)
     end
 
@@ -235,63 +311,81 @@ module Pingpp
                  "(HTTP response code was #{rcode})", rcode, rbody)
   end
 
-  def self.handle_api_error(rcode, rbody)
+  def self.handle_api_error(resp)
     begin
-      error_obj = JSON.parse(rbody)
+      error_obj = JSON.parse(resp.body)
       error_obj = Util.symbolize_names(error_obj)
-      error = error_obj[:error] or raise PingppError.new # escape from parsing
+      error = error_obj[:error]
+      raise PingppError.new unless error && error.is_a?(Hash)
 
     rescue JSON::ParserError, PingppError
-      raise general_api_error(rcode, rbody)
+      raise general_api_error(resp.code, resp.body)
     end
 
-    case rcode
+    case resp.code
     when 400, 404
-      raise invalid_request_error error, rcode, rbody, error_obj
+      raise invalid_request_error(error, resp, error_obj)
     when 401
-      raise authentication_error error, rcode, rbody, error_obj
+      raise authentication_error(error, resp, error_obj)
     when 402
-      raise channel_error error, rcode, rbody, error_obj
+      raise channel_error(error, resp, error_obj)
+    when 403
+      raise rate_limit_error(error, resp, error_obj)
     else
-      raise api_error error, rcode, rbody, error_obj
+      raise api_error(error, resp, error_obj)
     end
 
   end
 
-  def self.invalid_request_error(error, rcode, rbody, error_obj)
-    InvalidRequestError.new(error[:message], error[:param], rcode,
-                            rbody, error_obj)
+  def self.invalid_request_error(error, resp, error_obj)
+    InvalidRequestError.new(error[:message], error[:param], resp.code,
+                            resp.body, error_obj, resp.headers)
+  end
+
+  def self.authentication_error(error, resp, error_obj)
+    AuthenticationError.new(error[:message], resp.code, resp.body, error_obj,
+                            resp.headers)
   end
 
-  def self.authentication_error(error, rcode, rbody, error_obj)
-    AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+  def self.channel_error(error, resp, error_obj)
+    ChannelError.new(error[:message], error[:code], error[:param], resp.code,
+                     resp.body, error_obj, resp.headers)
   end
 
-  def self.channel_error(error, rcode, rbody, error_obj)
-    ChannelError.new(error[:message], error[:code], error[:param], rcode, rbody, error_obj)
+  def self.rate_limit_error(error, resp, error_obj)
+    RateLimitError.new(error[:message], resp.code, resp.body, error_obj,
+                       resp.headers)
   end
 
-  def self.api_error(error, rcode, rbody, error_obj)
-    APIError.new(error[:message], rcode, rbody, error_obj)
+  def self.api_error(error, resp, error_obj)
+    APIError.new(error[:message], resp.code, resp.body, error_obj, resp.headers)
   end
 
-  def self.handle_restclient_error(e)
+  def self.handle_restclient_error(e, request_opts, retry_count, api_base_url=nil)
+    api_base_url = @api_base unless api_base_url
+
     connection_message = "Please check your internet connection and try again. " \
         "If this problem persists, you should check Pingpp's service status at " \
         "https://www.pingxx.com/status"
 
     case e
     when RestClient::RequestTimeout
-      message = "Could not connect to Pingpp (#{@api_base}). #{connection_message}"
+      message = "Could not connect to Pingpp (#{api_base_url}). #{connection_message}"
 
     when RestClient::ServerBrokeConnection
-      message = "The connection to the server (#{@api_base}) broke before the " \
+      message = "The connection to the server (#{api_base_url}) broke before the " \
         "request completed. #{connection_message}"
 
+    when OpenSSL::SSL::SSLError
+      message = "Could not establish a secure connection to Ping++, you may " \
+                "need to upgrade your OpenSSL version. To check, try running " \
+                "'openssl s_client -connect api.pingxx.com:443' from the " \
+                "command line."
+
     when RestClient::SSLCertificateNotVerified
       message = "Could not verify Pingpp's SSL certificate. " \
         "Please make sure that your network is not intercepting certificates. " \
-        "(Try going to (#{@api_base}) in your browser.)"
+        "(Try going to (#{api_base_url}) in your browser.)"
 
     when SocketError
       message = "Unexpected error communicating when trying to connect to Pingpp. " \
@@ -303,6 +397,23 @@ module Pingpp
 
     end
 
+    if retry_count > 0
+      message += " Request was retried #{retry_count} times."
+    end
+
     raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
   end
+
+  def self.should_retry?(e, retry_count)
+    retry_count < self.max_network_retries &&
+      RETRY_EXCEPTIONS.any? { |klass| e.is_a?(klass) }
+  end
+
+  def self.sleep_time(retry_count)
+    sleep_seconds = [initial_network_retry_delay * (2 ** (retry_count - 1)), max_network_retry_delay].min
+    sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
+    sleep_seconds = [initial_network_retry_delay, sleep_seconds].max
+
+    sleep_seconds
+  end
 end

metadata

@@ -1,36 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: pingpp
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.1.0
 platform: ruby
 authors:
 - Xufeng Weng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '1.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
@@ -40,64 +26,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '1.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.2
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.0
 description: PingPlusPlus is the easiest way to accept payments online.  See https://pingxx.com
   for details.
 email:
@@ -111,15 +43,20 @@ files:
 - lib/pingpp/api_operations/create.rb
 - lib/pingpp/api_operations/delete.rb
 - lib/pingpp/api_operations/list.rb
+- lib/pingpp/api_operations/request.rb
 - lib/pingpp/api_operations/update.rb
 - lib/pingpp/api_resource.rb
+- lib/pingpp/batch_refund.rb
+- lib/pingpp/batch_transfer.rb
 - lib/pingpp/charge.rb
+- lib/pingpp/customs.rb
 - lib/pingpp/errors/api_connection_error.rb
 - lib/pingpp/errors/api_error.rb
 - lib/pingpp/errors/authentication_error.rb
 - lib/pingpp/errors/channel_error.rb
 - lib/pingpp/errors/invalid_request_error.rb
 - lib/pingpp/errors/pingpp_error.rb
+- lib/pingpp/errors/rate_limit_error.rb
 - lib/pingpp/event.rb
 - lib/pingpp/identification.rb
 - lib/pingpp/list_object.rb
@@ -132,7 +69,7 @@ files:
 - lib/pingpp/version.rb
 - lib/pingpp/webhook.rb
 - lib/pingpp/wx_pub_oauth.rb
-homepage: https://pingxx.com/document/api
+homepage: https://www.pingxx.com/api
 licenses:
 - MIT
 metadata: {}