coinkite 0.9 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9e4b935ab46f376d664cd1d96c0b29ccf0cbe1a
-  data.tar.gz: a0b409931a40c8522e174eab4b81032768f287ff
+  metadata.gz: 09719fb406dae1eb4e0e589a92db14b05f02fb2b
+  data.tar.gz: e0c4b67e64237221e2cc1c3ad311e90880ca5686
 SHA512:
-  metadata.gz: 29d35f924d8d07e68585512e75ede9ff96594d940597fa68171f5154d9eeabb563e3d255330b35ef6fac75493e1e11bb064066c2763d5afefbbf689bd6374377
-  data.tar.gz: e98d7d1636cdefdf94142bc3e3c464290c759f3b1d24102383022071a49d79f4138f63a00818117c93727452bdc558d68b57acc6e80618c0818cd7589aefe3dd
+  metadata.gz: 968a0e2a3c29b7c560dc44c191628bbe1896145e2027a8deb195d96c577360131d72f137463b1c935ade405edf3c1e3f651fbd251f79b353e95ce2ea9c813e37
+  data.tar.gz: aed894aa94f9e9c005067a7f04afbfb9684434ec73d299ce8ef9c8918e6fcc7dc2fcbf1b6fd52bbfde7b6e5dd7d243c127a632fa8a0084e490eaeaa26ef85d8e

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/README.md

@@ -7,7 +7,7 @@ account today!
 ## Introduction
 
 Every request made to the Coinkite API requires three special header
-lines. This code can generate the timestamp and signature value
+lines. The code in `sign.rb` can generate the timestamp and signature value
 required for 2 of those 3 headers. The remaining header is just
 the API key itself.
 
@@ -17,6 +17,9 @@ Header lines you need:
 	X-CK-Timestamp: 2014-06-23T03:10:04.905376
 	X-CK-Sign: 0aa7755aaa45189a98a5a8a887a564aa55aa5aa4aa7a98aa2858aaa60a5a56aa
 
+Use the Gem for a more complete solution that also checks SSL certificates, 
+handles some errors and wraps some API calls.
+
 ## How to Install
 
 Replace the two values shown here.
@@ -26,7 +29,7 @@ Replace the two values shown here.
 	API_SECRET = 'this-is-my-secret'
 ````
 
-The keys you need can be created on
+The keys you need can be created at
 [Coinkite.com under Merchant / API]([https://coinkite.com/merchant/api).
 
 
@@ -39,7 +42,7 @@ safely holding all your cryptocurrencies, including Bitcoin and Litecoin.
 
 ## Liscense
 
-Copyright (C) 2013 Coinkite Inc. (https://coinkite.com)
+Copyright (C) 2014 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

data/coinkite.gemspec

@@ -9,7 +9,7 @@ spec = Gem::Specification.new do |s|
   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.homepage = 'https://docs.coinkite.com/'
   s.license = 'MIT'
 
   s.add_dependency('rest-client', '~> 1.4')
@@ -17,6 +17,7 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('json', '~> 1.8')
 
   s.add_development_dependency('rspec', '~>3.0')
+  s.add_development_dependency('webmock')
 
   s.files = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")

data/lib/coinkite/version.rb

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

data/lib/coinkite.rb

@@ -44,12 +44,12 @@ module Coinkite
 
       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)
+                        :ssl_ca_file => @ssl_bundle_path,
+                        :method => method, :open_timeout => 30,
+                        :payload => payload, :url => url, :timeout => 80)
 
       begin
+        request_opts.update(:headers => request_headers(endpoint).update(headers))
         response = RestClient::Request.execute(request_opts)
       rescue SocketError => e
         handle_restclient_error(e)
@@ -63,8 +63,9 @@ module Coinkite
         end
       rescue RestClient::ExceptionWithResponse => e
         if rcode = e.http_code and rbody = e.http_body
+          rbody = JSON.parse(rbody)
           if rcode == 429 and rbody.has_key?("wait_time")
-            sleep(rbody.wait_time)
+            sleep(rbody["wait_time"])
             retry
           else
             handle_api_error(rcode, rbody)
@@ -76,6 +77,7 @@ module Coinkite
         handle_restclient_error(e)
       end
 
+      #puts response.body
       JSON.parse(response.body)
     end
 
@@ -129,7 +131,7 @@ module Coinkite
     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)
