stonk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c8aaeb619986b3fff1bfa2de91c70796287bc96335c650a16b0ab98e9d9cbb9
+  data.tar.gz: 757458f818e7a2bb9b4b6465a36b3b96299bb8d502ebb9883d63372e7bc7efc3
+SHA512:
+  metadata.gz: 10d76d734b74e04aa4e75d49a6ec9f64760ba70a15b494ddd26df0a9ada7707d4d2048d130bbb710154455ef70c5fb6ce72e58411d629c6db9fc350afd668251
+  data.tar.gz: a6866306f9d9c118c42ae331f2f74360751f56687c4508a0d411e2e575b6af9df6eb18e291754ed55a16c661ff24ebe9197f47e17b1cc0fc612428963800a8c0

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.1

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+## [1.0.0] - 2025-07-22
+
+### Core Features
+- **Fallback strategy** - automatically tries multiple adapters if one fails
+- **Built-in caching** with file-based cache adapter to reduce API calls
+- **Rate limiting support** with configurable retry logic
+- **Comprehensive error handling** for various failure scenarios
+
+### Data Sources
+- **Alpha Vantage adapter** - Premium stock data via RapidAPI
+  - Configurable retry logic for rate limits
+  - API key-based authentication
+  - JSON response parsing
+
+### Caching System
+- **File cache adapter** for local storage of stock prices
+  - JSON-based cache file format
+  - Automatic cache file creation and management
+  - Cache clearing functionality
+
+### Core Classes
+- **Stonk::Service** - Main service class for orchestrating adapters
+- **Stonk::Money** - BigDecimal-based money class for precise price handling
+- **Stonk::Adapter** - Base adapter module with common error classes
+  - StockNotFound, RateLimitExceeded, ServerError exceptions
+
+### Developer Experience
+- **Comprehensive test suite** with Minitest
+  - Unit tests for all adapters and core classes
+  - VCR cassettes for API response testing
+  - Fixtures for reliable test data
+- **Logging support** with configurable log levels via STONK_LOG_LEVEL
+- **Ruby 3.1+ compatibility** with modern Ruby features
+- **MIT license** for open source use
+- **Gem signing** with 1Password integration
+
+### Error Handling
+- Graceful handling of network failures
+- Rate limit detection and retry mechanisms
+- Stock symbol validation and not-found scenarios
+- Server error classification and reporting

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Nick Jones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,208 @@
+# Stonk
+
+A Ruby gem for fetching real-time stock prices from multiple data sources with a unified interface. Stonk provides adapters for popular financial APIs and includes caching capabilities for improved performance.
+
+## Features
+
+- **Caching**: Built-in file-based caching to reduce API calls
+- **Fallback Strategy**: Automatically tries multiple adapters if one fails
+- **Rate Limiting**: Built-in rate limit handling with retry logic
+- **Error Handling**: Comprehensive error handling for various failure scenarios
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stonk'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install stonk
+```
+
+## Usage
+
+### Basic Usage
+
+```ruby
+require 'stonk'
+
+# Create a service with lookup adapters and optional cache adapter
+cache_adapter = Stonk::Adapter::FileCacheAdapter.new('/tmp/stock_cache.json')
+service = Stonk::Service.new(
+  lookup_adapters: [
+    Stonk::Adapter::AlphaVantageAdapter.new(ENV['ALPHA_VANTAGE_API_KEY'])
+  ],
+  cache_adapter:
+)
+
+# Get stock price (automatically cached if cache_adapter is provided)
+price = service.get_stock_price('AAPL')
+puts "Apple stock price: $#{price}" if price
+```
+
+### Using Individual Adapters
+
+#### Alpha Vantage Adapter
+
+The Alpha Vantage adapter requires an API key from [Alpha Vantage](https://www.alphavantage.co/):
+
+```ruby
+require 'stonk'
+
+# Create Alpha Vantage adapter with API key
+alpha_adapter = Stonk::Adapter::AlphaVantageAdapter.new(
+  ENV['ALPHA_VANTAGE_API_KEY'],
+  retry_on_rate_limit: true,
+  rate_limit_sleep_seconds: 5
+)
+
+# Get stock price
+begin
+  price = alpha_adapter.get_stock_price('AAPL')
+  puts "Apple stock price: $#{price}"
+rescue Stonk::Adapter::StockNotFound
+  puts "Stock not found"
+rescue Stonk::Adapter::RateLimitExceeded
+  puts "Rate limit exceeded"
+rescue Stonk::Adapter::ServerError => e
+  puts "Server error: #{e.message}"
+end
+```
+
+#### File Cache Adapter
+
+The file cache adapter stores stock prices locally to reduce API calls:
+
+```ruby
+require 'stonk'
+
+# Create file cache adapter
+cache_adapter = Stonk::Adapter::FileCacheAdapter.new('/tmp/stock_cache.json')
+
+# Set a stock price in cache
+cache_adapter.set_stock_price('AAPL', Stonk::Money.new('150.25'))
+
+# Get stock price from cache
+begin
+  price = cache_adapter.get_stock_price('AAPL')
+  puts "Cached Apple stock price: $#{price}"
+rescue Stonk::Adapter::StockNotFound
+  puts "Stock not found in cache"
+end
+
+# Clear the cache
+cache_adapter.clear_cache
+```
+
+### Advanced Usage with Fallback Strategy
+
+```ruby
+require 'stonk'
+
+# Create adapters in order of preference
+cache_adapter = Stonk::Adapter::FileCacheAdapter.new('/tmp/stock_cache.json')
+alpha_adapter = Stonk::Adapter::AlphaVantageAdapter.new(ENV['ALPHA_VANTAGE_API_KEY'])
+alpha_adapter_with_retry = Stonk::Adapter::AlphaVantageAdapter.new(
+  ENV['ALPHA_VANTAGE_API_KEY'],
+  retry_on_rate_limit: true
+)
+
+# Service will try lookup adapters in order until one succeeds, and cache results
+service = Stonk::Service.new(
+  lookup_adapters: [
+    cache_adapter,           # Try looknig up in the cache first
+    alpha_adapter            # Then Alpha Vantage
+    alpha_adapter_with_retry # Then back to Alpha Vantage with a retry.
+  ],
+  cache_adapter:             # Cache successful results
+)
+
+# Get stock price (will try each lookup adapter until one returns a price, then cache the result)
+price = service.get_stock_price('AAPL')
+puts "Apple stock price: $#{price}" if price
+```
+
+### Working with Money Objects
+
+Stock prices are returned as `Stonk::Money` objects, which are based on `BigDecimal` for precision:
+
+```ruby
+require 'stonk'
+
+yahoo_adapter = Stonk::Adapter::YahooFinanceAdapter.new
+price = yahoo_adapter.get_stock_price('AAPL')
+
+# Money objects support arithmetic operations
+puts "Price: $#{price}"
+puts "Price as float: #{price.to_f}"
+puts "Price as string: #{price.to_s}"
+
+# You can perform calculations
+total_value = price * 100
+puts "Value of 100 shares: $#{total_value}"
+```
+
+### Error Handling
+
+```ruby
+require 'stonk'
+
+service = Stonk::Service.new(
+  lookup_adapters: [
+    Stonk::Adapter::YahooFinanceAdapter.new
+  ]
+)
+
+begin
+  price = service.get_stock_price('INVALID_SYMBOL')
+  puts "Price: $#{price}" if price
+rescue Stonk::Adapter::StockNotFound
+  puts "Stock symbol not found"
+rescue Stonk::Adapter::RateLimitExceeded
+  puts "Rate limit exceeded, try again later"
+rescue Stonk::Adapter::ServerError => e
+  puts "Server error: #{e.message}"
+rescue => e
+  puts "Unexpected error: #{e.message}"
+end
+```
+
+### Logging
+
+Stonk includes built-in logging that can be configured via environment variables:
+
+```ruby
+# Set log level via environment variable
+ENV['STONK_LOG_LEVEL'] = 'DEBUG'
+
+# Or access the logger directly
+Stonk.logger.level = Logger::DEBUG
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/punkstar/stonk.rb](https://github.com/punkstar/stonk.rb). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/punkstar/stonk.rb/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Stonk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/punkstar/stonk.rb/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "minitest/test_task"
+
+RuboCop::RakeTask.new
+
+Minitest::TestTask.create do |t|
+  t.warning = false
+end
+
+task default: :test

data/bin/stonk

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "stonk"
+require "optparse"
+
+use_cache = true
+
+def setup_service(use_cache:)
+  cache_adapter = Stonk::Adapter::FileCacheAdapter.new("/tmp/stock_cache.json")
+  alpha_adapter = Stonk::Adapter::AlphaVantageAdapter.new(ENV["ALPHA_VANTAGE_API_KEY"])
+  alpha_adapter_with_retry = Stonk::Adapter::AlphaVantageAdapter.new(
+    ENV["ALPHA_VANTAGE_API_KEY"],
+    retry_on_rate_limit: true,
+  )
+
+  lookup_adapters = [alpha_adapter, alpha_adapter_with_retry]
+
+  lookup_adapters.unshift(cache_adapter) if use_cache
+
+  Stonk::Service.new(
+    lookup_adapters:,
+    cache_adapter: use_cache ? cache_adapter : nil,
+  )
+end
+
+def lookup_stock(service, symbol)
+  puts "Looking up #{symbol.upcase}..."
+
+  begin
+    price = service.get_stock_price(symbol.upcase)
+
+    if price
+      puts "#{symbol.upcase}: $#{price.to_f}"
+    else
+      puts "Could not find price for #{symbol.upcase}"
+      exit(1)
+    end
+  rescue Stonk::Adapter::StockNotFound
+    puts "Stock not found: #{symbol.upcase}"
+    exit(1)
+  rescue Stonk::Adapter::RateLimitExceeded
+    puts "Rate limit exceeded. Please try again later."
+    exit(1)
+  rescue Stonk::Adapter::ServerError => e
+    puts "Server error occurred: #{e.message}"
+    exit(1)
+  rescue => e
+    puts "Error: #{e.message}"
+    exit(1)
+  end
+end
+
+def show_help
+  puts <<~HELP
+    Usage: stonk [OPTIONS] SYMBOL
+
+    Look up stock prices using multiple data sources.
+
+    Arguments:
+      SYMBOL                    Stock symbol to look up (e.g., AAPL, MSFT)
+
+    Options:
+      -h, --help               Show this help message
+
+    Environment Variables:
+      ALPHA_VANTAGE_API_KEY    API key for Alpha Vantage (optional)
+
+    Examples:
+      stonk AAPL               Look up Apple stock price
+      stonk MSFT               Look up Microsoft stock price
+
+    The tool will try multiple data sources in order:
+    1. Local cache
+    2. Alpha Vantage (if API key provided)
+    4. Alpha Vantage with retry (if API key provided)
+
+    Successful lookups are cached for future use.
+  HELP
+end
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: stonk [OPTIONS] SYMBOL"
+
+  opts.on("-h", "--help", "Show this help message") do
+    show_help
+    exit
+  end
+
+  opts.on("--verbose", "Show verbose output") do
+    Stonk.logger.level = Logger::DEBUG
+  end
+
+  opts.on("--no-cache", "Do not use the cache") do
+    use_cache = false
+  end
+end.parse!
+
+if ARGV.empty?
+  puts "Error: Stock symbol is required"
+  puts "Use 'stonk --help' for usage information"
+  exit 1
+end
+
+symbol = ARGV.first
+
+service = setup_service(use_cache:)
+lookup_stock(service, symbol)

data/etc/punkstar.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEdDCCAtygAwIBAgIBATANBgkqhkiG9w0BAQsFADBAMQ0wCwYDVQQDDARuaWNr
+MRkwFwYKCZImiZPyLGQBGRYJbmlja2pvbmVzMRQwEgYKCZImiZPyLGQBGRYEdGVj
+aDAeFw0yNTA3MDYxOTM3MzNaFw0yNjA3MDYxOTM3MzNaMEAxDTALBgNVBAMMBG5p
+Y2sxGTAXBgoJkiaJk/IsZAEZFgluaWNram9uZXMxFDASBgoJkiaJk/IsZAEZFgR0
+ZWNoMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAtVeWYtCOx6NWkD1H
+M01ivSrilcoVoJ10AtlLgH23yN3pP4iMg+/c4ZfFqsrSDFbigbOmimQx74NlMdFG
+dhhrAfPvoHmzUYvPWnCXkkqWRnXdK7+0m1tG4HxD1JJhgPtQKDSK9xx4seLZt01b
+kL4ndBDXd7YXCzQhoozwXBVbVuip3bE2OYnUsEV7wXMZJYHK5Tj68QH5oppHTRV5
+2Ws/W5CoHeZ7oExGYkYpF1U2/XG+722m6zHeUX9opLcXfvP+fpomDbFA7W1MFxTN
+C+lxXhZYPt1+Pr9YeUnsc9uiX/NTgCvOCczR4eH5EeEchOZKFypiERajFXV9mDTG
+f+fEBktE7zRdqTZD1KO/0peN8fvBlXWgA0fLD50UFfBR8s7pvYGzhs1uHiS8AFC/
+BTWm7ttFetzKVZURP4ym3xxzpYuOTWDqkqvfd4ew6BDXBuZJsqXWE8X4qzDsNMCx
+SGhyP3NbbRuY46T+T5K+k3zNtDRB7ZVjJFeum21mBkN6SVm7AgMBAAGjeTB3MAkG
+A1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBTnEkevlJfGftCtQSV5MwW5
+DDEKzDAeBgNVHREEFzAVgRNuaWNrQG5pY2tqb25lcy50ZWNoMB4GA1UdEgQXMBWB
+E25pY2tAbmlja2pvbmVzLnRlY2gwDQYJKoZIhvcNAQELBQADggGBADCu8hK3XBEm
+aVNShTjB1JR6Hy7+wCbUevLqRyTaf2aA2wpn7gJnlENMo4UKIXAzBSKMzTFTH2ZJ
+1WKrO045godBAqF005q3WHDNpUTCM1IALxxpUSqKJqRcz5zrymorX8sffqcP1dFY
+Gp5Qtx/1YRD0cQ4iAHMCz9pPxVkOM4pvz/7M3JjoU3loP8kVIKMD3E4xVgccBayP
+/9bTPaOM7sgtoPDzX/LsxICCBgxeW87wA7mwhQVgUu2BV0lVNKc5ZBXtoMBKHVEZ
+gU7bzkS10OiaB8dP1C54NpOquXDXJ1szS/qzry/dKS3OULsSw731cmAYF1KXLN01
+SNU7lyEKF7DglZ7e+v4q18c3QWttmkhJgNVku+scAf6Fg9qTB/Tp9znLSaC8JiEo
+az50nHustlmuPWriALbXeG493US/lYAIesFK9oZfFC3L/K9ni6LZPvGNQVymEAAD
+kOJf02iMdjt0UrCnKde4RZDPnifzBnMfEawwdHekT7T4UNWbzaaFgQ==
+-----END CERTIFICATE-----

data/lib/stonk/adapter/alpha_vantage_adapter.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module Stonk
+  module Adapter
+    class AlphaVantageAdapter
+      def initialize(api_key, retry_on_rate_limit: false, rate_limit_sleep_seconds: 3, rate_limit_retry_count: 10)
+        @api_key = api_key
+        @base_url = URI("https://alpha-vantage.p.rapidapi.com")
+        @retry_on_rate_limit = retry_on_rate_limit
+        @rate_limit_sleep_seconds = rate_limit_sleep_seconds
+        @rate_limit_retry_count = rate_limit_retry_count
+        @retry_attempts = 0
+
+        raise ConfigurationError, "API key is required" if @api_key.nil?
+        raise ConfigurationError, "Rate limit sleep seconds must be greater than 0" if @rate_limit_sleep_seconds < 0
+      end
+
+      def get_stock_price(stock_symbol)
+        make_stock_price_request(stock_symbol).dig("Global Quote", "05. price").then do |price|
+          raise Stonk::Adapter::StockNotFound, "Stock price not found for #{stock_symbol}" if price.nil?
+
+          reset_retry_attempts
+          Stonk::Money.new(price)
+        end
+      rescue Stonk::Adapter::RateLimitExceeded => e
+        raise e unless @retry_on_rate_limit
+
+        if @retry_attempts >= @rate_limit_retry_count
+          raise Stonk::Adapter::RateLimitRetryExceeded, "Rate limit retry count exceeded"
+        else
+          Stonk.logger.warn("[AlphaVantage] Too many requests for #{stock_symbol}, sleeping for #{@rate_limit_sleep_seconds} seconds")
+          sleep(@rate_limit_sleep_seconds) if @rate_limit_sleep_seconds > 0
+          register_retry_attempt
+          retry
+        end
+      rescue Net::HTTPError => e
+        raise Stonk::Adapter::ServerError, "Failed to fetch stock price for #{stock_symbol}: #{e.message}"
+      end
+
+      private
+
+      def make_stock_price_request(stock_symbol)
+        params = {
+          "function" => "GLOBAL_QUOTE",
+          "symbol" => stock_symbol,
+          "datatype" => "json",
+        }
+
+        make_request(params)
+      end
+
+      def make_request(params)
+        uri = @base_url.dup
+        uri.path = "/query"
+        uri.query = URI.encode_www_form(params)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        request = Net::HTTP::Get.new(uri)
+        request["x-rapidapi-key"] = @api_key
+        request["x-rapidapi-host"] = @base_url.host
+
+        Stonk.logger.debug("[AlphaVantage] Making request to #{uri}")
+
+        response = http.request(request)
+
+        Stonk.logger.debug("[AlphaVantage] #{response.code}, #{response.body.gsub("\n", " ")}, #{response.to_hash}")
+
+        if response.is_a?(Net::HTTPSuccess)
+          JSON.parse(response.body)
+        elsif response.is_a?(Net::HTTPTooManyRequests)
+          raise Stonk::Adapter::RateLimitExceeded, "Too many requests"
+        else
+          raise Stonk::Adapter::ServerError, "Failed to fetch stock price for #{params}: #{response.body}"
+        end
+      end
+
+      def register_retry_attempt
+        @retry_attempts += 1
+      end
+
+      def reset_retry_attempts
+        @retry_attempts = 0
+      end
+    end
+  end
+end

data/lib/stonk/adapter/file_cache_adapter.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "json"
+
+module Stonk
+  module Adapter
+    class FileCacheAdapter
+      def initialize(cache_file_path, default_ttl: 60 * 60)
+        @cache_file_path = cache_file_path
+        @default_ttl = default_ttl
+        @data = nil
+      end
+
+      def get_stock_price(stock_symbol)
+        load_data
+
+        raise Stonk::Adapter::StockNotFound, "Stock not found: #{stock_symbol}" unless @data.key?(stock_symbol)
+
+        entry = @data[stock_symbol]
+
+        if Time.now.to_i >= entry["expires_at"]
+          @data.delete(stock_symbol)
+          save_data
+          raise Stonk::Adapter::StockNotFound, "Stock not found: #{stock_symbol}"
+        end
+
+        entry["price"]
+      end
+
+      def set_stock_price(stock_symbol, price, ttl: nil)
+        return if price.nil?
+
+        load_data
+
+        ttl_seconds = ttl || @default_ttl
+        expires_at = Time.now.to_i + ttl_seconds
+
+        @data[stock_symbol] = {
+          "price" => price,
+          "expires_at" => expires_at,
+        }
+
+        save_data
+      end
+
+      def clear_cache
+        FileUtils.rm_f(cache_path)
+      end
+
+      def clear_expired_entries
+        load_data
+        original_size = @data.size
+
+        @data.delete_if do |_symbol, entry|
+          Time.now.to_i >= entry["expires_at"]
+        end
+
+        if @data.size < original_size
+          save_data
+          Stonk.logger.debug("[FileCacheAdapter] Cleared #{original_size - @data.size} expired entries")
+        end
+      end
+
+      private
+
+      def load_data
+        @data = JSON.parse(File.read(cache_path))
+      rescue JSON::ParserError
+        @data = {}
+      end
+
+      def save_data
+        Stonk.logger.debug("[FileCacheAdapter] Saving #{@data.to_json} to #{cache_path}")
+        File.write(cache_path, @data.to_json)
+      end
+
+      def cache_path
+        FileUtils.touch(@cache_file_path) unless File.exist?(@cache_file_path)
+
+        @cache_file_path
+      end
+    end
+  end
+end

data/lib/stonk/adapter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Stonk
+  module Adapter
+    class AdapterError < Error; end
+
+    class ConfigurationError < AdapterError; end
+    class StockNotFound < AdapterError; end
+    class RateLimitExceeded < AdapterError; end
+    class RateLimitRetryExceeded < AdapterError; end
+    class ServerError < AdapterError; end
+
+    autoload :AlphaVantageAdapter, "stonk/adapter/alpha_vantage_adapter"
+    autoload :FileCacheAdapter, "stonk/adapter/file_cache_adapter"
+    autoload :YahooFinanceAdapter, "stonk/adapter/yahoo_finance_adapter"
+  end
+end

data/lib/stonk/money.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bigdecimal"
+require "delegate"
+
+module Stonk
+  class Money < SimpleDelegator
+    def initialize(amount)
+      super(BigDecimal(amount))
+    end
+  end
+end

data/lib/stonk/service.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Stonk
+  class Service
+    def initialize(lookup_adapters: [], cache_adapter: nil)
+      @lookup_adapters = lookup_adapters
+      @cache_adapter = cache_adapter
+    end
+
+    def get_stock_price(stock_symbol)
+      get_stock_price_from_adapters(stock_symbol).tap do |price|
+        @cache_adapter.set_stock_price(stock_symbol, price) if has_cache_adapter?
+      end
+    end
+
+    private
+
+    def get_stock_price_from_adapters(stock_symbol)
+      @lookup_adapters.each do |adapter|
+        Stonk.logger.debug("Looking up #{stock_symbol} from #{adapter.class.name}")
+        return adapter.get_stock_price(stock_symbol)
+      rescue Stonk::Adapter::AdapterError => e
+        Stonk.logger.warn("Error looking up #{stock_symbol} from #{adapter.class.name}: #{e.message}")
+        next
+      end
+
+      nil
+    end
+
+    def has_cache_adapter?
+      !@cache_adapter.nil?
+    end
+  end
+end

data/lib/stonk/stock.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stonk
+  Stock = Data.define(:symbol, :price)
+end

data/lib/stonk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stonk
+  VERSION = "1.0.0"
+end

data/lib/stonk.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "stonk/version"
+require "logger"
+module Stonk
+  class Error < StandardError; end
+
+  autoload :Adapter, "stonk/adapter"
+  autoload :Service, "stonk/service"
+  autoload :Stock, "stonk/stock"
+  autoload :Money, "stonk/money"
+
+  class << self
+    def logger
+      @logger ||= Logger.new($stdout).tap do |logger|
+        logger.level = ENV["STONK_LOG_LEVEL"] || Logger::ERROR
+      end
+    end
+  end
+end

data/sig/stonk.rbs

@@ -0,0 +1,4 @@
+module Stonk
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: stonk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick Jones
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEdDCCAtygAwIBAgIBATANBgkqhkiG9w0BAQsFADBAMQ0wCwYDVQQDDARuaWNr
+  MRkwFwYKCZImiZPyLGQBGRYJbmlja2pvbmVzMRQwEgYKCZImiZPyLGQBGRYEdGVj
+  aDAeFw0yNTA3MDYxOTM3MzNaFw0yNjA3MDYxOTM3MzNaMEAxDTALBgNVBAMMBG5p
+  Y2sxGTAXBgoJkiaJk/IsZAEZFgluaWNram9uZXMxFDASBgoJkiaJk/IsZAEZFgR0
+  ZWNoMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAtVeWYtCOx6NWkD1H
+  M01ivSrilcoVoJ10AtlLgH23yN3pP4iMg+/c4ZfFqsrSDFbigbOmimQx74NlMdFG
+  dhhrAfPvoHmzUYvPWnCXkkqWRnXdK7+0m1tG4HxD1JJhgPtQKDSK9xx4seLZt01b
+  kL4ndBDXd7YXCzQhoozwXBVbVuip3bE2OYnUsEV7wXMZJYHK5Tj68QH5oppHTRV5
+  2Ws/W5CoHeZ7oExGYkYpF1U2/XG+722m6zHeUX9opLcXfvP+fpomDbFA7W1MFxTN
+  C+lxXhZYPt1+Pr9YeUnsc9uiX/NTgCvOCczR4eH5EeEchOZKFypiERajFXV9mDTG
+  f+fEBktE7zRdqTZD1KO/0peN8fvBlXWgA0fLD50UFfBR8s7pvYGzhs1uHiS8AFC/
+  BTWm7ttFetzKVZURP4ym3xxzpYuOTWDqkqvfd4ew6BDXBuZJsqXWE8X4qzDsNMCx
+  SGhyP3NbbRuY46T+T5K+k3zNtDRB7ZVjJFeum21mBkN6SVm7AgMBAAGjeTB3MAkG
+  A1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBTnEkevlJfGftCtQSV5MwW5
+  DDEKzDAeBgNVHREEFzAVgRNuaWNrQG5pY2tqb25lcy50ZWNoMB4GA1UdEgQXMBWB
+  E25pY2tAbmlja2pvbmVzLnRlY2gwDQYJKoZIhvcNAQELBQADggGBADCu8hK3XBEm
+  aVNShTjB1JR6Hy7+wCbUevLqRyTaf2aA2wpn7gJnlENMo4UKIXAzBSKMzTFTH2ZJ
+  1WKrO045godBAqF005q3WHDNpUTCM1IALxxpUSqKJqRcz5zrymorX8sffqcP1dFY
+  Gp5Qtx/1YRD0cQ4iAHMCz9pPxVkOM4pvz/7M3JjoU3loP8kVIKMD3E4xVgccBayP
+  /9bTPaOM7sgtoPDzX/LsxICCBgxeW87wA7mwhQVgUu2BV0lVNKc5ZBXtoMBKHVEZ
+  gU7bzkS10OiaB8dP1C54NpOquXDXJ1szS/qzry/dKS3OULsSw731cmAYF1KXLN01
+  SNU7lyEKF7DglZ7e+v4q18c3QWttmkhJgNVku+scAf6Fg9qTB/Tp9znLSaC8JiEo
+  az50nHustlmuPWriALbXeG493US/lYAIesFK9oZfFC3L/K9ni6LZPvGNQVymEAAD
+  kOJf02iMdjt0UrCnKde4RZDPnifzBnMfEawwdHekT7T4UNWbzaaFgQ==
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+email:
+- nick@nickjones.tech
+executables:
+- stonk
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/stonk
+- etc/punkstar.pem
+- lib/stonk.rb
+- lib/stonk/adapter.rb
+- lib/stonk/adapter/alpha_vantage_adapter.rb
+- lib/stonk/adapter/file_cache_adapter.rb
+- lib/stonk/money.rb
+- lib/stonk/service.rb
+- lib/stonk/stock.rb
+- lib/stonk/version.rb
+- sig/stonk.rbs
+homepage: https://github.com/punkstar/stonk.rb
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/punkstar/stonk.rb
+  changelog_uri: https://github.com/punkstar/stonk.rb/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A Ruby gem that fetches real-time stock prices from multiple sources.
+test_files: []