cpiu 0.1.0

data/README.md

@@ -0,0 +1,113 @@
+# CPIU
+
+[![Build Status](https://travis-ci.org/clpo13/cpiu-ruby.svg?branch=master)](https://travis-ci.org/clpo13/cpiu-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/clpo13/cpiu-ruby/badge.svg?branch=master)](https://coveralls.io/github/clpo13/cpiu-ruby?branch=master)
+
+CPIU is a Ruby interface for [CPI-U](https://www.bls.gov/cpi/) data provided by the U.S. Bureau of Labor Statistics. CPI-U data are commonly used for calculating inflation. More info on the BLS Public Data API is available [here](https://www.bls.gov/developers/home.htm).
+
+Neither I nor BLS.gov can vouch for the data or analyses derived from these data after the data have been retrieved from BLS.gov.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cpiu', '~> 0.1'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install cpiu
+```
+
+## Usage
+
+Add the following to your program:
+
+```ruby
+require 'cpiu'
+```
+
+The following methods will retrieve JSON objects containing CPI-U data:
+
+* `CPIU::Data.single_year(year)` - data for a single year
+* `CPIU::Data.year_range(startyear, endyear)` - data for a year range no greater than 20 years
+
+The data is returned in an array of hashes:
+
+```ruby
+[
+  {
+    "year" => "1913",
+    "period" => "M12",
+    "periodName" => "December",
+    "value" => "10.0",
+    "footnotes" => [{}]
+  },
+  ...
+]
+```
+
+A raw API call method is available too:
+
+* `CPIU::API.request_data(startyear, endyear, ann_avg, calcs)`
+
+If set to `true`, `ann_avg` will return the average CPI value for each year, and `calcs` will return net and percent changes in CPI. This method returns all response data in the form of a hash:
+
+```ruby
+{
+  "status" => "REQUEST_SUCCEEDED",
+  "responseTime" => 34,
+  "message" => [],
+  "Results" => {
+    "series" => [
+      {
+        "seriesID" => "CUUR0000SA0",
+        "data" => [
+          {
+            "year" => "1913",
+            "period" => "M13",
+            "periodName" => "Annual",
+            "value" => "9.9",
+            "footnotes" => [{}],
+            "calculations" => {
+              "net_changes" => {},
+              "pct_changes" => {
+                "1" => "-1.0",
+                "3" => "-1.0",
+                "6" => "0.0"
+              }
+            }
+          },
+          ...
+        ]
+      }
+    ]
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+### TODO
+
+* [ ] Handle API errors
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/clpo13/ruby_cpiu>.
+
+## License
+
+This code is licensed under [GPLv3](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cpiu'
+
+# 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/fixtures/vcr_cassettes/single_year.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.bls.gov/publicAPI/v2/timeseries/data/
+    body:
+      encoding: UTF-8
+      string: '{"seriesid":["CUUR0000SA0"],"startyear":1913,"endyear":1913,"annualaverage":false,"calculations":false,"registrationkey":"<SECURE>"}'
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (mingw32 x86_64) ruby/2.4.1p111
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '156'
+      Host:
+      - api.bls.gov
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 01 Aug 2017 23:28:15 GMT
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains;
+      Set-Cookie:
+      - JSESSIONID=09DB0ABAB033B05BC1CECBB682675792; Version=1; Path="/publicAPI/";
+        Secure; HttpOnly
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1137'
+    body:
+      encoding: UTF-8
+      string: |-
+        {"status":"REQUEST_SUCCEEDED","responseTime":38,"message":[],"Results":{
+        "series":
+        [{"seriesID":"CUUR0000SA0","data":[{"year":"1913","period":"M12","periodName":"December","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M11","periodName":"November","value":"10.1","footnotes":[{}]},{"year":"1913","period":"M10","periodName":"October","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M09","periodName":"September","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M08","periodName":"August","value":"9.9","footnotes":[{}]},{"year":"1913","period":"M07","periodName":"July","value":"9.9","footnotes":[{}]},{"year":"1913","period":"M06","periodName":"June","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M05","periodName":"May","value":"9.7","footnotes":[{}]},{"year":"1913","period":"M04","periodName":"April","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M03","periodName":"March","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M02","periodName":"February","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M01","periodName":"January","value":"9.8","footnotes":[{}]}]}]
+        }}
+    http_version: 
+  recorded_at: Tue, 01 Aug 2017 23:28:14 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/year_range.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.bls.gov/publicAPI/v2/timeseries/data/
+    body:
+      encoding: UTF-8
+      string: '{"seriesid":["CUUR0000SA0"],"startyear":1913,"endyear":1914,"annualaverage":false,"calculations":false,"registrationkey":"<SECURE>"}'
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (mingw32 x86_64) ruby/2.4.1p111
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '156'
+      Host:
+      - api.bls.gov
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 01 Aug 2017 23:28:36 GMT
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains;
+      Set-Cookie:
+      - JSESSIONID=F7FDB348E776CCB74BBDC3102716FACA; Version=1; Path="/publicAPI/";
+        Secure; HttpOnly
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '2154'
+    body:
+      encoding: UTF-8
+      string: |-
+        {"status":"REQUEST_SUCCEEDED","responseTime":45,"message":[],"Results":{
+        "series":
+        [{"seriesID":"CUUR0000SA0","data":[{"year":"1914","period":"M12","periodName":"December","value":"10.1","footnotes":[{}]},{"year":"1914","period":"M11","periodName":"November","value":"10.2","footnotes":[{}]},{"year":"1914","period":"M10","periodName":"October","value":"10.1","footnotes":[{}]},{"year":"1914","period":"M09","periodName":"September","value":"10.2","footnotes":[{}]},{"year":"1914","period":"M08","periodName":"August","value":"10.2","footnotes":[{}]},{"year":"1914","period":"M07","periodName":"July","value":"10.0","footnotes":[{}]},{"year":"1914","period":"M06","periodName":"June","value":"9.9","footnotes":[{}]},{"year":"1914","period":"M05","periodName":"May","value":"9.9","footnotes":[{}]},{"year":"1914","period":"M04","periodName":"April","value":"9.8","footnotes":[{}]},{"year":"1914","period":"M03","periodName":"March","value":"9.9","footnotes":[{}]},{"year":"1914","period":"M02","periodName":"February","value":"9.9","footnotes":[{}]},{"year":"1914","period":"M01","periodName":"January","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M12","periodName":"December","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M11","periodName":"November","value":"10.1","footnotes":[{}]},{"year":"1913","period":"M10","periodName":"October","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M09","periodName":"September","value":"10.0","footnotes":[{}]},{"year":"1913","period":"M08","periodName":"August","value":"9.9","footnotes":[{}]},{"year":"1913","period":"M07","periodName":"July","value":"9.9","footnotes":[{}]},{"year":"1913","period":"M06","periodName":"June","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M05","periodName":"May","value":"9.7","footnotes":[{}]},{"year":"1913","period":"M04","periodName":"April","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M03","periodName":"March","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M02","periodName":"February","value":"9.8","footnotes":[{}]},{"year":"1913","period":"M01","periodName":"January","value":"9.8","footnotes":[{}]}]}]
+        }}
+    http_version: 
+  recorded_at: Tue, 01 Aug 2017 23:28:36 GMT
+recorded_with: VCR 3.0.3

data/lib/cpiu.rb

@@ -0,0 +1,24 @@
+# CPIU - a Ruby interface for fetching CPI-U data from BLS.gov
+# Copyright (C) 2017 Cody Logan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'cpiu/api'
+require 'cpiu/data'
+require 'cpiu/version'
+
+# main cpiu module
+module CPIU
+  # Your code goes here...
+end

data/lib/cpiu/api.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# CPIU - a Ruby interface for fetching CPI-U data from BLS.gov
+# Copyright (C) 2017 Cody Logan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rest-client'
+require 'json'
+require 'dotenv/load'
+
+module CPIU
+  # Interacts with the BLS.gov public API
+  class API
+    # URL to send POST requests to
+    URL = 'https://api.bls.gov/publicAPI/v2/timeseries/data/'.freeze
+    # The time series to query
+    SERIESID = 'CUUR0000SA0'.freeze
+
+    # Requests CPI-U data from the BLS server given two years between 1913 and
+    # the present. The API will only return a maximum range of 20 years from
+    # the start year.
+    #
+    # @param startyear [Integer] the first year to get data for
+    # @param endyear [Integer] the last year to get data for
+    # @param ann_avg [Boolean] set to true to include the average of monthly CPI
+    #   values for a year
+    # @param calcs [Boolean] set to true to include net and percent CPI change
+    #   calculations
+    # @return [Hash{String => String, Integer, Array}] the response data
+    #   retrieved from the server
+    def self.request_data(startyear, endyear, ann_avg = false, calcs = false)
+      response = RestClient.post(URL,
+                                 {
+                                   'seriesid'        => [SERIESID],
+                                   'startyear'       => startyear,
+                                   'endyear'         => endyear,
+                                   'annualaverage'   => ann_avg,
+                                   'calculations'    => calcs,
+                                   'registrationkey' => ENV['BLS_API_KEY']
+                                 }.to_json,
+                                 content_type: 'application/json')
+      JSON(response)
+    end
+  end
+end

data/lib/cpiu/data.rb

@@ -0,0 +1,40 @@
+# CPIU - a Ruby interface for fetching CPI-U data from BLS.gov
+# Copyright (C) 2017 Cody Logan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'cpiu/api'
+
+module CPIU
+  # Return CPI data to the user while stripping the rest
+  # of the response data returned by the server
+  class Data
+    # Get CPI data for a single year
+    # @param year [Integer]
+    # @return [Array<Hash>] an array of hashes containing monthly CPI values
+    def self.single_year(year)
+      response = CPIU::API.request_data(year, year)
+      response['Results']['series'][0]['data']
+    end
+
+    # Get CPI data for a year range (up to 20 years)
+    # @param startyear [Integer] the first year to get data for
+    # @param endyear [Integer] the last year to get data for
+    # @return [Array<Hash>] an array of hashes containing monthly CPI values
+    def self.year_range(startyear, endyear)
+      response = CPIU::API.request_data(startyear, endyear)
+      response['Results']['series'][0]['data']
+    end
+  end
+end

data/lib/cpiu/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# CPIU - a Ruby interface for fetching CPI-U data from BLS.gov
+# Copyright (C) 2017 Cody Logan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module CPIU
+  # Current CPIU gem version
+  VERSION = '0.1.0'.freeze
+end

data/ruby_cpiu.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+
+# CPIU - a Ruby interface for fetching CPI-U data from BLS.gov
+# Copyright (C) 2017 Cody Logan
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cpiu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cpiu'
+  spec.version       = CPIU::VERSION
+  spec.authors       = ['Cody Logan']
+  spec.email         = ['cody@madrants.net']
+
+  spec.summary       = 'A Ruby interface for getting CPI-U data from BLS.gov'
+  spec.homepage      = 'https://github.com/clpo13/ruby_cpiu'
+
+  spec.license       = 'GPL-3.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+
+  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'json', '~> 2.1'
+  spec.add_dependency 'dotenv', '~> 2.2'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: cpiu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cody Logan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: 
+email:
+- cody@madrants.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/single_year.yml
+- fixtures/vcr_cassettes/year_range.yml
+- lib/cpiu.rb
+- lib/cpiu/api.rb
+- lib/cpiu/data.rb
+- lib/cpiu/version.rb
+- ruby_cpiu.gemspec
+homepage: https://github.com/clpo13/ruby_cpiu
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby interface for getting CPI-U data from BLS.gov
+test_files: []