algonquin_stocks 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 260c32104c95783e164d37f55e07b5bf9e3c31a2fd08a79c2c8c6f20d68e5b5c
-  data.tar.gz: 8146f1edbdfdc37924f555618d8171a2feb5e4d452b16069ec6f00d9ccee084a
+  metadata.gz: a853fc21135ba1200935b7ce64979a390eb1c2922ba179500fedb92da2504921
+  data.tar.gz: 639579beeb874967cd76a0e6d465dfa8b36b1ec061d57d016dfaf29ba6cb956b
 SHA512:
-  metadata.gz: f50ec185ca901f025433155c4611ee5ca777bb7ec0e7915d619429ec7f21d5dbd912dcaea87431a4f1b9871afba4822d2180859d511f804f30cfaf62c4c24618
-  data.tar.gz: c1f22651b66557a270945e0784cdca993bab152bc4ff430cad20f2fba1c811986b991e95d0cc3be3ee4ee271cc859c917e098a2e73d2ef2952f96ecdf0a89072
+  metadata.gz: 7f3974a9003813154409a4582f62c52080aa9c9307f3d46ffdd452958d3586a275cc4d8ed3d9b0fe0bd61083a68edba58c4feae2571f6090f67f5c5745bca44a
+  data.tar.gz: 6a0e4dae31a22042042f319a23392e62ec7a025929f188ca3d57aa6cce0acacf5dc4d0a03dff87baecc1d36a2cefbf60521bbb59eb518f9e08b423d044644828

data/README.md

@@ -12,14 +12,15 @@ To install the 'algonquin_stocks' ruby gem:
 
 To use the gem in your Rails Application, include it in your Gemfile:
 
-`gem "algonquin_stocks", "~> 1.5.0"`
+`gem "algonquin_stocks", "~> 2.1.0"`
 
 ## Initialization
 
 To initialize AlgonquinStocks with a valid API_KEY:
 
-`AlgonquinStocks::StockClient.new YOUR_API_KEY`
+`AlgonquinStocks::StockClient.new YOUR_API_KEY, CACHE`
 
+CACHE is optional and defaults to false.  If set to true, the gem will cache the stock data in a SQLite database.
 
 ## Usage
 
@@ -37,6 +38,7 @@ Quote is the primary method, returning a AlgonquinStocks::Stock instance includi
 - close
 - change
 - percent
+- data
 
 
 ### AlgonquinStocks::StockClient#data(symbol)

data/lib/algonquin_stocks/stock.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'logger'
 
 module AlgonquinStocks
   # => AlgonquinStocks::Stock
@@ -6,32 +7,19 @@ module AlgonquinStocks
   # @param json [Hash] The JSON response from Alpha Vantage.
   # @return [AlgonquinStocks::Stock] The stock object.
   class Stock
-    attr_reader :symbol, :data, :open, :high, :low, :price, :volume, :date, :close, :change, :percent
-
-    # => AlgonquinStocks::Stock#initialize
-    #
-    # @param json [Hash] The JSON response from Alpha Vantage.
-    # @return [AlgonquinStocks::Stock] The stock object.
     def initialize(json)
       update json
     end
-    
-    SYMBOL = '01. symbol'
-    OPEN = '02. open'
-    HIGH = '03. high'
-    LOW = '04. low'
-    PRICE = '05. price'
-    VOLUME = '06. volume'
-    DATE = '07. latest trading day'
-    CLOSE = '08. previous close'
-    CHANGE = '09. change'
-    PERCENT = '10. change percent'
 
+    @@log = Logger.new(STDOUT)
+    @@log.level = Logger::INFO
+    
     # => AlgonquinStocks::Stock#update
     #
     # @param json [Hash] The JSON response from Alpha Vantage.
     # @return [AlgonquinStocks::Stock] The stock object.
     def update(json)
+      @@log.info "update: #{json}"
       @symbol = json[SYMBOL]
       @open = json[OPEN].to_f
       @high = json[HIGH].to_f
@@ -55,11 +43,77 @@ module AlgonquinStocks
       }
     end
 
+    SYMBOL = '01. symbol'
+    OPEN = '02. open'
+    HIGH = '03. high'
+    LOW = '04. low'
+    PRICE = '05. price'
+    VOLUME = '06. volume'
+    DATE = '07. latest trading day'
+    CLOSE = '08. previous close'
+    CHANGE = '09. change'
+    PERCENT = '10. change percent'
+
     # => AlgonquinStocks::Stock#to_s
     #
     # @return [String] The stock object as a string.
     def to_s
       "#{symbol}: #{price} (#{change}, #{percent}) #{date}"
     end
+
+    # => AlgonquinStocks::Stock#symbol
+    #
+    # @return [String] The symbol of the stock.
+    attr_reader :symbol
+
+    # => AlgonquinStocks::Stock#data
+    #
+    # @return [Hash] The stock data.
+    attr_reader :data
+
+    # => AlgonquinStocks::Stock#open
+    #
+    # @return [Float] The open price of the stock.
+    attr_reader :open
+
+    # => AlgonquinStocks::Stock#high
+    #
+    # @return [Float] The high price of the stock.
+    attr_reader :high
+
+    # => AlgonquinStocks::Stock#low
+    #
+    # @return [Float] The low price of the stock.
+    attr_reader :low
+
+    # => AlgonquinStocks::Stock#price
+    #
+    # @return [Float] The price of the stock.
+    attr_reader :price
+
+    # => AlgonquinStocks::Stock#volume
+    #
+    # @return [Integer] The volume of the stock.
+    attr_reader :volume
+
+    # => AlgonquinStocks::Stock#date
+    #
+    # @return [Date] The latest trading day of the stock.
+    attr_reader :date
+
+    # => AlgonquinStocks::Stock#close
+    #
+    # @return [Float] The previous close price of the stock.
+    attr_reader :close
+
+    # => AlgonquinStocks::Stock#change
+    #
+    # @return [Float] The change of the stock price.
+    attr_reader :change
+
+    # => AlgonquinStocks::Stock#percent
+    #
+    # @return [Float] The percent change of the stock price.
+    attr_reader :percent
   end
 end

