gocoin 0.1.2

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/history.md

@@ -0,0 +1,21 @@
+###Changelog
+
+###### v0.1.1:
+Initial release: <br>
+Selected methods for User, Merchant, and Invoices
+
+###### v0.1.2:
+Decapitalized all instances of gocoin (except class name Gocoin). <br>
+This includes the gem name itself
+
+Added methods:
+* client.accounts.transactions
+* client.merchant.currencies.get
+* client.merchant.currencies.list
+* client.merchant.currencies.update
+* client.merchant.currency_conversions.get
+* client.merchant.currency_conversions.list
+* client.merchant.currency_conversions.request
+* client.merchant.payouts.get
+* client.merchant.payouts.list
+* client.merchant.payouts.request

data/lib/gocoin.rb

@@ -0,0 +1,27 @@
+require 'cgi'
+require 'json'
+require 'socket'
+require 'rest_client'
+require 'logger'
+
+require 'gocoin/version'
+require 'gocoin/util'
+
+require 'gocoin/errors/gocoin_error'
+require 'gocoin/errors/api_connection_error'
+require 'gocoin/errors/api_error'
+require 'gocoin/errors/authentication_error'
+require 'gocoin/errors/invalid_request_error'
+
+require 'gocoin/client'
+require 'gocoin/auth'
+require 'gocoin/api'
+require 'gocoin/xrate'
+
+require 'gocoin/api/invoices'
+require 'gocoin/api/merchant'
+require 'gocoin/api/user'
+require 'gocoin/api/accounts'
+require 'gocoin/api/merchants/currencies'
+require 'gocoin/api/merchants/currency_conversions'
+require 'gocoin/api/merchants/payouts'

data/lib/gocoin/api.rb

@@ -0,0 +1,35 @@
+module Gocoin
+  class API
+
+    attr_reader :client, :user, :merchant, :invoices, :accounts
+
+  	def initialize(client)
+  		@client = client
+      @accounts = Gocoin::Accounts.new(self)
+      @invoices = Gocoin::Invoices.new(self)
+      @merchant = Gocoin::Merchant.new(self)
+      @user = Gocoin::User.new(self)
+  	end
+
+  	def request(route, options = {})
+  		@client.logger.debug 'Gocoin::API#request called.'
+  		raise 'Gocoin::API#request: Options is not a hash object' unless options.nil? || options.kind_of?(Hash)
+  		raise 'Gocoin::API#request: API not ready. Token was not defined' unless @client.token
+
+  		headers = options[:headers] ? @client.headers.merge(options[:headers]) : @client.headers.dup
+  		headers['Authorization'] = "Bearer #{@client.token}"
+
+  		options = @client.options.merge(options)
+  		payload = options[:payload] ? options[:payload].to_json : nil
+
+  		config = {
+  			url: "#{@client.http_prefix(options[:secure])}#{options[:host]}#{@client.port}#{options[:path]}/#{options[:api_version]}#{route}",
+  			method: options[:method],
+  			headers: headers,
+  		}
+      config[:payload] = options[:payload].to_json if options[:payload]
+  		@client.raw_request config
+  	end
+
+  end
+end

data/lib/gocoin/api/accounts.rb

@@ -0,0 +1,16 @@
+module Gocoin
+  class Accounts
+
+		def initialize(api)
+		  @api = api
+		end
+
+		def transactions(account_id, params = {})
+			@api.client.logger.debug 'Gocoin::Accounts#transactions called.'
+			route = "/accounts/#{account_id}/transactions?#{Util.hash_to_url_params(params)}"
+			options = {}
+			@api.request route, options
+		end
+
+	end
+end

data/lib/gocoin/api/invoices.rb

@@ -0,0 +1,33 @@
+module Gocoin
+  class Invoices
+
+		def initialize(api)
+		  @api = api
+		end
+
+		def create(merchant_id, params)
+			@api.client.logger.debug 'Gocoin::Invoices#create called.'
+			route = "/merchants/#{merchant_id}/invoices"
+			options = {
+				method: 'POST',
+				payload: params
+			}
+			@api.request route, options
+		end
+
+		def get(id)
+			@api.client.logger.debug 'Gocoin::Invoices#get called.'
+			route = "/invoices/#{id}"
+			options = {}
+			@api.request route, options
+		end
+
+		def search(params = {})
+			@api.client.logger.debug 'Gocoin::Invoices#search called.'
+			route = "/invoices/search?#{Util.hash_to_url_params(params)}"
+			options = {}
+			@api.request route, options
+		end
+
+	end
+end

