startcoin-client 0.0.3

data/spec/lib/startcoin_client/api_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe StartcoinClient::API do
+  subject { StartcoinClient::API.new(:user => $user, :pass => $pass) }
+
+  it "should have default host, port, ssl" do
+    subject.host.should == 'localhost'
+    subject.port.should == 8332
+    subject.ssl?.should be_false
+  end
+
+  it "should accept host, port, ssl options" do
+    req = StartcoinClient::API.new(:user => $user, :pass => $pass, :host => 'example.com', :port => 1234, :ssl => true)
+    req.host.should == 'example.com'
+    req.port.should == 1234
+    req.ssl?.should be_true
+  end
+
+  it "should build an options hash" do
+    subject.to_hash.should == {
+      :user => $user,
+      :pass => $pass,
+      :host => 'localhost',
+      :port => 8332,
+      :ssl => false,
+    }
+  end
+end

data/spec/lib/startcoin_client/client_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe StartcoinClient::Client do
+  subject { StartcoinClient::Client.new($user, $pass) }
+
+  it "defaults" do
+    subject.user.should == $user
+    subject.pass.should == $pass
+    subject.host.should == 'localhost'
+    subject.port.should == 8332
+    subject.should_not be_ssl
+  end
+
+  context "RPC" do
+    extend RPCServiceHelper
+
+    service 'getinfo' do
+      it "should produce the expected result" do
+        result.should == {
+          'version' => 32400,
+          'balance' => 0.001,
+          'blocks' => 141957,
+          'connections' => 8,
+          'proxy' => "",
+          'generate' => false,
+          'genproclimit' => -1,
+          'difficulty' => 1805700.83619367,
+          'hashespersec' => 0,
+          'testnet' => false,
+          'keypoololdest' => 1313766189,
+          'paytxfee' => 0.0,
+          'errors' => ""
+        }
+      end
+    end
+
+    service 'getmininginfo' do
+      it "should produce the expected result" do
+        result.should == {
+          'blocks' => 237338,
+          'currentblocksize' => 0,
+          'currentblocktx' => 0,
+          'difficulty' => 11187257.46136079,
+          'errors' => "",
+          'generate' => false,
+          'genproclimit' => -1,
+          'hashespersec' => 0,
+          'pooledtx' => 0,
+          'testnet' => false
+        }
+      end
+    end
+
+    service 'getblock' do
+      it "should produce the expected result" do
+        result("0000000000000002e004985f39f929d001448623b312185bf5e4ab50e5a8e60a").should == {
+          'hash' => "0000000000000002e004985f39f929d001448623b312185bf5e4ab50e5a8e60a",
+          'confirmations' => 19,
+          'size' => 5227,
+          'height' => 240707,
+          'version' => 2,
+          'merkleroot' => "18b914e2d6bd4c3118a936af75afbd230611edb6929a607302c0d591ef49b24e",
+          'tx' => [
+            "cutforsimplicity",
+            "27f99033bdcea87b07f8eea4279d7ce24e479fcb49e9f54e9ffb3721e29838ed"
+          ],
+          'time' => Time.utc(2013, 6, 10, 5, 40, 3),
+          'nonce' => 3937756309,
+          "bits" => "1a011337",
+          "difficulty" => 15605632.68128593,
+          "previousblockhash" => "000000000000003fa76b2abdd3036d183d7e24cfb6b543781d59cdca289f6053",
+          "nextblockhash" => "0000000000000087a1e962f618f757393930e58a745165033fc9d281b7bb568a"
+        }
+        end
+    end
+
+    service 'getblockcount' do
+      it "should produce the expected result" do
+        result.should == 141972
+      end
+    end
+
+    service 'getblocknumber' do
+      it "should produce the expected result" do
+        result.should == 141972
+      end
+    end
+
+    service 'getconnectioncount' do
+      it "should produce the expected result" do
+        result.should == 8
+      end
+    end
+
+    service 'getdifficulty' do
+      it "should produce the expected result" do
+        result.should == 1805700.83619367
+      end
+    end
+
+    service 'getgenerate' do
+      it "should produce the expected result" do
+        result.should be_false
+      end
+    end
+
+    service 'gethashespersec' do
+      it "should produce the expected result" do
+        result.should == 0
+      end
+    end
+
+    service 'listreceivedbyaddress' do
+      context 'without params' do
+        it "should produce the expected result" do
+          result.should == [{
+            'address' => "1234",
+            'account' => "",
+            'label' => "",
+            'amount' => 0.001,
+            'confirmations' => 180}]
+        end
+      end
+
+      context 'with minconf 0' do
+        it "should produce the expected result" do
+          result(0).should == [{
+            'address' => "1234",
+            'account' => "",
+            'label' => "",
+            'amount' => 0.001,
+            'confirmations' => 180}]
+        end
+      end
+
+      context 'with minconf 0 and includeempty true' do
+        it "should produce the expected result" do
+          result(0, true).should == [{
+            'address' => "1234",
+            'account' => "",
+            'label' => "",
+            'amount' => 0.001,
+            'confirmations' => 180}]
+        end
+      end
+    end
+
+    service 'setaccount' do
+      it 'maps the call correctly' do
+        subject.api.should_receive(:request).with(*%w(setaccount bitcoinaddress account))
+        result('bitcoinaddress', 'account').should be_nil
+      end
+    end
+
+    service 'signmessage' do
+      context 'success' do
+        it "should produce the expected result" do
+          result('valid_address', 'message').should == 'Gwz2BAaqdsLTqJsh5a4'
+        end
+      end
+
+      context 'invalid address' do
+        it "should produce the expected result" do
+          lambda { result('invalid_address', 'message').should }.should \
+            raise_error StartcoinClient::Errors::RPCError
+        end
+      end
+    end
+
+    service 'verifymessage' do
+      context 'success' do
+        it "should produce the expected result" do
+          result('address', 'message', 'signature').should be_true
+        end
+      end
+
+      context 'failure' do
+        it "should produce the expected result" do
+          result('address', 'message', 'signature').should be_false
+        end
+      end
+    end
+  end
+end

