panoptes-client 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dc546adb36b049e8da428336c52673a0d9f983d
-  data.tar.gz: 85649db5d4650c8d9f92dffd5a23ab85ff8db1f4
+  metadata.gz: 3621f283592595fbf4099b4bfc445e5114b0e18e
+  data.tar.gz: 3a54d9787e2b0db82594ccd408376696161a780c
 SHA512:
-  metadata.gz: 60f2d4972099ce2d3273a4b4da5cfe1941b6d0f62c86d7fa390cf8db304c7a23971886289f1fea5e9d0d0e93ab8723d2b7cd045dda2e652b5ea9c544bfa98663
-  data.tar.gz: ade3768a597807f6fff9fd9636ff892f6c21f86b45c792d83cf6d8310d0038a253b32a3fa09477490825e7ce89734d0495a1994849311429cadf5c88e490229b
+  metadata.gz: 516d1f3d47837241e73c0a30cc21ea3691c367b290a39284f088d98873d1c4aa8b2c63ba8b97ce2325dfc8befbedd170d4e473ca3497e2ca8cc0ec2dc8eeae43
+  data.tar.gz: 5d3f8289862edb747d826bce689ad3f3eff82ab310c7e7ff29d13998bfc807671982ae68baf3f8658cf0a5b793614da7c8b98cb45cc791d941556a4462c5b194

data/.hound.yml

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

data/.ruby-style.yml

@@ -0,0 +1,206 @@
+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/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.2.8
+
+* Merged Client and TalkClient: `client.discussions` is now just on Client. TalkClient is still present as an alias for Client
+* Add `client.create_comment` to post a comment in a talk discussions
+* Add `client.current_user` to get information contained in the authentication token, if given
+* Add `client.cellect_workflows` to get information on workflows using the cellect services
+* Add `client.cellect_subjects` to get subject information for a given cellect workflow
+
 # 0.2.7
 
 * Add `TalkClient` to interact with the talk api.

data/data/doorkeeper-jwt-production.pub

@@ -0,0 +1,14 @@
+-----BEGIN PUBLIC KEY-----
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAvbmZ42QexoMJ1J9z47Y2
+7q5qvtE1mblpOnN7g4ItumcnoCv8xfdbhnzkHj/YBtqVoHhAVNwxSJKyQ4tZBehg
+yYMRzLzBeWO8vG8V/NqM/tmUXca3rvPqt8I7zMoesSggawwz3/Gsa6KFC0OLjDh+
+vE1HlqNX6usKiGmt6fv3KVU9cjtfREIieXgr36nkJDtIVJ2/hX1LY/v0+AEjZaFj
+IzXSihNkjPnq2ymdm0YtV0Mmy1sK4qBY8c/zCWQ9lisILu+/Ix2YwVlDXeV9CErE
+31b2jkPUVfLbCyeGPEIbYJw2pSiFWkuDR2VZaq+qeUbAwDfeu1OwueMZMt54vSYF
+AKOxqMJtkrf8hxLSBZepk9sTS20T7gaEUyBhyeycarQqY34+VwG6UqLSy2H/Mq7r
+5J8x7fnZPAtkFizcu/YDsELmD7Rw8SQ389NzApLi1jx8eSTZT+nqetU4FPs4CGCd
+A/XMj2kAz/IA7LbV4hhbx1tTwTo88Xzk9knTknFv1/sE/j+KeUTeA9dE7EniIgOg
+V01zobEXAP5Eyf3+OwYv+Qvq3cV2BvRZfEBhzj1RezVEh187hfCtCaSVf3YrEeL2
+MM74OPotMaVyaJFxj/GxhrahOgSv4TbMYk93d+vcIa0clO7wXrJJXoWwi3XpQvk7
+SwgqmRqSTqDuxJqlJAuVhmMCAwEAAQ==
+-----END PUBLIC KEY-----

data/data/doorkeeper-jwt-staging.pub

