ryp 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c71e065c00c656b3ebe2ae750ce7c37a7889224
-  data.tar.gz: 951a67222fd17a78da92ac0b8c8db29b8e7201b7
+  metadata.gz: 1037a00adca2cc8fcf89fe3c60a39d69148a0237
+  data.tar.gz: 94b1576abe78e42e8b4254d2ed565a596a114e48
 SHA512:
-  metadata.gz: 914b48005a4e4ac2b6c74086243f915a40ede8791eb08b59228fa67994c88bad23146f9c148963551ed9c5ba6265ef63f223f74f70949ca27068b7942c432ea2
-  data.tar.gz: 935dc4d589eeeccf6b7556ab0296c562ee24f04e2f77a179b39cfc3e83d73531ff13af483447e20e00af68a3661c0742d32f6f3ba56de275b08b9f819f863d63
+  metadata.gz: 2c58d1451a91a553276ca729652e12a1d36ca54af568c671fffdda0ed6fcb36609d53e321c5405d93a788172ccc5ecfef2d42c17a9ff8f050784037fe46a0e6f
+  data.tar.gz: 89e5720f7891759a7d24e6eeecb4f068d8a1d17874b1a79c50e6e2356959ceafddef53fc3ed687a4e75ee7f451c127409be14f8c47f6979c8137e3bda66640a4

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.rspec

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

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
-before_install: gem install bundler -v 1.16.0
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at m@mjw.io. All
+reported by contacting the project team at matthew@coinbase.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/README.md

