algonquin_stocks 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebfc73b1396d857b582c9e4d60930100280e2747d96b2dd7907e50a98adf8791
-  data.tar.gz: f463f4821055e3fd25e406e7c01f49da4221516b2fa3f3c1e64b8951667b003f
+  metadata.gz: e39fd00a6b032314a03d25e27caee203aa1c284fd7a917d3b93c3b08f5b0bcb3
+  data.tar.gz: db3d0b30bf93201ef13d81a7dee6e36d879533743a0787b0778b05c3756d6fad
 SHA512:
-  metadata.gz: 720606af099252a69d7b2bd69fa5a33cabe683fc4caf3893684868b3e0c6e1a2b6fbee17be674cc35064f46d0d794fc25597b2ee612f9b789a6a876e81b9941a
-  data.tar.gz: 373348b731c160a6659c6aac39b3600072e669276ed3d0475a844ce23da846bd2fe726c702fc84b24b70eb9c36017f534cdf7fa0ab62ff7f6e359c61e9354964
+  metadata.gz: fa67956856b743c75f887e6b6a28b63b4ff616da64867d9db55d268724bff3efe5a0724d1d2aca55384fa9419e7162a28d52e17e6d31dacf265d32860d7f0b28
+  data.tar.gz: 03a1da6dd9506884c701bde6f5a98adf6de4df8de35ca6b438528a0c659216f3bc5e6a625891aca804356582637a747fea47ff34059270b1e49eee248481506e

data/README.md