+      hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('SHA256'), @api_secret, data)
 
       return hmac, ts
     end
@@ -145,8 +147,8 @@ module Coinkite
       }
     end
 
-    def get(endpoint)
-      request('GET', endpoint)
+    def get(endpoint, *args)
+      request('GET', endpoint, *args)
     end
 
     def get_accounts
@@ -160,6 +162,41 @@ module Coinkite
     def get_balance(account)
       get("/v1/account/#{account}")["account"]
     end
+
+    def get_iter(endpoint, offset: 0, limit: nil, batch_size: 25, safety_limit: 500, **options)
+      Enumerator.new do |yielder|
+        loop do
+          if limit and limit < batch_size
+            batch_size = limit
+          end
+
+          response = get(endpoint, { offset: offset, limit: batch_size })
+
+          here = response["paging"]["count_here"]
+          total = response["paging"]["total_count"]
+
+          if total > safety_limit
+            raise StandardError.new("Too many results (#{total}); consider another approach")
+          end
+
+          raise StopIteration if not here
+
+          response["results"].each { |entry| yielder.yield entry }
+
+          offset += here
+          if limit != nil
+            limit -= here
+            raise StopIteration if limit <= 0
+          end
+        end
+      end
+    end
+
+    def get_list(what)
+      # this returns a generator function
+      endpoint = "/v1/list/#{what}"
+      get_iter(endpoint)
+    end
   end
 end
 

data/spec/coinkite_spec.rb

@@ -1,11 +1,43 @@
 require 'spec_helper'
 
 describe Coinkite do
-  let(:coinkite) { Coinkite::Client.new(ENV['CK_API_KEY'], ENV['CK_API_SECRET']) }
+  before(:all) do
+    @coinkite = Coinkite::Client.new(ENV['CK_API_KEY'], ENV['CK_API_SECRET'])
+  end
 
   describe "#get_accounts" do
     it "should be retrievable" do
-      expect(coinkite.get_accounts).to be_kind_of(Array)
+      stub_request(:get, "https://api.coinkite.com/v1/my/accounts").to_return(body: fixture("accounts.json"))
+
+      expect(@coinkite.get_accounts).to be_kind_of(Array)
+    end
+  end
+
+  describe "#get_list('activity')" do
+
+    before(:all) do
+      @activities = @coinkite.get_list("activity")
+    end
+
+    let(:next_item) do
+      stub_request(:get, "https://api.coinkite.com/v1/list/activity?limit=25&offset=0").to_return(body: fixture("list_activity.json"))
+      @activities.next
+    end
+
+     it "should return an Enumerator" do
+      expect(@activities).to be_kind_of(Enumerator)
+    end
+
+    describe "#next" do
+      it "should yield the first item" do
+        expect(next_item["CK_refnum"]).to eq("8DF23CD7E5-3934A1")
+      end
+    end
+
+    describe "#next again" do
+      it "should yield the second item" do
+        expect(next_item["CK_refnum"]).to eq("635CBAE25F-34E37A")
+      end
     end
   end
 end

data/spec/fixtures/accounts.json

@@ -0,0 +1,26 @@
+{
+  "paging": {
+    "count_here": 2,
+    "limit": 25,
+    "offset": 0,
+    "total_count": 2
+  },
+  "results": [
+    {
+      "CK_refnum": "F033F8C7CA-B2B217",
+      "CK_type": "CKAccount",
+      "coin_type": "BTC",
+      "is_closed": false,
+      "name": "My Bitcoins",
+      "subaccount": 0
+    },
+    {
+      "CK_refnum": "4469EFE54E-DE212F",
+      "CK_type": "CKAccount",
+      "coin_type": "LTC",
+      "is_closed": false,
+      "name": "My Litecoins",
+      "subaccount": 1
+    }
+  ]
+}

data/spec/fixtures/list_activity.json