@@ -2,6 +2,8 @@
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ryp`. To experiment with that code, run `bin/console` for an interactive prompt.
 
+TODO: Delete this and the text above, and describe your gem
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,6 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
+TODO: Write usage instructions here
 
 ## Development
 
@@ -33,7 +36,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 

data/exe/ryp

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require 'ryp'
+client = Ryp::Command.new
+command = ARGV[0]
+
+if client.respond_to?(command)
+  Ryp::Command.start
+else
+  client.info(command)
+end

data/lib/ryp.rb

@@ -1,5 +1,42 @@
-require "ryp/version"
+require 'ryp/version'
+require 'json'
 
 module Ryp
-  # Your code goes here...
+  require 'ryp/client'
+  require 'ryp/command'
+  require 'ryp/content'
+  require 'ryp/errors'
+  require 'ryp/presenter'
+  require 'ryp/resource'
+
+  require 'ryp/bitcoin_address'
+  require 'ryp/bitcoin_transaction'
+
+  require 'ryp/ethereum_address'
+  require 'ryp/ethereum_transaction'
+
+  module DataSource
+    require 'ryp/data_source/base'
+    require 'ryp/data_source/block_cypher'
+    require 'ryp/data_source/blockchain_info'
+  end
+
+  def self.info(args, options = {})
+    options = options.each_with_object({}) { |(k,v), h| h[k.to_sym] = v }
+    content = Ryp::Content.discover(args, options)
+    presenter = Ryp::Presenter.new(content.network)
+
+    puts "[\"#{content.type}\"] on [\"#{content.network}\"]: #{content.value}" if options[:verbose]
+    content.fetch_data!
+    presenter.present(content)
+  rescue Ryp::UnknownContentType => e
+    puts "Unable to identify #{content.value} on the #{content.network} network"
+  end
+
+  def self.ticker_to_name(ticker)
+    {
+      eth: 'Ethereum',
+      btc: 'Bitcoin'
+    }[ticker.to_s.downcase.to_sym]
+  end
 end

data/lib/ryp/bitcoin_address.rb

@@ -0,0 +1,38 @@
+module Ryp
+  class BitcoinAddress < Ryp::Resource
+
+    # https://www.blockcypher.com/dev/bitcoin/#address-balance-endpoint
+    def self.data_map
+      {
+        address: 'address',
+        total_received: 'total_received',
+        total_sent: 'total_sent',
+        balance: 'balance',
+        unconfirmed_balance: 'unconfirmed_balance',
+        transaction_count: 'n_tx',
+        unconfirmed_transaction_count: 'unconfirmed_n_tx',
+      }
+    end
+    attr_reader *data_map.keys
+
+    def total_received
+      @total_received.to_i / 1e8
+    end
+
+    def total_sent
+      @total_sent.to_i / 1e8
+    end
+
+    def balance
+      @balance.to_i / 1e8
+    end
+
+    def unconfirmed_balance
+      @unconfirmed_balance.to_i / 1e8
+    end
+
+    def url
+      "https://blockchain.info/address/#{address}"
+    end
+  end
+end

data/lib/ryp/bitcoin_transaction.rb

@@ -0,0 +1,31 @@
+module Ryp
+  class BitcoinTransaction < Ryp::Resource
+
+    # https://www.blockcypher.com/dev/bitcoin/#transaction-hash-endpoint
+    def self.data_map
+      {
+        hash: 'hash',
+        height: 'block_height',
+        total: 'total',
+        fees: 'fees',
+        size: 'size',
+        received_at: 'received',
+        confirmed_at: 'confirmed',
+        confirmations: 'confirmations'
+      }
+    end
+    attr_reader *data_map.keys
+
+    def total
+      @total / 1e8
+    end
+
+    def fees
+      @fees / 1e8
+    end
+
+    def url
+      "https://blockchain.info/tx/#{hash}"
+    end
+  end
+end

data/lib/ryp/client.rb

@@ -0,0 +1,42 @@
+module Ryp
+  class Client
+    attr_reader :network, :client
+
+    # ETH: https://www.blockcypher.com/dev/ethereum/
+    # BTC: https://www.blockcypher.com/dev/bitcoin/
+
+    def initialize(network)
+      @network = network.to_s.downcase.to_sym
+      raise ArgumentError, 'Unknown Network' if network.nil? || network == :unknown
+      @client = send("#{network}_data_source")
+    end
+
+    def transaction(arg)
+      data_class('Transaction').new.tap do |transaction|
+        transaction.parse! client.transaction(arg)
+      end
+    end
+
+    def address(arg)
+      data_class('Address').new.tap do |address|
+        address.parse! client.address(arg)
+      end
+    end
+
+    # `content_type` accepts Address and Transaction
+    def data_class(content_type)
+      network_name = Ryp.ticker_to_name(network)
+      Ryp.const_get("#{network_name}#{content_type}")
+    end
+
+    private
+
+    def eth_data_source
+      @eth_client ||= Ryp::DataSource::BlockCypher.new(:eth)
+    end
+
+    def btc_data_source
+      @btc_client ||= Ryp::DataSource::BlockCypher.new(:btc)
+    end
+  end
+end

data/lib/ryp/command.rb

@@ -0,0 +1,20 @@
+require 'thor'
+
+module Ryp
+  class Command < Thor
+
+    desc 'info <argument>', "Look up related information to any given argument"
+    option :network, aliases: :n
+    option :verbose, type: :boolean, aliases: :v
+    def info(argument)
+      Ryp.info(argument, options)
+    end
+
+    desc 'status', 'Report current status across all networks'
+    def status
+      puts 'Network Status: Not implemented yet'
+    end
+
+    default_command :info
+  end
+end

data/lib/ryp/content.rb

@@ -0,0 +1,61 @@
+module Ryp
+  class Content
+    attr_reader :type, :network, :value, :data
+
+    ETH_ADDRESS_REGEX = /^0x[a-fA-F0-9]{40}$/
+    ETH_TRANSACTION_REGEX = /^0x([A-Fa-f0-9]{64})$/
+
+    BTC_ADDRESS_REGEX = /^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$/
+    BTC_TRANSACTION_REGEX = /^[a-zA-Z0-9]{64}$/
+
+    MATCHERS = {
+      eth: {
+        address: ETH_ADDRESS_REGEX,
+        transaction: ETH_TRANSACTION_REGEX
+      },
+      btc: {
+        address: BTC_ADDRESS_REGEX,
+        transaction: BTC_TRANSACTION_REGEX
+      }
+    }
+
+    def initialize(type:, network:, value:)
+      @type = type
+      @network = network
+      @value = value
+    end
+
+    def self.discover(data, options = {})
+      value, network, type = *[data, determine_content(data, options)].flatten
+
+      new(type: type, network: network, value: data)
+    end
+
+    # Allow passing { network: 'n' } to specify a network
+    def self.determine_content(data, options = {})
+      specified_network = options[:network] && options[:network].downcase.to_sym
+
+      puts "Determining Content: #{[data, options].inspect}" if options[:verbose]
+      MATCHERS.each_pair do |network, matchers|
+        next if specified_network && specified_network != network
+
+        matchers.each_pair do |type, expression|
+          return [network, type] if data =~ expression
+        end
+      end
+
+      [specified_network || :unknown, :unknown]
+    end
+
+    def fetch_data!
+      raise Ryp::UnknownContentType, 'Unkown Content Type' if type == :unknown
+      @data = client.send(type, self)
+    rescue Ryp::BadResponseError => e
+      puts e
+    end
+
+    def client
+      @client ||= Ryp::Client.new(network)
+    end
+  end
+end

data/lib/ryp/data_source/base.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'json'
+
+module Ryp
+  module DataSource
+    class Base
+      def get(path)
+        response = connection.get(path)
+        if response.status != 200
+          raise BadResponseError, "#{response.status} response from server: #{response.body}"
+        end
+
+        JSON.parse(response.body)
+      end
+
+      def connection
+        @connection ||= Faraday.new(data_host)
+      end
+
+      def data_host
+        # Implemented in subclasses
+      end
+    end
+  end
+end

data/lib/ryp/data_source/block_cypher.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+
+module Ryp
+  module DataSource
+    class BlockCypher < Ryp::DataSource::Base
+      attr_reader :network
+
+      def initialize(network)
+        @network = network
+      end
+
+      def address(content)
+        get("v1/#{network}/main/addrs/#{content.value}")
+      end
+
+      def transaction(content)
+        get("v1/#{network}/main/txs/#{content.value}")
+      end
+
+      def data_host
+        'https://api.blockcypher.com'
+      end
+    end
+  end
+end

data/lib/ryp/data_source/blockchain_info.rb

@@ -0,0 +1,17 @@
+module Ryp
+  module DataSource
+    class BlockchainInfo < Ryp::DataSource::Base
+      def address(content)
+        get("rawaddr/#{content.value}")
+      end
+
+      def transaction(content)
+        get("rawtx/#{content.value}")
+      end
+
+      def data_host
+        'https://blockchain.info'
+      end
+    end
+  end
+end

data/lib/ryp/errors.rb

@@ -0,0 +1,6 @@
+module Ryp
+  class RypError < StandardError; end
+  class UnknownContentType < RypError; end
+  class UnknownNetwork < RypError; end
+  class BadResponseError < RypError; end
+end

data/lib/ryp/ethereum_address.rb

@@ -0,0 +1,42 @@
+module Ryp
+  class EthereumAddress < Ryp::Resource
+
+    # https://www.blockcypher.com/dev/ethereum/#address
+    def self.data_map
+      {
+        address: 'address',
+        total_received: 'total_received',
+        total_sent: 'total_sent',
+        balance: 'balance',
+        unconfirmed_balance: 'unconfirmed_balance',
+        transaction_count: 'n_tx',
+        unconfirmed_transaction_count: 'unconfirmed_n_tx'
+      }
+    end
+    attr_reader *data_map.keys
+
+    def hash
+      "0x#{@hash}"
+    end
+
+    def total_received
+      @total_received.to_i / 1e18
+    end
+
+    def total_sent
+      @total_sent.to_i / 1e18
+    end
+
+    def balance
+      @balance.to_i / 1e18
+    end
+
+    def unconfirmed_balance
+      @unconfirmed_balance.to_i / 1e18
+    end
+
+    def url
+      "https://etherscan.io/address/0x#{address}"
+    end
+  end
+end

data/lib/ryp/ethereum_transaction.rb

@@ -0,0 +1,37 @@
+module Ryp
+  class EthereumTransaction < Ryp::Resource
+
+    # https://www.blockcypher.com/dev/ethereum/#transaction
+    def self.data_map
+      {
+        hash: 'hash',
+        height: 'block_height',
+        total: 'total',
+        fees: 'fees',
+        size: 'size',
+        received_at: 'received',
+        confirmed_at: 'confirmed',
+        confirmations: 'confirmations',
+        gas_used: 'gas_used',
+        gas_price: 'gas_price'
+      }
+    end
+    attr_reader *data_map.keys
+
+    def hash
+      "0x#{@hash}"
+    end
+
+    def total
+      @total / 1e18
+    end
+
+    def fees
+      @fees / 1e18
+    end
+
+    def url
+      "https://etherscan.io/tx/#{hash}"
+    end
+  end
+end

data/lib/ryp/presenter.rb

@@ -0,0 +1,37 @@
+module Ryp
+  class Presenter
+    attr_reader :network
+
+    def initialize(network)
+      @network = network
+    end
+
+    def present(content)
+      puts "#{content.type.capitalize} on #{network.upcase}:\n\n"
+      data = content.data.to_h
+      url = data.delete(:url)
+      pretty_print data
+      puts "\n#{url}"
+    end
+
+    private
+
+    def pretty_print(object)
+      if object.is_a?(Hash)
+        object.each_pair do |key, value|
+          if value.is_a?(Array)
+            attribute = key.to_s.gsub(/-|_/, ' ').capitalize
+            puts ["#{attribute}:", value.map{|v| "  - #{v}"}].join("\n")
+          else
+            attribute = key.to_s.gsub(/-|_/, ' ').capitalize
+            puts "#{attribute.ljust(25)}: #{value}"
+          end
+        end
+      elsif object.is_a?(Array)
+        object.each { |n| puts n }
+      else
+        puts object
+      end
+    end
+  end
+end

data/lib/ryp/resource.rb

@@ -0,0 +1,24 @@
+module Ryp
+  class Resource
+    attr_reader :raw
+
+    def parse!(data)
+      self.class.data_map.each_pair do |attribute, key|
+        instance_variable_set("@#{attribute}", data[key])
+      end
+      @raw = data
+    end
+
+    def attributes
+      Hash.new.tap do |attributes|
+        self.class.data_map.keys.each do |attribute|
+          attributes[attribute] = send(attribute)
+        end
+      end
+    end
+
+    def to_h
+      { url: url }.merge(attributes)
+    end
+  end
+end

data/lib/ryp/version.rb

@@ -1,3 +1,3 @@
 module Ryp
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/ryp.gemspec

@@ -1,4 +1,4 @@
-
+# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "ryp/version"
@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "ryp"
   spec.version       = Ryp::VERSION
   spec.authors       = ["Matthew Werner"]
-  spec.email         = ["m@mjw.io"]
+  spec.email         = ["matthew@coinbase.com"]
 
-  spec.summary       = %q{Cryptocurrency Tooling CLI}
-  spec.description   = %q{Tools you can use on the command line to investigate a cryptocurrency}
+  spec.summary       = %q{Quick access cryptocurrency tools}
+  spec.description   = %q{Get information about cryptocurrency from the command line}
   spec.homepage      = "https://github.com/mwerner/ryp"
   spec.license       = "MIT"
 
@@ -21,7 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_dependency 'thor'
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: ryp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthew Werner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-01-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: 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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,10 +80,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Tools you can use on the command line to investigate a cryptocurrency
+description: Get information about cryptocurrency from the command line
 email:
-- m@mjw.io
-executables: []
+- matthew@coinbase.com
+executables:
+- ryp
 extensions: []
 extra_rdoc_files: []
 files:
@@ -69,7 +98,21 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/ryp
 - lib/ryp.rb
+- lib/ryp/bitcoin_address.rb
+- lib/ryp/bitcoin_transaction.rb
+- lib/ryp/client.rb
+- lib/ryp/command.rb
+- lib/ryp/content.rb
+- lib/ryp/data_source/base.rb
+- lib/ryp/data_source/block_cypher.rb
+- lib/ryp/data_source/blockchain_info.rb
+- lib/ryp/errors.rb
+- lib/ryp/ethereum_address.rb
+- lib/ryp/ethereum_transaction.rb
+- lib/ryp/presenter.rb
+- lib/ryp/resource.rb
 - lib/ryp/version.rb
 - ryp.gemspec
 homepage: https://github.com/mwerner/ryp
@@ -95,5 +138,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Cryptocurrency Tooling CLI
+summary: Quick access cryptocurrency tools
 test_files: []