helloblock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5705b196e7b8ac0e977d9958c959f8126f21fd5
+  data.tar.gz: a16a2f4bcc24a6cb4f42a2cacb0dfa6875987526
+SHA512:
+  metadata.gz: 5df3bdc542e11603862ca74da25cebec116923d61b8d5cd0c365047fb0e63768f7204290a568351797b514048a797d9349589fe4371d9e3c0e4637749a9b27fb
+  data.tar.gz: 970ea0b35c990cddeb516cca21ee03946a84feaff1ba02228dffb3e6f8e903950e88de61924fc049f5d7bd3ee25bfbd35afd3f374b3bdde4ba48bea2137665b9

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.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,56 @@
+# HelloBlock
+
+Fluent ruby wrapper for the [HelloBlock](http://www.helloblock.io) API.  For a simple, non-fluent wrapper that avoids the Singleton pattern, see [helloblock-ruby](http://github.com/nathanielwroblewski/helloblock-ruby).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'helloblock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install helloblock
+
+## Usage
+
+Configure your HelloBlock session:
+
+```rb
+HelloBlock.configure do |config|
+  config.api_key = ENV['APIKEY'] # your api key goes here
+  config.version = :v1           # defaults to latest version
+  config.network = :mainnet      # defaults to testnet
+end
+```
+
+Query the HelloBlock API with familiar [ActiveRecord](https://github.com/rails/rails/tree/master/activerecord)-like syntax.  NOTE: As of the current version, `#to_hash` must be called on each completed query as a kicker method.
+
+Description  | Method
+------------- | ------------- |
+Fetch a single address  | `HelloBlock::Address.find('1DQN9nop...')`|
+Fetch batch addresses  | `HelloBlock::Address.where(address: ['1DQN9nop...', ...])` |
+Fetch unspents for address  | `HelloBlock::Address.find('1DQN9nop...').unspents` |
+Fetch unspents for addresses  | `HelloBlock::Address.unspents.where(address: ['1DQN9nop...', ...])` |
+Fetch a single transaction  | `HelloBlock::Transaction.find('f37e6181...')` |
+Fetch batch transactions  | `HelloBlock::Transaction.where(transaction: ['f37e6181...', ...])` |
+Fetch transactions by addresses  | `HelloBlock::Transaction.where(address: ['1DQN9nop...', ...])` |
+Fetch latest transactions  | `HelloBlock::Transaction.last(5).offset(7)` |
+Propagate a transaction  | `HelloBlock::Transaction.create('01000...')` |
+Fetch a block  | `HelloBlock::Block.find('00000...')` |
+Fetch latest block  | `HelloBlock::Block.last(1)` |
+Fetch wallet information | `HelloBlock::Wallet.where(addresses: [...], unspents: false)` |
+Fetch unspents from faucet | `HelloBlock::Faucet.where(type: 3)` |
+Withdraw from faucet | `HelloBlock::Faucet.withdraw(to: '1DQN9nop...', amount: 100_000)` |
+
+## 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/helloblock.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"
+  spec.version       = HelloBlock::VERSION
+  spec.authors       = ["Nathaniel Wroblewski"]
+  spec.email         = ["nathanielwroblewski@gmail.com"]
+  spec.description   = %q{Fluent Ruby wrapper for the helloblock.io API}
+  spec.summary       = %q{Fluent Ruby wrapper for the helloblock.io API}
+  spec.homepage      = ""
+  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,20 @@
+require 'helloblock/version'
+require 'helloblock/api_interface/endpoints'
+require 'helloblock/resources/query'
+require 'helloblock/resources/address'
+require 'helloblock/resources/transaction'
+require 'helloblock/resources/block'
+require 'helloblock/resources/wallet'
+require 'helloblock/resources/faucet'
+require 'helloblock/http/connection'
+require 'helloblock/http/request'
+require 'helloblock/configuration'
+require 'helloblock/spec_helper'
+
+module HelloBlock
+  extend HelloBlock::Endpoints
+  extend HelloBlock::Request
+  extend HelloBlock::Connection
+  extend HelloBlock::Configuration
+  extend HelloBlock::SpecHelper
+end

data/lib/helloblock/api_interface/api_parameters.rb

@@ -0,0 +1,10 @@
+module HelloBlock
+  module APIParameters
+    API_PARAMETERS = {
+      address:     :addresses,
+      transaction: :txHashes,
+      propagate:   :rawTxHex,
+      to:          :toAddress
+    }
+  end
+end

data/lib/helloblock/api_interface/endpoints.rb

@@ -0,0 +1,23 @@
+module HelloBlock
+  module Endpoints
+    ENDPOINTS = {
+      address:                '/addresses/',
+      addresses_transactions: '/addresses/transactions',
+      unspents:               '/unspents',
+      transaction:            '/transactions/',
+      latest:                 'latest',
+      wallet:                 '/wallet',
+      block:                  '/blocks/',
+      faucet:                 '/faucet',
+      withdraw:               '/faucet/withdrawal'
+    }
+
+    def base_url
+      "http://#{network}.helloblock.io"
+    end
+
+    def version_path
+      "/#{version}"
+    end
+  end
+end

data/lib/helloblock/configuration.rb

@@ -0,0 +1,22 @@
+require 'helloblock/utils'
+
+module HelloBlock
+  module Configuration
+
+    extend HelloBlock::Utils
+    mattr_accessor :api_key, :network, :version
+
+
+    def network
+      @network ||= :testnet
+    end
+
+    def version
+      @version ||= :v1
+    end
+
+    def configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/helloblock/http/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday_middleware'
+
+module HelloBlock
+  module Connection
+    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 Gem #{HelloBlock::VERSION}"
+        },
+        request: {
+          open_timeout: 10,
+          timeout: 30
+        }
+      }
+    end
+  end
+end

