stocksy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0658fd1d695020d19b5c09160524f0d76678600d96723086abf4c574580af25
+  data.tar.gz: 45fc1f6edf80ce5e4671b0903c307cdd4fe912dbf3a1fd1516cef771a0315a0c
+SHA512:
+  metadata.gz: f3bf475c3567ec32cafb9cefcaba51739069705c0f2373cfa68a5415021737542c1c3c1547c003dc975e37f6d07a46edd210e7b99cb185a8cbe71c29cde11082
+  data.tar.gz: e72670c3dbe37c1171c03b26930b3a782036f6501bbfd063460de68a231ba5b57eb1634406d8d5d669460912f0260997a539f5afe12bb4c7947bb37070725d06

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Bruno Prieto
+
+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,33 @@
+# Stocksy
+
+Stocksy is a command line tool that displays stock market information obtained from the [Alpha Vantage API](https://www.alphavantage.co/).
+
+## Installation
+
+Install the gem by executing:
+
+    $ gem install stocksy
+
+## Usage
+
+Get a free API key from [Alpha Vantage](https://www.alphavantage.co/) and set it up with `stocksy login [API key]` or with the "ALPHA_VANTAGE_API_KEY" environment variable so Stocksy can get data.
+
+You can review the full list of commands by running `stocksy help`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/brunoprietog/stocksy. 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/brunoprietog/stocksy/blob/master/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 Stocksy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/brunoprietog/stocksy/blob/master/CODE_OF_CONDUCT.md).

data/bin/stocksy

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "stocksy"
+
+begin
+  Stocksy::Cli.start(ARGV)
+rescue StandardError => e
+  puts "  \e[31mERROR (#{e.class}): #{e.message}\e[0m"
+  puts e.backtrace if ENV["VERBOSE"]
+  exit 1
+end

data/lib/stocksy/alpha_vantage/api_key.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Stocksy::AlphaVantage::ApiKey
+  extend self
+  FILE_PATH = File.join(Dir.home, ".stocksy")
+
+  def fetch
+    api_key = ENV.fetch("ALPHA_VANTAGE_API_KEY") do
+      ENV["ALPHA_VANTAGE_API_KEY"] = retrieve_api_key_from_file
+    end
+    api_key || raise(Stocksy::Error, "No API key found")
+  end
+
+  def save(api_key)
+    File.write(FILE_PATH, api_key)
+  end
+
+  def delete
+    return unless File.exist?(FILE_PATH)
+
+    File.delete(FILE_PATH)
+  end
+
+  private
+
+  def retrieve_api_key_from_file
+    return unless File.exist? FILE_PATH
+
+    api_key = File.read(FILE_PATH).strip
+    return api_key unless api_key.empty?
+  end
+end

data/lib/stocksy/alpha_vantage.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "active_support/inflector"
+require "active_support/ordered_options"
+
+module Stocksy::AlphaVantage
+  extend self
+  URL = "https://www.alphavantage.co/query"
+
+  def overview(symbol)
+    response = get(function: "OVERVIEW", symbol:)
+    optionize(response)
+  end
+
+  def get_time_series_dayly(symbol)
+    response = get(function: "TIME_SERIES_DAILY", symbol:, outputsize: "full")
+    normalize_response(response["Time Series (Daily)"])
+  end
+
+  def search(keywords)
+    response = get(function: "SYMBOL_SEARCH", keywords:)
+    normalize_response(response["bestMatches"])
+  end
+
+  private
+
+  def get(params)
+    uri = URI.parse(URL)
+    uri.query = URI.encode_www_form(params.merge(apikey: api_key))
+    response = Net::HTTP.get(uri)
+    JSON.parse(response)
+  end
+
+  def api_key
+    ApiKey.fetch
+  end
+
+  def normalize_response(response)
+    if response.is_a?(Array)
+      response.map! { |hash| optionize(hash) }
+    elsif response.is_a?(Hash)
+      response.transform_values! { |hash| optionize(hash) }
+    end
+  end
+
+  def optionize(hash)
+    hash.transform_keys! { |key| key.split.last.underscore.to_sym }
+    ActiveSupport::InheritableOptions.new(hash)
+  end
+end

data/lib/stocksy/asset/overview.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Stocksy::Asset::Overview
+  extend ActiveSupport::Concern
+
+  included do
+    delegate :name, :asset_type, :description, :exchange, :currency, :country, :sector, :industry,
+             :dividend_per_share, :dividend_yield, :dividend_date, :ex_dividend_date, to: :overview
+  end
+
+  def overview
+    @overview ||= Stocksy::AlphaVantage.overview(symbol)
+  end
+end

data/lib/stocksy/asset/profitability.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Stocksy::Asset::Profitability
+  def profitability_summary
+    {
+      "1D" => profitability_ago(1.day),
+      "5D" => profitability_ago(5.days),
+      "1M" => profitability_ago(1.month),
+      "6M" => profitability_ago(6.months),
+      "YTD" => profitability_from(Date.today.beginning_of_year),
+      "1Y" => profitability_ago(1.year),
+      "5Y" => profitability_ago(5.years)
+    }
+  end
+
+  private
+
+  def profitability_ago(time_ago)
+    initial_date = time_ago == 1.day ? last_traded_date - 1.day : Date.today - time_ago
+    profitability_from(initial_date)
+  end
+
+  def profitability_from(date)
+    profitability_between(date, last_traded_date)
+  end
+
+  def profitability_between(initial_date, final_date)
+    initial_date = closest_traded_date_from(initial_date)
+    final_date = closest_traded_date_from(final_date)
+    initial_price = time_series_dayly[initial_date.to_s].close.to_f
+    final_price = time_series_dayly[final_date.to_s].close.to_f
+    profitability = ((final_price - initial_price) / initial_price) * 100
+    profitability.round(2)
+  end
+end

data/lib/stocksy/asset.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/numeric/time"
+require "active_support/core_ext/integer/time"
+
+class Stocksy::Asset
+  include Overview
+  include Profitability
+
+  attr_reader :symbol
+
+  def initialize(symbol)
+    @symbol = symbol
+  end
+
+  def last_traded_date
+    @last_traded_date ||= closest_traded_date_from(Date.today)
+  end
+
+  private
+
+  def closest_traded_date_from(date)
+    10.times do |days|
+      next_date = date - days.days
+      return next_date if time_series_dayly[next_date.to_s]
+    end
+    raise Stocksy::Error, "No trading date found in the last 10 days from #{date}"
+  end
+
+  def time_series_dayly
+    @time_series_dayly ||= Stocksy::AlphaVantage.get_time_series_dayly(symbol)
+  end
+end

data/lib/stocksy/cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "thor"
+
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/MethodLength
+class Stocksy::Cli < Thor
+  package_name "Stocksy"
+
+  desc "show [SYMBOL]", "Overview of an asset by symbol"
+  def show(symbol)
+    asset = Stocksy::Asset.new(symbol)
+
+    if asset.name
+      say "#{asset.name} (#{asset.symbol})"
+      say "#{asset.asset_type} - #{asset.exchange} - #{asset.currency} - #{asset.country}"
+      say "#{asset.sector}, #{asset.industry}"
+      blank_line
+      print_wrapped asset.description
+      blank_line
+      say "Dividend per share: #{asset.dividend_per_share} #{asset.currency}"
+      say "Dividend yield: #{asset.dividend_yield.to_f * 100}%"
+      say "Next dividend date: #{asset.dividend_date}"
+      say "Previous dividend date: #{asset.ex_dividend_date}"
+    else
+      say asset.symbol
+    end
+    blank_line
+    say "Profitabilities until #{asset.last_traded_date}:"
+    asset.profitability_summary.each do |interval, profitability|
+      say "#{interval}: #{profitability}%"
+    end
+  end
+
+  desc "search [KEYWORDS]", "Search for assets by keywords"
+  def search(keywords)
+    search = Stocksy::Search.new(keywords)
+    print_ordered_options_as_table(search.results, %i[name symbol type region currency])
+  end
+
+  desc "login [API KEY]", "Set AlphaVantage API key"
+  def login(api_key)
+    Stocksy::AlphaVantage::ApiKey.save(api_key)
+    say "API key saved into #{Stocksy::AlphaVantage::ApiKey::FILE_PATH}"
+  end
+
+  desc "logout", "Delete AlphaVantage API key"
+  def logout
+    Stocksy::AlphaVantage::ApiKey.delete
+    say "API key deleted from #{Stocksy::AlphaVantage::ApiKey::FILE_PATH}"
+  end
+
+  desc "version", "Show Stocksy version"
+  def version
+    say Stocksy::VERSION
+  end
+
+  private
+
+  def blank_line
+    say "\n"
+  end
+
+  def print_ordered_options_as_table(ordered_options, columns)
+    table_data = [columns.map { |column| column.to_s.gsub("_", " ").capitalize }]
+    ordered_options.each do |option|
+      row = columns.map { |column| option[column] }
+      table_data << row
+    end
+    print_table(table_data)
+  end
+end
+# rubocop:enable Metrics/AbcSize
+# rubocop:enable Metrics/MethodLength

data/lib/stocksy/search.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Stocksy::Search
+  attr_reader :results
+
+  def initialize(keywords)
+    @results = Stocksy::AlphaVantage.search(keywords)
+  end
+end

data/lib/stocksy/version.rb

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

data/lib/stocksy.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Stocksy
+  class Error < StandardError; end
+end
+
+require "active_support"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+loader.eager_load

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: stocksy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Prieto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brunoprietog@hey.com
+executables:
+- stocksy
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/stocksy
+- lib/stocksy.rb
+- lib/stocksy/alpha_vantage.rb
+- lib/stocksy/alpha_vantage/api_key.rb
+- lib/stocksy/asset.rb
+- lib/stocksy/asset/overview.rb
+- lib/stocksy/asset/profitability.rb
+- lib/stocksy/cli.rb
+- lib/stocksy/search.rb
+- lib/stocksy/version.rb
+homepage: https://github.com/brunoprietog/stocksy
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+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.4.15
+signing_key: 
+specification_version: 4
+summary: Command line tool to get stock market data
+test_files: []