stockticker_cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd8cd084b418a98723b9de29f8a0dfa10d708dc8402753e7d2c55e6bf8a99a36
+  data.tar.gz: 0f7a88f0c654dfafb452c17780dbc16bdc372429a5550875dda63fcebdec89cb
+SHA512:
+  metadata.gz: 98741371019935c5b46421c2ea82415d149adaf696a47df46c69ecbbba3cfda4230e96904a8d0ee58329b1662c81597ea5a42543a13de0e58c35f88601e8ad9d
+  data.tar.gz: 1b48c32b4f6cd9f7216cc1c841adf3b752f0e83f7e9e9b649b1651338ccde18a915e726a7baedccbeaa118c9024d8ce9a3cf554efcf088e941630d890152a2fb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.env/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stockticker_cli.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    stockticker_cli (0.1.0)
+      dotenv
+      json
+      pry
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.5)
+    gem-release (2.1.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.3.0)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    netrc (0.11.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gem-release
+  rake (~> 12.0)
+  stockticker_cli!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TerryThreatt
+
+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,39 @@
+# StocktickerCli
+
+Welcome to the Stock Ticker CLI app! This gem will allow you to find real-time stock quotes and gain additional company information for each stock. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stockticker_cli'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install stockticker_cli
+
+## Usage
+
+1. Choose to receive the top gainers in the stock market today. 
+2. You will have a option to receive additional information about company. 
+
+## 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 tags, 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/<github username>/stockticker_cli.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stockticker_cli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/stockticker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stockticker_cli"
+
+StocktickerCli::CLI.new.call 

data/lib/stockticker_cli/api.rb

@@ -0,0 +1,25 @@
+class StocktickerCli::API
+    BASE_URL = 'https://fmpcloud.io/api/v3/'
+    KEY = ENV["API_KEY"]
+
+
+    
+    # Api call 
+    def self.query
+        # https://fmpcloud.io/api/v3/actives?apikey=4b31fc84cd3248a0f61868b96f531bde
+        results = RestClient.get("#{BASE_URL}actives?apikey=#{KEY}") 
+        json = JSON.parse(results) 
+
+
+        # iterating through results and creating stock instances
+        json.each do |stock_hash|
+           StocktickerCli::STOCK.new(stock_hash) 
+        end  
+    end 
+
+    def self.info_query(stock_obj)
+        results = RestClient.get("#{BASE_URL}profile/#{stock_obj.ticker}?apikey=#{KEY}")
+        json = JSON.parse(results)
+        stock_obj.set_attributes(json[0])
+    end 
+end 

data/lib/stockticker_cli/cli.rb

@@ -0,0 +1,81 @@
+
+class StocktickerCli::CLI  
+    
+    def call
+        welcome 
+    end
+
+    def welcome 
+        puts "Welcome to the stock ticker cli app!"
+        puts ""
+        sleep(1)
+        menu 
+    end 
+    
+    def menu
+        puts "Would you like to view the top gainers in the stock market today?"
+        sleep(1)
+        puts ""
+        puts "Type 'yes' to view gainers or type 'exit' to quit the cli app"
+        puts ""
+
+        input = gets.strip.downcase
+
+        if input == 'exit'
+            goodbye
+        elsif input == 'yes' 
+            # API call 
+            puts ""
+            stock_query = StocktickerCli::API.query
+
+            # Return 
+            puts "Pick a stock from the list"
+            puts ""
+            puts "Gainers List:"
+            StocktickerCli::STOCK.all.each.with_index(1) do |s, i|
+                puts "#{i}. #{s.ticker} - #{s.companyName} - $#{s.price} - #{s.changesPercentage}" 
+            end 
+
+            puts ""
+            submenu
+        else 
+            puts "Try again"
+            puts ""
+            menu
+        end 
+    end 
+
+    def submenu 
+        puts "Type a number between '1 - 10' on gainers list for more information on the stock."
+        sleep(1)
+        
+        input = gets.strip.to_i
+     
+        if (input.between?(0, 10))
+            s = StocktickerCli::STOCK.all[input - 1]
+            StocktickerCli::API.info_query(s) 
+            puts ""       
+            puts "#{s.symbol} - #{s.companyName} - $#{s.price}"
+            puts ""
+            puts "Change: $ #{s.changes}"
+            puts "Sector: #{s.sector}"
+            puts "Industry: #{s.industry}"
+            puts "Website: #{s.website}"
+            puts ""
+            puts "Description: #{s.description}"
+            puts ""
+            sleep(1.5)
+            StocktickerCli::STOCK.reset 
+            menu
+        else
+          puts "Please try again"
+          submenu
+        end
+end  
+
+    def goodbye
+        puts "Happy Trading"
+        sleep(1)
+        puts "Goodbye!"
+    end 
+end 

data/lib/stockticker_cli/stock.rb

@@ -0,0 +1,28 @@
+
+# "symbol"=>"PAYX", "name"=>"Paychex, Inc.", "price"=>60.17
+
+class StocktickerCli::STOCK 
+    attr_accessor :ticker, :symbol, :changesPercentage, :name, :price, :changes, :companyName, :industry, :website, :description, :sector  
+
+    @@all = []
+    def initialize(args) 
+        set_attributes(args)
+        @@all << self
+    end 
+
+    def set_attributes(hash) 
+        hash.each do |k, v|
+            # checks if method exists for instance of stock
+            self.send("#{k}=", v) if self.respond_to?(k)
+        end 
+    end 
+
+    def self.all 
+        @@all 
+    end
+
+    def self.reset 
+        @@all.clear  
+    end
+
+end 

data/lib/stockticker_cli/version.rb

@@ -0,0 +1,3 @@
+module StocktickerCli
+  VERSION = "0.1.0"
+end

data/lib/stockticker_cli.rb

@@ -0,0 +1,19 @@
+require 'pry'
+require 'json'
+require 'rest-client'
+require 'dotenv'
+Dotenv.load
+
+
+
+require_relative "./stockticker_cli/version"
+require_relative "./stockticker_cli/cli"
+require_relative "./stockticker_cli/stock"
+require_relative "./stockticker_cli/api"
+
+
+
+
+
+
+

data/notes.md

@@ -0,0 +1,7 @@
+- A command line interface for getting daily stock quotes
+- welcome user
+- show menu 
+- Users type name/ticker symbol
+- Show company names 
+- List selected company stock prices
+- Give option to receive more info   

data/stockticker_cli.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/stockticker_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stockticker_cli"
+  spec.version       = StocktickerCli::VERSION
+  spec.authors       = ["TerryThreatt"]
+  spec.email         = ["terry.threatt@gmail.com"]
+
+  spec.summary       = %q{This application will use the command-line to query any stock ticker symbol and return the current price.}
+  spec.description   = %q{Real-time stock quote app.}
+  spec.homepage      = "https://github.com/TerryThreatt/stockticker_cli/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/TerryThreatt/stockticker_cli/"
+  spec.metadata["changelog_uri"] = "https://github.com/TerryThreatt/stockticker_cli/"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["stockticker"] 
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency('gem-release')
+  spec.add_dependency('pry')
+  spec.add_dependency('json')
+  spec.add_dependency('rest-client')
+  spec.add_dependency('dotenv')
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: stockticker_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TerryThreatt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: json
+  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: rest-client
+  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: dotenv
+  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: Real-time stock quote app.
+email:
+- terry.threatt@gmail.com
+executables:
+- stockticker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/stockticker
+- lib/stockticker_cli.rb
+- lib/stockticker_cli/api.rb
+- lib/stockticker_cli/cli.rb
+- lib/stockticker_cli/stock.rb
+- lib/stockticker_cli/version.rb
+- notes.md
+- stockticker_cli.gemspec
+homepage: https://github.com/TerryThreatt/stockticker_cli/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/TerryThreatt/stockticker_cli/
+  source_code_uri: https://github.com/TerryThreatt/stockticker_cli/
+  changelog_uri: https://github.com/TerryThreatt/stockticker_cli/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: This application will use the command-line to query any stock ticker symbol
+  and return the current price.
+test_files: []