panoptes-client 1.0.0.pre → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b31b1558519ae640f4ee2504b01797b31ec3758526900bed1c52f0e355f210c
-  data.tar.gz: 87fef50c3aa0669ed3ba57d6acc423f5bfa1c7a2658ce90c2b6c7a038bcfabc5
+  metadata.gz: dca50d5041bcc66daaaa93724829dcfc22cf23b274dab2b9d9cd970518aa6525
+  data.tar.gz: b97521a77b9d5e45b79d8f5edaf70fc12040abf02d9047164913296e07f1f511
 SHA512:
-  metadata.gz: 8bdb6f370c994b60217d16c3f3ef01dc40d09c3b6cc0615fdaed9c044431cfbdd68b2d3ee6fa2a50736a42b303c91f6b1d55374c2e353f9bb44e04c3bb2f13c8
-  data.tar.gz: 1df9b85193256c608b06f21e24db4bea2105c6a74c605967bd3d6ce76c38a662a78dbc96837993246ab32ef594a6965a42d66800d325879ce4cdce729b4c3b5c
+  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/.hound.yml

@@ -1,2 +1,2 @@
-ruby:
-  config_file: .ruby-style.yml
+rubocop:
+  config_file: .rubocop.yml

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 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
+
+# 1.0.0
+
+* Refactor of authentication code public interface
+* Remove deprecated `current_user` method
+* Stable API release
+
 # 0.4.0
 
 * Additional methods for interacting with JWT

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/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in panoptes-client.gemspec

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,12 +13,22 @@ 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 test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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:
 
@@ -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/Rakefile

@@ -1,13 +1,15 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 require 'yard'
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']   # optional
+  t.files   = ['lib/**/*.rb'] # optional
   t.options = ['--any', '--extra', '--opts'] # optional
   t.stats_options = ['--list-undoc']         # optional
 end
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "panoptes/client"
+require 'bundler/setup'
+require 'panoptes/client'
 
 # 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.
@@ -10,5 +11,5 @@ require "panoptes/client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

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/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'deprecate'
 
 module Panoptes
@@ -53,11 +55,6 @@ module Panoptes
         token_contents.fetch('admin', false)
       end
 
-      def current_user
-        token_contents
-      end
-      deprecate :current_user, :token_contents, 2019, 7
-
       private
 
       def ensure_authenticated
@@ -87,14 +84,19 @@ module Panoptes
 
       def public_key_for_env(env)
         case env.to_s
-        when "staging"
-          File.expand_path(File.join("..","..", "..", "..", "data", "doorkeeper-jwt-staging.pub"), __FILE__)
-        when "production"
-          File.expand_path(File.join("..","..", "..", "..", "data", "doorkeeper-jwt-production.pub"), __FILE__)
-        else
-          nil
+        when 'staging'
+          key_file_path('doorkeeper-jwt-staging.pub')
+        when 'production'
+          key_file_path('doorkeeper-jwt-production.pub')
         end
       end
+
+      def key_file_path(file_name)
+        File.expand_path(
+          File.join('..', '..', '..', '..', 'data', file_name),
+          __FILE__
+        )
+      end
     end
   end
 end

data/lib/panoptes/client/cellect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module Panoptes

data/lib/panoptes/client/classifications.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Classifications
       def get_subject_classifications(subject_id, workflow_id)
-        panoptes.paginate("/classifications/project", {
-          admin: true,
-          workflow_id: workflow_id,
-          subject_id: subject_id
-        }, resource: "classifications")
+        panoptes.paginate('/classifications/project', {
+                            admin: true,
+                            workflow_id: workflow_id,
+                            subject_id: subject_id
+                          }, resource: 'classifications')
       end
 
       def get_user_classifications(user_id, workflow_id)
-        panoptes.paginate("/classifications/project", {
-          admin: true,
-          workflow_id: workflow_id,
-          user_id: user_id
-        }, resource: "classifications")
+        panoptes.paginate('/classifications/project', {
+                            admin: true,
+                            workflow_id: workflow_id,
+                            user_id: user_id
+                          }, resource: 'classifications')
       end
     end
   end

data/lib/panoptes/client/collections.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Collections
+      def collection(collection_id)
+        response = panoptes.get("/collections/#{collection_id}")
+        response['collections'].first
+      end
+
       def add_subjects_to_collection(collection_id, subject_ids)
