cpiu 0.1.1 → 0.2.0

data/fixtures/vcr_cassettes/year_range.yml

@@ -1,47 +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
+---
+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 (darwin16.6.0 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:
+      - Wed, 02 Aug 2017 04:42:19 GMT
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains;
+      Set-Cookie:
+      - JSESSIONID=6BE4A1C96F1FD629B9A6C995B3F46E6C; Version=1; Path="/publicAPI/";
+        Secure; HttpOnly
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '2154'
+    body:
+      encoding: UTF-8
+      string: |-
+        {"status":"REQUEST_SUCCEEDED","responseTime":37,"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: Wed, 02 Aug 2017 04:42:26 GMT
+recorded_with: VCR 3.0.3

data/lib/cpiu.rb

@@ -1,24 +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
+# 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

@@ -1,57 +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
+# 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

@@ -1,40 +1,57 @@
-# 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
+# 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, true)
+      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
+
+    # Get annual average CPI for a given year
+    # @param year [Integer] the year
+    # @return [Float]
+    def self.cpiu_year(year)
+      data = CPIU::Data.single_year(year)
+      data[0]['value'].to_f
+    end
+
+    # Get CPI value for a given month and year
+    # @param year [Integer] the year
+    # @param month [Integer] the month (1-12)
+    # @return [Float]
+    def self.cpiu_month(year, month)
+      data = CPIU::Data.single_year(year).reverse
+      data[month - 1]['value'].to_f
+    end
+  end
+end

data/lib/cpiu/version.rb

@@ -1,22 +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.1'.freeze
-end
+# 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.2.0'.freeze
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpiu
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Cody Logan
@@ -153,13 +153,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- cpiu.gemspec
 - 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/cpiu-ruby
 licenses:
 - GPL-3.0