cpiu 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51a7cb3a1996baef1fdf93d9ff21455f8074a26f
-  data.tar.gz: 3c13af4b28743a60824d703fb88584f9b00c66b0
+SHA256:
+  metadata.gz: 10ed76839dd29d78e9f22e7def78b29e3c408c197898f8df034e67494623ad0a
+  data.tar.gz: 656bb9d2034ee200482ca11fdf8f3614fc02ae4a618adf052000281672ce4210
 SHA512:
-  metadata.gz: d05b50acb1ae1acb17cc7e01eac772af5f6f3986fb5a94e5af57bf6b29734182685d99f326a9121973640d48ee8a2375a2ad9bedc283fd81acc12b5c4c59a185
-  data.tar.gz: b2e294c471770e0166306517c82d5d0a07963a61d0ae422c9b941cf6d9c65db3bce70e422deecf4630db3b42dc998eda80acc3140f1d3ac3ac63ca2f729b2ef8
+  metadata.gz: 29c67cb7606492757507a15aa7eb6972bbf9882cc20f68c991b22fd16492130d6ae1a683e311894f4e041bac9cfdb8e791c9c492307e57c667c26fb85924c88c
+  data.tar.gz: 7db34775289b579cf0dbda79daa59dd8a9691f3c5f69bba24e741e05d9b84311d5286f5c061c457165d9b9c04bf1ca661a35df3e5aebc97be1c599f32d216010

data/.github/workflows/gem-push.yml

@@ -0,0 +1,43 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags: [ "v*" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 3.0
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,54 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+    - name: Coveralls
+      uses: coverallsapp/github-action@v2
+      with:
+        flag-name: run-${{ join(matrix.*, '-') }}
+        parallel: true
+
+  finish:
+    needs: test
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@v2
+      with:
+        parallel-finished: true
+        carryforward: "run-3.0,run-3.1,run-3.2"

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# CPIU
+
+## 0.2.1
+
+* Add information on `.env` file to documentation
+
+## 0.2.0
+
+* Added two new methods to CPIU::Data:
+  * cpiu_year(year): get the annual average CPI of a given year
+  * cpiu_month(year, month): get the CPI of a given month and year
+
+## 0.1.1
+
+* Fixed gem homepage link in gemspec
+
+## 0.1.0
+
+* Initial release

data/README.md

@@ -1,6 +1,5 @@
 # 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)
 [![Gem Version](https://badge.fury.io/rb/cpiu.svg)](https://badge.fury.io/rb/cpiu)
 
@@ -13,7 +12,7 @@ Neither I nor BLS.gov can vouch for the data or analyses derived from these data
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cpiu', '~> 0.1'
+gem 'cpiu', '~> 0.2'
 ```
 
 And then execute:
@@ -36,6 +35,8 @@ Add the following to your program:
 require 'cpiu'
 ```
 
+In order to get the most out of the BLS API, you will need a registration key, which can be obtained [here](https://data.bls.gov/registrationEngine/). Create a file named `.env` in the root of your project folder with the contents `BLS_API_KEY=<your key here>`. The API can still be queried without a key, but there are [restrictions](https://www.bls.gov/developers/api_faqs.htm#register1) on what data will be returned.
+
 The following methods will retrieve JSON objects containing CPI-U data:
 
 * `CPIU::Data.single_year(year)` - data for a single year
@@ -56,6 +57,11 @@ The data is returned in an array of hashes:
 ]
 ```
 
+If you just want CPI-U values:
+
+* `CPIU::Data.cpiu_year(year)` - the annual average CPI value for a year
+* `CPIU::Data.cpiu_month(year, month)` - the CPI value for a particular month
+
 A raw API call method is available too:
 
 * `CPIU::API.request_data(startyear, endyear, ann_avg, calcs)`
@@ -111,4 +117,10 @@ Bug reports and pull requests are welcome on GitHub at <https://github.com/clpo1
 
 ## License
 
-This code is licensed under [GPLv3](LICENSE.txt).
+Copyright &copy; 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.
+
+A copy of the GNU General Public License can be found in [LICENSE.txt](LICENSE.txt) and at <http://www.gnu.org/licenses/>.

data/cpiu.gemspec

@@ -38,12 +38,13 @@ Gem::Specification.new do |spec|
   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 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 12.3'
   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_development_dependency 'vcr', '~> 6.2'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
 
   spec.add_dependency 'rest-client', '~> 2.0'
   spec.add_dependency 'json', '~> 2.1'

data/lib/cpiu/version.rb

@@ -18,5 +18,5 @@
 
 module CPIU
   # Current CPIU gem version
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cpiu
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Cody Logan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,16 +72,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -143,10 +157,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -179,8 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: A Ruby interface for getting CPI-U data from BLS.gov

data/.travis.yml

@@ -1,16 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- 2.4
-- 2.3
-- 2.2
-before_install: gem install bundler -v 1.15.3
-cache: bundler
-deploy:
-  provider: rubygems
-  api_key:
-    secure: mwHBcES+QeqKqbz3o9Xoz5J87C1S9BoqhLU6E5+wjskzfuUUPb5nFiZXN7Fe1zssx2jzEF1K0rGD5eYpJaq/qnoRXMSTFWNrOhk+CAy5g6yzizqRO8Gx7T7H2jMtxkEP0I+x/bFFXlHIhh2t7+cBm2WBSDWtAVnHKXlNAq+lDBhuQX9r9XKW50dfjPVaio4dvUAtehea3AhAFH+S/s1Vkz5bJYPYxZA/ddpwt1KfGvYnvhyuWPHPyuMCmQnyeOifaQZhQy5GCqSnlCs5nOlmn+Y7JTDGv4UNsSPt7Fkhlp7leqCto06oh82hHfUtJP8pzW42prU0rCfN4Un1zAnNMf5KNFp4o3SmAkHjAOQ1LrHafiTXNKUpLm6aLlKRr6O6S2ly3EKPDVlCcMU34n7X7vTH2YdK8AsWZUa/LB3gNLTM6HwNrzjJe77t4TU3NgVbVjqb9nuiFrVkBxuDDRVKc6zR2j04jwQswljxoyr5zXAvq4V/YRvpB4RlZAmhS+CtirRFYtIK/n85wtv7uRHQODcF67E2V/YsTQ1X8Tr1Z39waVbMRSIsqazas5XODNYzYW3gtHO45C12V3F8Zj5e6p23lqFSjqXxMy+/fIjvVA3Uyjl4UvHcNmPaMZSdRrr5T0WZk0x+BR8Z0v/aSb+xKCA1g4C7wSUqXJuLYOyifC8=
-  gem: cpiu
-  on:
-    tags: true
-    repo: clpo13/cpiu-ruby