-        panoptes.post("/collections/#{collection_id}/links/subjects",subjects: subject_ids)
+        panoptes.post("/collections/#{collection_id}/links/subjects", subjects: subject_ids)
       end
     end
   end

data/lib/panoptes/client/comments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Comments
@@ -7,9 +9,9 @@ module Panoptes
       # @param focus_type [String] filter by focussable type
       # @return list of discussions
       def create_comment(discussion_id:, body:)
-        user_id = token_contents["id"]
-        response = talk.post("/comments", comments: {discussion_id: discussion_id, body: body, user_id: user_id})
-        response.fetch("comments")[0]
+        user_id = token_contents['id']
+        response = talk.post('/comments', comments: { discussion_id: discussion_id, body: body, user_id: user_id })
+        response.fetch('comments')[0]
       end
     end
   end

data/lib/panoptes/client/discussions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Discussions
@@ -11,8 +13,8 @@ module Panoptes
         query[:focus_id] = focus_id
         query[:focus_type] = focus_type
 
-        response = talk.get("/discussions", query)
-        response.fetch("discussions")
+        response = talk.get('/discussions', query)
+        response.fetch('discussions')
       end
     end
   end

data/lib/panoptes/client/me.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'jwt'
 
@@ -5,7 +7,7 @@ module Panoptes
   class Client
     module Me
       def me
-        panoptes.get("/me")["users"][0]
+        panoptes.get('/me')['users'][0]
       end
     end
   end

data/lib/panoptes/client/project_preferences.rb

@@ -1,32 +1,31 @@
+# frozen_string_literal: true
 
 module Panoptes
   class Client
     module ProjectPreferences
       def project_preferences(id)
         response = panoptes.get("project_preferences/#{id}")
-        response.fetch("project_preferences").first
+        response.fetch('project_preferences').first
       end
 
       def user_project_preferences(user_id, project_id)
-        response = panoptes.get("project_preferences", {
-          user_id: user_id,
-          project_id: project_id
-        })
-        response.fetch("project_preferences").first
+        response = panoptes.get('project_preferences',
+                                user_id: user_id,
+                                project_id: project_id)
+        response.fetch('project_preferences').first
       end
 
       def promote_user_to_workflow(user_id, project_id, workflow_id)
-        id = panoptes.get("project_preferences", {
-          user_id: user_id,
-          project_id: project_id
-        }).fetch("project_preferences").first["id"]
+        id = panoptes.get('project_preferences',
+                          user_id: user_id,
+                          project_id: project_id).fetch('project_preferences').first['id']
 
         response = panoptes.connection.get("/api/project_preferences/#{id}")
-        etag = response.headers["ETag"]
+        etag = response.headers['ETag']
 
         panoptes.put("project_preferences/#{id}", {
-          project_preferences: { settings: { workflow_id: workflow_id } }
-        }, etag: etag)
+                       project_preferences: { settings: { workflow_id: workflow_id } }
+                     }, etag: etag)
       end
     end
   end

data/lib/panoptes/client/projects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Projects
@@ -10,7 +12,7 @@ module Panoptes
         params = {}
         params[:search] = search if search
 
-        panoptes.paginate("/projects", params)["projects"]
+        panoptes.paginate('/projects', params)['projects']
       end
 
       # Fetches the specified project
@@ -20,7 +22,7 @@ module Panoptes
       # @return [Hash] The requested project
       def project(project_id)
         response = panoptes.get("/projects/#{project_id}")
-        response.fetch("projects").find {|i| i.fetch("id").to_s == project_id.to_s }
+        response.fetch('projects').find { |i| i.fetch('id').to_s == project_id.to_s }
       end
 
       # Starts a background process to generate a new CSV export of all the classifications in the project.
@@ -28,8 +30,9 @@ module Panoptes
       # @param project_id [Integer] the id of the project to export
       # @return [Hash] the medium information where the export will be stored when it's generated
       def create_classifications_export(project_id)
-        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
-        panoptes.post("/projects/#{project_id}/classifications_export", params)["media"].first
+        params = export_params('text/csv')
+        path = export_path(project_id, 'classifications_export')
+        panoptes.post(path, params)['media'].first
       end
 
       # Starts a background process to generate a new CSV export of all the subjects in the project.
@@ -37,8 +40,9 @@ module Panoptes
       # @param project_id [Integer] the id of the project to export
       # @return [Hash] the medium information where the export will be stored when it's generated
       def create_subjects_export(project_id)
-        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
-        panoptes.post("/projects/#{project_id}/subjects_export", params)["media"].first
+        params = export_params('text/csv')
+        path = export_path(project_id, 'subjects_export')
+        panoptes.post(path, params)['media'].first
       end
 
       # Starts a background process to generate a new CSV export of all the workflows in the project.
@@ -46,8 +50,9 @@ module Panoptes
       # @param project_id [Integer] the id of the project to export
       # @return [Hash] the medium information where the export will be stored when it's generated
       def create_workflows_export(project_id)
-        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
-        panoptes.post("/projects/#{project_id}/workflows_export", params)["media"].first
+        params = export_params('text/csv')
+        path = export_path(project_id, 'workflows_export')
+        panoptes.post(path, params)['media'].first
       end
 
       # Starts a background process to generate a new CSV export of all the workflow_contents in the project.
@@ -55,8 +60,9 @@ module Panoptes
       # @param project_id [Integer] the id of the project to export
       # @return [Hash] the medium information where the export will be stored when it's generated
       def create_workflow_contents_export(project_id)
-        params = {media: {content_type: "text/csv", metadata: { recipients: []}}}
-        panoptes.post("/projects/#{project_id}/workflow_contents_export", params)["media"].first
+        params = export_params('text/csv')
+        path = export_path(project_id, 'workflow_contents_export')
+        panoptes.post(path, params)['media'].first
       end
 
       # Starts a background process to generate a new CSV export of the aggretation results of the project.
@@ -64,8 +70,19 @@ module Panoptes
       # @param project_id [Integer] the id of the project to export
       # @return [Hash] the medium information where the export will be stored when it's generated
       def create_aggregations_export(project_id)
-        params = {media: {content_type: "application/x-gzip", metadata: { recipients: []}}}
-        panoptes.post("/projects/#{project_id}/aggregations_export", params)["media"].first
+        params = export_params('application/x-gzip')
+        path = export_path(project_id, 'aggregations_export')
+        panoptes.post(path, params)['media'].first
+      end
+
+      private
+
+      def export_params(content_type)
+        { media: { content_type: content_type, metadata: { recipients: [] } } }
+      end
+
+      def export_path(project_id, export_type)
+        "/projects/#{project_id}/#{export_type}"
       end
     end
   end

data/lib/panoptes/client/subject_sets.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module SubjectSets
       def subject_set(subject_set_id)
         response = panoptes.get("/subject_sets/#{subject_set_id}")
-        response.fetch("subject_sets").find {|i| i.fetch("id").to_s == subject_set_id.to_s }
+        response.fetch('subject_sets').find { |i| i.fetch('id').to_s == subject_set_id.to_s }
       end
 
       def create_subject_set(attributes)
-        response = panoptes.post("/subject_sets", subject_sets: attributes)
-        response.fetch("subject_sets").first
+        response = panoptes.post('/subject_sets', subject_sets: attributes)
+        response.fetch('subject_sets').first
       end
 
       def update_subject_set(subject_set_id, attributes)
         response = panoptes.connection.get("/api/subject_sets/#{subject_set_id}")
-        etag = response.headers["ETag"]
+        etag = response.headers['ETag']
 
-        response = panoptes.put("/subject_sets/#{subject_set_id}", {subject_sets: attributes}, etag: etag)
-        response.fetch("subject_sets").first
+        response = panoptes.put("/subject_sets/#{subject_set_id}", { subject_sets: attributes }, etag: etag)
+        response.fetch('subject_sets').first
       end
 
       def add_subjects_to_subject_set(subject_set_id, subject_ids)

data/lib/panoptes/client/subjects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Subjects
@@ -12,8 +14,8 @@ module Panoptes
 
         raise 'Must filter on at least one of subject_set_id, workflow_id' if query.empty?
 
-        response = panoptes.paginate("/subjects", query)
-        response.fetch("subjects")
+        response = panoptes.paginate('/subjects', query)
+        response.fetch('subjects')
       end
 
       # Fetch a subject given filters (including permissions)
@@ -27,7 +29,7 @@ module Panoptes
 
         response = panoptes.get("/subjects/#{subject_id}", query)
         if response.fetch('subjects', []).count > 1
-          raise StandardError.new 'Unexpectedly many subjects returned'
+          raise StandardError, 'Unexpectedly many subjects returned'
         end
 
         response.fetch('subjects', []).fetch(0, nil)
