blocktrail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e73c584f0de2d9f87d47d34b21d7b172ac0de20
+  data.tar.gz: 7960133d5b375727a74520d64539d5be8b7d5904
+SHA512:
+  metadata.gz: 4cd5f9c2f62c3fad9c2bff579884e99b0090775d41fe8e9626b741f5a322391d81176d1f4046a1acc6a264c757dcc3bfc5d34cc62031e8bd7c298082c0a3f41e
+  data.tar.gz: 599388a820d983676f0967de4bd7e78d1f1f83ada69edfdd85e8628ce1e6f66e41fcdb811339030893d24b5dd035884cc583337987cdf3ade904e689c8845abf

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'dotenv', '~> 2.2'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuri Skurikhin
+
+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,42 @@
+BlockTrail Ruby SDK
+=====================
+This is the BlockTrail Ruby SDK. This SDK contains methods for easily interacting with the BlockTrail API.
+
+IMPORTANT! FLOATS ARE EVIL!!
+----------------------------
+As is best practice with financial data, The API returns all values as an integer, the Bitcoin value in Satoshi's.
+
+The BlockTrail SDK has some easy to use functions to do this for you, we recommend using these
+and we also **strongly** recommend doing all Bitcoin calculation and storing of data in integers
+and only convert to/from Bitcoin float values for displaying it to the user.
+
+Installation
+------------
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blocktrail'
+```
+
+Or install it yourself as:
+
+```
+$ gem install blocktrail
+```
+
+Usage
+-----
+
+To use the BlockTrail API, you need your API_KEY as well as a API_SECRET. The gem reads both values from the environment variables. Alternatively you can specify the values by configuring the `Blocktrail::Client` like this:
+
+Please visit our official documentation at https://www.blocktrail.com/api/docs/ for the usage.
+
+Support and Feedback
+--------------------
+
+If you find a bug, please submit the issue in Github directly.
+[BlockTrail-Ruby-SDK Issues](https://github.com/yunixon/blocktrail/issues)
+
+License
+-------
+The BlockTrail Ruby SDK is released under the terms of the MIT license. See LICENCE.md for more information or see http://opensource.org/licenses/MIT.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "blocktrail"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/blocktrail.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blocktrail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blocktrail"
+  spec.version       = Blocktrail::VERSION
+  spec.authors       = ["Yuri Skurikhin"]
+  spec.email         = ["yunixon@gmail.com"]
+
+  spec.summary       = %q{Ruby bindings for the Blocktrail API.}
+  spec.description   = %q{Ruby bindings for the Blocktrail API.}
+  spec.homepage      = "https://github.com/yunixon/blocktrail"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/blocktrail.rb

@@ -0,0 +1,7 @@
+require 'blocktrail/version'
+require 'blocktrail/client'
+require 'blocktrail/exceptions'
+
+module Blocktrail
+  SDK_USER_AGENT = "blocktrail-sdk-ruby"
+end

data/lib/blocktrail/client.rb

@@ -0,0 +1,138 @@
+require 'rest-client'
+require 'digest/md5'
+require 'json'
+require 'blocktrail/exceptions'
+
+module Blocktrail
+  class Client
+    attr_accessor :api_key, :api_secret, :api_version, :testnet, :debug
+
+    def initialize(api_key, api_secret, api_version = 'v1', testnet = true, debug = true)
+      @api_key = api_key
+      @api_secret = api_secret
+      @api_version = api_version
+      @testnet = testnet
+      @debug = debug
+    end
+
+    def api_key
+      @api_key || ENV['API_KEY']
+    end
+
+    def api_secret
+      @api_secret ||= ENV['API_SECRET']
+    end
+
+    def default_headers
+      {
+        'Content-Type' => 'application/json',
+        'User-Agent': "#{Blocktrail::SDK_USER_AGENT}/#{Blocktrail::VERSION}",
+        'Date': Time.now.utc.iso8601,
+        'Content-MD5': Digest::MD5.hexdigest('')
+      }
+    end
+
+    def default_params
+      {
+        'api_key': api_key
+      }
+    end
+
+    def get(*args)
+      request(:get, *args)
+    end
+
+    def post(*args)
+      request(:post, *args)
+    end
+
+    def put(*args)
+      request(:put, *args)
+    end
+
+    def delete(*args)
+      request(:delete, *args)
+    end
+
+    def head(*args)
+      request(:head, *args)
+    end
+
+    def options(*args)
+      request(:options, *args)
+    end
+
+    # Data API
+
+    def address(address)
+      get("/address/#{address}")
+    end
+
+    def address_transactions(address, page = 1, limit = 20, sort_dir = 'asc')
+      get("/address/#{address}/transactions", headers: { params: { page: page, limit: limit, sort_dir: sort_dir } })
+    end
+
+    def address_unconfirmed_transactions(address, page = 1, limit = 20, sort_dir = 'asc')
+      get("/address/#{address}/unconfirmed-transactions", headers: { params: { page: page, limit: limit, sort_dir: sort_dir } })
+    end
+
+    def address_unspent_outputs(address, page = 1, limit = 20, sort_dir = 'asc')
+      get("/address/#{address}/unspent-outputs", headers: { params: { page: page, limit: limit, sort_dir: sort_dir } })
+    end
+
+    def all_blocks(page = 1, limit = 20, sort_dir = 'asc')
+      get("/all-blocks", headers: { params: { page: page, limit: limit, sort_dir: sort_dir } })
+    end
+
+    def block_latest
+      get("/block/latest")
+    end
+
+    def block(block)
+      get("/block/#{block}")
+    end
+
+    def block_transactions(block, page = 1, limit = 20, sort_dir = 'asc')
+      get("/block/#{block}/transactions", headers: { params: { page: page, limit: limit, sort_dir: sort_dir } })
+    end
+
+    def transaction(txhash)
+      get("/transaction/#{txhash}")
+    end
+
+    def all_webhooks(page = 1, limit = 20)
+      get("/webhooks", headers: { params: { page: page, limit: limit } })
+    end
+
+    def webhook(identifier)
+      get("/webhook/#{identifier}")
+    end
+
+    def webhook_events(identifier, page = 1, limit = 20)
+      get("/webhook/#{identifier}/events", headers: { params: { page: page, limit: limit } })
+    end
+
+    def price
+      get("/price")
+    end
+
+    private
+
+    def request(method, url, payload = {}, headers = {})
+      url = "https://api.blocktrail.com/#{api_version}/#{testnet ? 't' : ''}btc#{url}"
+      headers = default_headers.merge(headers).merge({ params: default_params })
+      payload = payload.to_json
+
+      response = RestClient::Request.execute(method: method, url: url, payload: payload, headers: headers)
+      if debug
+        puts 'Request: ' + response.request.inspect
+        puts 'Status code: ' + response.code.inspect
+        puts 'Headers: ' + response.headers.inspect
+        puts 'Content: ' + response.body.inspect
+      end
+      response.empty? ? nil : JSON.parse(response)
+    rescue RestClient::ExceptionWithResponse => error
+      raise Blocktrail::Exceptions.build_exception(error)
+    end
+  end
+end

data/lib/blocktrail/exceptions.rb

@@ -0,0 +1,60 @@
+module Blocktrail
+  EXCEPTION_INVALID_CREDENTIALS = "Your credentials are incorrect."
+  EXCEPTION_GENERIC_HTTP_ERROR = "An HTTP Error has occurred!"
+  EXCEPTION_GENERIC_SERVER_ERROR = "An Server Error has occurred!"
+  EXCEPTION_EMPTY_RESPONSE = "The HTTP Response was empty."
+  EXCEPTION_UNKNOWN_ENDPOINT_SPECIFIC_ERROR = "The endpoint returned an unknown error."
+  EXCEPTION_MISSING_ENDPOINT = "The endpoint you've tried to access does not exist. Check your URL."
+  EXCEPTION_OBJECT_NOT_FOUND = "The object you've tried to access does not exist."
+
+  module Exceptions
+    def self.build_exception(error)
+      case error.http_code
+      when 400, 403
+        data = JSON.parse(error.response)
+        if data.present? && data['msg'] && data['code']
+          Blocktrail::Exceptions::EndpointSpecificError.new(data['msg'], data['code'])
+        else
+          Blocktrail::Exceptions::UnknownEndpointSpecificError.new(Blocktrail::EXCEPTION_UNKNOWN_ENDPOINT_SPECIFIC_ERROR)
+        end
+      when 401
+        Blocktrail::Exceptions::InvalidCredentials.new(Blocktrail::EXCEPTION_INVALID_CREDENTIALS, 401)
+      when 404
+        if error.response.body == 'Endpoint Not Found'
+          Blocktrail::Exceptions::MissingEndpoint.new(Blocktrail::EXCEPTION_MISSING_ENDPOINT, 404)
+        else
+          Blocktrail::Exceptions::ObjectNotFound.new(Blocktrail::EXCEPTION_OBJECT_NOT_FOUND, 404)
+        end
+      when 500
+        Blocktrail::Exceptions::GenericServerError.new(Blocktrail::EXCEPTION_GENERIC_SERVER_ERROR, error.http_code)
+      else
+        Blocktrail::Exceptions::GenericHTTPError.new(Blocktrail::EXCEPTION_GENERIC_HTTP_ERROR, error.http_code)
+      end
+    rescue
+      Blocktrail::Exceptions::Exception.new(error.message)
+    end
+
+    class Exception < StandardError
+      attr_reader :code
+
+      def initialize(message, code = nil)
+        @code = code
+        super(message)
+      end
+
+      def message
+        self.code.present? ? "[#{self.code}] #{self.message}" : self.message
+      end
+    end
+
+    class InvalidFormat < Exception; end
+    class EmptyResponse < Exception; end
+    class EndpointSpecificError < Exception; end
+    class UnknownEndpointSpecificError < Exception; end
+    class InvalidCredentials < Exception; end
+    class MissingEndpoint < Exception; end
+    class ObjectNotFound < Exception; end
+    class GenericHTTPError < Exception; end
+    class GenericServerError < Exception; end
+  end
+end

data/lib/blocktrail/version.rb

@@ -0,0 +1,3 @@
+module Blocktrail
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: blocktrail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuri Skurikhin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Ruby bindings for the Blocktrail API.
+email:
+- yunixon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blocktrail.gemspec
+- lib/blocktrail.rb
+- lib/blocktrail/client.rb
+- lib/blocktrail/exceptions.rb
+- lib/blocktrail/version.rb
+homepage: https://github.com/yunixon/blocktrail
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Blocktrail API.
+test_files: []