helloblock-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88a1a989cdcc3a44441a2ecc0e300016074ca45d
+  data.tar.gz: 9a5234bcca9038a62de9084e36018bcd837ee14e
+SHA512:
+  metadata.gz: 2945c98405b7654d50c72ee0e028529dbe4a203eddd16ab620efe070b71fa29d22de3cfd565231ca8127ec3fb970fd13461f7e8efc13d3ab161ed4ee1d0338be
+  data.tar.gz: ced578c8bdeaa3a66e7814971ca5af93e378ac99f081798e5431134b170f9c3444053745b864c987eb04dc3d4a1c4beb5e673bf9df8588d05819f51c00915092

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Wroblewski
+
+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,48 @@
+# HelloBlock
+
+Ruby wrapper for the [HelloBlock.io](http://helloblock.io) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'helloblock-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install helloblock-ruby
+
+## Usage
+
+Initialize the HelloBlock client, and set the network to testnet or mainnet.
+
+```rb
+block = HelloBlock::Client.new
+block.network = :mainnet # defaults to :testnet
+```
+
+Description  | Method
+------------- | ------------- |
+Batch get addresses  | `block.addresses(addresses: ['ADDRESS1', 'ADDRESS2'])`|
+Batch get unspents  | `block.unspents(addresses: [...])` |
+Batch get transactions from address | `block.transactions_for_address(addresses: [...])`
+Batch get transactions | `block.transactions(txHashes: [...])` |
+Get latest transactions | `block.latest_transaction` |
+Post transaction propagation | `block.propagate(rawTxHash: '...')` |
+Get block | `block.blocks(blockId: '...')` |
+Get latest block | `block.latest_blocks` |
+Get wallet info | `block.wallet(addresses: [...])` |
+Get faucet coins | `block.faucet(type: 3)` |
+Post coins withdrawal | `block.withdrawal(amount: 100000, toAddress: '...')` |
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fixture/vcr_cassettes/addresses.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://testnet.helloblock.io/addresses/?addresses=1DQN9nopGvSCDnM3LH1w7j36FtnQDZKnej
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*'
+      User-Agent:
+      - HelloBlock Ruby Gem 0.0.1
+      Content-Type:
+      - application/json; charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Tue, 11 Mar 2014 08:04:14 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d5eeced580ba2f4e54df36669bb813c661394525054678; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.helloblock.io; HttpOnly
+      X-Powered-By:
+      - Express
+      Cf-Ray:
+      - 10963d77bde40651-SJC
+    body:
+      encoding: UTF-8
+      string: '{"status":"fail","message":"The endpoint you are looking for does not
+        exist!","details":[]}'
+    http_version: 
+  recorded_at: Tue, 11 Mar 2014 08:04:14 GMT
+recorded_with: VCR 2.8.0

data/helloblock-ruby.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'helloblock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "helloblock-ruby"
+  spec.version       = HelloBlock::VERSION
+  spec.authors       = ["Nathaniel Wroblewski"]
+  spec.email         = ["nathanielwroblewski@gmail.com"]
+  spec.description   = %q{Ruby wrapper for the HelloBlock.io API}
+  spec.summary       = %q{Ruby wrapper for the HelloBlock.io API}
+  spec.homepage      = "http://www.github.com/nathanielwroblewski/helloblock-ruby"
+  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_development_dependency 'bundler',        '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec',          '~> 2.14'
+  spec.add_development_dependency 'webmock',        '~> 1.17'
+  spec.add_development_dependency 'vcr',            '~> 2.8'
+  spec.add_development_dependency 'guard-rspec',    '~> 4.2'
+
+  spec.add_runtime_dependency 'multi_json',         '~> 1.9'
+  spec.add_runtime_dependency 'yajl-ruby',          '~> 1.2'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_runtime_dependency 'rash',               '~> 0.4'
+end

data/lib/helloblock.rb

@@ -0,0 +1,6 @@
+require 'helloblock/version'
+require 'helloblock/client'
+
+module HelloBlock
+
+end

data/lib/helloblock/client.rb

@@ -0,0 +1,25 @@
+require 'helloblock/client/connection'
+require 'helloblock/client/request'
+require 'helloblock/client/endpoints'
+
+module HelloBlock
+  class Client
+    attr_writer :network
+
+    include Connection
+    include Request
+    include Endpoints
+
+    def initialize
+
+    end
+
+    def network
+      @env ||= :testnet # :mainnet
+    end
+
+    def target_url
+      "http://#{network}.helloblock.io"
+    end
+  end
+end

data/lib/helloblock/client/connection.rb

@@ -0,0 +1,34 @@
+require 'faraday_middleware'
+
+module HelloBlock
+  class Client
+    module Connection
+      attr_writer :connection_options
+
+      private
+
+      def connection
+        @connection ||= Faraday.new(base_url, connection_options) do |connection|
+          connection.request :json
+          connection.response :json
+          connection.use FaradayMiddleware::Rashify
+
+          connection.adapter :net_http
+        end
+      end
+
+      def connection_options
+        @connection_options ||= {
+          headers: {
+            accept: 'application/json',
+            user_agent: "HelloBlock Ruby Gem #{HelloBlock::VERSION}"
+          },
+          request: {
+            open_timeout: 10,
+            timeout: 30
+          }
+        }
+      end
+    end
+  end
+end

data/lib/helloblock/client/endpoints.rb

@@ -0,0 +1,47 @@
+module HelloBlock
+  class Client
+    module Endpoints
+
+      ADDRESSES_PATH                = '/addresses/'
+      UNSPENTS_PATH                 = '/addresses/unspents'
+      TRANSACTIONS_FOR_ADDRESS_PATH = '/addresses/transactions'
+      TRANSACTIONS_PATH             = '/transactions'
+      LATEST_TRANSACTION_PATH       = '/transactions/latest'
+      PROPAGATE_PATH                = '/transactions' # POST
+      BLOCKS_PATH                   = '/blocks'
+      LATEST_BLOCKS_PATH            = '/blocks/latest'
+      WALLET_PATH                   = '/wallet'
+      FAUCET_PATH                   = '/faucet'
+      WITHDRAWAL_PATH               = '/withdrawal' # POST
+
+      POST_REQUESTS                 = [:propagate, :withdrawal]
+
+      def base_url
+        "http://#{network}.helloblock.io"
+      end
+
+      # client.unspents(addresses: ...) => method_missing(:unspents, addresses: ... )
+
+      def method_missing(method, *args, &block)
+        endpoint_defined?(method) ? navigate_to_path(method, args[0]) : super
+      end
+
+      # :unspents => UNSPENTS_PATH
+
+      def endpoint_defined?(method)
+        Endpoints.constants.include?("#{method.upcase}_PATH".to_sym)
+      end
+
+      # get(UNSPENTS_PATH, addresses: ...)
+
+      def navigate_to_path(method, *args)
+        path = Endpoints.const_get("#{method.upcase}_PATH".to_sym)
+        post_request?(method) ? post(path, body: args[0]) : get(path, args[0])
+      end
+
+      def post_request?(method)
+        POST_REQUESTS.include?(method)
+      end
+    end
+  end
+end

data/lib/helloblock/client/request.rb

@@ -0,0 +1,31 @@
+module HelloBlock
+  class Client
+    module Request
+
+      def get(path, params={})
+        request(:get, path, params, headers)
+      end
+
+      def post(path, params={})
+        request(:post, path, { body: params }, headers)
+      end
+
+      private
+
+      def request(method, path, params={}, headers={})
+        format_batches(params) if params
+        connection.send(method.to_sym, path, params, headers).body
+      end
+
+      def headers
+        { accept: '*/*', content_type: 'application/json; charset=UTF-8' }
+      end
+
+      def format_batches(params)
+        params.each do |key, value|
+          params[key] = value.join("&#{key}=") if value.is_a?(Array)
+        end
+      end
+    end
+  end
+end

data/lib/helloblock/version.rb

@@ -0,0 +1,3 @@
+module HelloBlock
+  VERSION = '0.0.1'
+end

data/spec/fixture/vcr_cassettes/addresses.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://testnet.helloblock.io/addresses/?addresses=1DQN9nopGvSCDnM3LH1w7j36FtnQDZKnej
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*'
+      User-Agent:
+      - HelloBlock Ruby Gem 0.0.1
+      Content-Type:
+      - application/json; charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Tue, 11 Mar 2014 08:23:07 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=d664258a348122c961459c49b3f0cc08a1394526187048; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.helloblock.io; HttpOnly
+      X-Powered-By:
+      - Express
+      Cf-Ray:
+      - 1096591d050c0651-SJC
+    body:
+      encoding: UTF-8
+      string: '{"status":"fail","message":"The endpoint you are looking for does not
+        exist!","details":[]}'
+    http_version: 
+  recorded_at: Tue, 11 Mar 2014 08:23:07 GMT
+recorded_with: VCR 2.8.0

data/spec/fixture/vcr_cassettes/blocks.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://testnet.helloblock.io/blocks?blockId=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*'
+      User-Agent:
+      - HelloBlock Ruby Gem 0.0.1
+      Content-Type:
+      - application/json; charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Tue, 11 Mar 2014 08:40:10 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=dd5f037677b4debb8bbb64f726b9cb40a1394527209887; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.helloblock.io; HttpOnly
+      X-Powered-By:
+      - Express
+      Cf-Ray:
+      - 10967215c800070d-SJC
+    body:
+      encoding: UTF-8
+      string: '{"status":"fail","message":"The endpoint you are looking for does not
+        exist!","details":[]}'
+    http_version: 
+  recorded_at: Tue, 11 Mar 2014 08:40:10 GMT
+recorded_with: VCR 2.8.0

data/spec/fixture/vcr_cassettes/faucet.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://testnet.helloblock.io/faucet?type=3
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*'
+      User-Agent:
+      - HelloBlock Ruby Gem 0.0.1
+      Content-Type:
+      - application/json; charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - cloudflare-nginx
+      Date:
+      - Tue, 11 Mar 2014 08:40:11 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - __cfduid=de2567497499f3e146f152cad910d824b1394527210396; expires=Mon, 23-Dec-2019
+        23:50:00 GMT; path=/; domain=.helloblock.io; HttpOnly
+      X-Powered-By:
+      - Express
+      Cf-Ray:
+      - 10967218f2820651-SJC
+    body:
+      encoding: UTF-8
+      string: '{"status":"success","data":{"privateKeyWIF":"92iusiayAuJYFNPZiPMTS38AhgBYgdYQxMRh9479ayjMPxkCmU1","privateKeyHex":"95d98c8d17c7823d7a55a543ede007cd38d0b6ffd94a382b73b7e7c0a0e95aec","address":"mkh5mguJjf9RKNYoU6eRxb4k8mbr1U175D","hash160":"38c307920ed2a0cb53a021ff5d3407aa5aac2c08","faucetType":3,"unspents":[{"confirmations":11704,"blockHeight":192654,"txHash":"b3ea79f7f0d0ee55853ad1587b3848f428d5c7cb318641bd461368e23a05ea6b","index":0,"scriptPubKey":"76a91438c307920ed2a0cb53a021ff5d3407aa5aac2c0888ac","type":"pubkeyhash","value":100000,"hash160":"38c307920ed2a0cb53a021ff5d3407aa5aac2c08","address":"mkh5mguJjf9RKNYoU6eRxb4k8mbr1U175D"},{"confirmations":11704,"blockHeight":192654,"txHash":"9cd62ac433117f09ba0707346d28df6d9f3b1bb02b1ef0cc46f19c0fda1bad68","index":0,"scriptPubKey":"76a91438c307920ed2a0cb53a021ff5d3407aa5aac2c0888ac","type":"pubkeyhash","value":50000,"hash160":"38c307920ed2a0cb53a021ff5d3407aa5aac2c08","address":"mkh5mguJjf9RKNYoU6eRxb4k8mbr1U175D"},{"confirmations":11704,"blockHeight":192654,"txHash":"b381965d5fecafefca829d50a5b6f4553b3eb6e0c20cddd1ab41a50f860fb43c","index":0,"scriptPubKey":"76a91438c307920ed2a0cb53a021ff5d3407aa5aac2c0888ac","type":"pubkeyhash","value":10000,"hash160":"38c307920ed2a0cb53a021ff5d3407aa5aac2c08","address":"mkh5mguJjf9RKNYoU6eRxb4k8mbr1U175D"}]}}'
+    http_version: 
+  recorded_at: Tue, 11 Mar 2014 08:40:11 GMT
+recorded_with: VCR 2.8.0