silkroad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5050de75e2288298be54325a2ff9428d98c9cde
+  data.tar.gz: cf687338313a99fa297a2a5d532f67e66280bb00
+SHA512:
+  metadata.gz: aa2924a294708adde8b1e45fb25011d318d0af511b3633a61ab74d1750c30f80b067a7482233c620000a5ebf80244270933aaaa43adb40266b1fd6e8348ffffc
+  data.tar.gz: aac2a971cfd4e06d27fe4b0b6cd821053ba8230921c6bc1254a6c9ed038c36a96a080c803b72a80b44266c1e8a7ba2712d7b1b61de84dad13b9ff3a14dddf300

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.rb
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in silkroad.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kyle Drake
+
+MIT License
+
+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/README.md

@@ -0,0 +1,76 @@
+# Silkroad
+
+A fast, thread-safe, simple, lightweight, batchable interface to the bitcoind JSON-RPC api. Uses HTTPClient for [high performance](http://bibwild.wordpress.com/2012/04/30/ruby-http-performance-shootout-redux).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'silkroad'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install silkroad
+
+## Usage
+
+Initialize the client:
+
+```ruby
+silkroad = Silkroad::Client.new 'rpcuser', 'rpcpass'
+```
+
+You can set a custom url:
+```ruby
+silkroad = Silkroad::Client.new 'rpcuser', 'rpcpass', url: 'https://yourbitcoinddaemon.com:31337'
+```
+
+Now you can make RPC API calls (see the [API calls list](https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_calls_list)). Pass params as per the spec, and the result will be returned as an array or hash (depending on the call):
+
+```ruby
+silkroad.rpc 'getbalance', 'derp@example.com' # => 31337
+```
+
+Errors throw the `Silkroad::Client::Error` exception. Catch it if you want to do something custom:
+
+```ruby
+begin
+  silkroad.rpc 'failcmd', 'fail'
+rescue Silkroad::Client::Error => e
+  puts "Error: #{e.inspect}"
+end
+```
+
+### Batching
+
+If you use batching, it will throw all your requests into a JSON array, send them at once, and return all of them when they are done, per the [JSON-RPC spec](http://json-rpc.org/wiki/specification). Batch is much lower level, and does not raise exceptions on errors. You will need to look for the `response[index]['error']` in the return and handle it.
+
+```ruby
+response = @silkroad.batch do
+  rpc 'getbalance', 'tyler@example.com'
+  rpc 'notworking', 'derp'
+end
+
+# response is:
+[
+  {result: 31337, error: nil, id: nil},
+  {result: nil, error: {code: -32601, message: 'Method not found'}, id: nil}
+]
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+
+![Winners Don't Use Drugs - William S. Sessions, Director, FBI](http://i.imgur.com/4KdKeOK.gif)

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+desc "Run all tests"
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/silkroad.rb

@@ -0,0 +1,6 @@
+require "httpclient"
+require "addressable/uri"
+require "json"
+require "silkroad/batch"
+require "silkroad/client"
+require "silkroad/version"

data/lib/silkroad/batch.rb

@@ -0,0 +1,14 @@
+module Silkroad
+  class Batch < BasicObject
+    attr_reader :requests
+
+    def initialize(&block)
+      @requests = []
+      instance_eval &block
+    end
+
+    def rpc(meth, *params)
+      @requests << {method: meth, params: params}
+    end
+  end
+end

data/lib/silkroad/client.rb

@@ -0,0 +1,46 @@
+module Silkroad
+  class Client
+    class Error < StandardError; end
+    DEFAULT_PORT    = 8332
+    JSONRPC_VERSION = '2.0'
+
+    def initialize(user, pass, opts={})
+      @user        = user
+      @opts        = opts
+      @url         = Addressable::URI.parse @opts[:url] || "http://localhost:#{DEFAULT_PORT}"
+      @url.port    = DEFAULT_PORT if @url.port.nil?
+
+      @http_client = HTTPClient.new
+      @http_client.set_auth @url.to_s, user, pass
+    end
+
+    def batch(requests=nil, &block)
+      requests ||= Batch.new(&block).requests
+      requests.each {|r| r[:jsonrpc] = JSONRPC_VERSION unless r[:jsonrpc]}
+      JSON.parse send(requests).body
+    end
+
+    def rpc(meth, *params)
+      response = send jsonrpc: JSONRPC_VERSION, method: meth, params: params
+
+      if response.status != 200
+        if response.body.nil?
+          raise Error.new "bitcoind returned HTTP status #{response.status} with no body: #{response.http_header.reason_phrase}"
+        else
+          response_obj = JSON.parse response.body
+          raise Error.new "bitcoind returned error code #{response_obj['error']['code']}: #{response_obj['error']['message']}"
+        end
+      else
+        JSON.parse(response.body)['result']
+      end
+    end
+
+    def send(request)
+      @http_client.post @url, request.to_json, {'Content-Type' => 'application/json'}
+    end
+
+    def inspect
+      "#<#{self.class} user=\"#{@user}\" @url=\"#{@url.to_s}\">"
+    end
+  end
+end

data/lib/silkroad/version.rb

@@ -0,0 +1,3 @@
+module Silkroad
+  VERSION = "0.0.1"
+end

data/silkroad.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silkroad/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "silkroad"
+  spec.version       = Silkroad::VERSION
+  spec.authors       = ["Kyle Drake"]
+  spec.email         = ["kyledrake@gmail.com"]
+  spec.description   = %q{A fast, thread-safe, simple, lightweight, batchable, sober interface to the bitcoind JSON-RPC api.}
+  spec.summary       = %q{A fast, thread-safe, simple, lightweight, batchable, sober interface to the bitcoind JSON-RPC api. Uses HTTPClient for high performance (http://bibwild.wordpress.com/2012/04/30/ruby-http-performance-shootout-redux).}
+  spec.homepage      = "https://github.com/kyledrake/silkroad"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "addressable"
+  spec.add_dependency "httpclient"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
+end

data/test/client_test.rb

@@ -0,0 +1,64 @@
+# Bundler.setup
+require 'rubygems'
+require './lib/silkroad.rb'
+require 'minitest/autorun'
+require 'webmock'
+include WebMock::API
+
+def url
+  'http://user:pass@localhost:8332/'
+end
+
+def stub_with_body(body, response)
+  stub_request(:post, url).
+    with(body: body,
+         headers: {'Authorization'=>'Basic dXNlcjpwYXNz'}).
+    to_return(response)
+end
+
+describe Silkroad::Client do
+  before do
+    @silkroad = Silkroad::Client.new('user', 'pass')
+  end
+
+  it 'makes a call' do
+    stub_with_body(
+      {jsonrpc: "2.0", method: "getbalance", params: ["tyler@example.com"]},
+      {status: 200, body: {result: 31337}.to_json}
+    )
+
+    @silkroad.rpc('getbalance', 'tyler@example.com').must_equal 31337
+  end
+
+  it 'fails with error' do
+    stub_with_body(
+      {jsonrpc: "2.0", method: "failbalance", params: ["tyler@example.com"]},
+      {status: 200, body: {result: 31337}.to_json}
+    )
+  end
+
+  it 'makes a batch call' do
+    stub_request(:post, url).
+      with(
+        body: [
+          {method: 'getbalance', params: ['tyler@example.com'], jsonrpc: '2.0'},
+          {method: 'notworking', params: ['derp'], jsonrpc: '2.0'}
+        ].to_json,
+        headers: {'Authorization'=>'Basic dXNlcjpwYXNz', 'Content-Type'=>'application/json'}).
+      to_return(
+        :body => [
+          {result: 31337, error: nil, id: nil},
+          {result: nil, error: {code: -32601, message: 'Method not found'}, id: nil}
+        ].to_json
+      )
+
+    response = @silkroad.batch do
+      rpc 'getbalance', 'tyler@example.com'
+      rpc 'notworking', 'derp'
+    end
+
+    response.length.must_equal 2
+    response.first['result'].must_equal 31337
+    response.last['error']['message'].must_equal 'Method not found'
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: silkroad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: A fast, thread-safe, simple, lightweight, batchable, sober interface
+  to the bitcoind JSON-RPC api.
+email:
+- kyledrake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/silkroad.rb
+- lib/silkroad/batch.rb
+- lib/silkroad/client.rb
+- lib/silkroad/version.rb
+- silkroad.gemspec
+- test/client_test.rb
+homepage: https://github.com/kyledrake/silkroad
+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: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A fast, thread-safe, simple, lightweight, batchable, sober interface to the
+  bitcoind JSON-RPC api. Uses HTTPClient for high performance (http://bibwild.wordpress.com/2012/04/30/ruby-http-performance-shootout-redux).
+test_files:
+- test/client_test.rb
+has_rdoc: