yafa 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2faaa4583f9ed8fb64fab2398144100d48095b99
-  data.tar.gz: bd026569282943484bca5e4f11978d3ffd47de28
+  metadata.gz: 7ecc1c4be19bdfea084ad10a25841b2a9e63a4b1
+  data.tar.gz: b57af1fe5ef71e6464d505595a96a122a70a1c8b
 SHA512:
-  metadata.gz: c16dbb6c15af16d38f506f2244f7a922c7572568c70d251fd2c190b916f5a5fe8f603eb8e2a6968e3948467e0b085270ea7648f3e71909bd7196f72cafb9e298
-  data.tar.gz: e303aed5f6b3bfa30b93eb19d1219514182da62340047106264c21c4384ea118e17398e9ab637adbea4282547337b5b6638ac8f6af6e8bb0385d385313c3640b
+  metadata.gz: d2419a7e974d3bae2920c3cff3b4b867dac971ac08ec6f98d20d698a6aea0045a0fca42d6767cda0a3954bad39a8e70c0ef312f1d17c80155151f927173f8f54
+  data.tar.gz: af40620f83b3264368881200e65fada01a728365f6f658c6e3907a43ab0e497592f5bd4c614f0677ec33242f686593431bb1b9a33df3f8dd982e270a4c07d309

data/README.md

@@ -1,41 +1,49 @@
-# YFAPI
+# Yafa
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/YFAPI`. To experiment with that code, run `bin/console` for an interactive prompt.
+**Ya**hoo **F**inance **A**PI wrapper, fetch stock quotes and stock 
+chart data
 
-TODO: Delete this and the text above, and describe your gem
+### Setup
 
-## Installation
+Just install yafa or add it to your gemfile `gem 'yafa'`
 
-Add this line to your application's Gemfile:
+### Usage
+#### Quotes data
+
+Fetches the current/most recent stock quote:
 
 ```ruby
-gem 'YFAPI'
+tickers = ['GOOG']
+fetcher = StockQuotes.new(tickers)
+quotes  = fetcher.fetch
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install YFAPI
-
-## Usage
+Tickers array takes up to 400 tickers at once
 
-TODO: Write usage instructions here
+#### Chart data
 
-## Development
+Fetches per-minute quotes for the last day, good for making charts of
+recent stock prices
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
+```ruby
+ticker = 'GOOG'
+fetcher = StockChart.new(ticker)
+chart_data = fetcher.fetch
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/YFAPI. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Fetches for a single ticker per request
 
+#### Historical Data
 
-## License
+Coming soon...
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+### Worth knowing
+ * Yahoo Finance API sometimes goes down, so handle failed requests
+ * Stay under your Yahoo API request limit, something like 20k/day 
+ (based on IP address making the request)
 
+### Improvements
+ * Historical data api
+ * Config for fetcher (i.e. timeouts, query params)
+ * Option to replace Yahoo time and key formatting with a consistent 
+ format

data/lib/yafa/stock_chart.rb

@@ -8,17 +8,17 @@ module Yafa
     READ_TIMEOUT    = 5
     DATA_SOURCE     = 'yahoo_chart_api'.freeze
 
-    def call(ticker)
-      get_bars_data(ticker)
+    def initialize(ticker)
+      @ticker = ticker
     end
 
-    private
-
-    def get_bars_data(ticker)
-      quote_data = call_api ticker
+    def fetch
+      quote_data = call_api @ticker
       parse_quote quote_data
     end
 
+    private
+
     def call_api(ticker)
       url      = format_api_url ticker
       response = perform_api_request url

data/lib/yafa/stock_quotes.rb

@@ -13,19 +13,19 @@ module Yafa
     YAHOO_API_END   = '&format=json&diagnostics=true&env=store%3A%2F%2Fdatata'\
                         'bles.org%2Falltableswithkeys&callback='.freeze
 
-    def call(tickers)
-      fetch_quotes_from_api tickers
+    def initialize(tickers)
+      @tickers = tickers
     end
 
-    private
-
-    def fetch_quotes_from_api(tickers)
-      formatted_tickers = format_tickers tickers
+    def fetch
+      formatted_tickers = format_tickers @tickers
       quote_data        = call_api(formatted_tickers)
 
       format_quote_data(quote_data)
     end
 
+    private
+
     def call_api(yahoo_tickers)
       url      = format_api_url yahoo_tickers
       response = open(

data/lib/yafa/version.rb

@@ -1,3 +1,3 @@
 module Yafa
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/yafa.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary     = 'yahoo finance api'
   spec.description = 'wrapper for yahoo finance stock quotes and chart data'
-  spec.homepage    = ''
+  spec.homepage    = 'https://github.com/KlotzAndrew/yafa'
   spec.license     = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yafa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Klotz
@@ -90,7 +90,7 @@ files:
 - lib/yafa/stock_quotes.rb
 - lib/yafa/version.rb
 - yafa.gemspec
-homepage: ''
+homepage: https://github.com/KlotzAndrew/yafa
 licenses:
 - MIT
 metadata: {}