etherscan_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01707c5cfea737a769f02e8ee5ce2ce0f6291f053fbab8ec1f5299bd63e55ee2
-  data.tar.gz: 91f81cb30c5e90359999e5b037283f4e046aa9669b7dfdab18b79df746b792ad
+  metadata.gz: 94ca4f583b2c81087814b37c99b1821f2eee522b88677c122a660e7d76d7ede1
+  data.tar.gz: 59bc3c44379ac3095ebfae93f74485bf963f8411c980ed03257a6fa8c2ac5a46
 SHA512:
-  metadata.gz: 7b8b1679a83c5c4d82cc2571bf9a18421be9d1414ccc0858e2d5142539f2807a8bff5e5ef8cd5835d4f6b752d38136f65681759b4014f28310c3a2dbf6bdaf13
-  data.tar.gz: 310532f8c725bfa4fe53e80c79e3d0f38f48301046af59e78fef8d9b887c8bfebcbdcf2a2f540160abbdd7f48dcb91c248d2115463314d51f3602e134d69ea3e
+  metadata.gz: 77c303ba5ce6866f580ff7913a0377804257e3b14076103c28eb8ccdf48cd6526384f646d51b984a0da87fa689845e6279a8e7e22722ddfc1d1434b0433708ee
+  data.tar.gz: '09a2dbe36b771b4f1b843a5d48bd9479f5848aaf4286f0374f6ba76fa597de7834557d1ed38d4163537f714c91bce1df7bee67d2015e4d5be1d635ca5a7b64fc'

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# gem 'faraday', '~> 0.15'
+gem 'faraday'
 
 group :development do
   gem 'json', '~> 2.1'
@@ -8,7 +8,7 @@ group :development do
   gem 'shoulda', '>= 0'
   gem 'rdoc', '~> 6.0.3'
   gem 'bundler', '~> 1.0'
-  gem 'juwelier', '~> 2.1'
+  gem 'juwelier', '~> 2.4'
   gem 'simplecov', '~> 0.16'
   gem 'pry-byebug'
   gem 'webmock'

data/Gemfile.lock

@@ -112,8 +112,9 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
+  faraday
   json (~> 2.1)
-  juwelier (~> 2.1)
+  juwelier (~> 2.4)
   pry-byebug
   rdoc (~> 6.0.3)
   rspec (~> 3.0)

data/README.md

@@ -1,6 +1,6 @@
 # EtherScan API gem
 