@@ -0,0 +1,14 @@
+-----BEGIN PUBLIC KEY-----
+MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEArqLiWfs+Nm3BBMu9bcma
+JaFhfSpKoHwsFjzRzkdFO0uKXPkS5nJq3UD/ZORr31XKYmwlbhGBzvpBUSoTmsjj
+AXXP9cOlX/opoojuII2JXoUPjZH+YDl4y4M7YzXLyVKYW0FYR2pBXyhtEL9Lx0Ny
+Nw2DW6p7Z9RwoU46WkapjMWor2wAlpnUM4ngDM/7ysEg8oi9KExrXlI4MCH1sVqj
+U++8zkIXarqyDnyVk94ZoGA8EEqjeK3s3HonGG/DZyoj7OMcRa81fm94Sage5PWd
+sJfgUw8bcj3/h/boRIJSMwRv1IJVQxz2o44es6dN+12q3hpXBhCfVZWz3MgoJFpt
+t3e+KHB3UDBEIo55aPgbUAeuWV1IrBqZIQWLZcce4pzgS+A+0JgeetwbzubjHfZu
+8FQ/d+29M8N+R+TOS2WzVXCKzEZtw1BZ8V595X1Rf9FcklnA6CH32LybQD4/4ALz
+JGx2WaCa2246pgJzT7fIo/L/bgRuEsBfwMR+wcOVr7yroFrndEyw1eGv2RuFsLNH
+JwOjF+MTg/wtvaI8AXSTCSeKfoljUndNsiPTO8gJmiAq4yWFiMP1fKm/uczN6PKy
+rYdQDSMt3a8UXZbw+9DocHDD0VvDHg6zuaa75tZrb7WvGrO7kbhUrJYwNCAbD2kN
+Ca6VZnNmmy57yB/+jhBSNkECAwEAAQ==
+-----END PUBLIC KEY-----

data/lib/panoptes/client.rb

@@ -1,19 +1,18 @@
-require "panoptes/concerns/common_client"
-require "panoptes/client/me"
-require "panoptes/client/projects"
-require "panoptes/client/subjects"
-require "panoptes/client/subject_sets"
-require "panoptes/client/user_groups"
-require "panoptes/client/workflows"
+require 'panoptes/endpoints/json_api_endpoint'
+require 'panoptes/endpoints/json_endpoint'
+
+require 'panoptes/client/cellect'
+require 'panoptes/client/comments'
+require 'panoptes/client/discussions'
+require 'panoptes/client/me'
+require 'panoptes/client/projects'
+require 'panoptes/client/subject_sets'
+require 'panoptes/client/subjects'
+require 'panoptes/client/user_groups'
+require 'panoptes/client/workflows'
 
 module Panoptes
   class Client
-    class GenericError < StandardError; end
-    class ConnectionFailed < GenericError; end
-    class ResourceNotFound < GenericError; end
-    class ServerError < GenericError; end
-
-    include Panoptes::CommonClient
     include Panoptes::Client::Me
     include Panoptes::Client::Projects
     include Panoptes::Client::Subjects
@@ -21,73 +20,60 @@ module Panoptes
     include Panoptes::Client::UserGroups
     include Panoptes::Client::Workflows
 
-    def get(path, query = {})
-      response = conn.get("/api" + path, query)
-      handle_response(response)
-    end
-
-    def post(path, body = {})
-      response = conn.post("/api" + path, body)
-      handle_response(response)
-    end
+    include Panoptes::Client::Discussions
+    include Panoptes::Client::Comments
 
-    def put(path, body = {}, etag: nil)
-      headers = {}
-      headers["If-Match"] = etag if etag
+    include Panoptes::Client::Cellect
 
-      response = conn.put("/api" + path, body, headers)
-      handle_response(response)
+    class GenericError < StandardError; end
+    class ConnectionFailed < GenericError; end
+    class ResourceNotFound < GenericError; end
+    class ServerError < GenericError; end
+    class NotLoggedIn < GenericError; end
+
+    attr_reader :env, :auth, :panoptes, :talk, :cellect
+
+    def initialize(env: :production, auth: {}, public_key_path: nil)
+      @env = env
+      @auth = auth
+      @public_key_path = public_key_path
+      @panoptes = Panoptes::Endpoints::JsonApiEndpoint.new(
+        auth: auth, url: panoptes_url, prefix: '/api'
+      )
+      @talk = Panoptes::Endpoints::JsonApiEndpoint.new(
+        auth: auth, url: talk_url
+      )
+      @cellect = Panoptes::Endpoints::JsonEndpoint.new(
+        url: panoptes_url, prefix: '/cellect'
+      )
     end
 
-    def patch(path, body = {}, etag: nil)
-      headers = {}
-      headers["If-Match"] = etag if etag
+    def current_user
+      raise NotLoggedIn unless @auth[:token]
 
-      response = conn.patch("/api" + path, body, headers)
-      handle_response(response)
+      payload, = JWT.decode @auth[:token], jwt_signing_public_key, algorithm: 'RS512'
+      payload.fetch('data')
     end
 
-    def delete(path, query = {}, etag: nil)
-      headers = {}
-      headers["If-Match"] = etag if etag
-
-      response = conn.delete("/api" + path, query, headers)
-      handle_response(response)
+    def jwt_signing_public_key
+      @jwt_signing_public_key ||= OpenSSL::PKey::RSA.new(File.read(@public_key_path))
     end
 
-    # Get a path and perform automatic depagination
-    def paginate(path, query, resource: nil)
-      resource = path.split("/").last if resource.nil?
-      data = last_response = get(path, query)
-
-      while next_path = last_response["meta"][resource]["next_href"]
-        last_response = get(next_path, query)
-        if block_given?
-          yield data, last_response
-        else
-          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
+    def panoptes_url
+      case env
+      when :production, 'production'.freeze
+        'https://panoptes.zooniverse.org'.freeze
+      else
+        'https://panoptes-staging.zooniverse.org'.freeze
       end
-
-      data
-    end
-
-    private
-
-    def conn
-      @conn
     end
 
-    def handle_response(response)
-      case response.status
-      when 404
-        raise ResourceNotFound, status: response.status, body: response.body
-      when 400..600
-        raise ServerError.new(response.body)
+    def talk_url
+      case env
+      when :production, 'production'.freeze
+        'https://talk.zooniverse.org'.freeze
       else
-        response.body
+        'https://talk-staging.zooniverse.org'.freeze
       end
     end
   end

data/lib/panoptes/client/cellect.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+
+module Panoptes
+  class Client
+    module Cellect
+      # Fetches all cellect-enabled, launched workflows.
+      #
+      # @return [Hash] the list of workflows
+      def cellect_workflows
+        cellect.get '/workflows'
+      end
+
+      # Fetches all active subjects for a cellect-enabled workflow.
+      #
+      # @param workflow_id [Integer] the id of the workflow
+      # @return [Hash] the list of subjects
+      def cellect_subjects(workflow_id)
+        cellect.get '/subjects', workflow_id: workflow_id
+      end
+    end
+  end
+end

data/lib/panoptes/client/comments.rb

@@ -0,0 +1,16 @@
+module Panoptes
+  class Client
+    module Comments
+      # Post a comment to a talk discussion
+      #
+      # @param discussion_id [Integer] filter by focussable id
+      # @param focus_type [String] filter by focussable type
+      # @return list of discussions
+      def create_comment(discussion_id:, body:)
+        user_id = current_user["id"]
+        response = talk.post("/comments", comments: {discussion_id: discussion_id, body: body, user_id: user_id})
+        response.fetch("comments")[0]
+      end
+    end
+  end
+end

data/lib/panoptes/client/discussions.rb

@@ -11,7 +11,7 @@ module Panoptes
         query[:focus_id] = focus_id
         query[:focus_type] = focus_type
 
-        response = get("/discussions", query)
+        response = talk.get("/discussions", query)
         response.fetch("discussions")
       end
     end

data/lib/panoptes/client/me.rb

@@ -1,8 +1,11 @@
+require 'openssl'
+require 'jwt'
+
 module Panoptes
   class Client
     module Me
       def me
-        get("/me")["users"][0]
+        panoptes.get("/me")["users"][0]
       end
     end
   end

data/lib/panoptes/client/projects.rb

@@ -10,7 +10,7 @@ module Panoptes
         params = {}
         params[:search] = search if search
 
-        paginate("/projects", params)["projects"]
+        panoptes.paginate("/projects", params)["projects"]
       end
 
       # Starts a background process to generate a new CSV export of all the classifications in the project.
@@ -19,7 +19,7 @@ module Panoptes
       # @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: []}}}
-        post("/projects/#{project_id}/classifications_export", params)["media"].first
+        panoptes.post("/projects/#{project_id}/classifications_export", params)["media"].first
       end
 
       # Starts a background process to generate a new CSV export of all the subjects in the project.
@@ -28,7 +28,7 @@ module Panoptes
       # @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: []}}}
