coinquery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f23a051f568acaab4c738d29fac386542ccc59ed10446a2502c00ef8d4e2eef
+  data.tar.gz: c8c21260fecd79db5645057b4fcd68efb6e751cadf6bd99bcbf4ac9012ffee5e
+SHA512:
+  metadata.gz: 4473291976036afd8912c54e14308ee605a9debbbd631fe2713ea60a91ad156f1559f1e19ffc88e81bc0f22c030a5f8158c573e9113a32f1a18e9d73fa946129
+  data.tar.gz: fb1d9fcc8256edf7a1d68a1048a2cb40d89d75b88fd13be45c63c955bdc77b5b5d792a90eb8d60ae891050302189d55e212dc137d61f762868ae182957f844bf

data/lib/coinquery.rb

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby
+
+# file: coinquery.rb
+# description: Uses the Coingecko API. Inspired by the coingecko_client gem
+
+require 'c32'
+require 'json'
+require 'excon'
+require 'unichron'
+require 'did_you_mean'
+
+
+class CoinQueryException < Exception
+end
+
+class CoinQuery
+  using ColouredText
+
+  attr_reader :list
+
+  def initialize(autofind: true, dym: true, debug: false)
+
+    @autofind, @dym, @debug = autofind, dym, debug
+
+    @url_base = 'https://api.coingecko.com/api/v3/'
+    r = ping()
+
+    if r then
+
+      puts ('CoinQuery').highlight + ' (powered by CoinGecko)'
+      puts
+      puts ('ping response: ' + r.to_a.first.join(' ')).info
+
+      if autofind then
+
+        file = 'coinquery.dat'
+
+        if not File.exists? file then
+
+          puts ('fetching coins list ...').info  
+          @list = api_call 'coins/list'
+        
+
+          if @dym then
+
+            puts 'loading did_you_mean ...'.info if @debug          
+
+            @dym = DidYouMean::SpellChecker.new(dictionary: @list.flat_map \
+                      {|x| [x['symbol'], x['name']]})
+          end
+
+        end
+
+
+        if not File.exists? file then
+
+          File.open(file, 'w+') do |f|  
+           Marshal.dump([@list, @dym], f)  
+          end 
+
+        else
+        
+          puts ('loading coins list ...').info  
+          File.open(file) do |f|  
+            @list, @dym = Marshal.load(f)  
+          end
+    
+        end
+
+      end
+    end
+
+  end
+
+  # lists the top coins (limited to 5 by default)
+  # 
+  def coins(limit: 5)
+    currency = 'usd'
+    api_call "coins/markets?vs_currency=#{currency}&per_page=#{limit}"
+  end
+
+  # lists the names and identifiers of all coins
+  #
+  def coins_list
+    @list
+  end
+
+  # returns the price of a coin for a given historical date
+  # e.g. historical_price('Bitcoin', '01-05-2021')
+  #
+  def historical_price(coin, rawdate)
+
+    uc = Unichron.new(rawdate.to_s, :little_endian)
+    raise 'invalid date' unless uc.valid?
+    date = uc.to_date.strftime("%d-%m-%Y")
+
+    id = find_id coin
+    r = api_call "coins/%s/history?date=%s" % [id, date]
+    price = r['market_data']['current_price']['usd']
+    price < 1 ? price : price.round(2)
+
+  end
+
+  alias history historical_price
+  
+  def ping
+    api_call 'ping'
+  end
+
+  # returns the price for a given a coin
+  # e.g. price('Litecoin')
+  #
+  def price(coin)
+
+    currency = 'usd'
+    id = find_id coin
+    r = api_call("simple/price?ids=#{id}&vs_currencies=#{currency}")
+
+    if r then
+      val = r[id][currency]
+      val < 1 ? val : val.round(2)
+    end
+  end
+
+
+  private
+
+  def api_call(api_request)
+    
+    begin
+      Timeout::timeout(3){
+        response = Excon.get(@url_base + api_request)
+        JSON.parse(response.body)
+      }
+    rescue Timeout::Error => e
+      raise CoinQueryException, 'connection timed out'
+    rescue OpenURI::HTTPError => e
+      raise CoinQueryException, '400 bad request'
+    end
+
+  end
+
+  def find_id(coin_name)
+
+    return coin_name unless @autofind
+
+    s = coin_name.to_s.downcase
+    puts 's: ' + s.inspect if @debug
+    r = @list.find {|coin| coin['symbol'].downcase == s || coin['name'].downcase == s}
+    puts 'r: ' + r.inspect if @debug
+    
+    if r.nil? then
+
+      if @dym then
+
+        suggestion = @dym.correct coin_name
+        raise CoinQueryException, "unknown coin or token name. \n"  \
+            + "Did you mean %s?" % [suggestion.first]
+
+      else
+
+        raise CoinQueryException, "unknown coin or token name."
+
+      end
+
+    end
+
+    r['id']
+
+  end
+
+end
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: coinquery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Robertson
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEXjCCAsagAwIBAgIBATANBgkqhkiG9w0BAQsFADAsMSowKAYDVQQDDCFnZW1t
+  YXN0ZXIvREM9amFtZXNyb2JlcnRzb24vREM9ZXUwHhcNMjEwNTAxMTc0MDQwWhcN
+  MjIwNTAxMTc0MDQwWjAsMSowKAYDVQQDDCFnZW1tYXN0ZXIvREM9amFtZXNyb2Jl
+  cnRzb24vREM9ZXUwggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC6rjtU
+  mmToxQ17l/iglxID3NQELOPb0Og3PomskJjMMP3Z6DfR7HFG4oCf+AOqApu1MJlY
+  HtA9D+wBc3UDwXqx+tGb5jK8z5wiPc7bxZw8KWXlMr6xl39aOV6Mar+ba85YfXYy
+  A0AKLFZ0aGJlWFJDhaKY15A1BvCLIxzs8khQhU9SrswpMRvTMh4vbGMUTSLH6YfM
+  CePCq4oePv0hCt9mJRM07mvnZTluvC3luKCZX/epoXhz27SjfEfkIDLBp5CGBi/F
+  T1glfaiFeGMZXvEIOSSYD334FlpFssJm17ZkCZbyhEpJbADKf59tp3SopApkCp8a
+  jgOaxAwNAPx1x4O7b+QB6cc94UJ8dUBzGpO4k+WmjMfyD2uH5tRy31wgOYtEFdwK
+  PnP4nhcNlCarLW8mlhdTjuv/MF3LL+eTPeSNzYjLVB6llRTIOuMRbZMtRGqqxakO
+  xF7uFbx551al1xMp7a2j9/8ms1i/HOUC7HYIY3Sypbxo4vr+DS4exHFw/HkCAwEA
+  AaOBijCBhzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUj4/MG5Mc
+  hxuUT+ppdcmWq844BvswJgYDVR0RBB8wHYEbZ2VtbWFzdGVyQGphbWVzcm9iZXJ0
+  c29uLmV1MCYGA1UdEgQfMB2BG2dlbW1hc3RlckBqYW1lc3JvYmVydHNvbi5ldTAN
+  BgkqhkiG9w0BAQsFAAOCAYEAea5PKLTuEVWpVIPL9qnLJy8nLsIlK5pCo4jIvSUj
+  aAio8zozuuuF4xmL99fL25AR0azdGNdbTqir87Nw89UCIeWCaoVT+xoBzIDjOk+K
+  6/zU5ycp9R1MpkCUxyQVJkPzS5sv/GSobGt1+N+ezZX6PTQ0E15pYZw1EgTfoj+P
+  DpmmpF+2oQ7p3EkTw9Zq68frhVOr58eDq2c/UTB54ONFMNc2fAsG0pCjcbxiKb9/
+  aA/xcjAS/wQOj7E0SnMZ30VHq+/ZJ1Iuo4SOTUdIs0Q83U5NmSAenD1rS2GqE9Cq
+  jYE1eDshtl97Xr7PUmlWAEhdG0ftXhq2T2ihNnufpa4fzIKyGENSIMv77j6gbdkq
+  RxI8h/TvvVjmGBA48mE72dv2EOWUOB03ER5kNxLl/ewhn2Ya1sBSyttRAl/prDFr
+  KVqLf8YURgYwosAadSWCIhJ2efQFYT3GwOQXoeYsgAZtjSlrVzoyQ6UNkYulTmkH
+  A92PcSEe/WR5K1FfkBZK5q7Q
+  -----END CERTIFICATE-----
+date: 2021-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.81.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+- !ruby/object:Gem::Dependency
+  name: uniqchron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+description: 
+email: digital.robertson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/coinquery.rb
+homepage: https://github.com/jrobertson/coinquery
+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.7.10
+signing_key: 
+specification_version: 4
+summary: Uses the Coingecko API. Inspired by the coingecko_client gem
+test_files: []