-[![Gem Version](https://badge.fury.io/rb/ehterscan.png)](http://badge.fury.io/rb/ehterscan)
+[![Gem Version](https://badge.fury.io/rb/etherscan_api.png)](http://badge.fury.io/rb/etherscan_api)
 [![Build Status](https://travis-ci.org/dpaluy/etherscan.svg?branch=master)](https://travis-ci.org/dpaluy/etherscan)
 [![Maintainability](https://api.codeclimate.com/v1/badges/75848a6693e61972e5f3/maintainability)](https://codeclimate.com/github/dpaluy/etherscan/maintainability)
 [![Dependency Status](https://gemnasium.com/badges/github.com/dpaluy/etherscan.svg)](https://gemnasium.com/github.com/dpaluy/etherscan)
@@ -27,7 +27,7 @@ Get your api key: https://etherscan.io/myapikey
 
 ```
 # config/initializers/etherscan.rb
-EtherScan.configure do |config|
+Etherscan.configure do |config|
   config.key = 'my_api_key'
 end
 ```
@@ -45,7 +45,7 @@ address = '0xb36efd48c9912bd9fd58b67b65f7438f6364a256'
 etherscan.balance(address, contract_address)
 ```
 
-== Contributing to etherscan
+## Contributing to etherscan
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -55,7 +55,7 @@ etherscan.balance(address, contract_address)
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2018 David Paluy. See LICENSE.txt for
+Copyright (c) 2018 David Paluy. See [LICENSE.txt](LICENSE.txt) for
 further details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/etherscan_api.gemspec

@@ -0,0 +1,90 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: etherscan_api 0.3.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "etherscan_api".freeze
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["David Paluy".freeze]
+  s.date = "2018-04-26"
+  s.description = "This Gem allows you to send Etherscan get requests using native Ruby".freeze
+  s.email = "dpaluy@gmail.com".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".codeclimate.yml",
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "etherscan_api.gemspec",
+    "lib/etherscan.rb",
+    "lib/etherscan/accounts.rb",
+    "lib/etherscan/api.rb",
+    "lib/etherscan/client.rb",
+    "lib/etherscan/config.rb",
+    "lib/etherscan/engine.rb",
+    "lib/etherscan/exceptions.rb",
+    "lib/etherscan/tokens.rb",
+    "spec/etherscan/accounts_spec.rb",
+    "spec/etherscan/api_spec.rb",
+    "spec/etherscan/tokens_spec.rb",
+    "spec/etherscan_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/dpaluy/etherscan".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.7.3".freeze
+  s.summary = "Ruby Gem for the Etherscan API https://etherscan.io/apis".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>.freeze, [">= 0"])
+      s.add_development_dependency(%q<json>.freeze, ["~> 2.1"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.0"])
+      s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0.3"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+      s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.16"])
+      s.add_development_dependency(%q<pry-byebug>.freeze, [">= 0"])
+      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<faraday>.freeze, [">= 0"])
+      s.add_dependency(%q<json>.freeze, ["~> 2.1"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3.0"])
+      s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 6.0.3"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+      s.add_dependency(%q<simplecov>.freeze, ["~> 0.16"])
+      s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+      s.add_dependency(%q<webmock>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<faraday>.freeze, [">= 0"])
+    s.add_dependency(%q<json>.freeze, ["~> 2.1"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.0"])
+    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 6.0.3"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2.4"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.16"])
+    s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+    s.add_dependency(%q<webmock>.freeze, [">= 0"])
+  end
+end
+

data/lib/etherscan/accounts.rb

@@ -21,42 +21,42 @@ module Etherscan
 
     # Get a list of 'Normal' Transactions By Address
     # if page is not defined Returns up to 10000 last transactions
+    # Available args: start_block, end_block, sort, page, offset
     # @param sort 'asc' -> ascending order, 'des' -> descending order
     # @param start_block starting blockNo to retrieve results
     # @param end_block ending blockNo to retrieve results
     # @param page Paginated result <page number>
     # @param offset max records to return
-    def normal_transactions(address, sort='asc', page=nil, offset=nil, start_block=nil, end_block=nil)
+    def normal_transactions(address, args = {})
       action = 'txlist'
-      contract_address = nil
-      transcations(action, address, contract_address, start_block, end_block, sort, page, offset)
+      transcations(action, address, nil, args)
     end
 
     # Get a list of 'Internal' Transactions By Address
-    def internal_transactions(address, sort='asc', page=nil, offset=nil, start_block=nil, end_block=nil)
+    # Available args: start_block, end_block, sort, page, offset
+    def internal_transactions(address, args = {})
       action = 'txlistinternal'
-      contract_address = nil
-      transcations(action, address, contract_address, start_block, end_block, sort, page, offset)
+      transcations(action, address, nil, args)
     end
 
     # Get a list of "ERC20 - Token Transfer Events"
     # @param contract_address Token address (set nil to get a list of all ERC20 transactions)
     # @param address Address for ERC20 transactions (optional)
-    def token_transactions(contract_address, address=nil, sort='asc',
-                           page=nil, offset=nil, start_block=nil, end_block=nil)
+    # Available args: start_block, end_block, sort, page, offset
+    def token_transactions(contract_address, address = nil, args = {})
       fail Etherscan::Exception, 'contract or address must be defined' if (contract_address || address).nil?
       action = 'tokentx'
-      transcations(action, address, contract_address, start_block, end_block, sort, page, offset)
+      transcations(action, address, contract_address, args)
     end
 
     private
 
-    def transcations(action, address, contract_address, start_block, end_block, sort, page, offset)
+    def transcations(action, address, contract_address, args)
       params = {
         module: 'account', action: action,
-        address: address, contractaddress: contract_address, sort: sort,
-        startblock: start_block, endblock: end_block,
-        page: page, offset: offset
+        address: address, contractaddress: contract_address,
+        startblock: args[:start_block], endblock: args[:end_block],
+        page: args[:page], offset: args[:offset], sort: args[:sort]
       }.select {|_, v| !v.nil? }
       get(params)
     end

data/spec/etherscan/accounts_spec.rb

@@ -48,7 +48,7 @@ describe Etherscan::Accounts do
       }
     ]
     response = { 'status' => '1', 'message' => 'OK', 'result' => transactions }
-    params = { module: 'account', action: 'txlist', address: address, sort: 'asc' }
+    params = { module: 'account', action: 'txlist', address: address }
     expect(connection_mock).to receive(:get).with(params).and_return(response)
     expected_response = subject.normal_transactions(address)
     expect(expected_response).to eq(response['result'])

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: etherscan_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Paluy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-25 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +167,7 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- etherscan_api.gemspec
 - lib/etherscan.rb
 - lib/etherscan/accounts.rb
 - lib/etherscan/api.rb