@@ -1,32 +1,31 @@
-# Stocks
+# AlgonquinStocks
 
 Stock data provided by [Alpha Vantage](https://www.alphavantage.co/). An [API KEY](https://www.alphavantage.co/support/#api-key) is required.
 
 ## Installation
 
-To install the 'stocks' ruby gem:
+To install the 'algonquin_stocks' ruby gem:
 
-`gem install stocks`
+`gem install algonquin_stocks`
 
 ## Gem Configuration
 
 To use the gem in your Rails Application, include it in your Gemfile:
 
-`gem "stocks"`, '~> 1.0.0'
-
+`gem "algonquin_stocks", "~> 1.5.0"`
 
 ## Initialization
 
-To initialize Stocks with a valid API_KEY:
+To initialize AlgonquinStocks with a valid API_KEY:
 
-`Stocks::Stock.new(api_key: YOUR_API_KEY)`
+`AlgonquinStocks::StockClient.new YOUR_API_KEY`
 
 
 ## Usage
 
-### Stocks::StockClient.quote(symbol)
+### AlgonquinStocks::StockClient#quote(symbol)
 
-Quote is the primary method, returning a Stocks::Stock instance including the following attributes:
+Quote is the primary method, returning a AlgonquinStocks::Stock instance including the following attributes:
 
 - symbol
 - open
@@ -40,19 +39,19 @@ Quote is the primary method, returning a Stocks::Stock instance including the fo
 - percent
 
 
-### Stocks::StockClient.data(symbol)
+### AlgonquinStocks::StockClient#data(symbol)
 
-Data returns a hash representation of JSON the data.
+Data returns a hash representation of the JSON data.
 
 
-### Stocks::Stock.new(json)
+### AlgonquinStocks::Stock.new(json)
 
-Stock.new(json) initializes a new Stocks::Stock instance with the given JSON data.
+Stock.new(json) initializes a new AlgonquinStocks::Stock instance with the given JSON data.
 
-### Stocks::Stock#update(json)
+### AlgonquinStocks::Stock#update(json)
 
-Update updates the Stocks::Stock instance with the given JSON data.
+Update updates the AlgonquinStocks::Stock instance with the given JSON data.
 
-### Stocks::Stock#to_s
+### AlgonquinStocks::Stock#to_s
 
-to_s returns a string representation of the Stocks::Stock instance.
+to_s returns a string representation of the AlgonquinStocks::Stock instance.

data/lib/algonquin_stocks/stock.rb

@@ -0,0 +1,54 @@
+require 'date'
+
+module AlgonquinStocks
+  # => AlgonquinStocks::Stock
+  #
+  # @param json [Hash] The JSON response from Alpha Vantage.
+  # @return [AlgonquinStocks::Stock] The stock object.
+  class Stock
+    attr_reader :symbol, :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'
+
+    # => AlgonquinStocks::Stock#update
+    #
+    # @param json [Hash] The JSON response from Alpha Vantage.
+    # @return [AlgonquinStocks::Stock] The stock object.
+    def update(json)
+      @symbol = json[SYMBOL]
+      @open = json[OPEN].to_f
+      @high = json[HIGH].to_f
+      @low = json[LOW].to_f
+      @price = json[PRICE].to_f
+      @volume = json[VOLUME].to_i
+      @date = Date.parse json[DATE]
+      @close = json[CLOSE].to_f
+      @change = json[CHANGE].to_f
+      @percent = json[PERCENT].to_f
+    end
+
+    # => AlgonquinStocks::Stock#to_s
+    #
+    # @return [String] The stock object as a string.
+    def to_s
+      "#{symbol}: #{price} (#{change}, #{percent}) #{date}"
+    end
+  end
+end

data/lib/{stocks → algonquin_stocks}/stock_client.rb

@@ -1,47 +1,45 @@
 require 'rest-client'
 require 'json'
-require 'date'
 
-module Stocks
-
-  # => Stocks::StockClient
+module AlgonquinStocks
+  # => AlgonquinStocks::StockClient
   #
   # @param api_key [String] The API key for Alpha Vantage.
-  # @return [Stocks::StockClient] The stock client object.
+  # @return [AlgonquinStocks::StockClient] The stock client object.
   class StockClient
     URL_BASE = "https://www.alphavantage.co/query"
     FUNCTION = "GLOBAL_QUOTE"
 
-    # => Stocks::StockClient#initialize
+    # => AlgonquinStocks::StockClient#initialize
     #
     # @param api_key [String] The API key for Alpha Vantage.
-    # @return [Stocks::StockClient] The stock client object.
+    # @return [AlgonquinStocks::StockClient] The stock client object.
     def initialize(api_key)
       @api_key = api_key
       @url = "#{URL_BASE}?apikey=#{@api_key}"
     end
 
-    # => Stocks::StockClient#data
+    # => AlgonquinStocks::StockClient#data
     #
     # @param symbol [String] The symbol of the stock.
     # @param function [String] The function to use.
     # @return [Hash] The JSON response from Alpha Vantage.
     def data(symbol, function=FUNCTION)
       url = "#{@url}&function=#{function}&symbol=#{symbol}"
-      RestClient::Request.execute(url: url, method: :get, verify_ssl: false) do |response|
+      RestClient::Request.execute url: url, method: :get, verify_ssl: false do |response|
         raise response.body unless response.code == 200
-        JSON.parse(response.body)
+        JSON.parse response.body
       end
     end
 
-    # => Stocks::StockClient#quote
+    # => AlgonquinStocks::StockClient#quote
     #
     # @param symbol [String] The symbol of the stock.
     # @param function [String] The function to use.
-    # @return [Stocks::Stock] The stock object.
+    # @return [AlgonquinStocks::Stock] The stock object.
     def quote(symbol, function=FUNCTION)
-      json = data(symbol, function)
-      Stock.new(json['Global Quote'])
+      json = data symbol, function
+      Stock.new json['Global Quote']
     end
   end
 end

data/lib/algonquin_stocks/version.rb

@@ -0,0 +1,5 @@
+# => AlgonquinStocks::VERSION
+module AlgonquinStocks
+  VERSION = '1.5.0'
+end
+

data/lib/algonquin_stocks.rb

@@ -0,0 +1,3 @@
+require_relative "algonquin_stocks/version"
+require_relative "algonquin_stocks/stock"
+require_relative "algonquin_stocks/stock_client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algonquin_stocks
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Andrei Grobnic
@@ -10,18 +10,18 @@ bindir: exe
 cert_chain: []
 date: 2025-04-22 00:00:00.000000000 Z
 dependencies: []
-description: A gem for managing stocks
+description: A gem for retrieving stock information
 email:
-- grobnia@algonquincollege.com
+- andrey.grobnik@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/stocks.rb
-- lib/stocks/stock.rb
-- lib/stocks/stock_client.rb
-- lib/stocks/version.rb
+- lib/algonquin_stocks.rb
+- lib/algonquin_stocks/stock.rb
+- lib/algonquin_stocks/stock_client.rb
+- lib/algonquin_stocks/version.rb
 homepage: https://github.com/andreigrob/stocks
 licenses:
 - GPL-2.0

data/lib/stocks/stock.rb

@@ -1,38 +0,0 @@
-module Stocks
-
-  # => Stocks::Stock
-  #
-  # @param json [Hash] The JSON response from Alpha Vantage.
-  # @return [Stocks::Stock] The stock object.
-  class Stock
-    attr_reader :symbol, :open, :high, :low, :price, :volume, :date, :close, :change, :percent
-
-    def initialize(json)
-      update(json)
-    end
-
-    # => Stocks::Stock#update
-    #
-    # @param json [Hash] The JSON response from Alpha Vantage.
-    # @return [Stocks::Stock] The stock object.
-    def update(json)
-      @symbol = json['01. symbol']
-      @open = json['02. open'].to_f
-      @high = json['03. high'].to_f
-      @low = json['04. low'].to_f
-      @price = json['05. price'].to_f
-      @volume = json['06. volume'].to_i
-      @date = Date.parse(json['07. latest trading day'])
-      @close = json['08. previous close'].to_f
-      @change = json['09. change'].to_f
-      @percent = json['10. change percent'].to_f
-    end
-
-    # => Stocks::Stock#to_s
-    #
-    # @return [String] The stock object as a string.
-    def to_s
-      "#{symbol}: #{price} (#{change}, #{percent}) #{date}"
-    end
-  end
-end

data/lib/stocks/version.rb

@@ -1,5 +0,0 @@
-# => Stocks::VERSION
-module Stocks
-  VERSION = '1.1.0'
-end
-

data/lib/stocks.rb

@@ -1,3 +0,0 @@
-require_relative "stocks/version"
-require_relative "stocks/stock"
-require_relative "stocks/stock_client"