data/lib/gocoin/api/merchant.rb

@@ -0,0 +1,38 @@
+module Gocoin
+  class Merchant
+
+    attr_reader :currencies, :currency_conversions, :payouts
+
+		def initialize(api)
+		  @api = api
+		  @currencies = Gocoin::Merchants::Currencies.new(api)
+		  @currency_conversions = Gocoin::Merchants::CurrencyConversions.new(api)
+		  @payouts = Gocoin::Merchants::Payouts.new(api)
+		end
+
+		def get(id)
+			@api.client.logger.debug 'Gocoin::Merchant#get called.'
+			route = "/merchants/#{id}"
+			options = {}
+			@api.request route, options
+		end
+
+		def update(id, params)
+			@api.client.logger.debug 'Gocoin::Merchant#update called.'
+			route = "/merchants/#{id}"
+			options = {
+				method: 'PATCH',
+				payload: params
+			}
+			@api.request route, options
+		end
+
+		def accounts(id)
+			@api.client.logger.debug 'Gocoin::Merchant#accounts called.'
+			route = "/merchants/#{id}/accounts"
+			options = {}
+			@api.request route, options
+		end
+
+	end
+end

data/lib/gocoin/api/merchants/currencies.rb

@@ -0,0 +1,35 @@
+module Gocoin
+	module Merchants
+	  class Currencies
+
+			def initialize(api)
+			  @api = api
+			end
+
+			def get(merchant_id, currency_code)
+				@api.client.logger.debug 'Gocoin::Merchants::Currencies#get called.'
+				route = "/merchants/#{merchant_id}/currencies/#{currency_code}"
+				options = {}
+				@api.request route, options
+			end
+
+			def list(merchant_id)
+				@api.client.logger.debug 'Gocoin::Merchants::Currencies#list called.'
+				route = "/merchants/#{merchant_id}/currencies"
+				options = {}
+				@api.request route, options
+			end
+
+			def update(merchant_id, currency_code, params)
+				@api.client.logger.debug 'Gocoin::Merchants::Currencies#update called.'
+				route = "/merchants/#{merchant_id}/currencies/#{currency_code}"
+				options = {
+					method: 'PATCH',
+					payload: params
+				}
+				@api.request route, options
+			end
+
+		end
+	end
+end

data/lib/gocoin/api/merchants/currency_conversions.rb

@@ -0,0 +1,35 @@
+module Gocoin
+	module Merchants
+	  class CurrencyConversions
+
+			def initialize(api)
+			  @api = api
+			end
+
+			def get(merchant_id, currency_conversion_id)
+				@api.client.logger.debug 'Gocoin::Merchants::CurrencyConversion#get called.'
+				route = "/merchants/#{merchant_id}/currency_conversions/#{currency_conversion_id}"
+				options = {}
+				@api.request route, options
+			end
+
+			def list(merchant_id)
+				@api.client.logger.debug 'Gocoin::Merchants::CurrencyConversion#list called.'
+				route = "/merchants/#{merchant_id}/currency_conversions"
+				options = {}
+				@api.request route, options
+			end
+
+			def request(merchant_id, params)
+				@api.client.logger.debug 'Gocoin::Merchants::CurrencyConversion#request called.'
+				route = "/merchants/#{merchant_id}/currency_conversions"
+				options = {
+					method: 'POST',
+					payload: params
+				}
+				@api.request route, options
+			end
+
+		end
+	end
+end

data/lib/gocoin/api/merchants/payouts.rb

@@ -0,0 +1,35 @@
+module Gocoin
+	module Merchants
+	  class Payouts
+
+			def initialize(api)
+			  @api = api
+			end
+
+			def get(merchant_id, payout_id)
+				@api.client.logger.debug 'Gocoin::Merchants::Payouts#get called.'
+				route = "/merchants/#{merchant_id}/payouts/#{payout_id}"
+				options = {}
+				@api.request route, options
+			end
+
+			def list(merchant_id)
+				@api.client.logger.debug 'Gocoin::Merchants::Payouts#list called.'
+				route = "/merchants/#{merchant_id}/payouts"
+				options = {}
+				@api.request route, options
+			end
+
+			def request(merchant_id, params)
+				@api.client.logger.debug 'Gocoin::Merchants::Payouts#request called.'
+				route = "/merchants/#{merchant_id}/payouts"
+				options = {
+					method: 'POST',
+					payload: params
+				}
+				@api.request route, options
+			end
+
+		end
+	end
+end

data/lib/gocoin/api/user.rb

@@ -0,0 +1,43 @@
+module Gocoin
+  class User
+
+		def initialize(api)
+		  @api = api
+		end
+
+		def get(id)
+			@api.client.logger.debug 'Gocoin::User#get called.'
+			route = "/users/#{id}"
+			options = {}
+			@api.request route, options
+		end
+
+		def self
+			@api.client.logger.debug 'Gocoin::User#self called.'
+			route = "/user"
+			options = {}
+			@api.request route, options
+		end
+
+		def update(id, params)
+			@api.client.logger.debug 'Gocoin::User#update called.'
+			route = "/users/#{id}"
+			options = {
+				method: 'PATCH',
+				payload: params
+			}
+			@api.request route, options
+		end
+
+		def update_password(id, params)
+			@api.client.logger.debug 'Gocoin::User#update_password called.'
+			route = "/users/#{id}/password"
+			options = {
+				method: 'PATCH',
+				payload: params
+			}
+			@api.request route, options
+		end
+
+	end
+end

data/lib/gocoin/auth.rb

@@ -0,0 +1,51 @@
+module Gocoin
+  class Auth
+
+    REQUIRED_CODE_PARAMS = %w[grant_type client_id client_secret code redirect_uri]
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def authenticate(options = {})
+      @client.logger.debug 'Gocoin::Auth#authenticate method called.'
+
+      headers = @client.headers.merge(options[:headers] || {})
+      options = @client.options.merge options
+      verify_required_params options
+      route = '/oauth/token'
+
+      config = {
+        url: "#{@client.http_prefix}#{@client.options[:host]}#{@client.port}#{@client.options[:path]}/#{@client.options[:api_version]}#{route}",
+        method: 'POST',
+        headers: headers,
+        payload: options.to_json
+      }
+
+      @client.raw_request config
+    end
+
+    def construct_code_url(params)
+      "https://#{@client.options[:dashboard_host]}/auth?#{Util.hash_to_url_params(params)}"
+    end
+
+    private
+
+    def verify_required_params(options)
+      if options[:grant_type] == 'authorization_code'
+        required = REQUIRED_CODE_PARAMS
+      else
+        raise 'Gocoin::Auth#authenticate: grant_type was not defined properly or is unsupported'
+      end      
+
+      @client.logger.debug "Required params: #{required}"
+      required.each do |required_attribute|
+        raise "Gocoin::Auth#authenticate requires '#{required_attribute}' option." unless options[required_attribute.to_sym]
+      end
+      options
+    end
+
+  end
+end

data/lib/gocoin/client.rb

@@ -0,0 +1,201 @@
+module Gocoin
+	class Client
+
+		attr_reader :api, :auth, :xrate, :user, :merchant, :accounts, :invoices, :apps, :headers, :options, :logger
+		attr_accessor :token
+
+		def initialize(options = {})
+			@defaults = {
+				client_id: nil,
+				client_secret: nil,
+				host: 'api.gocoin.com',
+				port: nil,
+				path: '/api',
+				api_version: 'v1',
+				secure: true,
+				method: 'GET',
+				headers: nil,
+				grant_type: 'authorization_code',
+				request_id: nil,
+				dashboard_host: 'dashboard.gocoin.com',
+				xrate_host: 'x.g0cn.com',
+				log_file: nil
+			}
+
+			@default_headers = {
+				'Content-Type' => 'application/json'
+			}
+
+			@options = @defaults.merge options
+			@logger = Logger.new(@options[:log_file] || STDOUT)
+			@headers = @options[:headers] || @default_headers
+			@headers['X-Request-Id'] = @options[:request_id] if @options[:request_id]
+
+			@auth = Gocoin::Auth.new(self)
+			@api = Gocoin::API.new(self)
+			@xrate = Gocoin::Xrate.new(self)
+
+			@accounts = @api.accounts
+			@invoices = @api.invoices
+			@merchant = @api.merchant
+			@user = @api.user
+
+			@options[:secure] = false if @options[:secure] == 'false'
+		end
+
+		def authenticate(options)
+			@logger.debug 'Gocoin::Client#authenticate method called.'
+			@auth.authenticate options
+		end
+
+		def http_prefix(secure = true)
+			secure ? 'https://' : 'http://'
+		end
+
+		def port
+			@options[:port] ? ":#{@options[:port]}" : nil
+		end
+
+		def raw_request(config)
+			unless config[:payload].nil?
+				config[:headers]['Content-Length'] = config[:payload].length
+			end
+
+			log_config = config.dup
+			log_config[:headers] = config[:headers].dup
+			@logger.debug 'Raw request made' + strip_secure_from_raw(log_config).to_s
+
+			error_response = nil
+			begin
+				response = RestClient::Request.execute(
+					config.merge(
+						open_timeout: 30,
+						timeout: 80
+					)
+				)
+			rescue SocketError => error_response
+				handle_restclient_error error_response
+			rescue NoMethodError => error_response
+				if error_response.message =~ /\WRequestFailed\W/
+					error_response = APIConnectionError.new('Unexpected HTTP response code')
+					handle_restclient_error error_response
+				else
+					raise
+				end
+			rescue RestClient::ExceptionWithResponse => error_response
+				if rcode = error_response.http_code and rbody = error_response.http_body
+					handle_api_error rcode, rbody
+				else
+					handle_restclient_error error_response
+				end
+			rescue RestClient::Exception, Errno::ECONNREFUSED => error_response
+				handle_restclient_error error_response
+			end
+
+			return parse_error(error_response) if error_response
+			parse response
+		end
+
+		private
+
+		def strip_secure_from_raw(obj)
+			strippable = %w[client_secret password current_password password_confirmation]
+			if obj[:payload]
+				obj[:payload] = JSON.parse obj[:payload]
+				strippable.each do |k|
+					obj[:payload][k] = "<#{k}>" if obj[:payload][k]
+				end
+			end
+			obj[:headers]['Authorization'] = '<bearer>' if obj[:headers]['Authorization']
+			
+			obj
+		end
+
+		def parse(response)
+			begin
+				response = JSON.parse response.body
+			rescue JSON::ParserError
+				raise general_api_error response.code, response.body
+			end
+
+			Util.symbolize_names response
+		end
+
+		def parse_error(error_response)
+			begin
+				response = JSON.parse error_response.http_body
+			rescue JSON::ParserError
+				raise general_api_error error_response.http_code, error_response.error_body
+			end
+
+			response[:status] = error_response.http_code
+
+			Util.symbolize_names response
+		end
+
+		def general_api_error(rcode, rbody)
+			APIError.new( "Invalid response object from API: #{rbody.inspect} " +
+										"(HTTP response code was #{rcode}", rcode, rbody)
+		end
+
+		def handle_api_error(rcode, rbody)
+			begin
+				error_obj = JSON.parse rbody
+				error_obj = Util.symbolize_names(error_obj)
+				error = error_obj[:error_description] or error_obj[:errors] or raise GocoinError.new
+			rescue JSON::ParserError, GocoinError
+				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 422 # Don't raise an error. Pass back a JSON object
+				return
+			else
+				raise api_error error, rcode, rbody, error_obj
+			end
+		end
+
+		def invalid_request_error(error, rcode, rbody, error_obj)
+			InvalidRequestError.new(error, rcode, rbody, error_obj)
+		end
+
+	  def authentication_error(error, rcode, rbody, error_obj)
+	    AuthenticationError.new(error, rbody, error_obj)
+	  end
+
+	  def api_error(error, rcode, rbody, error_obj)
+	    APIError.new(error, rcode, rbody, error_obj)
+	  end
+
+		def handle_restclient_error(e)
+	    case e
+	    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+	      message = "Could not connect to GoCoin (#{@options[:host]}). " +
+	        "Please check your internet connection and try again. " +
+	        "If this problem persists,  let us know at tech@gocoin.com."
+
+	    when RestClient::SSLCertificateNotVerified
+	      message = "Could not verify GoCoin's SSL certificate. " +
+	        "Please make sure that your network is not intercepting certificates. " +
+	        "(Try going to https://#{options[:host]}/#{options[:api_version]} in your browser.) " +
+	        "If this problem persists, let us know at tech@gocoin.com."
+
+	    when SocketError
+	      message = "Unexpected error communicating when trying to connect to GoCoin. " +
+	        "You may be seeing this message because your DNS is not working. " +
+	        "To check, try running 'host gocoin.com' from the command line."
+
+	    else
+	      message = "Unexpected error communicating with GoCoin. " +
+	        "If this problem persists, let us know at tech@gocoin.com."
+	    end
+
+	    raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
+	  end
+
+	end
+end