data/lib/helloblock/http/request.rb

@@ -0,0 +1,26 @@
+require 'helloblock/api_interface/endpoints'
+
+module HelloBlock
+  module Request
+
+    include HelloBlock::Endpoints
+
+    def get(path, params={})
+      request(:get, version_path + path, params, headers)
+    end
+
+    def post(path, params={})
+      request(:post, version_path + path, { body: params }, headers)
+    end
+
+    private
+
+    def request(method, path, params={}, headers={})
+      connection.send(method.to_sym, path, params, headers).body
+    end
+
+    def headers
+      { accept: '*/*', content_type: 'application/json; charset=UTF-8' }
+    end
+  end
+end

data/lib/helloblock/resources/address.rb

@@ -0,0 +1,15 @@
+require 'helloblock/resources/query'
+require 'helloblock/api_interface/endpoints'
+
+module HelloBlock
+  class Address
+    extend HelloBlock::Query
+    include HelloBlock::Endpoints
+
+    def self.unspents
+      query[:path] += ENDPOINTS[:unspents]
+      query[:path].squeeze!('/')
+      self
+    end
+  end
+end

data/lib/helloblock/resources/block.rb

@@ -0,0 +1,7 @@
+require 'helloblock/resources/query'
+
+module HelloBlock
+  class Block
+    extend HelloBlock::Query
+  end
+end

data/lib/helloblock/resources/faucet.rb

@@ -0,0 +1,17 @@
+require 'helloblock/resources/query'
+require 'helloblock/api_interface/endpoints'
+require 'helloblock/api_interface/api_parameters'
+
+module HelloBlock
+  class Faucet
+    extend HelloBlock::Query
+    include HelloBlock::Endpoints
+    include HelloBlock::APIParameters
+
+    def self.withdraw(conditions)
+      where(conditions.merge({post: true}))
+      query[:path] = ENDPOINTS[:withdraw]
+      self
+    end
+  end
+end

data/lib/helloblock/resources/query.rb

@@ -0,0 +1,74 @@
+require 'helloblock/api_interface/endpoints'
+require 'helloblock/api_interface/api_parameters'
+
+module HelloBlock
+  module Query
+    include HelloBlock::Endpoints
+    include HelloBlock::APIParameters
+
+    def query
+      @query ||= default_query
+    end
+
+    def default_query
+      { path: ENDPOINTS[parent_class], params: {} }
+    end
+
+    def parent_class
+      self.to_s.split('::').last.downcase.to_sym
+    end
+
+    def find(id)
+      query[:path] += id
+      self
+    end
+
+    # where(transaction: [...]) => converts :transaction to API's :txHashes
+    def where(conditions)
+      conditions.each do |resource, ids|
+        api_resource = API_PARAMETERS[resource] || resource
+        query[:params][api_resource] = ids
+      end
+      determine_parent_resource
+      self
+    end
+
+    def last(limit)
+      query[:path] = ENDPOINTS[parent_class] + ENDPOINTS[:latest]
+      query[:params][:limit] = limit
+      self
+    end
+
+    def offset(number)
+      query[:params][:offset] = number
+      self
+    end
+
+    def to_hash
+      (query_copy = query.clone) and (@query = default_query)
+      method = query_copy[:params][:post] ? :post : :get
+      query_copy[:params].delete(:post)
+      HelloBlock.send(method, query_copy[:path], query_copy[:params])
+    end
+
+    def [](attribute)
+      to_hash[attribute]
+    end
+
+    def []=(attribute, value)
+      to_hash[attribute] = value
+    end
+
+    def inspect
+      to_hash.to_s
+    end
+
+    # exceptions: querying transactions with addresses actually hits
+    # /addresses/transactions endpoint
+    def determine_parent_resource
+      if query[:path] == ENDPOINTS[:transaction] && query[:params][:addresses]
+        query[:path] = ENDPOINTS[:addresses_transactions]
+      end
+    end
+  end
+end

data/lib/helloblock/resources/transaction.rb

@@ -0,0 +1,15 @@
+require 'helloblock/resources/query'
+require 'helloblock/api_interface/api_parameters'
+
+module HelloBlock
+  class Transaction
+    extend HelloBlock::Query
+    include HelloBlock::APIParameters
+
+    def self.create(raw_tx_hex)
+      api_parameter = API_PARAMETERS[:propagate]
+      query[:params][api_parameter] = raw_tx_hex
+      self
+    end
+  end
+end

data/lib/helloblock/resources/wallet.rb

@@ -0,0 +1,7 @@
+require 'helloblock/resources/query'
+
+module HelloBlock
+  class Wallet
+    extend HelloBlock::Query
+  end
+end

data/lib/helloblock/spec_helper.rb

@@ -0,0 +1,11 @@
+module HelloBlock
+  module SpecHelper
+    def reset
+      @api_key = nil
+      @network = nil
+      @version = nil
+      @connection = nil
+      @connection_options = nil
+    end
+  end
+end