panoptes-client 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39aeafa72adb7b23aa7f2c92feb0e0fa673c2fe88c85a4d007362ad5609a5aa1
-  data.tar.gz: 35626ac17f0645ed4de74a9ec9e85515152a0b8b8f6a55bde827f9c2b29e779e
+  metadata.gz: dca50d5041bcc66daaaa93724829dcfc22cf23b274dab2b9d9cd970518aa6525
+  data.tar.gz: b97521a77b9d5e45b79d8f5edaf70fc12040abf02d9047164913296e07f1f511
 SHA512:
-  metadata.gz: 0727eb9c0a4d26eec16972c82e6b122ce74e966458a8850de2197905d496dff2ab454fcd9e286f42d71d53d6240ab2faffedb5bf624ccfa02e361ced61174165
-  data.tar.gz: 7505d21379cf1cff27d679c512267bbdde3ce2672410f9716dd4b6345f00e111c37a6f6c1aa8b26ddf49fed8f4da2de1c55d56a1ef30b5a71eaef35f8f4f5a4d
+  metadata.gz: d14a54f1d75d8b1af316a09cc0a9c629c750d1e50e60aacc4df928192d11445b16311c08223dfad2c9762c5defdd2ced5fa77772475020350c6a1ce85362e77b
+  data.tar.gz: dc1d5c58f876ff541fe113d35ef5837ad2c66a410e5ce0f18933550f5451fce065533ea0fc617b2ef170b396007e0b5d84c2cbb2d117ed0f8e0827a79cce56a2

data/.github/workflows/run_tests_CI.yml

@@ -0,0 +1,17 @@
+name: Zooni CI
+on:
+  pull_request:
+  push: { branches: master }
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.rubocop.yml

@@ -1,2 +1,9 @@
 Style/Documentation:
   Enabled: false
+
+Layout/LineLength:
+  Max: 160
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 1.1.1
+
+* Fix a pagination bug that skipped the first page of API results when using a block to process results. Note this did not impact the use of the paginate method without a block.
+
+```ruby
+# impacted
+client.paginate('/subjects', {}) { |initial_page, page| .. }
+# not impacted
+all_page_results = client.paginate('/subjects', {})
+```
+
 # 1.1.0
 
 * Add method to get single collection

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.7-slim
+
+WORKDIR /panoptes-client
+
+RUN apt-get update && apt-get -y upgrade && \
+    apt-get install --no-install-recommends -y \
+        build-essential \
+        # git is required for installing gems from git repos
+        git \
+        nano \
+        vim
+
+ADD ./Gemfile /panoptes-client/
+ADD ./panoptes-client.gemspec /panoptes-client/
+ADD ./lib/panoptes/client/version.rb /panoptes-client/lib/panoptes/client/
+ADD .git/ /panoptes-client/
+
+RUN bundle config --global jobs `cat /proc/cpuinfo | grep processor | wc -l | xargs -I % expr % - 1` && bundle install
+
+ADD ./ /panoptes-client
+
+CMD ["bundle", "exec", "rspec"]

data/README.md

@@ -1,6 +1,6 @@
 # Panoptes::Client
 
-[![Build Status](https://travis-ci.org/zooniverse/panoptes-client.rb.svg?branch=master)](https://travis-ci.org/zooniverse/panoptes-client.rb)
+[![Build Status](https://github.com/zooniverse/panoptes-client.rb/actions/workflows/run_tests_CI.yml/badge.svg?)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/zooniverse/panoptes-client.rb/)
 
 ## Installation
@@ -13,13 +13,23 @@ gem 'panoptes-client'
 
 In general, this library is supposed to be a thin, flat layer over our [HTTP-based API](http://docs.panoptes.apiary.io/). All public API methods can be found on the `Client` object.
 
-**A lot of methods are still missing. We've only just started with this wrapper. You can either issue a PR adding the one you need, or use the generic `get` / `post` methods on `Client`.**
+**A lot of methods are still missing. You can either issue a PR adding the one you need, or use the generic `get` / `post` methods on `Client`.**
 
 
 ## 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.
 
+Alternatively use docker and docker-compose to get your dev env setup.
+
+``` bash
+docker-compose build # to build your dev docker image
+docker-compose up # to run the tests in the dev container
+
+# or run an interactive bash session in the dev container
+docker-compose run --service-ports --rm panoptes-client bash
+```
+
 The test suite uses VCR to record HTTP requests, so if you're not making any new requests you should be fine with the existing cassettes. If you are, the test suite uses environment variables to pull in authentication credentials. You'll need to [create an OAuth application on staging](https://panoptes-staging.zooniverse.org/oauth/applications), and set the following env vars:
 
 | Variable                   | Value |
@@ -34,6 +44,16 @@ We recommend [Direnv](https://github.com/direnv/direnv) as good utility to allow
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/panoptes-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+## Publishing
+
+Follow these steps for publishing changes to the panoptes-client.rb ruby gem.
+
+1. Make sure changes have been outlined in CHANGELOG.md, and version has been updated in lib/panoptes/client/version.rb. Reference [Semantic Versioning](https://semver.org/) for guidance on how to update the version number.
+2. Tag a release when your PR has been merged into master. Use [this guide](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) for reference on how to create release tags. Set the version number (e.g. v1.1.1) as the tag name. Select the master branch as the target branch. In the release description, list out the changes that have been made just as you did in CHANGELOG.md. Do not select pre-release unless it’s not yet ready for production, and then click ‘Publish Release’.
+3. Once the release tag is set, check out the release branch locally and test to make sure everything is working as expected, run tests and make sure they pass. Use the following command to check out a branch via its tag: `git checkout tags/<tag>`
+4. Create the package by running `rake build`. This will build the new version of the panoptes gem (e.g. panoptes-client-1.1.1.gem) into the pkg directory. Once you’ve done this, run `bundler console` to make sure everything works as expected. For more details on packaging and distributing ruby gems, check out [this article](https://www.digitalocean.com/community/tutorials/how-to-package-and-distribute-ruby-applications-as-a-gem-using-rubygems).
+5. To publish the gem, use the command `[sudo] gem push [gem file]`. You’ll need to enter your rubygem.org credentials. Make sure you are one of the owners of the gem, or else you will not have permission to publish. You should see the version updated shortly on https://rubygems.org/gems/panoptes-client. And that’s it!
+
 
 ## License
 

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  panoptes-client:
+    build:
+      context: .
+    volumes:
+      - ./:/panoptes-client
+      - gem_cache:/usr/local/bundle
+
+volumes:
+  gem_cache:

data/lib/panoptes/client/version.rb

@@ -2,6 +2,6 @@
 
 module Panoptes
   class Client
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/panoptes/endpoints/json_api_endpoint.rb

@@ -10,17 +10,25 @@ module Panoptes
         resource = path.split('/').last if resource.nil?
         data = last_response = get(path, query)
 
-        while next_path = last_response['meta'][resource]['next_href']
+        # ensure we yield the first page of data
+        yield data, last_response if block_given?
+
+        # while we have more result set pages
+        while (next_path = last_response['meta'][resource]['next_href'])
+          # fetch next page of data
           last_response = get(next_path, query)
           if block_given?
+            # if we pass a block then yield the first page and current page responses
             yield data, last_response
           else
+            # add to the data representation of all result set pages
             data[resource].concat(last_response[resource]) if data[resource].is_a?(Array)
             data['meta'][resource].merge!(last_response['meta'][resource])
             data['links'].merge!(last_response['links'])
           end
         end
 
+        # return the data results for when we don't use a block to process response pages
         data
       end
     end

data/panoptes-client.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday-panoptes', '~> 0.3.0'
   spec.add_dependency 'jwt', '~> 1.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'timecop', '~> 0.8.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panoptes-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Marten Veldthuis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deprecate
@@ -72,58 +72,58 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -147,13 +147,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/run_tests_CI.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -162,6 +163,7 @@ files:
 - bin/setup
 - data/doorkeeper-jwt-production.pub
 - data/doorkeeper-jwt-staging.pub
+- docker-compose.yml
 - lib/panoptes-client.rb
 - lib/panoptes/client.rb
 - lib/panoptes/client/authentication.rb
@@ -204,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: API wrapper for https://panoptes.zooniverse.org

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-before_install: gem install bundler -v 1.11.2