-        post("/projects/#{project_id}/subjects_export", params)["media"].first
+        panoptes.post("/projects/#{project_id}/subjects_export", params)["media"].first
       end
 
       # Starts a background process to generate a new CSV export of all the workflows in the project.
@@ -37,7 +37,7 @@ module Panoptes
       # @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: []}}}
-        post("/projects/#{project_id}/workflows_export", params)["media"].first
+        panoptes.post("/projects/#{project_id}/workflows_export", params)["media"].first
       end
 
       # Starts a background process to generate a new CSV export of all the workflow_contents in the project.
@@ -46,7 +46,7 @@ module Panoptes
       # @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: []}}}
-        post("/projects/#{project_id}/workflow_contents_export", params)["media"].first
+        panoptes.post("/projects/#{project_id}/workflow_contents_export", params)["media"].first
       end
 
       # Starts a background process to generate a new CSV export of the aggretation results of the project.
@@ -55,7 +55,7 @@ module Panoptes
       # @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: []}}}
-        post("/projects/#{project_id}/aggregations_export", params)["media"].first
+        panoptes.post("/projects/#{project_id}/aggregations_export", params)["media"].first
       end
     end
   end

data/lib/panoptes/client/subject_sets.rb

@@ -2,25 +2,25 @@ module Panoptes
   class Client
     module SubjectSets
       def subject_set(subject_set_id)
-        response = get("/subject_sets/#{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 }
       end
 
       def create_subject_set(attributes)
-        response = post("/subject_sets", subject_sets: attributes)
+        response = panoptes.post("/subject_sets", subject_sets: attributes)
         response.fetch("subject_sets").first
       end
 
       def update_subject_set(subject_set_id, attributes)
-        response = conn.get("/api/subject_sets/#{subject_set_id}")
+        response = panoptes.connection.get("/api/subject_sets/#{subject_set_id}")
         etag = response.headers["ETag"]
 
-        response = put("/subject_sets/#{subject_set_id}", {subject_sets: attributes}, etag: etag)
+        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)
-        response = post("/subject_sets/#{subject_set_id}/links/subjects", subjects: subject_ids)
+        response = panoptes.post("/subject_sets/#{subject_set_id}/links/subjects", subjects: subject_ids)
         true
       end
     end

data/lib/panoptes/client/subjects.rb

@@ -9,7 +9,7 @@ module Panoptes
         query = {}
         query[:subject_set_id] = subject_set_id
 
-        response = get("/subjects", query)
+        response = panoptes.get("/subjects", query)
         response.fetch("subjects")
       end
 
@@ -20,7 +20,7 @@ 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)
-        post("/workflows/#{workflow_id}/retired_subjects", {
+        panoptes.post("/workflows/#{workflow_id}/retired_subjects", {
           admin: true,
           subject_id: subject_id,
           retirement_reason: reason

data/lib/panoptes/client/user_groups.rb

@@ -7,31 +7,31 @@ 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)
-        post("/user_groups", user_groups: {
+        panoptes.post("/user_groups", user_groups: {
           name: name
         })["user_groups"][0]
       end
 
       def user_groups
-        get("/user_groups")["user_groups"]
+        panoptes.get("/user_groups")["user_groups"]
       end
 
       def join_user_group(user_group_id, user_id, join_token:)
-        post("/memberships", memberships: {
+        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)
-        delete("/user_groups/#{user_group_id}/links/users/#{user_id}")
+        panoptes.delete("/user_groups/#{user_group_id}/links/users/#{user_id}")
       end
 
       def delete_user_group(user_group_id)
-        response = conn.get("/api/user_groups/#{user_group_id}")
+        response = panoptes.connection.get("/api/user_groups/#{user_group_id}")
         etag = response.headers["ETag"]
 
-        delete("/user_groups/#{user_group_id}", {}, etag: etag)
+        panoptes.delete("/user_groups/#{user_group_id}", {}, etag: etag)
       end
     end
   end

data/lib/panoptes/client/version.rb

@@ -1,5 +1,5 @@
 module Panoptes
   class Client
-    VERSION = "0.2.7"
+    VERSION = "0.2.8".freeze
   end
 end

data/lib/panoptes/client/workflows.rb

@@ -2,12 +2,12 @@ module Panoptes
   class Client
     module Workflows
       def workflow(workflow_id)
-        response = get("/workflows/#{workflow_id}")
+        response = panoptes.get("/workflows/#{workflow_id}")
         response.fetch("workflows").find {|i| i.fetch("id").to_s == workflow_id.to_s }
       end
 
       def create_workflow(attributes)
-        response = post("/workflows", workflows: attributes)
+        response = panoptes.post("/workflows", workflows: attributes)
         response.fetch("workflows").first
       end
     end

data/lib/panoptes/endpoints/base_endpoint.rb

@@ -0,0 +1,102 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/panoptes'
+
+module Panoptes
+  module Endpoints
+    class BaseEndpoint
+      attr_reader :auth, :url, :prefix
+
+      # @param auth [Hash<token: String, client_id: String, client_secret: String>] Authentication details
+      #   * either nothing,
+      #   * a hash with +:token+ (an existing OAuth user token),
+      #   * or a hash with +:client_id+ and +:client_secret+
+      #     (a keypair for an OAuth Application).
+      # @param url [String] API location to use.
+      # @param prefix [String] An optional API url prefix
+      # @yield Allows an optional block to configure the faraday connection
+      # @yieldparam faraday [Faraday::Connection] The faraday connection
+      def initialize(auth: {}, url: nil, prefix: nil, &config)
+        @auth = auth
+        @url = url
+        @prefix = prefix
+        @config = config
+      end
+
+      def connection
+        @connection ||= Faraday.new(url) do |faraday|
+          auth_request faraday, auth
+          configure faraday
+        end
+      end
+
+      def get(path, query = {})
+        request :get, path, query
+      end
+
+      def post(path, body = {})
+        request :post, path, body
+      end
+
+      def put(path, body = {}, etag: nil)
+        request :put, path, body, etag_header(etag)
+      end
+
+      def patch(path, body = {}, etag: nil)
+        request :patch, path, body, etag_header(etag)
+      end
+
+      def delete(path, query = {}, etag: nil)
+        request :delete, path, query, etag_header(etag)
+      end
+
+      def etag_header(etag)
+        {}.tap do |headers|
+          headers['If-Match'] = etag if etag
+        end
+      end
+
+      def request(method, path, *args)
+        path = "#{prefix}/#{path}" if prefix
+        handle_response connection.send(method, path, *args)
+      end
+
+      def handle_response(response)
+        case response.status
+        when 404
+          raise ResourceNotFound, status: response.status, body: response.body
+        when 400..600
+          raise ServerError.new, response.body
+        else
+          response.body
+        end
+      end
+
+      protected
+
+      def configure(faraday)
+        if @config
+          @config.call faraday
+        else
+          faraday.request :panoptes_api_v1
+          faraday.request :json
+          faraday.response :json
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+
+      def auth_request(faraday, auth)
+        if auth[:token]
+          faraday.request :panoptes_access_token,
+                          url: url,
+                          access_token: auth[:token]
+        elsif auth[:client_id] && auth[:client_secret]
+          faraday.request :panoptes_client_credentials,
+                          url: url,
+                          client_id: auth[:client_id],
+                          client_secret: auth[:client_secret]
+        end
+      end
+    end
+  end
+end

data/lib/panoptes/endpoints/json_api_endpoint.rb

@@ -0,0 +1,26 @@
+require_relative 'base_endpoint'
+
+module Panoptes
+  module Endpoints
+    class JsonApiEndpoint < BaseEndpoint
+      # Get a path and perform automatic depagination
+      def paginate(path, query, resource: nil)
+        resource = path.split('/').last if resource.nil?
+        data = last_response = get(path, query)
+
+        while next_path = last_response['meta'][resource]['next_href']
+          last_response = get(next_path, query)
+          if block_given?
+            yield data, last_response
+          else
+            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
+
+        data
+      end
+    end
+  end
+end

data/lib/panoptes/endpoints/json_endpoint.rb

@@ -0,0 +1,18 @@
+require_relative 'base_endpoint'
+
+module Panoptes
+  module Endpoints
+    class JsonEndpoint < BaseEndpoint
+      # Automatically configured connection to use JSON requests/responses
+      # @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
+          faraday.request :json
+          faraday.response :json
+          faraday.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/panoptes/session.rb

@@ -0,0 +1,6 @@
+module Panoptes
+  class Session
+    def initialize(auth)
+    end
+  end
+end

data/lib/panoptes/talk_client.rb

@@ -1,25 +1,5 @@
-require "panoptes/concerns/common_client"
-require "panoptes/client/discussions"
-
 module Panoptes
-  class TalkClient
-    include Panoptes::CommonClient
-    include Panoptes::Client::Discussions
-
-    # @param auth [Hash] Authentication details
-    #   * either nothing,
-    #   * a hash with +:token+ (an existing OAuth user token),
-    #   * or a hash with +:client_id+ and +:client_secret+ (a keypair for an OAuth Application).
-    # A client is the main interface to the talk v2 API.
-    # @param url [String] Optional override for the API location to use. Defaults to the official talk api production environment.
-    # @param auth_url [String] Optional override for the auth API location to use. Defaults to the official api production environment.
-    def initialize(auth: {}, url: PROD_TALK_API_URL, auth_url: PROD_API_URL)
-      super(auth: auth, url: url, auth_url: auth_url)
-    end
-
-    def get(path, query = {})
-      response = conn.get(path, query)
-      handle_response(response)
-    end
+  # Backwards compat
+  class TalkClient < Client
   end
 end

data/panoptes-client.gemspec

@@ -20,9 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday"
   spec.add_dependency "faraday-panoptes", "~> 0.2.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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panoptes-client
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +130,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".ruby-style.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -112,8 +142,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- data/doorkeeper-jwt-production.pub
+- data/doorkeeper-jwt-staging.pub
 - lib/panoptes-client.rb
 - lib/panoptes/client.rb
+- lib/panoptes/client/cellect.rb
+- lib/panoptes/client/comments.rb
 - lib/panoptes/client/discussions.rb
 - lib/panoptes/client/me.rb
 - lib/panoptes/client/projects.rb
@@ -122,7 +156,10 @@ files:
 - lib/panoptes/client/user_groups.rb
 - lib/panoptes/client/version.rb
 - lib/panoptes/client/workflows.rb
-- lib/panoptes/concerns/common_client.rb
+- lib/panoptes/endpoints/base_endpoint.rb
+- lib/panoptes/endpoints/json_api_endpoint.rb
+- lib/panoptes/endpoints/json_endpoint.rb
+- lib/panoptes/session.rb
 - lib/panoptes/talk_client.rb
 - panoptes-client.gemspec
 homepage: https://github.com/zooniverse/panoptes-client.rb

data/lib/panoptes/concerns/common_client.rb

@@ -1,77 +0,0 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday/panoptes'
-
-require "panoptes/client/version"
-
-module Panoptes
-  module CommonClient
-    PROD_API_URL = "https://panoptes.zooniverse.org".freeze
-    PROD_TALK_API_URL = "https://talk.zooniverse.org".freeze
-
-    # A client is the main interface to the API.
-    #
-    # @param auth [Hash] Authentication details
-    #   * either nothing,
-    #   * a hash with +:token+ (an existing OAuth user token),
-    #   * or a hash with +:client_id+ and +:client_secret+ (a keypair for an OAuth Application).
-    # @param url [String] API location to use.
-    # @param auth_url [String] Auth API location to use.
-    def initialize(auth: {}, url: PROD_API_URL, auth_url: PROD_API_URL)
-      @conn = Faraday.new(url: url) do |faraday|
-        case
-        when auth[:token]
-          faraday.request :panoptes_access_token,
-            url: auth_url,
-            access_token: auth[:token]
-        when auth[:client_id] && auth[:client_secret]
-          faraday.request :panoptes_client_credentials,
-            url: auth_url,
-            client_id: auth[:client_id],
-            client_secret: auth[:client_secret]
-        end
-
-        faraday.request :panoptes_api_v1
-        faraday.request :json
-        faraday.response :json
-        faraday.adapter Faraday.default_adapter
-      end
-    end
-
-    # Get a path and perform automatic depagination
-    def paginate(path, query, resource: nil)
-      resource = path.split("/").last if resource.nil?
-      data = last_response = get(path, query)
-
-      while next_path = last_response["meta"][resource]["next_href"]
-        last_response = get(next_path, query)
-        if block_given?
-          yield data, last_response
-        else
-          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
-
-      data
-    end
-
-    private
-
-    def conn
-      @conn
-    end
-
-    def handle_response(response)
-      case response.status
-      when 404
-        raise ResourceNotFound, status: response.status, body: response.body
-      when 400..600
-        raise ServerError.new(response.body)
-      else
-        response.body
-      end
-    end
-  end
-end