@@ -40,11 +42,10 @@ module Panoptes
       # @param subject_id  [Integer] the ID of a subject associated with that workflow (through one of the assigned subject_sets)
       # @return nothing
       def retire_subject(workflow_id, subject_id, reason: nil)
-        panoptes.post("/workflows/#{workflow_id}/retired_subjects", {
-          admin: true,
-          subject_id: subject_id,
-          retirement_reason: reason
-        })
+        panoptes.post("/workflows/#{workflow_id}/retired_subjects",
+                      admin: true,
+                      subject_id: subject_id,
+                      retirement_reason: reason)
         true
       end
     end

data/lib/panoptes/client/user_groups.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module UserGroups
@@ -7,20 +9,20 @@ module Panoptes
       # @param name [String] The name of the user group. Must be unique for the entirity of Zooniverse.
       # @return [Hash] The created user group.
       def create_user_group(name)
-        panoptes.post("/user_groups", user_groups: {
-          name: name
-        })["user_groups"][0]
+        panoptes.post('/user_groups', user_groups: {
+                        name: name
+                      })['user_groups'][0]
       end
 
       def user_groups
-        panoptes.get("/user_groups")["user_groups"]
+        panoptes.get('/user_groups')['user_groups']
       end
 
       def join_user_group(user_group_id, user_id, join_token:)
-        panoptes.post("/memberships", memberships: {
-          join_token: join_token,
-          links: {user: user_id, user_group: user_group_id}
-        })["memberships"][0]
+        panoptes.post('/memberships', memberships: {
+                        join_token: join_token,
+                        links: { user: user_id, user_group: user_group_id }
+                      })['memberships'][0]
       end
 
       def remove_user_from_user_group(user_group_id, user_id)
@@ -29,7 +31,7 @@ module Panoptes
 
       def delete_user_group(user_group_id)
         response = panoptes.connection.get("/api/user_groups/#{user_group_id}")
-        etag = response.headers["ETag"]
+        etag = response.headers['ETag']
 
         panoptes.delete("/user_groups/#{user_group_id}", {}, etag: etag)
       end

data/lib/panoptes/client/users.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Users
       def user(user_id)
         response = panoptes.get("users/#{user_id}")
-        response.fetch("users").find{ |i| i.fetch("id").to_s == user_id.to_s }
+        response.fetch('users').find { |i| i.fetch('id').to_s == user_id.to_s }
       end
     end
   end

data/lib/panoptes/client/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
-    VERSION = '1.0.0.pre'.freeze
+    VERSION = '1.1.1'
   end
 end

data/lib/panoptes/client/workflows.rb

@@ -1,18 +1,25 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Client
     module Workflows
       def workflow(workflow_id)
         response = panoptes.get("/workflows/#{workflow_id}")
-        response.fetch("workflows").find {|i| i.fetch("id").to_s == workflow_id.to_s }
+        response.fetch('workflows').find do |i|
+          i.fetch('id').to_s == workflow_id.to_s
+        end
       end
 
       def create_workflow(attributes)
-        response = panoptes.post("/workflows", workflows: attributes)
-        response.fetch("workflows").first
+        response = panoptes.post('/workflows', workflows: attributes)
+        response.fetch('workflows').first
       end
 
       def add_subject_set_to_workflow(workflow_id, subject_set_id)
-        panoptes.post("/workflows/#{workflow_id}/links/subject_sets",subject_sets: subject_set_id)
+        panoptes.post(
+          "/workflows/#{workflow_id}/links/subject_sets",
+          subject_sets: subject_set_id
+        )
       end
     end
   end

data/lib/panoptes/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'panoptes/endpoints/json_api_endpoint'
 require 'panoptes/endpoints/json_endpoint'
 
@@ -66,19 +68,19 @@ module Panoptes
 
     def panoptes_url
       case env
-      when :production, 'production'.freeze
-        'https://panoptes.zooniverse.org'.freeze
+      when :production, 'production'
+        'https://panoptes.zooniverse.org'
       else
-        'https://panoptes-staging.zooniverse.org'.freeze
+        'https://panoptes-staging.zooniverse.org'
       end
     end
 
     def talk_url
       case env
-      when :production, 'production'.freeze
-        'https://talk.zooniverse.org'.freeze
+      when :production, 'production'
+        'https://talk.zooniverse.org'
       else
-        'https://talk-staging.zooniverse.org'.freeze
+        'https://talk-staging.zooniverse.org'
       end
     end
   end

data/lib/panoptes/endpoints/base_endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday/panoptes'
@@ -58,7 +60,10 @@ module Panoptes
       end
 
       def request(method, path, *args)
-        path = "#{prefix}/#{path}" if prefix
+        if prefix
+          sep = path[0] == '/' ? nil : '/'
+          path = "#{prefix}#{sep}#{path}"
+        end
         handle_response connection.send(method, path, *args)
       end
 
@@ -83,9 +88,7 @@ module Panoptes
           faraday.request :json
           faraday.response :json
           faraday.adapter Faraday.default_adapter
-          if @params
-            faraday.params = @params
-          end
+          faraday.params = @params if @params
         end
       end
 

data/lib/panoptes/endpoints/json_api_endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_endpoint'
 
 module Panoptes
@@ -8,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/lib/panoptes/endpoints/json_endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base_endpoint'
 
 module Panoptes
@@ -7,7 +9,7 @@ module Panoptes
       # @see Panoptes::Endpoints::BaseEndpoint#initialize
       def initialize(auth: {}, url: nil, prefix: nil, &config)
         super auth: auth, url: url, prefix: prefix do |faraday|
-          config.call(faraday) if config
+          yield(faraday) if config
           faraday.request :json
           faraday.response :json
           faraday.adapter Faraday.default_adapter

data/lib/panoptes/session.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Panoptes
   class Session
-    def initialize(auth)
-    end
+    def initialize(auth); end
   end
 end

data/lib/panoptes/talk_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Panoptes
   # Backwards compat
   class TalkClient < Client

data/lib/panoptes-client.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'panoptes/client'
 require 'panoptes/talk_client'

data/panoptes-client.gemspec

@@ -1,31 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'panoptes/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "panoptes-client"
+  spec.name          = 'panoptes-client'
   spec.version       = Panoptes::Client::VERSION
   spec.authors       = ['Marten Veldthuis', 'Zach Wolfenbarger', 'Amy Boyer']
   spec.email         = ['marten@veldthuis.com', 'zach@zooniverse.org', 'amy@zooniverse.org']
 
