avantage 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29165b7eb62a73fefa8c1007475b6dcec0a92467ca589f2398bd2ed881d83824
-  data.tar.gz: '027311472815753cb99601d1fe4dc815141264f03861176b87247e865fffe636'
+  metadata.gz: b636721c2bffd6f0c193f31a9a92a3ece3dd818cde4e4d095fba8a1c28f8c543
+  data.tar.gz: bddfec80486d6f303de470a28f4fd27579999d324b9051e5fe06e6e632abf070
 SHA512:
-  metadata.gz: 39b6ea975fcaf2825c4425d971450623c2a7cadc3d363c486896e4f5b01a3959dc5e9111f3ed1f9e21f4870c62e9f26a509b91abafcb9cdc454dad1b3565acba
-  data.tar.gz: 9bb51cc603e4116a7ba98e57b3b941c480d29b3af72951508fe96cde8c89b2aba68e267d55cc0df84c74d7dae112993ca4dbf7028d3ab534e2e8ae35af077552
+  metadata.gz: b55eb347c6ae28226358d1606e59bb1e1f6bfe0c75e0a136bbb68d08bd2e86770b6d9e665e19673d60fd1bac1e2e847760a88dd52af322ee7cef2f3d8c150cd7
+  data.tar.gz: 7722bab312b6c954160691007aaa2b5c5a3657923c60fbd19525230f2cd5c8ccef49e2bfce4084ae9de61903f492fc404d76bafefa3b019acfe5ade597947088

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 # CHANGELOG.md
 
 
+## avantage 0.1.0  released 2019-06-19
+
+* Initial working release
+
+
 ## avantage 0.0.1  released 2019-06-14
 
 * Initial release

data/README.md

@@ -8,6 +8,66 @@ A Ruby library to query the [Alpha Vantage API](https://www.alphavantage.co/docu
 
 ## usage
 
+The first step is to instantiate a client:
+```ruby
+require 'avantage'
+
+client = Avantage::Client.new('6SAMPLEWO0KLUG55')
+  # or more something like
+client = Avantage::Client.new(File.read('.api.key').strip)
+```
+
+Functions may be called directly:
+```ruby
+require 'pp'
+
+pp client.get(:global_quote, symbol: 'GOOG')
+  #
+  # ==>
+  #
+  # {"Global Quote"=>
+  #   {"01. symbol"=>"GOOG",
+  #    "02. open"=>"1109.6900",
+  #    "03. high"=>"1116.3900",
+  #    "04. low"=>"1098.9995",
+  #    "05. price"=>"1103.6000",
+  #    "06. volume"=>"1386684",
+  #    "07. latest trading day"=>"2019-06-18",
+  #    "08. previous close"=>"1092.5000",
+  #    "09. change"=>"11.1000",
+  #    "10. change percent"=>"1.0160%"}}
+```
+
+GLOBAL_QUOTE, SYMBOL_SEARCH, CURRENCY_EXCHANGE_RATE, and SECTOR can be called directly:
+```ruby
+client.global_quote('GOOG')
+client.global_quote(symbol: 'GOOG')
+client.global_quote(symbol: 'GOOG', datatype: 'csv')
+client.quote('GOOG')
+# ...
+
+client.symbol_search(keywords: 'IBM')
+client.symbol_search('IBM')
+client.search(keywords: 'IBM')
+client.search('IBM')
+client.search(keywords: 'IBM', datatype: 'csv')
+# ...
+
+client.currency_exchange_rate('USD', 'JPY')
+client.exchange_rate('USD', 'JPY')
+client.exchange_rate(from: 'USD', to: 'JPY')
+client.exchange_rate(from_currency: 'USD', to_currency: 'JPY')
+client.forex(from: 'USD', to: 'JPY')
+client.forex('USD', 'JPY')
+client.forex(from: 'USD', to: 'JPY', datatype: 'csv')
+# ...
+
+client.sectors
+client.sector
+client.sectors(datatype: 'csv')
+# ...
+```
+
 
 ## license
 

data/lib/avantage.rb

@@ -1,8 +1,109 @@
 
+require 'json'
+require 'net/http'
+
+
 module Avantage
 
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
+
+  USER_AGENT = "avantage #{VERSION} - https://github.com/jmettraux/avantage"
+  API_ROOT_URI = 'https://www.alphavantage.co/query?'
+
+  class Client
+
+    def initialize(api_key)
+
+      @api_key = api_key
+    end
+
+    def global_quote(symbol)
+
+      os = symbol.is_a?(Hash) ? symbol : { symbol: symbol }
+
+      get('GLOBAL_QUOTE', os)
+    end
+    alias quote global_quote
+
+    def symbol_search(keywords)
+
+      os = keywords.is_a?(Hash) ? keywords : { keywords: keywords }
+
+      get('SYMBOL_SEARCH', os)
+    end
+    alias search symbol_search
+
+    def sector(os={})
+
+      get('SECTOR', os)
+    end
+    alias sectors sector
+
+    def currency_exchange_rate(from, to=nil)
+
+      os =
+        if from.is_a?(Hash)
+          from.inject({}) { |k, v|
+            if k == :from
+              h[:from_currency] = v
+            elsif k == :to
+              h[:to_currency] = v
+            else
+              h[k] = v
+            end
+            h }
+        else
+          { from_currency: from, to_currency: to }
+        end
+
+      get('CURRENCY_EXCHANGE_RATE', os)
+    end
+    alias exchange_rate currency_exchange_rate
+    alias forex currency_exchange_rate
+
+    def get(function, parameters)
+
+      func = function.to_s.upcase
+
+      params = parameters.merge(function: func, apikey: @api_key)
+      params[:datatype] = 'json' if params.delete(:json)
+      params[:datatype] = 'csv' if params.delete(:csv)
+
+      uri = API_ROOT_URI + URI.encode_www_form(params)
+
+      req = Net::HTTP::Get.new(uri)
+      req.instance_eval { @header.clear }
+      def req.set_header(k, v); @header[k] = [ v ]; end
+
+      req.set_header('User-Agent', USER_AGENT)
+
+      u = URI(uri)
+
+      t0 = monow
+
+      t = Net::HTTP.new(u.host, u.port)
+      t.use_ssl = (u.scheme == 'https')
+#t.set_debug_output($stdout)
+
+      res = t.request(req)
+
+      r = res.body
+      if res.content_type.match(/\Aapplication\/json\b/)
+        r = JSON.parse(r)
+      end
+
+      class << r; attr_accessor :_response, :_client, :_elapsed; end
+        #
+      r._response = res
+      r._client = self
+      r._elapsed = monow - t0
+
+      r
+    end
+
+    protected
 
-  USER_AGENT = "avantage - #{VERSION} - https://github.com/jmettraux/avantage"
+    def monow; Process.clock_gettime(Process::CLOCK_MONOTONIC); end
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avantage
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec