coinquery 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758496fcb32b9afca80bfefaa6b2f5c08453bd608048ddb0692465461c403afe
-  data.tar.gz: 874d762332465a5aacd1819cb3dcc21f3e0e6e995ce7931a931ee3f53ccb2221
+  metadata.gz: af2b23cb6aab30532b99a66db98e5425da892c1989219eaf25099582971beb4c
+  data.tar.gz: eae541068ad3050c2dda702977d51cd1ec7dbcaa7e642352448163b76fd459f4
 SHA512:
-  metadata.gz: 85b0a5363cd75c308e3613910aab22f15a8a13f584482a10dff27da2863200c038f88af1428b056103105b171a6da525db7bc77a6c830ed4c70b66c47a00e845
-  data.tar.gz: 3eaa803951290bba188013a2b5f6c4c963b16de0aa020ec8c2caa0fb19fa50d3588bba46290a4944365505e2be525d16f40349fd1cef06a7e02f912c6e25463e
+  metadata.gz: 726587aa2b8da2869e3ed6cc59dc6028a27cbcd449a825041c7d211e0ce31d8c0c99619039f912b4f326cc196028833bb8600eae17f27745fc4157cd93201dc5
+  data.tar.gz: 7f308647d75cf2d26083377be5376a2e46663f59d2a9d7593bc490cdc4f8204140933a01ae44d804e3189dfa25649838cf1ee7c124be020d1c01fbf82d5c8073

data/lib/coinquery.rb

@@ -8,6 +8,8 @@ require 'json'
 require 'excon'
 require 'unichron'
 require 'did_you_mean'
+require 'recordx_sqlite'
+
 
 
 class CoinQueryException < Exception
@@ -18,9 +20,11 @@ class CoinQuery
 
   attr_reader :list
 
-  def initialize(autofind: true, dym: true, debug: false)
+  def initialize(autofind: true, dym: true, timeout: 5, filepath: '.', 
+                 debug: false)
 
-    @autofind, @dym, @debug = autofind, dym, debug
+    @autofind, @dym, @timeout, @debug = autofind, dym, timeout, debug
+    @filepath = filepath
 
     @url_base = 'https://api.coingecko.com/api/v3/'
     r = ping()
@@ -54,14 +58,14 @@ class CoinQuery
 
         if not File.exists? file then
 
-          File.open(file, 'w+') do |f|  
+          File.open(File.join(@filepath, file), 'w+') do |f|  
            Marshal.dump([@list, @dym], f)  
           end 
 
         else
         
           puts ('loading coins list ...').info  
-          File.open(file) do |f|  
+          File.open(File.join(@filepath, file)) do |f|  
             @list, @dym = Marshal.load(f)  
           end
     
@@ -69,7 +73,33 @@ class CoinQuery
 
       end
     end
+    
+    @table = RecordxSqlite.new(File.join(@filepath, 'coinquery.db'), 
+      table: {coins: {id: '', cname: '', price: '', date: 0}})
+    
 
+  end
+  
+  # archives the cryptocurrency prices in a local sqlite database
+  # note: intended for archiving prices on a daily basis
+  # 
+  def archive(limit: 250)    
+        
+    puts 'archive: fetching coins ...'.info
+    a = coins(limit: limit)
+    
+    puts 'archive: saving to database ...'.info
+
+    a.each do |coin|
+      
+      uid = coin['id'] + Date.today.to_time.to_i.to_s
+      @table.create id: uid.to_s, cname: coin['name'], 
+          price: coin['current_price'].to_s, date: Date.today.to_time.to_i
+      
+    end
+    
+    puts 'archive: completed'.info
+    
   end
 
   # lists the top coins (limited to 5 by default)
@@ -84,6 +114,45 @@ class CoinQuery
   def coins_list
     @list
   end
+  
+  def find_coin(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
+
+  end
+
+  def find_id(name)
+    r = find_coin(name)
+    r['id']
+  end  
+  
+  def find_name(s)
+    r = find_coin s
+    r['name']
+  end
 
   # returns the price of a coin for a given historical date
   # e.g. historical_price('Bitcoin', '01-05-2021')
@@ -121,6 +190,23 @@ class CoinQuery
       val < 1 ? val : val.round(2)
     end
   end
+  
+  # use the database archive to query the historical price of a coin
+  # e.g. query_archive :btc, '1 May 2021'
+  #
+  def query_archive(coin_name, rawdate)
+
+    uc = Unichron.new(rawdate.to_s, :little_endian)
+    raise 'invalid date' unless uc.valid?
+    date = uc.to_date
+    
+    coin_id = find_id coin_name    
+    
+    id = coin_id + date.to_time.to_i.to_s
+    r = @table.query "select * from coins where id == '#{id}'"
+    r.first if r
+    
+  end
 
 
   private
@@ -128,7 +214,7 @@ class CoinQuery
   def api_call(api_request)
     
     begin
-      Timeout::timeout(3){
+      Timeout::timeout(@timeout){
         response = Excon.get(@url_base + api_request)
         JSON.parse(response.body)
       }
@@ -139,35 +225,5 @@ class CoinQuery
     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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coinquery
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - James Robertson
@@ -77,6 +77,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: recordx_sqlite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  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.3
 description: 
 email: digital.robertson@gmail.com
 executables: []