paysio 1.0.0

data/lib/paysio.rb

@@ -0,0 +1,252 @@
+# Paysio Ruby bindings
+# API spec at https://paysio.com/docs/api
+require 'cgi'
+require 'set'
+require 'rubygems'
+require 'openssl'
+
+gem 'rest-client', '~> 1.4'
+require 'rest_client'
+require 'multi_json'
+
+# Version
+require 'paysio/version'
+
+# API operations
+require 'paysio/api_operations/create'
+require 'paysio/api_operations/update'
+require 'paysio/api_operations/delete'
+require 'paysio/api_operations/list'
+
+# Resources
+require 'paysio/util'
+require 'paysio/json'
+require 'paysio/paysio_object'
+require 'paysio/api_resource'
+require 'paysio/singleton_api_resource'
+require 'paysio/list_object'
+require 'paysio/account'
+require 'paysio/customer'
+require 'paysio/charge'
+require 'paysio/coupon'
+require 'paysio/event'
+
+# Errors
+require 'paysio/errors/paysio_error'
+require 'paysio/errors/api_error'
+require 'paysio/errors/api_connection_error'
+require 'paysio/errors/card_error'
+require 'paysio/errors/invalid_request_error'
+require 'paysio/errors/authentication_error'
+
+module Paysio
+  @@ssl_bundle_path = File.join(File.dirname(__FILE__), 'data/ca-certificates.crt')
+  @@api_key = nil
+  @@api_base = 'api.paysio.com'
+  @@verify_ssl_certs = true
+  @@api_version = nil
+
+  def self.api_url(url='')
+    "https://#{api_key}@#{api_base}/#{url}"
+  end
+
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  def self.api_key
+    @@api_key
+  end
+
+  def self.api_base=(api_base)
+    @@api_base = api_base
+  end
+
+  def self.api_base
+    @@api_base
+  end
+
+  def self.verify_ssl_certs=(verify)
+    @@verify_ssl_certs = verify
+  end
+
+  def self.verify_ssl_certs
+    @@verify_ssl_certs
+  end
+
+  def self.api_version=(version)
+    @@api_version = version
+  end
+
+  def self.api_version
+    @@api_version
+  end
+
+  def self.request(method, url, api_key, params={}, headers={})
+    api_key ||= @@api_key
+    raise AuthenticationError.new('No API key provided.  (HINT: set your API key using "Paysio.api_key = <API-KEY>".  You can generate API keys from the Paysio web interface.  See https://paysio.com/api for details, or email support@paysio.com if you have any questions.)') unless api_key
+
+    if !verify_ssl_certs
+      unless @no_verify
+        $stderr.puts "WARNING: Running without SSL cert verification.  Execute 'Paysio.verify_ssl_certs = true' to enable verification."
+        @no_verify = true
+      end
+      ssl_opts = { :verify_ssl => false }
+    elsif !Util.file_readable(@@ssl_bundle_path)
+      unless @no_bundle
+        $stderr.puts "WARNING: Running without SSL cert verification because #{@@ssl_bundle_path} isn't readable"
+        @no_bundle = true
+      end
+      ssl_opts = { :verify_ssl => false }
+    else
+      ssl_opts = {
+        :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+        :ssl_ca_file => @@ssl_bundle_path
+      }
+    end
+    uname = (@@uname ||= RUBY_PLATFORM =~ /linux|darwin/i ? `uname -a 2>/dev/null`.strip : nil)
+    lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
+    ua = {
+      :bindings_version => Paysio::VERSION,
+      :lang => 'ruby',
+      :lang_version => lang_version,
+      :platform => RUBY_PLATFORM,
+      :publisher => 'paysio',
+      :uname => uname
+    }
+
+    params = Util.objects_to_ids(params)
+    url = self.api_url(url)
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      # Make params into GET parameters
+      if params && params.count > 0
+        query_string = Util.flatten_params(params).collect{|key, value| "#{key}=#{Util.url_encode(value)}"}.join('&')
+        url += "?#{query_string}"
+      end
+      payload = nil
+    else
+      payload = Util.flatten_params(params).collect{|(key, value)| "#{key}=#{Util.url_encode(value)}"}.join('&')
+    end
+
+    begin
+      headers = { :x_paysio_client_user_agent => Paysio::JSON.dump(ua) }.merge(headers)
+    rescue => e
+      headers = {
+        :x_paysio_client_raw_user_agent => ua.inspect,
+        :error => "#{e} (#{e.class})"
+      }.merge(headers)
+    end
+
+    headers = {
+      :user_agent => "Paysio/v1 RubyBindings/#{Paysio::VERSION}",
+      :content_type => 'application/x-www-form-urlencoded'
+    }.merge(headers)
+
+    if self.api_version
+      headers[:paysio_version] = self.api_version
+    end
+
+    opts = {
+      :method => method,
+      :url => url,
+      :headers => headers,
+      :open_timeout => 30,
+      :payload => payload,
+      :timeout => 80
+    }.merge(ssl_opts)
+
+    begin
+      response = execute_request(opts)
+    rescue SocketError => e
+      self.handle_restclient_error(e)
+    rescue NoMethodError => e
+      # Work around RestClient bug
+      if e.message =~ /\WRequestFailed\W/
+        e = APIConnectionError.new('Unexpected HTTP response code')
+        self.handle_restclient_error(e)
+      else
+        raise
+      end
+    rescue RestClient::ExceptionWithResponse => e
+      if rcode = e.http_code and rbody = e.http_body
+        self.handle_api_error(rcode, rbody)
+      else
+        self.handle_restclient_error(e)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      self.handle_restclient_error(e)
+    end
+
+    rbody = response.body
+    rcode = response.code
+    begin
+      # Would use :symbolize_names => true, but apparently there is
+      # some library out there that makes symbolize_names not work.
+      resp = Paysio::JSON.load(rbody)
+    rescue MultiJson::DecodeError
+      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+    end
+
+    resp = Util.symbolize_names(resp)
+    [resp, api_key]
+  end
+
+  private
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def self.handle_api_error(rcode, rbody)
+    begin
+      error_obj = Paysio::JSON.load(rbody)
+      error_obj = Util.symbolize_names(error_obj)
+      error = error_obj[:error] or raise PaysioError.new # escape from parsing
+    rescue MultiJson::DecodeError, PaysioError
+      raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+    end
+
+    case rcode
+    when 400, 404 then
+      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
+
+  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.card_error(error, rcode, rbody, error_obj)
+    CardError.new(error[:message], error[:param], error[:code], 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)
+    case e
+    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+      message = "Could not connect to Paysio (#{@@api_base}).  Please check your internet connection and try again.  If this problem persists, you should check Paysio's service status at https://twitter.com/paysiostatus, or let us know at support@paysio.com."
+    when RestClient::SSLCertificateNotVerified
+      message = "Could not verify Paysio's SSL certificate.  Please make sure that your network is not intercepting certificates.  (Try going to https://api.paysio.com/v1 in your browser.)  If this problem persists, let us know at support@paysio.com."
+    when SocketError
+      message = "Unexpected error communicating when trying to connect to Paysio.  HINT: You may be seeing this message because your DNS is not working.  To check, try running 'host paysio.com' from the command line."
+    else
+      message = "Unexpected error communicating with Paysio.  If this problem persists, let us know at support@paysio.com."
+    end
+    message += "\n\n(Network error: #{e.message})"
+    raise APIConnectionError.new(message)
+  end
+end

