infura_ruby 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bec78f6153262da586b44f024f9247c7508af7c7
+  data.tar.gz: cb2f8572bec68b2a76817af04e4645fd2e823cb3
+SHA512:
+  metadata.gz: a3f091c2737ec85074f1b0659661ad27d35e0b0ba1208066f9f21be7224bc52f885507b0f6f9a2116e7c0b44f6c53ee599ce4161b30213ef63240628cee98397
+  data.tar.gz: 82edfdc537ea144ecff266f6d1273e74d31e493b41fbf14bfc8780aa1548a4381a1abc4ed5554cf77ad8724fdf9361ceb54adc6eb8ae6f07410061074d16acb5

data/.gitignore

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

data/README.md

@@ -0,0 +1,22 @@
+# InfuraRuby
+
+Ruby gem to wrap the [INFURA](https://github.com/ethereum/wiki/wiki/JSON-RPC() API which gives HTTP API access to ethereum and IPFS nodes. The API uses the same format as the [JSON RPC spec](https://github.com/ethereum/wiki/wiki/JSON-RPCi) for normal ethereum nodes.
+
+For now, I only need the `getBalance` call an so that is all I will build. Feel free to add the rest of the functionality or I may get to it over time...
+
+## Usage
+
+__Installation__
+```bash
+gem install infura_ruby
+```
+
+```ruby
+require 'infura_ruby'
+
+# create a client object
+infura = InfuraRuby.client(api_key: key)
+
+# get the balance (in wei) of an address
+infura.get_balance('0x81F631b8615EaB75d38DaC4d4bce4A5b63e10310') #=> 591686024850016
+```

data/infura_ruby.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'infura_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "infura_ruby"
+  spec.version       = InfuraRuby::VERSION
+  spec.authors       = ["Julian Borrey"]
+  spec.email         = ["julianborrey@gmail.com"]
+
+  spec.summary       = "Library for the INFURA API."
+  spec.description   = "Ruby client to the INFURA (infura.io) API. Allows HTTP "\
+                       "access to ethereum and IPFS nodes."
+  spec.homepage      = "https://github.com/jborrey/infura_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^spec/) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.11.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/infura_ruby.rb

@@ -0,0 +1,14 @@
+require 'infura_ruby/version'
+require 'infura_ruby/client'
+
+module InfuraRuby
+  class InvalidApiKeyError < StandardError; end
+  class InvalidNetworkError < StandardError; end
+
+  class << self
+    # Generate a new client for the Infura api.
+    def client(api_key:, network: :main)
+      Client.new(api_key: api_key, network: network)
+    end
+  end
+end

data/lib/infura_ruby/client.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'json'
+
+module InfuraRuby
+  class Client
+    # Infura URLs for each network.
+    NETWORK_URLS = {
+      main:      'https://mainnet.infura.io',
+      test:      'https://ropsten.infura.io',
+      consensys: 'https://consensysnet.inufra.io'
+    }.freeze
+
+    JSON_RPC_METHODS = [
+      'eth_getBalance'
+    ].freeze
+
+    def initialize(api_key:, network: :main)
+      validate_api_key(api_key)
+      validate_network(network)
+
+      @api_key = api_key
+      @network = network
+    end
+
+    # Returns balance of address in wei as integer.
+    def get_balance(address)
+      resp = conn.post do |req|
+        req.headers['Content-Type'] = 'application/json'
+        req.body = json_rpc(method: 'eth_getBalance', params: [address, 'latest']).to_json
+      end
+
+      resp_body  = JSON.parse(resp.body)
+      wei_amount_hex_string = resp_body['result']
+      wei_amount_hex_string.to_i(16)
+    end
+
+    private
+
+    # TODO: this JSON RPC object should be a whole object / gem.
+    def json_rpc(method:, params:)
+      validate_json_rpc_method(method)
+      
+      {
+        "jsonrpc" => "2.0",
+        "method"  => method,
+        "params"  => params,
+        "id"      => 1
+      }
+    end
+
+    def validate_json_rpc_method(method)
+      raise NotImplementedError unless JSON_RPC_METHODS.include?(method)
+    end
+
+    def conn
+      @conn ||= Faraday.new(
+        url: "#{NETWORK_URLS[@network]}/#{@api_key}",
+      )
+    end
+
+    def validate_api_key(api_key)
+      raise InvalidApiKeyError unless /^[a-zA-Z0-9]{20}$/ =~ api_key
+    end
+
+    def validate_network(network)
+      raise InvalidNetworkError if NETWORK_URLS[network].nil?
+    end
+  end
+end

data/lib/infura_ruby/version.rb

@@ -0,0 +1,3 @@
+module InfuraRuby
+  VERSION = '1.1.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: infura_ruby
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Julian Borrey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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 client to the INFURA (infura.io) API. Allows HTTP access to ethereum
+  and IPFS nodes.
+email:
+- julianborrey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- infura_ruby.gemspec
+- lib/infura_ruby.rb
+- lib/infura_ruby/client.rb
+- lib/infura_ruby/version.rb
+homepage: https://github.com/jborrey/infura_ruby
+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.6.9
+signing_key: 
+specification_version: 4
+summary: Library for the INFURA API.
+test_files: []