tsp_scraper 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec2e1a667752fcc2b962f2e8208bebd954fba08b
-  data.tar.gz: c7f68da49a768d65081c5c7b14ab450a807ca075
+  metadata.gz: b69375e7e65e0d12ba96ed093c71da4101e96a43
+  data.tar.gz: 7a119bc38c237fdfbb0f207025a4706cb1bc554b
 SHA512:
-  metadata.gz: fe7e09babf748c3f83e63aa565cbef6b997bc18b8377a4de9c06c44afe3ca662ff9577dbba42bab5457541bd99b4a23aa0cadda4350bd7a769ba4a24e084c93d
-  data.tar.gz: e915066e082c33b933406183e170d162ee2663c9656a523ee7df1221db404b7f7975e7b0222d559c5d7c93d0cfd56cf148ce20cc21e1a8ead1a7f4a94ff19ba0
+  metadata.gz: 91068db4e62f0a2329f8b7510adc59101b910b3ba8f588c958f49d2a3931bf7834de4fda2f14485402ce53d824fc9c121ce1a24dfd7915b05992a8078d9e08b6
+  data.tar.gz: 5e89d26bc0bbb0704f88fc6f95fdd0abfe168a96846efb371e39c515655878572e39824cdbcd11ef5f325a929e2273a2804810370e6beb14071b633df3085711

data/README.md

@@ -13,6 +13,10 @@ gem install tsp_scraper
 
 ## Usage
 
+The `tsp_scraper` gem includes both an API and a command-line interface (CLI).
+
+### API Usage
+
 The `scrape` method accepts `Date` objects as parameters and returns TSP price data as an array of hashes:
 
 ```ruby
@@ -54,10 +58,46 @@ The returned array of hashes has the format:
 
 You can get the raw CSV data as returned by the TSP website by using `TSPScraper::Client.scrape_raw()`, which accepts the same parameters as the `scrape` method.
 
-### HTTParty Options
+#### HTTParty Options
 
 The `scrape` and `scrape_raw` methods also accept an options hash for the HTTP request. The options hash should contain [HTTParty](https://github.com/jnunemaker/httparty) options.
 
 ```ruby
 TSPScraper::Client.scrape(start_date, end_date, verify: false) # Don't verify SSL certificate
 ```
+
+### CLI Usage
+
+Installing the gem makes the `tsp_scraper` command available to you.
+
+```
+tsp_scraper START_DATE END_DATE
+```
+
+START_DATE and END_DATE should be in the format YYYY-MM-DD.
+
+```
+$ tsp_scraper 2017-01-23 2017-01-24
+2017-01-24,L Income,18.5121
+2017-01-24,L 2010,0.0                      
+2017-01-24,L 2020,24.7183                                              
+2017-01-24,L 2030,27.2166             
+2017-01-24,L 2040,29.1416                                  
+2017-01-24,L 2050,16.6275                  
+2017-01-24,G Fund,15.2106
+2017-01-24,F Fund,17.4619
+2017-01-24,C Fund,31.4713
+2017-01-24,S Fund,42.0024
+2017-01-24,I Fund,25.2087
+2017-01-23,L Income,18.4934
+2017-01-23,L 2010,0.0
+2017-01-23,L 2020,24.6629
+2017-01-23,L 2030,27.12
+2017-01-23,L 2040,29.0183
+2017-01-23,L 2050,16.5456
+2017-01-23,G Fund,15.2096
+2017-01-23,F Fund,17.5237
+2017-01-23,C Fund,31.2661
+2017-01-23,S Fund,41.434
+2017-01-23,I Fund,25.1846
+```

data/bin/tsp_scraper

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'tsp_scraper'
-require 'date'
+require "tsp_scraper"
 
-start_date = Date.parse(ARGV[0])
-end_date = Date.parse(ARGV[1])
-
-csv = TSPScraper::Client.scrape(start_date, end_date)
-puts csv
+TSPScraper::CLI.start

data/lib/tsp_scraper.rb

@@ -1,3 +1,4 @@
 require 'tsp_scraper/version'
 require 'tsp_scraper/converter'
 require 'tsp_scraper/client'
+require 'tsp_scraper/cli'

data/lib/tsp_scraper/cli.rb

@@ -0,0 +1,30 @@
+module TSPScraper
+  class CLI
+    def self.start
+      begin
+        end_date_raw = ARGV.pop
+        start_date_raw = ARGV.pop
+        start_date = Date.parse(start_date_raw)
+        end_date = Date.parse(end_date_raw)
+      rescue
+        print_help
+        exit 1
+      end
+      quotes = TSPScraper::Client.scrape(start_date, end_date)
+      print_quotes quotes
+    end
+
+    def self.print_help
+      puts "Usage: tsp_scraper START_DATE END_DATE"
+      puts "START_DATE and END_DATE should be in the format YYYY-MM-DD."
+    end
+
+    def self.print_quotes(quotes)
+      quotes.each do |quote|
+        quote[:funds].each do |name, price|
+          puts "#{quote[:date]},#{name},#{price.to_s('F')}"
+        end
+      end
+    end
+  end
+end

data/lib/tsp_scraper/version.rb

@@ -1,3 +1,3 @@
 module TSPScraper
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsp_scraper
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jeff Fredrickson
@@ -98,6 +98,7 @@ files:
 - bin/setup
 - bin/tsp_scraper
 - lib/tsp_scraper.rb
+- lib/tsp_scraper/cli.rb
 - lib/tsp_scraper/client.rb
 - lib/tsp_scraper/converter.rb
 - lib/tsp_scraper/version.rb