coinkite 0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9e4b935ab46f376d664cd1d96c0b29ccf0cbe1a
+  data.tar.gz: a0b409931a40c8522e174eab4b81032768f287ff
+SHA512:
+  metadata.gz: 29d35f924d8d07e68585512e75ede9ff96594d940597fa68171f5154d9eeabb563e3d255330b35ef6fac75493e1e11bb064066c2763d5afefbbf689bd6374377
+  data.tar.gz: e98d7d1636cdefdf94142bc3e3c464290c759f3b1d24102383022071a49d79f4138f63a00818117c93727452bdc558d68b57acc6e80618c0818cd7589aefe3dd

data/.gitignore

@@ -0,0 +1,3 @@
+.env
+.idea/
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# Coinkite API Code for Ruby
+
+[Learn more about Coinkite's API here](https://docs.coinkite.com/)
+and visit the [Coinkite Main Site](https://coinkite.com/) to open your
+account today!
+
+## Introduction
+
+Every request made to the Coinkite API requires three special header
+lines. This code can generate the timestamp and signature value
+required for 2 of those 3 headers. The remaining header is just
+the API key itself.
+
+Header lines you need:
+
+	X-CK-Key: K5555a555-55a555aa-a55aa5a5555aaa5a
+	X-CK-Timestamp: 2014-06-23T03:10:04.905376
+	X-CK-Sign: 0aa7755aaa45189a98a5a8a887a564aa55aa5aa4aa7a98aa2858aaa60a5a56aa
+
+## How to Install
+
+Replace the two values shown here.
+
+````ruby
+	API_KEY = 'this-is-my-key'
+	API_SECRET = 'this-is-my-secret'
+````
+
+The keys you need can be created on
+[Coinkite.com under Merchant / API]([https://coinkite.com/merchant/api).
+
+
+## More about Coinkite
+
+Coinkite is the world's easiest and most powerful web wallet for
+safely holding all your cryptocurrencies, including Bitcoin and Litecoin.
+
+[Learn more about all we offer](https://coinkite.com/)
+
+## Liscense
+
+Copyright (C) 2013 Coinkite Inc. (https://coinkite.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+

data/coinkite.gemspec

@@ -0,0 +1,24 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'coinkite/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'coinkite'
+  s.version = Coinkite::VERSION
+  s.summary = 'Ruby bindings for the Coinkite API'
+  s.description = 'Coinkite is the most secure way to transact in bitcoin online. See https://coinkite.com for details.'
+  s.authors = ['Ilia Lobsanov']
+  s.email = ['ilia@lobsanov.com']
+  s.homepage = 'https://docs.coinkite.com/api/index.html'
+  s.license = 'MIT'
+
+  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('mime-types', '>= 1.25', '< 3.0')
+  s.add_dependency('json', '~> 1.8')
+
+  s.add_development_dependency('rspec', '~>3.0')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/lib/coinkite/errors/api_connection_error.rb

@@ -0,0 +1,21 @@
+module Coinkite
+  class APIConnectionError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end
+

data/lib/coinkite/errors/coinkite_error.rb

@@ -0,0 +1,32 @@
+module Coinkite
+  class CoinkiteError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+
+  class CKServerSideError < CoinkiteError
+
+  end
+
+  class CKMissingError < CoinkiteError
+
+  end
+
+  class CKArgumentError < CoinkiteError
+
+  end
+end

data/lib/coinkite/version.rb

@@ -0,0 +1,3 @@
+module Coinkite
+  VERSION = '0.9'
+end

data/lib/coinkite.rb

@@ -0,0 +1,165 @@
+require 'cgi'
+require 'time'
+require 'openssl'
+require 'rest-client'
+require 'json'
+
+require 'coinkite/version'
+
+require 'coinkite/errors/api_connection_error'
+require 'coinkite/errors/coinkite_error'
+
+module Coinkite
+  class Client
+    DEFAULT_CA_BUNDLE_PATH = File.dirname(__FILE__) + '/data/ca-certificates.crt'
+
+    def initialize(api_key, api_secret)
+      @api_key = api_key
+      @api_secret = api_secret
+      @api_base = 'https://api.coinkite.com'
+      @ssl_bundle_path  = DEFAULT_CA_BUNDLE_PATH
+    end
+
+    def api_url(url='')
+      @api_base + url
+    end
+
+    def request(method, endpoint, params={}, headers={})
+      unless api_key ||= @api_key
+        raise AuthenticationError.new('No API key provided. ' +
+          'Set your API key using "Coinkite.api_key = <API-KEY>". ' +
+          'You can generate API keys from the Coinkite web interface. ')
+      end
+
+      url = api_url(endpoint)
+
+      case method.to_s.downcase.to_sym
+      when :get, :head, :delete
+        url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+        payload = nil
+      else
+        payload = JSON.encode(params.fetch('_data', params))
+        headers['Content-Type'] = 'application/json'
+      end
+
+      request_opts = {}
+      request_opts.update(:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+                          :ssl_ca_file => @ssl_bundle_path,
+                          :headers => request_headers(endpoint).update(headers),
+                          :method => method, :open_timeout => 30,
+                          :payload => payload, :url => url, :timeout => 80)
+
+      begin
+        response = RestClient::Request.execute(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
+          if rcode == 429 and rbody.has_key?("wait_time")
+            sleep(rbody.wait_time)
+            retry
+          else
+            handle_api_error(rcode, rbody)
+          end
+        else
+          handle_restclient_error(e)
+        end
+      rescue RestClient::Exception, Errno::ECONNREFUSED => e
+        handle_restclient_error(e)
+      end
+
+      JSON.parse(response.body)
+    end
+
+    def uri_encode(params)
+      params.map { |k,v| "#{k}=#{url_encode(v)}" }.join('&')
+    end
+
+    def url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def handle_restclient_error(e)
+      case e
+      when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+        message = "Could not connect to Coinkite (#{@api_base}). " +
+          "Please check your internet connection and try again. " +
+          "If this problem persists, you should check Coinkite's service status at " +
+          "https://twitter.com/Coinkite, or let us know at support@coinkite.com."
+
+      when RestClient::SSLCertificateNotVerified
+        message = "Could not verify Coinkite's SSL certificate. " +
+          "Please make sure that your network is not intercepting certificates. " +
+          "(Try going to https://api.coinkite.com in your browser.) " +
+          "If this problem persists, let us know at support@coinkite.com."
+
+      when SocketError
+        message = "Unexpected error communicating when trying to connect to Coinkite. " +
+          "You may be seeing this message because your DNS is not working. " +
+          "To check, try running 'host coinkite.com' from the command line."
+
+      else
+        message = "Unexpected error communicating with Coinkite. " +
+          "If this problem persists, let us know at support@coinkite.com."
+
+      end
+
+      raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})")
+    end
+
+    def handle_api_error(rcode, rbody)
+      case rcode
+      when 400
+        raise CoinkiteError.new(rbody)
+      when 404
+        raise CoinkiteError.new(rbody)
+      else
+        raise CoinkiteError.new(rbody)
+      end
+    end
+
+    def make_signature(endpoint, force_ts=nil)
+      ts = force_ts || Time.now.utc.iso8601
+      data = endpoint + '|' + ts
+      hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('SHA256'), @api_secret, data)
+
+      return hmac, ts
+    end
+
+    def request_headers(endpoint, force_ts=nil)
+      signature, timestamp = make_signature(endpoint, force_ts)
+
+      {
+        'X-CK-Key' => @api_key,
+        'X-CK-Timestamp' => timestamp,
+        'X-CK-Sign' => signature,
+        'User-Agent' => "Coinkite/v1 RubyBindings/#{Coinkite::VERSION}"
+      }
+    end
+
+    def get(endpoint)
+      request('GET', endpoint)
+    end
+
+    def get_accounts
+      get('/v1/my/accounts')["results"]
+    end
+
+    def get_detail(refnum)
+      get("/v1/detail/#{refnum}")["detail"]
+    end
+
+    def get_balance(account)
+      get("/v1/account/#{account}")["account"]
+    end
+  end
+end
+