decred_ruby_explorer 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.rubocop.yml +2 -0
- data/.ruby-version +1 -0
- data/.travis.yml +7 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +35 -0
- data/LICENSE.txt +21 -0
- data/README.md +71 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/decred_ruby_explorer.gemspec +39 -0
- data/lib/decred_ruby_explorer.rb +12 -0
- data/lib/decred_ruby_explorer/api.rb +83 -0
- data/lib/decred_ruby_explorer/version.rb +5 -0
- metadata +107 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 869e43aec2820d10bf2621aea5a511dfadebcaaa349a8f0f5870412dcfca4d32
|
4
|
+
data.tar.gz: ccd38a2fb09dda6f547619837a64a177493d0172df9bfd5944dff020e0186b61
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b045f2c06f2029d443c1cfe10285dbddf665dd98d20f2e196732322755493fb6721cad48cff097d149812d8b7548c3ebb1869f5a0db82feeb05d9f3ada0fd894
|
7
|
+
data.tar.gz: e7ecbb756583cd58f2f0b11c90cd8bb52ee71dba393ccb6dc3e8648f164eedfc97ab8f52f40be138be1f8d4a0593a774da0ddeb72c4c0a55689d2958014b48c8
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.5.3
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
decred_ruby_explorer (0.1.0)
|
5
|
+
|
6
|
+
GEM
|
7
|
+
remote: https://rubygems.org/
|
8
|
+
specs:
|
9
|
+
diff-lcs (1.3)
|
10
|
+
rake (10.5.0)
|
11
|
+
rspec (3.8.0)
|
12
|
+
rspec-core (~> 3.8.0)
|
13
|
+
rspec-expectations (~> 3.8.0)
|
14
|
+
rspec-mocks (~> 3.8.0)
|
15
|
+
rspec-core (3.8.0)
|
16
|
+
rspec-support (~> 3.8.0)
|
17
|
+
rspec-expectations (3.8.2)
|
18
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
19
|
+
rspec-support (~> 3.8.0)
|
20
|
+
rspec-mocks (3.8.0)
|
21
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
22
|
+
rspec-support (~> 3.8.0)
|
23
|
+
rspec-support (3.8.0)
|
24
|
+
|
25
|
+
PLATFORMS
|
26
|
+
ruby
|
27
|
+
|
28
|
+
DEPENDENCIES
|
29
|
+
bundler (~> 1.17)
|
30
|
+
decred_ruby_explorer!
|
31
|
+
rake (~> 10.0)
|
32
|
+
rspec (~> 3.0)
|
33
|
+
|
34
|
+
BUNDLED WITH
|
35
|
+
1.17.1
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2018 Rodrigo Alves Vieira
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,71 @@
|
|
1
|
+
# Decred Ruby Explorer
|
2
|
+
Ruby wrapper for the popular [Decred] blockchain query API service. Developed to be used at [BitJá], the Brazilian cryptocurrency liquidity exchange.
|
3
|
+
|
4
|
+
## INSTALLATION
|
5
|
+
|
6
|
+
Add this line to your application's Gemfile:
|
7
|
+
|
8
|
+
```ruby
|
9
|
+
gem 'decred_ruby_explorer'
|
10
|
+
```
|
11
|
+
|
12
|
+
And then execute:
|
13
|
+
|
14
|
+
$ bundle
|
15
|
+
|
16
|
+
Or install it yourself as:
|
17
|
+
|
18
|
+
$ gem install decred_ruby_explorer
|
19
|
+
|
20
|
+
## USAGE
|
21
|
+
Here's how to perform queries by block, address and transactions.
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# Get all transactions from a given block
|
25
|
+
explorer.block_full_txs '00000000000000000312d464517dac67b8e92c3a76d594daa8abfb2f03ac6144'
|
26
|
+
|
27
|
+
# Get all transactions involving a given address
|
28
|
+
|
29
|
+
explorer = DecredRubyExplorer::Api.new
|
30
|
+
explorer.address_full_txs 'Dso5XEY8AoYBtjDUTuxyExfYeqMv7vuZDsG'
|
31
|
+
|
32
|
+
# Get information about a specific transaction
|
33
|
+
|
34
|
+
explorer.tx_info '1eac92a05a4d9a954b3cf7d0cd235d81312d7b79d3373ffe217cecc6fa06f522'
|
35
|
+
```
|
36
|
+
|
37
|
+
## DEVELOPMENT
|
38
|
+
|
39
|
+
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.
|
40
|
+
|
41
|
+
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].
|
42
|
+
|
43
|
+
### CODE QUALITY
|
44
|
+
|
45
|
+
I prefer good code whenever possible, just like you. The [rubocop] tool is used in this project to ensure the code is well written:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
$ rubocop lib/
|
49
|
+
```
|
50
|
+
|
51
|
+
### CONTRIBUTING
|
52
|
+
|
53
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/rodrigoalvesvieira/decred_ruby_explorer.
|
54
|
+
|
55
|
+
## AUTHORS
|
56
|
+
|
57
|
+
* Rodrigo Alves Vieira <rodrigo@bitja.com.br>
|
58
|
+
|
59
|
+
This project is based on BlockCypher's [ruby client].
|
60
|
+
|
61
|
+
## LICENSE
|
62
|
+
|
63
|
+
The gem is available as open source under the terms of the [MIT License].
|
64
|
+
|
65
|
+
[Decred]: https://www.decred.org/
|
66
|
+
[BitJá]: https://www.bitja.com.br/
|
67
|
+
[rubygems.org]: https://rubygems.org
|
68
|
+
[rubocop]: https://github.com/rubocop-hq/rubocop
|
69
|
+
[ruby client]: https://github.com/blockcypher/ruby-client
|
70
|
+
[MIT License]: https://opensource.org/licenses/MIT
|
71
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "decred_ruby_explorer"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
require "decred_ruby_explorer/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "decred_ruby_explorer"
|
7
|
+
spec.version = DecredRubyExplorer::VERSION
|
8
|
+
spec.authors = ["Rodrigo Alves Vieira"]
|
9
|
+
spec.email = ["rodrigoalvesvieira@protonmail.com", "rodrigo@bitja.com.br"]
|
10
|
+
|
11
|
+
spec.summary = %q{Ruby wrapper for the popular Decred blockchain query API service}
|
12
|
+
spec.description = %q{Ruby wrapper for the popular Decred blockchain query API service. Enables queries by block, address and transactions.}
|
13
|
+
spec.homepage = "https://github.com/rodrigoalvesvieira/decred_ruby_explorer"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
17
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
18
|
+
if spec.respond_to?(:metadata)
|
19
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
20
|
+
spec.metadata["source_code_uri"] = "https://github.com/rodrigoalvesvieira/decred_ruby_explorer"
|
21
|
+
spec.metadata["changelog_uri"] = "https://github.com/rodrigoalvesvieira/decred_ruby_explorer"
|
22
|
+
else
|
23
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
24
|
+
"public gem pushes."
|
25
|
+
end
|
26
|
+
|
27
|
+
# Specify which files should be added to the gem when it is released.
|
28
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
29
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
30
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
31
|
+
end
|
32
|
+
spec.bindir = "exe"
|
33
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
34
|
+
spec.require_paths = ["lib"]
|
35
|
+
|
36
|
+
spec.add_development_dependency "bundler", "~> 1.17"
|
37
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
38
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
39
|
+
end
|
@@ -0,0 +1,83 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module DecredRubyExplorer
|
4
|
+
# Main class of this library, contains the following public methods:
|
5
|
+
# block_full_txs, address_full_txs and tx_info
|
6
|
+
class Api
|
7
|
+
def block_full_txs(block, page = 0)
|
8
|
+
query = {
|
9
|
+
block: block,
|
10
|
+
pageNum: page
|
11
|
+
}
|
12
|
+
|
13
|
+
api_http_get('txs/', query: query)
|
14
|
+
end
|
15
|
+
|
16
|
+
def address_full_txs(address, page = 0)
|
17
|
+
query = {
|
18
|
+
address: address,
|
19
|
+
pageNum: page
|
20
|
+
}
|
21
|
+
|
22
|
+
api_http_get('txs/', query: query)
|
23
|
+
end
|
24
|
+
|
25
|
+
def tx_info(hash)
|
26
|
+
api_http_get("tx/#{hash}")
|
27
|
+
end
|
28
|
+
|
29
|
+
private
|
30
|
+
|
31
|
+
def api_http_call(http_method, api_path, query, json_payload: nil)
|
32
|
+
uri = endpoint_uri(api_path, query)
|
33
|
+
|
34
|
+
# Build the connection
|
35
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
36
|
+
http.use_ssl = true
|
37
|
+
|
38
|
+
# Build the Request
|
39
|
+
if http_method == :post
|
40
|
+
request = Net::HTTP::Post.new(uri.request_uri)
|
41
|
+
elsif http_method == :get
|
42
|
+
request = Net::HTTP::Get.new(uri.request_uri)
|
43
|
+
elsif http_method == :delete
|
44
|
+
request = Net::HTTP::Delete.new(uri.request_uri)
|
45
|
+
else
|
46
|
+
raise 'Invalid HTTP method'
|
47
|
+
end
|
48
|
+
|
49
|
+
unless json_payload.nil?
|
50
|
+
request.content_type = 'application/json'
|
51
|
+
request.body = json_payload.to_json
|
52
|
+
end
|
53
|
+
|
54
|
+
response = http.request(request)
|
55
|
+
response_code = response.code.to_i
|
56
|
+
|
57
|
+
# Detect errors/return 204 empty body
|
58
|
+
if response_code >= 400
|
59
|
+
raise Error.new(uri.to_s + ' Response:' + response.body)
|
60
|
+
elsif response_code == 204
|
61
|
+
return nil
|
62
|
+
end
|
63
|
+
|
64
|
+
# Process the response
|
65
|
+
begin
|
66
|
+
json_response = JSON.parse(response.body)
|
67
|
+
return json_response
|
68
|
+
rescue => e
|
69
|
+
raise "Unable to parse JSON response #{e.inspect}, #{response.body}"
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
def api_http_get(api_path, query: {})
|
74
|
+
api_http_call(:get, api_path, query)
|
75
|
+
end
|
76
|
+
|
77
|
+
def endpoint_uri(api_path, query)
|
78
|
+
uri = URI("https://mainnet.decred.org/api/#{api_path}")
|
79
|
+
uri.query = URI.encode_www_form(query) unless query.empty?
|
80
|
+
uri
|
81
|
+
end
|
82
|
+
end
|
83
|
+
end
|
metadata
ADDED
@@ -0,0 +1,107 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: decred_ruby_explorer
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Rodrigo Alves Vieira
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2018-11-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.17'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.17'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
description: Ruby wrapper for the popular Decred blockchain query API service. Enables
|
56
|
+
queries by block, address and transactions.
|
57
|
+
email:
|
58
|
+
- rodrigoalvesvieira@protonmail.com
|
59
|
+
- rodrigo@bitja.com.br
|
60
|
+
executables: []
|
61
|
+
extensions: []
|
62
|
+
extra_rdoc_files: []
|
63
|
+
files:
|
64
|
+
- ".gitignore"
|
65
|
+
- ".rspec"
|
66
|
+
- ".rubocop.yml"
|
67
|
+
- ".ruby-version"
|
68
|
+
- ".travis.yml"
|
69
|
+
- Gemfile
|
70
|
+
- Gemfile.lock
|
71
|
+
- LICENSE.txt
|
72
|
+
- README.md
|
73
|
+
- Rakefile
|
74
|
+
- bin/console
|
75
|
+
- bin/setup
|
76
|
+
- decred_ruby_explorer.gemspec
|
77
|
+
- lib/decred_ruby_explorer.rb
|
78
|
+
- lib/decred_ruby_explorer/api.rb
|
79
|
+
- lib/decred_ruby_explorer/version.rb
|
80
|
+
homepage: https://github.com/rodrigoalvesvieira/decred_ruby_explorer
|
81
|
+
licenses:
|
82
|
+
- MIT
|
83
|
+
metadata:
|
84
|
+
homepage_uri: https://github.com/rodrigoalvesvieira/decred_ruby_explorer
|
85
|
+
source_code_uri: https://github.com/rodrigoalvesvieira/decred_ruby_explorer
|
86
|
+
changelog_uri: https://github.com/rodrigoalvesvieira/decred_ruby_explorer
|
87
|
+
post_install_message:
|
88
|
+
rdoc_options: []
|
89
|
+
require_paths:
|
90
|
+
- lib
|
91
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - ">="
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - ">="
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '0'
|
101
|
+
requirements: []
|
102
|
+
rubyforge_project:
|
103
|
+
rubygems_version: 2.7.6
|
104
|
+
signing_key:
|
105
|
+
specification_version: 4
|
106
|
+
summary: Ruby wrapper for the popular Decred blockchain query API service
|
107
|
+
test_files: []
|