algonquin_stocks 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ebfc73b1396d857b582c9e4d60930100280e2747d96b2dd7907e50a98adf8791
+  data.tar.gz: f463f4821055e3fd25e406e7c01f49da4221516b2fa3f3c1e64b8951667b003f
+SHA512:
+  metadata.gz: 720606af099252a69d7b2bd69fa5a33cabe683fc4caf3893684868b3e0c6e1a2b6fbee17be674cc35064f46d0d794fc25597b2ee612f9b789a6a876e81b9941a
+  data.tar.gz: 373348b731c160a6659c6aac39b3600072e669276ed3d0475a844ce23da846bd2fe726c702fc84b24b70eb9c36017f534cdf7fa0ab62ff7f6e359c61e9354964

data/README.md

@@ -0,0 +1,58 @@
+# Stocks
+
+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:
+
+`gem install stocks`
+
+## Gem Configuration
+
+To use the gem in your Rails Application, include it in your Gemfile:
+
+`gem "stocks"`, '~> 1.0.0'
+
+
+## Initialization
+
+To initialize Stocks with a valid API_KEY:
+
+`Stocks::Stock.new(api_key: YOUR_API_KEY)`
+
+
+## Usage
+
+### Stocks::StockClient.quote(symbol)
+
+Quote is the primary method, returning a Stocks::Stock instance including the following attributes:
+
+- symbol
+- open
+- high
+- low
+- price
+- volume
+- date
+- close
+- change
+- percent
+
+
+### Stocks::StockClient.data(symbol)
+
+Data returns a hash representation of JSON the data.
+
+
+### Stocks::Stock.new(json)
+
+Stock.new(json) initializes a new Stocks::Stock instance with the given JSON data.
+
+### Stocks::Stock#update(json)
+
+Update updates the Stocks::Stock instance with the given JSON data.
+
+### Stocks::Stock#to_s
+
+to_s returns a string representation of the Stocks::Stock instance.

data/lib/stocks/stock.rb

@@ -0,0 +1,38 @@
+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/stock_client.rb

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

data/lib/stocks/version.rb

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

data/lib/stocks.rb

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

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: algonquin_stocks
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Andrei Grobnic
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-22 00:00:00.000000000 Z
+dependencies: []
+description: A gem for managing stocks
+email:
+- grobnia@algonquincollege.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
+homepage: https://github.com/andreigrob/stocks
+licenses:
+- GPL-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/andreigrob/stocks
+  source_code_uri: https://github.com/andreigrob/stocks
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Stocks
+test_files: []