@@ -0,0 +1,221 @@
+{
+  "filters": {},
+  "paging": {
+    "count_here": 25,
+    "limit": 25,
+    "offset": 0,
+    "total_count": 50
+  },
+  "results": [
+    {
+      "CK_refnum": "8DF23CD7E5-3934A1",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-16T00:54:42.771753Z",
+      "detail_url": "https://coinkite.com/detail-view/204AFD04E2-582536",
+      "ip_address": "70.28.22.73",
+      "is_failed_login": true,
+      "summary": "API Security: Timestamp (2014-07-16T00:54:23Z) is same as last request (2014-07-16T00:54:23)"
+    },
+    {
+      "CK_refnum": "635CBAE25F-34E37A",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T07:12:52.963799Z",
+      "summary": "Session logout due to: idle"
+    },
+    {
+      "CK_refnum": "6EEE9E70EB-2182C2",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T06:42:24.693065Z",
+      "ip_address": "173.230.162.137",
+      "is_good_login": true,
+      "summary": "Successful login"
+    },
+    {
+      "CK_refnum": "379DC805EB-D6500C",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T06:41:38.094765Z",
+      "ip_address": "173.230.162.137",
+      "is_failed_login": true,
+      "summary": "Wrong password provided"
+    },
+    {
+      "CK_refnum": "C087D345E9-169E52",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T06:41:28.450025Z",
+      "ip_address": "173.230.162.137",
+      "is_failed_login": true,
+      "summary": "Wrong password provided"
+    },
+    {
+      "CK_refnum": "FC7B5563A5-46A711",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:47:00.456048Z",
+      "summary": "Session logout due to: idle"
+    },
+    {
+      "CK_refnum": "38409A3FD4-A77931",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:15:34.210910Z",
+      "email_msg": {
+        "CK_refnum": "3B4176F6BA-E366DC",
+        "CK_type": "CKEmailMessage",
+        "template": "event_notify",
+        "to": "foo@bar.com"
+      },
+      "summary": "Sent email: \"Coinkite notification: API Key added/changed\" to foo@bar.com"
+    },
+    {
+      "CK_refnum": "43C3F7C40B-B34430",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:15:34.011270Z",
+      "detail_url": "https://coinkite.com/detail-view/204AFD04E2-582536",
+      "ip_address": "173.230.162.137",
+      "summary": "Edited API Key (xxx-xxx-xxxx): perms [read] \u2192 [term, read, send2, xfer, recv, events, send]"
+    },
+    {
+      "CK_refnum": "13CCF205B4-457B5A",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:15:05.307082Z",
+      "email_msg": {
+        "CK_refnum": "4981672827-8B8376",
+        "CK_type": "CKEmailMessage",
+        "template": "event_notify",
+        "to": "foo@bar.com"
+      },
+      "summary": "Sent email: \"Coinkite notification: API Key added/changed\" to foo@bar.com"
+    },
+    {
+      "CK_refnum": "509D38A9F4-927A96",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:15:05.152984Z",
+      "detail_url": "https://coinkite.com/detail-view/204AFD04E2-582536",
+      "ip_address": "173.230.162.137",
+      "summary": "New API key created: xxx-xxx-xxxx"
+    },
+    {
+      "CK_refnum": "39EDD669B7-D707DB",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:07:19.250733Z",
+      "ip_address": "173.230.162.137",
+      "is_good_login": true,
+      "summary": "Successful login"
+    },
+    {
+      "CK_refnum": "8BE9182341-5B345F",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:06:50.360758Z",
+      "ip_address": "173.230.162.137",
+      "is_failed_login": true,
+      "summary": "Password right, but no token given"
+    },
+    {
+      "CK_refnum": "E060DF5539-6B10E1",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T02:06:39.615590Z",
+      "ip_address": "173.230.162.137",
+      "is_failed_login": true,
+      "summary": "Password right, but no token given"
+    },
+    {
+      "CK_refnum": "F79ABE27E1-E9E836",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-15T01:56:46.168697Z",
+      "ip_address": "173.230.162.137",
+      "is_failed_login": true,
+      "summary": "Password right, but wrong token given"
+    },
+    {
+      "CK_refnum": "4A815CA99A-656010",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-03T19:44:06.590482Z",
+      "summary": "Session logout due to: idle"
+    },
+    {
+      "CK_refnum": "BF3FFEBF97-02309D",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-03T19:09:20.358185Z",
+      "ip_address": "174.114.27.33",
+      "is_good_login": true,
+      "summary": "Successful login"
+    },
+    {
+      "CK_refnum": "E151FBF523-DB6774",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-03T18:27:11.538728Z",
+      "summary": "Session logout due to: idle"
+    },
+    {
+      "CK_refnum": "3882BAAA86-1F09C9",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-03T17:51:54.778717Z",
+      "ip_address": "174.114.27.33",
+      "is_good_login": true,
+      "summary": "Successful login"
+    },
+    {
+      "CK_refnum": "D011210218-184323",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-07-03T17:51:29.361788Z",
+      "ip_address": "174.114.27.33",
+      "is_failed_login": true,
+      "summary": "Password right, but no token given"
+    },
+    {
+      "CK_refnum": "890F381357-FEC713",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-06-23T13:50:43.190186Z",
+      "email_msg": {
+        "CK_refnum": "501D894646-4F0D49",
+        "CK_type": "CKEmailMessage",
+        "template": "outstanding",
+        "to": "foo@bar.com"
+      },
+      "summary": "Sent email: \"Reminder: Empty Account\" to foo@bar.com"
+    },
+    {
+      "CK_refnum": "6A2A3AB45B-8E4B39",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-05-14T13:50:29.757841Z",
+      "email_msg": {
+        "CK_refnum": "656C56B946-81069E",
+        "CK_type": "CKEmailMessage",
+        "template": "outstanding",
+        "to": "foo@bar.com"
+      },
+      "summary": "Sent email: \"Reminder: Empty Account\" to foo@bar.com"
+    },
+    {
+      "CK_refnum": "EA1FED5560-337C96",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-04-10T21:59:36.462092Z",
+      "summary": "Session logout due to: idle"
+    },
+    {
+      "CK_refnum": "644EAB22CC-8CF221",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-04-10T21:27:24.028223Z",
+      "ip_address": "199.33.114.66",
+      "summary": "Updated your country to CA: Canada"
+    },
+    {
+      "CK_refnum": "3FD13A7BAB-F9E413",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-04-10T21:27:24.005037Z",
+      "ip_address": "199.33.114.66",
+      "is_good_login": true,
+      "summary": "Successful login"
+    },
+    {
+      "CK_refnum": "E4D82430DE-3F4A49",
+      "CK_type": "CKActivityLog",
+      "created_at": "2014-04-09T13:51:02.205891Z",
+      "email_msg": {
+        "CK_refnum": "DBF7AE83BA-AE2865",
+        "CK_type": "CKEmailMessage",
+        "template": "outstanding",
+        "to": "foo@bar.com"
+      },
+      "summary": "Sent email: \"Empty Account\" to foo@bar.com"
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'coinkite'
 require 'rspec'
+require 'webmock/rspec'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
@@ -7,3 +8,10 @@ RSpec.configure do |config|
   end
 end
 
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinkite
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: 0.9.1
 platform: ruby
 authors:
 - Ilia Lobsanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Coinkite is the most secure way to transact in bitcoin online. See https://coinkite.com
   for details.
 email:
@@ -81,6 +95,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - README.md
 - coinkite.gemspec
@@ -91,8 +106,10 @@ files:
 - lib/data/ca-certificates.crt
 - sign.rb
 - spec/coinkite_spec.rb
+- spec/fixtures/accounts.json
+- spec/fixtures/list_activity.json
 - spec/spec_helper.rb
-homepage: https://docs.coinkite.com/api/index.html
+homepage: https://docs.coinkite.com/
 licenses:
 - MIT
 metadata: {}
@@ -118,4 +135,6 @@ specification_version: 4
 summary: Ruby bindings for the Coinkite API
 test_files:
 - spec/coinkite_spec.rb
+- spec/fixtures/accounts.json
+- spec/fixtures/list_activity.json
 - spec/spec_helper.rb