-  spec.summary       = %q{API wrapper for https://panoptes.zooniverse.org}
-  spec.homepage      = "https://github.com/zooniverse/panoptes-client.rb"
-  spec.license       = "Apache 2.0"
+  spec.summary       = 'API wrapper for https://panoptes.zooniverse.org'
+  spec.homepage      = 'https://github.com/zooniverse/panoptes-client.rb'
+  spec.license       = 'Apache 2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "deprecate"
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday-panoptes", "~> 0.3.0"
-  spec.add_dependency "jwt", "~> 1.5.0"
+  spec.add_dependency 'deprecate'
+  spec.add_dependency 'faraday'
+  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 "yard"
+  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.0.0.pre
+  version: 1.1.1
 platform: ruby
 authors:
 - Marten Veldthuis
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-29 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"
-- ".ruby-style.yml"
-- ".travis.yml"
+- ".rubocop.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
@@ -200,11 +202,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: API wrapper for https://panoptes.zooniverse.org

data/.ruby-style.yml

@@ -1,206 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  Exclude:
-    - "vendor/**/*"
-    - "db/schema.rb"
-  UseCache: false
-
-Style/DotPosition:
-  Description: Checks the position of the dot in multi-line method calls.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
-  Enabled: true
-  EnforcedStyle: leading
-  SupportedStyles:
-  - leading
-  - trailing
-Style/FileName:
-  Description: Use snake_case for source file names.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
-  Enabled: true
-  Exclude: []
-Style/GuardClause:
-  Description: Check for conditionals that can be replaced with guard clauses
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
-  Enabled: false
-  MinBodyLength: 1
-Style/IfUnlessModifier:
-  Description: Favor modifier if/unless usage when you have a single-line body.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
-  Enabled: false
-  MaxLineLength: 80
-Style/OptionHash:
-  Description: Don't use option hashes when you can use keyword arguments.
-  Enabled: false
-Style/ParallelAssignment:
-  Enabled: false
-Style/PercentLiteralDelimiters:
-  Description: Use `%`-literal delimiters consistently
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
-  Enabled: false
-  PreferredDelimiters:
-    "%": "()"
-    "%i": "()"
-    "%q": "()"
-    "%Q": "()"
-    "%r": "{}"
-    "%s": "()"
-    "%w": "()"
-    "%W": "()"
-    "%x": "()"
-Style/PredicateName:
-  Description: Check the names of predicate methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
-  Enabled: true
-  NamePrefix:
-  - is_
-  - has_
-  - have_
-  NamePrefixBlacklist:
-  - is_
-  Exclude:
-  - spec/**/*
-Style/RaiseArgs:
-  Description: Checks the arguments passed to raise/fail.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
-  Enabled: false
-  EnforcedStyle: exploded
-  SupportedStyles:
-  - compact
-  - exploded
-Style/SignalException:
-  Description: Checks for proper usage of fail and raise.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
-  Enabled: false
-  EnforcedStyle: semantic
-  SupportedStyles:
-  - only_raise
-  - only_fail
-  - semantic
-Style/SingleLineBlockParams:
-  Description: Enforces the names of some block params.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
-  Enabled: false
-  Methods:
-  - reduce:
-    - a
-    - e
-  - inject:
-    - a
-    - e
-Style/SingleLineMethods:
-  Description: Avoid single-line methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
-  Enabled: false
-  AllowIfMethodIsEmpty: true
-Metrics/AbcSize:
-  Description: A calculated magnitude based on number of assignments, branches, and
-    conditions.
-  Enabled: false
-  Max: 15
-Metrics/ClassLength:
-  Description: Avoid classes longer than 100 lines of code.
-  Enabled: false
-  CountComments: false
-  Max: 100
-Metrics/LineLength:
-  Enabled: false
-Metrics/ModuleLength:
-  CountComments: false
-  Max: 100
-  Description: Avoid modules longer than 100 lines of code.
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Description: A complexity metric that is strongly correlated to the number of test
-    cases needed to validate a method.
-  Enabled: false
-  Max: 6
-Metrics/MethodLength:
-  Description: Avoid methods longer than 10 lines of code.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
-  Enabled: false
-  CountComments: false
-  Max: 10
-Metrics/ParameterLists:
-  Description: Avoid parameter lists longer than three or four parameters.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
-  Enabled: false
-  Max: 5
-  CountKeywordArgs: true
-Metrics/PerceivedComplexity:
-  Description: A complexity metric geared towards measuring complexity for a human
-    reader.
-  Enabled: false
-  Max: 7
-Lint/AssignmentInCondition:
-  Description: Don't use assignment in conditions.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
-  Enabled: false
-  AllowSafeAssignment: true
-Style/InlineComment:
-  Description: Avoid inline comments.
-  Enabled: false
-Style/AccessorMethodName:
-  Description: Check the naming of accessor methods for get_/set_.
-  Enabled: false
-Style/Alias:
-  Description: Use alias_method instead of alias.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
-  Enabled: false
-Style/Documentation:
-  Description: Document classes and non-namespace modules.
-  Enabled: false
-Style/DoubleNegation:
-  Description: Checks for uses of double negation (!!).
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
-  Enabled: false
-Style/EachWithObject:
-  Description: Prefer `each_with_object` over `inject` or `reduce`.
-  Enabled: false
-Style/EmptyLiteral:
-  Description: Prefer literals to Array.new/Hash.new/String.new.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
-  Enabled: false
-Style/ModuleFunction:
-  Description: Checks for usage of `extend self` in modules.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
-  Enabled: false
-Style/OneLineConditional:
-  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
-  Enabled: false
-Style/PerlBackrefs:
-  Description: Avoid Perl-style regex back references.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
-  Enabled: false
-Style/Send:
-  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
-    may overlap with existing methods.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
-  Enabled: false
-Style/SpecialGlobalVars:
-  Description: Avoid Perl-style global variables.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
-  Enabled: false
-Style/VariableInterpolation:
-  Description: Don't interpolate global, instance and class variables directly in
-    strings.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
-  Enabled: false
-Style/WhenThen:
-  Description: Use when x then ... for one-line cases.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
-  Enabled: false
-Lint/EachWithObjectArgument:
-  Description: Check for immutable argument given to each_with_object.
-  Enabled: true
-Lint/HandleExceptions:
-  Description: Don't suppress exception.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
-  Enabled: false
-Lint/LiteralInCondition:
-  Description: Checks of literals used in conditions.
-  Enabled: false
-Lint/LiteralInInterpolation:
-  Description: Checks for literals used in interpolation.
-  Enabled: false

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2