data/spec/lib/startcoin_client/request_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe StartcoinClient::Request do
+  it "should omit null arguments and everything after them" do
+    # bitcoin rejects null values even for optional params. Since
+    # even params following those may have default non-nil values,
+    # we'll assume the first non-nil value marks a set of optional
+    # params, and drop it and everything following it.
+
+    req = StartcoinClient::Request.new('svc', [1, nil, nil, nil])
+    req.params.should == [1]
+
+    req = StartcoinClient::Request.new('svc', [nil])
+    req.params.should == []
+
+    req = StartcoinClient::Request.new('svc', [1, nil, nil, 1, nil])
+    req.params.should == [1]
+  end
+end

data/spec/lib/startcoin_client_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe StartcoinClient do
+  before :each do
+    FakeWeb.register_uri(:post, "http://user:pass@localhost:8332", :response => fixture('getbalance'))
+  end
+
+  it "as a function" do
+    cli = StartcoinClient($user, $pass)
+    cli.balance.should == 0.001
+  end
+
+  it "DSL, included" do
+    class << self
+      include StartcoinClient
+    end
+
+    username $user
+    password $pass
+
+    balance.should == 0.001
+  end
+
+  it "DSL, extended" do
+    class << self
+      include StartcoinClient
+
+      username $user
+      password $pass
+
+      balance.should == 0.001
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'fakeweb'
+
+# bitcoin user settings
+$user = 'user'
+$pass = 'pass'
+
+require File.expand_path('../lib/startcoin_client', File.dirname(__FILE__))
+
+Dir[File.expand_path("support/**/*.rb", File.dirname(__FILE__))].each { |f| require f }
+
+RSpec.configure do |c|
+  c.include FixturesHelper
+  c.before { FakeWeb.allow_net_connect = false }
+  c.after  { FakeWeb.allow_net_connect = true  }
+end

data/spec/support/fixtures_helper.rb

@@ -0,0 +1,5 @@
+module FixturesHelper
+  def fixture(name)
+    File.read(File.expand_path("../fixtures/#{name}.json", File.dirname(__FILE__)))
+  end
+end

data/spec/support/rpc_service_helper.rb

@@ -0,0 +1,34 @@
+module RPCServiceHelper
+  def service(name, &block)
+    context "'#{name}'" do
+      define_method :fixture_name do
+        suffix = self.class.fixture_suffix.gsub(/\s/, '_')
+        if suffix.length > 0
+          "#{name}_#{suffix}"
+        else
+          name
+        end
+      end
+      
+      define_method :result do |*args|
+        FakeWeb.register_uri(:post, "http://user:pass@localhost:8332", :response => fixture(fixture_name))
+        subject.send(name, *args)
+      end
+      
+      class << self
+        def fixture_suffix
+          @fixture_suffix ||= ""
+        end
+        
+        def context(desc, &block)
+          super desc do
+            fixture_suffix.concat desc
+            instance_eval &block
+          end
+        end
+      end
+
+      instance_eval &block
+    end
+  end
+end

