zcash_ruby_explorer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 104a1373ad10ef9eb01ff8ac681827daf29e3545455b82209c4f098065f027a7
+  data.tar.gz: 0633b81e602a42012f120e0eb9fe65c18a427275ac1f242be99d3a9950385774
+SHA512:
+  metadata.gz: 35d8bc440ecbabd8286e7676182ac11a649e733012f8c2d3d54b1ecabfdcf02ce0a6a429380d1c5a9cf3867178b05ce799234a95c2adae790788313643515995
+  data.tar.gz: a44993f97b32a2c0378ac4d84d5f98ace0775a7ddc2e02cb9a78aaff05dbabd35aaf6fec524ad5ded413f8d0abf27a178346466508658466731c5d54c86b9b12

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zcash_ruby_explorer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    zcash_ruby_explorer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  zcash_ruby_explorer!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rodrigo Alves Vieira
+
+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,72 @@
+# Zcash Ruby Explorer
+Ruby wrapper for the popular [Zcash] blockchain query API service by [Zchain]. Developed to be used at [BitJá], the Brazilian cryptocurrency liquidity exchange.
+
+## INSTALLATION
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zcash_ruby_explorer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zcash_ruby_explorer
+
+## USAGE
+Here's how to perform queries by block, address and transactions.
+
+```ruby
+explorer = ZcashRubyExplorer::Api.new
+
+# Get all transactions from a given block
+explorer.block_full_txs '0000000002ad5f889aa7c8c0c5df9f4a87e48c01e16d93bbe5636fcffae599f0'
+
+# Get all transactions involving a given address (account)
+explorer.address_full_txs 't3Vz22vK5z2LcKEdg16Yv4FFneEL1zg9ojd'
+
+# Get information about a specific transaction
+
+explorer.tx_info 'ac52e46a632f92693a2dcf297f1584e330307ce128eda432564ac1d46a3418a1'
+```
+
+## DEVELOPMENT
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org].
+
+### CODE QUALITY
+
+I prefer good code whenever possible, just like you. The [rubocop] tool is used in this project to ensure the code is well written:
+
+```shell
+$ rubocop lib/
+```
+
+### CONTRIBUTING
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rodrigoalvesvieira/zcash_ruby_explorer.
+
+## AUTHORS
+
+* Rodrigo Alves Vieira <rodrigo@bitja.com.br>
+
+This project is based on BlockCypher's [ruby client].
+
+## LICENSE
+
+The gem is available as open source under the terms of the [MIT License].
+
+[Zcash]: https://z.cash
+[Zchain]: https://explorer.zcha.in
+[BitJá]: https://www.bitja.com.br/
+[rubygems.org]: https://rubygems.org
+[rubocop]: https://github.com/rubocop-hq/rubocop
+[ruby client]: https://github.com/blockcypher/ruby-client
+[MIT License]: https://opensource.org/licenses/MIT
+

data/Rakefile

@@ -0,0 +1,6 @@
+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 "zcash_ruby_explorer"
+
+# 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/lib/zcash_ruby_explorer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+require 'net/http'
+
+require 'zcash_ruby_explorer/version'
+require 'zcash_ruby_explorer/api'
+
+module ZcashRubyExplorer
+  class Error < StandardError; end
+end

data/lib/zcash_ruby_explorer/api.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module ZcashRubyExplorer
+  # Main class of this library, contains the following public methods:
+  # block_full_txs, address_full_txs and tx_info
+  class Api
+    # direction: ascending | descending
+    # limit: integer
+    # offset: integer
+    def block_full_txs(hash, direction = 'ascending', limit = 10, offset = 0)
+      query = {
+        sort: 'index',
+        direction: direction,
+        limit: limit,
+        offset: offset
+      }
+
+      api_http_get("blocks/#{hash}/transactions", query: query)
+    end
+
+    def address_full_txs(address, limit = 10, offset = 0)
+      query = { limit: limit, offset: offset }
+      api_http_get("accounts/#{address}/recv", query: query)
+    end
+
+    def tx_info(hash)
+      api_http_get("transactions/#{hash}")
+    end
+
+    private
+
+    def api_http_call(http_method, api_path, query, json_payload: nil)
+      uri = endpoint_uri(api_path, query)
+
+      # Build the connection
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      # Build the Request
+      if http_method == :post
+        request = Net::HTTP::Post.new(uri.request_uri)
+      elsif http_method == :get
+        request = Net::HTTP::Get.new(uri.request_uri)
+      elsif http_method == :delete
+        request = Net::HTTP::Delete.new(uri.request_uri)
+      else
+        raise 'Invalid HTTP method'
+      end
+
+      unless json_payload.nil?
+        request.content_type = 'application/json'
+        request.body = json_payload.to_json
+      end
+
+      response = http.request(request)
+      response_code = response.code.to_i
+
+      # Detect errors/return 204 empty body
+      if response_code >= 400
+        raise Error.new(uri.to_s + ' Response:' + response.body)
+      elsif response_code == 204
+        return nil
+      end
+
+      # Process the response
+      begin
+        json_response = JSON.parse(response.body)
+        return json_response
+      rescue => e
+        raise "Unable to parse JSON response #{e.inspect}, #{response.body}"
+      end
+    end
+
+    def api_http_get(api_path, query: {})
+      api_http_call(:get, api_path, query)
+    end
+
+    def endpoint_uri(api_path, query)
+      uri = URI("https://api.zcha.in/v2/mainnet/#{api_path}")
+      uri.query = URI.encode_www_form(query) unless query.empty?
+      uri
+    end
+  end
+end

data/lib/zcash_ruby_explorer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ZcashRubyExplorer
+  VERSION = '0.1.0'
+end

data/zcash_ruby_explorer.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zcash_ruby_explorer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zcash_ruby_explorer"
+  spec.version       = ZcashRubyExplorer::VERSION
+  spec.authors       = ["Rodrigo Alves Vieira"]
+  spec.email         = ["rodrigoalvesvieira@protonmail.com", "rodrigo@bitja.com.br"]
+
+  spec.summary       = %q{Ruby wrapper for the popular Zcash blockchain query API service by Zchain}
+  spec.description   = %q{Ruby wrapper for the popular Zcash blockchain query API service by Zchain. Enables queries by block, address and transactions.}
+  spec.homepage      = "https://github.com/rodrigoalvesvieira/zcash_ruby_explorer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/rodrigoalvesvieira/zcash_ruby_explorer"
+    spec.metadata["changelog_uri"] = "https://github.com/rodrigoalvesvieira/zcash_ruby_explorer"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: zcash_ruby_explorer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Alves Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for the popular Zcash blockchain query API service by Zchain.
+  Enables queries by block, address and transactions.
+email:
+- rodrigoalvesvieira@protonmail.com
+- rodrigo@bitja.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zcash_ruby_explorer.rb
+- lib/zcash_ruby_explorer/api.rb
+- lib/zcash_ruby_explorer/version.rb
+- zcash_ruby_explorer.gemspec
+homepage: https://github.com/rodrigoalvesvieira/zcash_ruby_explorer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rodrigoalvesvieira/zcash_ruby_explorer
+  source_code_uri: https://github.com/rodrigoalvesvieira/zcash_ruby_explorer
+  changelog_uri: https://github.com/rodrigoalvesvieira/zcash_ruby_explorer
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the popular Zcash blockchain query API service by Zchain
+test_files: []