pingpp 1.0.2

data/lib/pingpp.rb

@@ -0,0 +1,274 @@
+# Pingpp Ruby bindings
+# API spec at https://pingplusplus.com/document/api
+require 'cgi'
+require 'set'
+require 'openssl'
+require 'rest_client'
+require 'json'
+
+# Version
+require 'pingpp/version'
+
+# Channel constants
+require 'pingpp/channel'
+
+# API operations
+require 'pingpp/api_operations/create'
+require 'pingpp/api_operations/update'
+require 'pingpp/api_operations/delete'
+require 'pingpp/api_operations/list'
+
+# Resources
+require 'pingpp/util'
+require 'pingpp/pingpp_object'
+require 'pingpp/api_resource'
+require 'pingpp/singleton_api_resource'
+require 'pingpp/list_object'
+require 'pingpp/certificate_blacklist'
+require 'pingpp/charge'
+require 'pingpp/refund'
+
+# Errors
+require 'pingpp/errors/pingpp_error'
+require 'pingpp/errors/api_error'
+require 'pingpp/errors/api_connection_error'
+require 'pingpp/errors/invalid_request_error'
+require 'pingpp/errors/authentication_error'
+
+module Pingpp
+  DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
+  @api_base = 'https://api.pingplusplus.com'
+
+  @api_version = '2014-10-10'
+
+  @ssl_bundle_path  = DEFAULT_CA_BUNDLE_PATH
+  @verify_ssl_certs = true
+  @CERTIFICATE_VERIFIED = false
+
+
+  class << self
+    attr_accessor :api_key, :api_base, :verify_ssl_certs, :api_version
+  end
+
+  def self.api_url(url='')
+    @api_base + url
+  end
+
+  def self.request(method, url, api_key, params={}, headers={})
+    unless api_key ||= @api_key
+      raise AuthenticationError.new('No API key provided. ' +
+        'Set your API key using "Pingpp.api_key = <API-KEY>". ' +
+        'You can generate API keys from the Pingpp web interface. ' +
+        'See https://pingplusplus.com/document/api for details, or email support@pingplusplus.com ' +
+        'if you have any questions.')
+    end
+
+    if api_key =~ /\s/
+      raise AuthenticationError.new('Your API key is invalid, as it contains ' +
+        'whitespace. (HINT: You can double-check your API key from the ' +
+        'Pingpp web interface. See https://pingplusplus.com/document/api for details, or ' +
+        'email support@pingplusplus.com if you have any questions.)')
+    end
+
+    request_opts = { :verify_ssl => false, :ssl_version => 'TLSv1' }
+
+    if ssl_preflight_passed?
+      request_opts.update(:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+                          :ssl_ca_file => @ssl_bundle_path)
+    end
+
+    if @verify_ssl_certs and !@CERTIFICATE_VERIFIED
+      @CERTIFICATE_VERIFIED = CertificateBlacklist.check_ssl_cert(@api_base, @ssl_bundle_path)
+    end
+
+    params = Util.objects_to_ids(params)
+    url = api_url(url)
+
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      # Make params into GET parameters
+      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+      payload = nil
+    else
+      payload = uri_encode(params)
+    end
+
+    request_opts.update(:headers => request_headers(api_key).update(headers),
+                        :method => method, :open_timeout => 30,
+                        :payload => payload, :url => url, :timeout => 80)
+
+    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
+
+    [parse(response), api_key]
+  end
+
+  private
+
+  def self.ssl_preflight_passed?
+    if !verify_ssl_certs && !@no_verify
+      $stderr.puts "WARNING: Running without SSL cert verification. " +
+        "Execute 'Pingpp.verify_ssl_certs = true' to enable verification."
+
+      @no_verify = true
+
+    elsif !Util.file_readable(@ssl_bundle_path) && !@no_bundle
+      $stderr.puts "WARNING: Running without SSL cert verification " +
+        "because #{@ssl_bundle_path} isn't readable"
+
+      @no_bundle = true
+    end
+
+    !(@no_verify || @no_bundle)
+  end
+
+  def self.user_agent
+    @uname ||= get_uname
+    lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
+
+    {
+      :bindings_version => Pingpp::VERSION,
+      :lang => 'ruby',
+      :lang_version => lang_version,
+      :platform => RUBY_PLATFORM,
+      :publisher => 'pingpp',
+      :uname => @uname
+    }
+
+  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
+    "uname lookup failed"
+  end
+
+  def self.uri_encode(params)
+    Util.flatten_params(params).
+      map { |k,v| "#{k}=#{Util.url_encode(v)}" }.join('&')
+  end
+
+  def self.request_headers(api_key)
+    headers = {
+      :user_agent => "Pingpp/v1 RubyBindings/#{Pingpp::VERSION}",
+      :authorization => "Bearer #{api_key}",
+      :content_type => 'application/x-www-form-urlencoded'
+    }
+
+    headers[:pingplusplus_version] = api_version if api_version
+
+    begin
+      headers.update(:x_pingpp_client_user_agent => JSON.generate(user_agent))
+    rescue => e
+      headers.update(:x_pingpp_client_raw_user_agent => user_agent.inspect,
+                     :error => "#{e} (#{e.class})")
+    end
+  end
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def self.parse(response)
+    begin
+      # Would use :symbolize_names => true, but apparently there is
+      # some library out there that makes symbolize_names not work.
+      response = JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise general_api_error(response.code, response.body)
+    end
+
+    Util.symbolize_names(response)
+  end
+
+  def self.general_api_error(rcode, rbody)
+    APIError.new("Invalid response object from API: #{rbody.inspect} " +
+                 "(HTTP response code was #{rcode})", rcode, rbody)
+  end
+
+  def self.handle_api_error(rcode, rbody)
+    begin
+      error_obj = JSON.parse(rbody)
+      error_obj = Util.symbolize_names(error_obj)
+      error = error_obj[:error] or raise PingppError.new # escape from parsing
+
+    rescue JSON::ParserError, PingppError
+      raise general_api_error(rcode, rbody)
+    end
+
+    case rcode
+    when 400, 404
+      raise invalid_request_error error, rcode, rbody, error_obj
+    when 401
+      raise authentication_error error, rcode, rbody, error_obj
+    else
+      raise api_error error, rcode, rbody, error_obj
+    end
+
+  end
+
+  def self.invalid_request_error(error, rcode, rbody, error_obj)
+    InvalidRequestError.new(error[:message], error[:param], rcode,
+                            rbody, error_obj)
+  end
+
+  def self.authentication_error(error, rcode, rbody, error_obj)
+    AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.api_error(error, rcode, rbody, error_obj)
+    APIError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.handle_restclient_error(e)
+    connection_message = "Please check your internet connection and try again. " \
+        "If this problem persists, you should check Pingpp's service status at " \
+        "https://pingplusplus.com, or let us know at support@pingplusplus.com."
+
+    case e
+    when RestClient::RequestTimeout
+      message = "Could not connect to Pingpp (#{@api_base}). #{connection_message}"
+
+    when RestClient::ServerBrokeConnection
+      message = "The connection to the server (#{@api_base}) broke before the " \
+        "request completed. #{connection_message}"
+
+    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.) " \
+        "If this problem persists, let us know at support@pingplusplus.com."
+
+    when SocketError
+      message = "Unexpected error communicating when trying to connect to Pingpp. " \
+        "You may be seeing this message because your DNS is not working. " \
+        "To check, try running 'host pingplusplus.com' from the command line."
+
+    else
+      message = "Unexpected error communicating with Pingpp. " \
+        "If this problem persists, let us know at support@pingplusplus.com."
+
+    end
+
+    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: pingpp
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Xufeng Weng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-03 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.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
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PingPlusPlus is the easiest way to accept payments online.  See https://pingplusplus.com
+  for details.
+email:
+- xufeng.weng@pingplusplus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/data/ca-certificates.crt
+- lib/pingpp.rb
+- lib/pingpp/api_operations/create.rb
+- lib/pingpp/api_operations/delete.rb
+- lib/pingpp/api_operations/list.rb
+- lib/pingpp/api_operations/update.rb
+- lib/pingpp/api_resource.rb
+- lib/pingpp/certificate_blacklist.rb
+- lib/pingpp/channel.rb
+- lib/pingpp/charge.rb
+- lib/pingpp/errors/api_connection_error.rb
+- lib/pingpp/errors/api_error.rb
+- lib/pingpp/errors/authentication_error.rb
+- lib/pingpp/errors/invalid_request_error.rb
+- lib/pingpp/errors/pingpp_error.rb
+- lib/pingpp/list_object.rb
+- lib/pingpp/pingpp_object.rb
+- lib/pingpp/refund.rb
+- lib/pingpp/singleton_api_resource.rb
+- lib/pingpp/util.rb
+- lib/pingpp/version.rb
+homepage: https://pingplusplus.com/document/api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the PingPlusPlus API
+test_files: []