data/startcoin-client.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'startcoin_client/version'
+
+Gem::Specification.new do |s|
+  s.licenses    = ['MIT']
+  s.name        = 'startcoin-client'
+  s.version     = StartcoinClient::VERSION
+  s.authors     = ['Colin MacKenzie IV', 'Krzysztof Szromek']
+  s.email       = ['sinisterchipmunk@gmail.com', 'k.szromek@exlabs.co.uk']
+  s.homepage    = 'http://github.com/szromek/startcoin-client'
+  s.summary     = %q{Provides a Ruby library to the complete Startcoin JSON-RPC API.}
+  s.description = 'Provides a Ruby library to the complete Startcoin JSON-RPC API. ' +
+                  'Implements all methods listed at ' +
+                  'https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list ' +
+                  'which is the same as Startcoin API. ' +
+                  'Lets you set options such as the host and port number, and whether to use SSL.'
+
+  s.rubyforge_project = 'startcoin-client'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency "rake",    '~> 0.9'
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec",   '~> 2.6'
+  s.add_development_dependency "fakeweb", '~> 1.3'
+  s.add_development_dependency "coveralls"
+  s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: startcoin-client
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Colin MacKenzie IV
+- Krzysztof Szromek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a Ruby library to the complete Startcoin JSON-RPC API. Implements
+  all methods listed at https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list
+  which is the same as Startcoin API. Lets you set options such as the host and port
+  number, and whether to use SSL.
+email:
+- sinisterchipmunk@gmail.com
+- k.szromek@exlabs.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/startcoin_client.rb
+- lib/startcoin_client/api.rb
+- lib/startcoin_client/client.rb
+- lib/startcoin_client/dsl.rb
+- lib/startcoin_client/errors.rb
+- lib/startcoin_client/request.rb
+- lib/startcoin_client/rpc.rb
+- lib/startcoin_client/version.rb
+- spec/fixtures/backupwallet_without_params.json
+- spec/fixtures/build_fixture.rb
+- spec/fixtures/getbalance.json
+- spec/fixtures/getbestblockhash.json
+- spec/fixtures/getblock.json
+- spec/fixtures/getblockcount.json
+- spec/fixtures/getblocknumber.json
+- spec/fixtures/getconnectioncount.json
+- spec/fixtures/getdifficulty.json
+- spec/fixtures/getgenerate.json
+- spec/fixtures/gethashespersec.json
+- spec/fixtures/getinfo.json
+- spec/fixtures/getmininginfo.json
+- spec/fixtures/help.json
+- spec/fixtures/listreceivedbyaddress_with_minconf_0.json
+- spec/fixtures/listreceivedbyaddress_with_minconf_0_and_includeempty_true.json
+- spec/fixtures/listreceivedbyaddress_without_params.json
+- spec/fixtures/setaccount.json
+- spec/fixtures/signmessage_invalid_address.json
+- spec/fixtures/signmessage_success.json
+- spec/fixtures/verifymessage_failure.json
+- spec/fixtures/verifymessage_success.json
+- spec/lib/startcoin_client/api_spec.rb
+- spec/lib/startcoin_client/client_spec.rb
+- spec/lib/startcoin_client/request_spec.rb
+- spec/lib/startcoin_client_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures_helper.rb
+- spec/support/rpc_service_helper.rb
+- startcoin-client.gemspec
+homepage: http://github.com/szromek/startcoin-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: startcoin-client
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Provides a Ruby library to the complete Startcoin JSON-RPC API.
+test_files:
+- spec/fixtures/backupwallet_without_params.json
+- spec/fixtures/build_fixture.rb
+- spec/fixtures/getbalance.json
+- spec/fixtures/getbestblockhash.json
+- spec/fixtures/getblock.json
+- spec/fixtures/getblockcount.json
+- spec/fixtures/getblocknumber.json
+- spec/fixtures/getconnectioncount.json
+- spec/fixtures/getdifficulty.json
+- spec/fixtures/getgenerate.json
+- spec/fixtures/gethashespersec.json
+- spec/fixtures/getinfo.json
+- spec/fixtures/getmininginfo.json
+- spec/fixtures/help.json
+- spec/fixtures/listreceivedbyaddress_with_minconf_0.json
+- spec/fixtures/listreceivedbyaddress_with_minconf_0_and_includeempty_true.json
+- spec/fixtures/listreceivedbyaddress_without_params.json
+- spec/fixtures/setaccount.json
+- spec/fixtures/signmessage_invalid_address.json
+- spec/fixtures/signmessage_success.json
+- spec/fixtures/verifymessage_failure.json
+- spec/fixtures/verifymessage_success.json
+- spec/lib/startcoin_client/api_spec.rb
+- spec/lib/startcoin_client/client_spec.rb
+- spec/lib/startcoin_client/request_spec.rb
+- spec/lib/startcoin_client_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures_helper.rb
+- spec/support/rpc_service_helper.rb