startcoin-client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 795bc699e065fa6a9ef2b4b24ffdd06448099889
-  data.tar.gz: 941517fb97e1e0229345cf17c7f36210c2d62230
+  metadata.gz: bde3485c1c709cfb9529a751a981ec6dc265d76c
+  data.tar.gz: bb4bca71ededf287c427be0a0a896340782b1979
 SHA512:
-  metadata.gz: 05261fec773f80989ffa655f633a446e8a9baaa86890b1cc047bf82b4e30c3d7d0ebc39ab0a7921520280bfd1ed4bfbf60414def3364dacc2d10138380121f28
-  data.tar.gz: 76372fc5b7f77eae5fe5684022efbd643044307732d0532900306b968b5b477a4535f45667733e54d439bff7fb8cb66ae8921999bae8ab79c7c00384cd45e30c
+  metadata.gz: 90ccde8a5828afdbff9ec9acf486ec86dbc0f5d46a225cf06a71b51354276a78df51d2d3bb3c5d8afc9a952a55aec5697af0568b03ed1e34cbc50275937733a5
+  data.tar.gz: 07d0ff28b67a6748304bf9557f8865ea7ef680b82d815192df59c776401ff208ea47eeb8b51061100d4ec53334443ecf0a9fdd4a9d0680da40808a44e795c6ad

data/.gitignore

@@ -1,3 +1,4 @@
+.ruby-*
 *.gem
 .bundle
 Gemfile.lock

data/README.rdoc

@@ -6,19 +6,17 @@ Also supports customizing the host and port number to connect to.
 
 == Installation
 
-On Ruby 1.9, you can just install the gem and start using it. On 1.8, the 'json' gem is also required, so you'll need to install that first:
+To install gem just add this entry to your Gemfile
 
-  gem install json
+  gem 'startcoin-client'
+  gem 'json', '~> 1.5.3' # For Ruby < 1.9
 
-Or, if you're using Bundler (and you should be), just add it to the Gemfile:
-
-  gem 'json', '~> 1.5.3'
 
 == Usage
 
 As with most Ruby gems, you first need to require the library into your project:
 
-  require 'bitcon_client'
+  require 'startcoin_client'
 
 After doing this, the simplest possible usage looks like this:
 
@@ -32,47 +30,34 @@ same task:
   client.balance
   # => 0.001
 
-The third and final way to use the library is by taking advantage of a simple DSL:
-
-  include StartcoinClient
-
-  # set up credentials
-  username 'username'
-  password 'password'
-
-  balance
-  # => 0.001
-
-  accounts
-  # => {"account" => 0.001}
-
 The RPC method names available to you are exactly the same as those listed on the Startcoin wiki
 (again, that's {https://en.bitcoin.it/wiki/Original_Startcoin_client/API_Calls_list}[https://en.bitcoin.it/wiki/Original_Startcoin_client/API_Calls_list]). Some aliases
 have been added to make them more "ruby-ish," but none of the original names have been changed.
 
+== Host, Port, SSL, Proxy
 
-== Host, Port and SSL
+Here are several examples of how you can change the host and proxy information:
 
-Here are several examples of how you can change the host information:
-
-  StartcoinClient('username', 'password', :host => 'example.com', :port => 38332, :ssl => true)
+  StartcoinClient('username', 'password', :host => 'example.com', :port => 38332, :ssl => true, :proxy => 'http://someproxy.com')
 
   client = StartcoinClient::Client.new('username', 'password', :host => 'example.com')
   client.port = 38332
+  client.proxy = 'http://someproxy.com'
   client.ssl = true
   client.ssl?
   # => true
 
-  include StartcoinClient
-  host 'example.com'
-  port 38332
-  ssl?
-  # => false
-  ssl true
-  ssl?
-  # => true
-
 You should see the StartcoinClient::Client class documentation if you'd like to see the other options and methods
 that are made available.
 
+== Test environment
+
+It's highly recommended to not connect StartcoinClient to live network, but instead use local testnet. One possibility is to use docker image called **bitcoin-testnet-box** (https://github.com/freewil/bitcoin-testnet-box). For installation process please follow instructions on its wiki page.
+
+After successful instalation you can connect to wallets with following commands
+
+  StartcoinClient('admin1', '123', :host => '127.0.0.1', :port => 19001)
+  StartcoinClient('admin2', '123', :host => '127.0.0.1', :port => 19011)
+
+At this point you can use regular RPC methods provided in API
 

data/lib/startcoin_client/api.rb

@@ -8,17 +8,20 @@ class StartcoinClient::API
   def port; options[:port]; end
   def ssl;  options[:ssl];  end
   def ssl?; options[:ssl];  end
+  def proxy; options[:proxy]; end
   def user=(a); options[:user] = a; end
   def pass=(a); options[:pass] = a; end
   def host=(a); options[:host] = a; end
   def port=(a); options[:port] = a; end
   def ssl=(a);  options[:ssl]  = a; end
+  def proxy=(a); options[:proxy] = a; end
 
   def initialize(options = {})
     @options = {
       :host => 'localhost',
       :port => 8332,
-      :ssl  => false
+      :ssl  => false,
+      :proxy => nil
     }.merge(options)
   end
 

data/lib/startcoin_client/client.rb

@@ -5,12 +5,14 @@ class StartcoinClient::Client
   def host; api.host; end
   def port; api.port; end
   def ssl;  api.ssl;  end
+  def proxy; api.proxy; end
   def ssl?; api.ssl?; end
   def user=(a); api.user = a; end
   def pass=(a); api.pass = a; end
   def host=(a); api.host = a; end
   def port=(a); api.port = a; end
   def ssl=(a);  api.ssl  = a; end
+  def proxy=(a); api.proxy = a; end
 
   def options
     api.options

data/lib/startcoin_client/dsl.rb

@@ -27,6 +27,10 @@ module StartcoinClient::DSL
     bitcoin.ssl = value
   end
 
+  def proxy=(value)
+    bitcoin.proxy = value
+  end
+
   def username(value = nil)
     value ? bitcoin.user = value : bitcoin.user
   end
@@ -47,6 +51,10 @@ module StartcoinClient::DSL
     value.nil? ? bitcoin.ssl : bitcoin.ssl = value
   end
 
+  def proxy(value = nil)
+    value.nil? ? bitcoin.proxy : bitcoin.proxy = value
+  end
+
   def ssl?
     bitcoin.ssl?
   end

data/lib/startcoin_client/rpc.rb

@@ -4,7 +4,7 @@ class StartcoinClient::RPC
   def initialize(options)
     @user, @pass = options[:user], options[:pass]
     @host, @port = options[:host], options[:port]
-    @ssl = options[:ssl]
+    @ssl, @proxy = options[:ssl], options[:proxy]
   end
 
   def credentials
@@ -23,11 +23,19 @@ class StartcoinClient::RPC
   end
 
   def dispatch(request)
-    RestClient.post(service_url, request.to_post_data, content_type: :json) do |respdata, request, result|
+    process_response = lambda do |respdata, _request, _result|
       response = JSON.parse(respdata)
       raise StartcoinClient::Errors::RPCError, response['error'] if response['error']
       response['result']
     end
+    RestClient::Request.execute(method: :post,
+                                url: service_url,
+                                payload: request.to_post_data,
+                                proxy: @proxy,
+                                headers: { content_type: :json },
+                                &process_response)
+
+    end
   end
 
   private

data/lib/startcoin_client/version.rb

@@ -2,7 +2,7 @@ module StartcoinClient
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 3
+    PATCH = 4
     REL = nil
 
     STRING = REL ? [MAJOR, MINOR, PATCH, REL].join('.') : [MAJOR, MINOR, PATCH].join('.')

data/spec/lib/startcoin_client/api_spec.rb

@@ -3,16 +3,23 @@ require 'spec_helper'
 describe StartcoinClient::API do
   subject { StartcoinClient::API.new(:user => $user, :pass => $pass) }
 
-  it "should have default host, port, ssl" do
+  it "should have default host, port, ssl, proxy" do
     subject.host.should == 'localhost'
     subject.port.should == 8332
     subject.ssl?.should be_false
+    subject.proxy.should be_nil
   end
 
-  it "should accept host, port, ssl options" do
-    req = StartcoinClient::API.new(:user => $user, :pass => $pass, :host => 'example.com', :port => 1234, :ssl => true)
+  it "should accept host, port, ssl, proxy options" do
+    req = StartcoinClient::API.new(:user => $user,
+                                   :pass => $pass,
+                                   :host => 'example.com',
+                                   :port => 1234,
+                                   :ssl => true,
+                                   :proxy => 'proxy.com')
     req.host.should == 'example.com'
     req.port.should == 1234
+    req.proxy.should == 'proxy.com'
     req.ssl?.should be_true
   end
 
@@ -23,6 +30,7 @@ describe StartcoinClient::API do
       :host => 'localhost',
       :port => 8332,
       :ssl => false,
+      :proxy => nil
     }
   end
 end

data/spec/lib/startcoin_client/client_spec.rb

@@ -8,6 +8,7 @@ describe StartcoinClient::Client do
     subject.pass.should == $pass
     subject.host.should == 'localhost'
     subject.port.should == 8332
+    subject.proxy.should be_nil
     subject.should_not be_ssl
   end
 

data/startcoin-client.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |s|
   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"
+  s.add_runtime_dependency "rest-client", '~> 2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: startcoin-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Colin MacKenzie IV
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,16 +85,16 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.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