tsp_scraper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dcb08a62c8c7ec079c79b626f3dd3c5abeb08d3
-  data.tar.gz: 769dfb4c2b13fbe082270131f7e66b09a2b33300
+  metadata.gz: 75f11917c9778038cc5e3006a0e211bdf1277544
+  data.tar.gz: fe3d69b27f7b84296855e55b209e62dd16ccd86d
 SHA512:
-  metadata.gz: 8582400a77033d9498d900a0cb42f2c95556a82f7a8c40e36546aaaee0caf35a217f5bde20102e504ac77e8b743f837425dd3f596f9aba720036b65ed2c7f453
-  data.tar.gz: 12fd735a93202d3292a2a036d06f29c8e37872ee218dca26d423927029d98397c948fa7ff622ce36c9c86c7789a0fa3e3330adbcd24081990fd8bfe53c6695c5
+  metadata.gz: 312dff98fa87d7ddb55a3f7f8712649325b600a506f74cf6b16a25b9449541de5854cf7e5509def054b8320a82961929a735a66a889fcfd7cd3f7ba062444dd6
+  data.tar.gz: f5a39e561daa2bf857f9a400ffaa82d2a4509b2570beb95efd64f7a92b301d22b6cfa7743ba806a57d6671c2b0a0e1506dd17aca1ee5ec0cc144a1401ee5cc74

data/.gitignore

@@ -1,4 +1,4 @@
-*.gem
-.env
-.DS_Store
-Gemfile.lock
+*.gem
+.env
+.DS_Store
+Gemfile.lock

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
-
-gemspec
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Jeff Fredrickson
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2015 Jeff Fredrickson
+
+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

@@ -1,3 +1,25 @@
-# tsp_scraper
-
-Scrapes fund price history from the TSP.gov website.
+# tsp_scraper
+
+Scrapes fund price history from the TSP.gov website.
+
+## Installation
+
+```sh
+gem install tsp_scraper
+```
+
+## Usage
+
+The `scrape` method returns CSV data:
+
+```ruby
+require 'tsp_scraper'
+TSPScraper::Client.scrape() # Get trailing one month's prices
+TSPScraper::Client.scrape("2016-01-01", "2016-01-31") # Get January prices
+```
+
+The `scrape` method also accepts an options hash for the HTTP request. The options hash should contain [HTTParty](https://github.com/jnunemaker/httparty) options.
+
+```ruby
+TSPScraper::Client.scrape("2016-01-01", "2016-01-31", verify: false) # Don't verify SSL certificate
+```

data/bin/console

@@ -1,3 +1,3 @@
-#!/usr/bin/env sh
-
-irb -Ilib -rtsp_scraper
+#!/usr/bin/env sh
+
+irb -Ilib -rtsp_scraper

data/bin/tsp_scraper

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

data/lib/tsp_scraper/client.rb

@@ -1,24 +1,26 @@
-require 'httparty'
-
-module TSPScraper
-  class Client
-    include HTTParty
-    disable_rails_query_string_format
-    base_uri "https://www.tsp.gov/InvestmentFunds/FundPerformance"
-
-    def self.scrape(start_date = Date.today.prev_month, end_date = Date.today)
-      funds = ["Linc", "L2010", "L2020", "L2030", "L2040", "L2050", "G", "F", "C", "S", "I"]
-      options = {
-        query: {
-          reloaded: 1,
-          startdate: start_date.strftime("%m/%d/%Y"),
-          enddate: end_date.strftime("%m/%d/%Y"),
-          whichButton: "CSV",
-          fundgroup: funds
-        }
-      }
-      response = self.get("/index.html", options)
-      csv = response.body.strip
-    end
-  end
-end
+require 'httparty'
+
+module TSPScraper
+  class Client
+    include HTTParty
+    disable_rails_query_string_format
+    base_uri "https://www.tsp.gov/InvestmentFunds/FundPerformance"
+
+    def self.scrape(start_date = Date.today.prev_month, end_date = Date.today, options = {})
+      funds = ["Linc", "L2010", "L2020", "L2030", "L2040", "L2050", "G", "F", "C", "S", "I"]
+      default_options = {
+        query: {
+          reloaded: 1,
+          startdate: start_date.strftime("%m/%d/%Y"),
+          enddate: end_date.strftime("%m/%d/%Y"),
+          whichButton: "CSV",
+          fundgroup: funds
+        }
+      }
+      options = default_options.merge(options)
+
+      response = self.get("/index.html", options)
+      csv = response.body.strip
+    end
+  end
+end

data/lib/tsp_scraper/version.rb

@@ -1,3 +1,3 @@
-module TSPScraper
-  VERSION = "0.1.0"
-end
+module TSPScraper
+  VERSION = "0.2.0"
+end

data/lib/tsp_scraper.rb

@@ -1,2 +1,2 @@
-require 'tsp_scraper/version'
-require 'tsp_scraper/client'
+require 'tsp_scraper/version'
+require 'tsp_scraper/client'

data/tsp_scraper.gemspec

@@ -1,20 +1,20 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tsp_scraper/version'
-
-Gem::Specification.new do |s|
-  s.name = 'tsp_scraper'
-  s.summary = 'Scrapes fund price history from the TSP.gov website'
-  s.description = 'Scrapes fund price history from the TSP.gov website.'
-  s.homepage = 'https://github.com/jfredrickson/tsp_scraper'
-  s.version = TSPScraper::VERSION
-  s.authors = ['Jeff Fredrickson']
-  s.email = %w(jeff.fredrickson@gmail.com)
-  s.files = `git ls-files -z`.split("\x0")
-  s.require_paths = ['lib']
-  s.license = 'MIT'
-  s.required_ruby_version = '>= 1.9.3'
-  s.executables = ['tsp_scraper']
-
-  s.add_runtime_dependency 'httparty', '~> 0.13'
-end
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tsp_scraper/version'
+
+Gem::Specification.new do |s|
+  s.name = 'tsp_scraper'
+  s.summary = 'Scrapes fund price history from the TSP.gov website'
+  s.description = 'Scrapes fund price history from the TSP.gov website.'
+  s.homepage = 'https://github.com/jfredrickson/tsp_scraper'
+  s.version = TSPScraper::VERSION
+  s.authors = ['Jeff Fredrickson']
+  s.email = %w(jeff.fredrickson@gmail.com)
+  s.files = `git ls-files -z`.split("\x0")
+  s.require_paths = ['lib']
+  s.license = 'MIT'
+  s.required_ruby_version = '>= 1.9.3'
+  s.executables = ['tsp_scraper']
+
+  s.add_runtime_dependency 'httparty', '~> 0.13'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tsp_scraper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Fredrickson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -62,9 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Scrapes fund price history from the TSP.gov website
 test_files: []
-has_rdoc: