module Payjp

Constants

VERSION

Attributes

api_base[RW]
api_key[RW]
api_version[RW]
connect_base[RW]
open_timeout[RW]
read_timeout[RW]
ssl_ca_file[RW]
ssl_ca_path[RW]
ssl_cert_store[RW]
uploads_base[RW]

Public Class Methods

api_url(url = '', api_base_url = nil) click to toggle source
# File lib/payjp.rb, line 59
def self.api_url(url = '', api_base_url = nil)
  (api_base_url || @api_base) + url
end
request(method, url, api_key, params = {}, headers = {}, api_base_url = nil, open_timeout = nil, read_timeout = nil, ssl_ca_file = nil, ssl_ca_path = nil, ssl_cert_store = nil) click to toggle source
# File lib/payjp.rb, line 63
def self.request(method, url, api_key, params = {}, headers = {}, api_base_url = nil, open_timeout = nil, read_timeout = nil, ssl_ca_file = nil, ssl_ca_path = nil, ssl_cert_store = nil)
  api_base_url ||= @api_base
  open_timeout ||= @open_timeout
  read_timeout ||= @read_timeout
  ssl_ca_file ||= @ssl_ca_file
  ssl_ca_path ||= @ssl_ca_path
  ssl_cert_store ||= @ssl_cert_store

  unless api_key ||= @api_key
    raise AuthenticationError.new('No API key provided. ' \
      'Set your API key using "Payjp.api_key = <API-KEY>". ' \
      'You can generate API keys from the Payjp web interface. ' \
      'See https://pay.jp/api for details, or email support@pay.jp ' \
      '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 ' \
      'Payjp web interface. See https://pay.jp/api for details, or ' \
      'email support@pay.jp if you have any questions.)')
  end

  request_opts = {}

  params = Util.objects_to_ids(params)
  url = api_url(url, api_base_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
    if headers[:content_type] && headers[:content_type] == "multipart/form-data"
      payload = params
    else
      payload = uri_encode(params)
    end
  end

  request_opts.update(:headers => request_headers(api_key).update(headers),
                      :method => method, :payload => payload, :url => url,
                      :open_timeout => open_timeout, :read_timeout => read_timeout,
                      :ssl_ca_file => ssl_ca_file, :ssl_ca_path => ssl_ca_path,
                      :ssl_cert_store => ssl_cert_store)

  begin
    # $stderr.puts request_opts

    response = execute_request(request_opts)
  rescue SocketError => e
    handle_restclient_error(e, api_base_url)
  rescue NoMethodError => e
    # Work around RestClient bug
    if e.message =~ /\WRequestFailed\W/
      e = APIConnectionError.new('Unexpected HTTP response code')
      handle_restclient_error(e, api_base_url)
    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, api_base_url)
    end
  rescue RestClient::Exception, Errno::ECONNREFUSED => e
    handle_restclient_error(e, api_base_url)
  end

  [parse(response), api_key]
end

Private Class Methods

_uname_uname() click to toggle source
# File lib/payjp.rb, line 170
def self._uname_uname
  (`uname -a 2>/dev/null` || '').strip
rescue Errno::ENOMEM # couldn't create subprocess
  "uname lookup failed"
end
_uname_ver() click to toggle source
# File lib/payjp.rb, line 176
def self._uname_ver
  (`ver` || '').strip
rescue Errno::ENOMEM # couldn't create subprocess
  "uname lookup failed"
end
api_error(error, rcode, rbody, error_obj) click to toggle source
# File lib/payjp.rb, line 261
def self.api_error(error, rcode, rbody, error_obj)
  APIError.new(error[:message], rcode, rbody, error_obj)
end
authentication_error(error, rcode, rbody, error_obj) click to toggle source
# File lib/payjp.rb, line 252
def self.authentication_error(error, rcode, rbody, error_obj)
  AuthenticationError.new(error[:message], rcode, rbody, error_obj)
end
card_error(error, rcode, rbody, error_obj) click to toggle source
# File lib/payjp.rb, line 256
def self.card_error(error, rcode, rbody, error_obj)
  CardError.new(error[:message], error[:param], error[:code],
                rcode, rbody, error_obj)
end
execute_request(opts) click to toggle source
# File lib/payjp.rb, line 204
def self.execute_request(opts)
  RestClient::Request.execute(opts)
end
general_api_error(rcode, rbody) click to toggle source
# File lib/payjp.rb, line 220
def self.general_api_error(rcode, rbody)
  APIError.new("Invalid response object from API: #{rbody.inspect} " \
               "(HTTP response code was #{rcode})", rcode, rbody)
end
handle_api_error(rcode, rbody) click to toggle source
# File lib/payjp.rb, line 225
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 PayjpError.new # escape from parsing

  rescue JSON::ParserError, PayjpError
    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
  when 402
    raise card_error error, rcode, rbody, error_obj
  else
    raise api_error error, rcode, rbody, error_obj
  end
end
handle_restclient_error(e, api_base_url = nil) click to toggle source
# File lib/payjp.rb, line 265
def self.handle_restclient_error(e, 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 Payjp's service status at " \
      "https://status.pay.jp or let us know at support@pay.jp."

  case e
  when RestClient::RequestTimeout
    message = "Timed out over #{@read_timeout} sec. " \
      "Check if your request successed or not."

  when RestClient::ServerBrokeConnection
    message = "The connection to the server (#{api_base_url}) broke before the " \
      "request completed. #{connection_message}"

  when SocketError
    message = "Unexpected error communicating when trying to connect to Payjp. " \
      "Your DNS may not work. Check 'host api.pay.jp' from the command line."

  else
    message = "Unexpected error communicating with Payjp. " \
      "If this problem persists, let us know at support@pay.jp."

  end

  raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
end
invalid_request_error(error, rcode, rbody, error_obj) click to toggle source
# File lib/payjp.rb, line 247
def self.invalid_request_error(error, rcode, rbody, error_obj)
  InvalidRequestError.new(error[:message], error[:param], rcode,
                          rbody, error_obj)
end
parse(response) click to toggle source
# File lib/payjp.rb, line 208
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
request_headers(api_key) click to toggle source
# File lib/payjp.rb, line 187
def self.request_headers(api_key)
  headers = {
    :user_agent => "Payjp/v1 RubyBindings/#{Payjp::VERSION}",
    :authorization => "Basic #{Base64.strict_encode64("#{api_key}:")}",
    :content_type => 'application/x-www-form-urlencoded'
  }

  headers[:payjp_version] = api_version if api_version

  begin
    headers.update(:x_payjp_client_user_agent => JSON.generate(user_agent))
  rescue => e
    headers.update(:x_payjp_client_raw_user_agent => user_agent.inspect,
                   :error => "#{e} (#{e.class})")
  end
end
uname() click to toggle source
# File lib/payjp.rb, line 155
def self.uname
  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
uri_encode(params) click to toggle source
# File lib/payjp.rb, line 182
def self.uri_encode(params)
  Util.flatten_params(params).
    map { |k, v| "#{k}=#{Util.url_encode(v)}" }.join('&')
end
user_agent() click to toggle source
# File lib/payjp.rb, line 139
def self.user_agent
  @uname ||= uname
  lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"

  {
    :bindings_version => Payjp::VERSION,
    :lang => 'ruby',
    :lang_version => lang_version,
    :platform => RUBY_PLATFORM,
    :engine => defined?(RUBY_ENGINE) ? RUBY_ENGINE : '',
    :publisher => 'payjp',
    :uname => @uname,
    :hostname => Socket.gethostname
  }
end