data/paysio.gemspec

@@ -0,0 +1,28 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'paysio/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'paysio'
+  s.version = Paysio::VERSION
+  s.summary = 'Ruby bindings for the Pays.io API'
+  s.description = 'See https://paysio.com for details.'
+  s.authors = ['Iskander Haziev']
+  s.email = ['gvalmon@gmail.com']
+  s.homepage = 'https://paysio.com'
+  s.executables = 'paysio'
+  s.require_paths = %w{lib}
+
+  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('multi_json', '>= 1.0.4', '< 2')
+
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('shoulda')
+  s.add_development_dependency('test-unit')
+  s.add_development_dependency('rake')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/test/test_helper.rb

@@ -0,0 +1,162 @@
+require 'stringio'
+require 'test/unit'
+require 'paysio'
+require 'mocha'
+include Mocha
+
+#monkeypatch request methods
+module Paysio
+  @mock_rest_client = nil
+
+  def self.mock_rest_client=(mock_client)
+    @mock_rest_client = mock_client
+  end
+
+  def self.execute_request(opts)
+    get_params = (opts[:headers] || {})[:params]
+    post_params = opts[:payload]
+    case opts[:method]
+    when :get then @mock_rest_client.get opts[:url], get_params, post_params
+    when :post then @mock_rest_client.post opts[:url], get_params, post_params
+    when :delete then @mock_rest_client.delete opts[:url], get_params, post_params
+    end
+  end
+end
+
+def test_response(body, code=200)
+  # When an exception is raised, restclient clobbers method_missing.  Hence we
+  # can't just use the stubs interface.
+  body = MultiJson.dump(body) if !(body.kind_of? String)
+  m = mock
+  m.instance_variable_set('@paysio_values', { :body => body, :code => code })
+  def m.body; @paysio_values[:body]; end
+  def m.code; @paysio_values[:code]; end
+  m
+end
+
+def test_customer(params={})
+  {
+    :subscription_history => [],
+    :bills => [],
+    :charges => [],
+    :livemode => false,
+    :object => "customer",
+    :id => "c_test_customer",
+    :active_card => {
+      :type => "Visa",
+      :last4 => "4242",
+      :exp_month => 11,
+      :country => "US",
+      :exp_year => 2012,
+      :id => "cc_test_card",
+      :object => "card"
+    },
+    :created => 1304114758
+  }.merge(params)
+end
+
+def test_customer_array
+  {
+    :data => [test_customer, test_customer, test_customer],
+    :object => 'list',
+    :url => '/v1/customers'
+  }
+end
+
+def test_charge(params={})
+  {
+    :refunded => false,
+    :paid => true,
+    :amount => 100,
+    :card => {
+      :type => "Visa",
+      :last4 => "4242",
+      :exp_month => 11,
+      :country => "US",
+      :exp_year => 2012,
+      :id => "cc_test_card",
+      :object => "card"
+    },
+    :id => "ch_test_charge",
+    :reason => "execute_charge",
+    :livemode => false,
+    :currency => "usd",
+    :object => "charge",
+    :created => 1304114826
+  }.merge(params)
+end
+
+def test_charge_array
+  {
+    :data => [test_charge, test_charge, test_charge],
+    :object => 'list',
+    :url => '/v1/charges'
+  }
+end
+
+def test_card(params={})
+  {
+    :type => "Visa",
+    :last4 => "4242",
+    :exp_month => 11,
+    :country => "US",
+    :exp_year => 2012,
+    :id => "cc_test_card",
+    :object => "card"
+  }.merge(params)
+end
+
+def test_coupon(params={})
+  {
+    :duration => 'repeating',
+    :duration_in_months => 3,
+    :percent_off => 25,
+    :id => "co_test_coupon",
+    :object => "coupon"
+  }.merge(params)
+end
+
+def test_invalid_api_key_error
+  {
+    "error" => {
+      "type" => "invalid_request_error",
+      "message" => "Invalid API Key provided: invalid"
+    }
+  }
+end
+
+def test_invalid_exp_year_error
+  {
+    "error" => {
+      "code" => "invalid_expiry_year",
+      "param" => "exp_year",
+      "type" => "card_error",
+      "message" => "Your card's expiration year is invalid"
+    }
+  }
+end
+
+def test_missing_id_error
+  {
+    :error => {
+      :param => "id",
+      :type => "invalid_request_error",
+      :message => "Missing id"
+    }
+  }
+end
+
+def test_api_error
+  {
+    :error => {
+      :type => "api_error"
+    }
+  }
+end
+
+def test_delete_discount_response
+  {
+    :deleted => true,
+    :id => "di_test_coupon"
+  }
+end