data/lib/algonquin_stocks/stock_client.rb

@@ -1,45 +1,104 @@
 require 'rest-client'
 require 'json'
+require 'date'
+require 'sqlite3'
+require 'logger'
 
 module AlgonquinStocks
   # => AlgonquinStocks::StockClient
   #
   # @param api_key [String] The API key for Alpha Vantage.
+  # @param cached [Boolean] Whether to use cached data.
   # @return [AlgonquinStocks::StockClient] The stock client object.
   class StockClient
-    URL_BASE = "https://www.alphavantage.co/query"
-    FUNCTION = "GLOBAL_QUOTE"
-
-    # => AlgonquinStocks::StockClient#initialize
-    #
-    # @param api_key [String] The API key for Alpha Vantage.
-    # @return [AlgonquinStocks::StockClient] The stock client object.
-    def initialize(api_key)
+    def initialize(api_key, cached = false)
       @api_key = api_key
+      @cached = cached
       @url = "#{URL_BASE}?apikey=#{@api_key}"
+      @db = SQLite3::Database.new 'cache.db'
+      @db.execute 'create table if not exists Stocks (Symbol text, Function text, Data text, Fetched datetime, primary key (Symbol, Function))'
+    end
+
+    @@log = Logger.new(STDOUT)
+    @@log.level = Logger::INFO
+
+    URL_BASE = 'https://www.alphavantage.co/query'
+    FUNCTION = 'GLOBAL_QUOTE'
+
+    SQL_SYMBOL = 0
+    SQL_FUNCTION = 1
+    SQL_DATA = 2
+    SQL_FETCHED = 3
+    # => AlgonquinStocks::StockClient#save_cached
+    #
+    # @param symbol [String] The symbol of the stock.
+    # @param function [String] The API function value.
+    # @param data [Hash] The data to save.
+    # @return [Boolean] Whether the data was saved.
+    def save_cached(symbol, function, data)
+      @@log.info "save_cached: #{symbol}, #{function}, #{data}"
+      return @db.execute 'insert into Stocks (Symbol, Function, Data, Fetched) values (?, ?, ?, ?)', [symbol, function, data, DateTime.now.to_s]
+    end
+
+    # => AlgonquinStocks::StockClient#get_cached
+    #
+    # @param symbol [String] The symbol of the stock.
+    # @param function [String] The API function value.
+    # @return [Hash, String] The cached data and fetched date.
+    def get_cached(symbol, function)
+      @@log.info "get_cached: #{symbol}, #{function}"
+      result = @db.execute 'select * from Stocks where Symbol = ? and Function = ?', [symbol, function]
+      if result.length > 0
+        @@log.info "cached data: #{result}"
+        return result[0][SQL_DATA], result[0][SQL_FETCHED]
+      end
+      @@log.info '*** no cached data found ***'
+      return nil
     end
 
     # => AlgonquinStocks::StockClient#data
     #
     # @param symbol [String] The symbol of the stock.
-    # @param function [String] The function to use.
+    # @param function [String] The API function value.
     # @return [Hash] The JSON response from Alpha Vantage.
     def data(symbol, function=FUNCTION)
+      @@log.info "data: #{symbol}, #{function}"
       url = "#{@url}&function=#{function}&symbol=#{symbol}"
+      @@log.info "url: #{url}"
       RestClient::Request.execute url: url, method: :get, verify_ssl: false do |response|
         raise response.body unless response.code == 200
-        JSON.parse response.body
+        response.body
       end
     end
 
     # => AlgonquinStocks::StockClient#quote
     #
     # @param symbol [String] The symbol of the stock.
-    # @param function [String] The function to use.
+    # @param function [String] The API function value.
     # @return [AlgonquinStocks::Stock] The stock object.
     def quote(symbol, function=FUNCTION)
-      json = data symbol, function
-      Stock.new json['Global Quote']
+      @@log.info "quote: #{symbol}, #{function}"
+      if @cached
+        json_str, fetched = get_cached symbol, function
+        if fetched
+          fetched_date = DateTime.parse fetched
+          if fetched_date > DateTime.now - DateTime.parse('5 hours')
+            @@log.info '*** using cached data ***'
+            json = JSON.parse json_str
+            stock = Stock.new json
+            return stock
+          end
+        end
+      end
+      json_data = data symbol, function
+      json = (JSON.parse json_data)['Global Quote']
+      if !json
+        @@log.info '*** no data found ***'
+        return nil
+      end
+      stock = Stock.new json
+      save_cached symbol, function, json.to_json
+      return stock
     end
   end
 end

data/lib/algonquin_stocks/version.rb

@@ -1,5 +1,5 @@
 # => AlgonquinStocks::VERSION
 module AlgonquinStocks
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algonquin_stocks
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrei Grobnic
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-22 00:00:00.000000000 Z
+date: 2025-04-25 00:00:00.000000000 Z
 dependencies: []
 description: A gem for retrieving stock information
 email: