panoptes-client 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96fa7b8f5e137b8dc426c6f119587471fcc9189
-  data.tar.gz: 41794d9a41090bf7fc1c3d87ef8e46ffadd5e0fe
+  metadata.gz: 8dc546adb36b049e8da428336c52673a0d9f983d
+  data.tar.gz: 85649db5d4650c8d9f92dffd5a23ab85ff8db1f4
 SHA512:
-  metadata.gz: fa3d24cb731c90c486c313c46c33d0ae4f8ba833e995c6515bfd1035e9477cc358ae4002d7380d6bf2d7060bcd13b02706fda799982196f5cddda5d3524ebf40
-  data.tar.gz: ccae89f05b4129fac56897aa0a823d9d23e4e2670629d7b24ad3dad3de9c709becfda07b2829eb46f3152a71a04e4c49ba2d16ec62b8c3836bfc979f1e88cf29
+  metadata.gz: 60f2d4972099ce2d3273a4b4da5cfe1941b6d0f62c86d7fa390cf8db304c7a23971886289f1fea5e9d0d0e93ab8723d2b7cd045dda2e652b5ea9c544bfa98663
+  data.tar.gz: ade3768a597807f6fff9fd9636ff892f6c21f86b45c792d83cf6d8310d0038a253b32a3fa09477490825e7ce89734d0495a1994849311429cadf5c88e490229b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.7
+
+* Add `TalkClient` to interact with the talk api.
+* Add `client.discussions` to fetch talk discussions for a focus object.
+* Refactored the client connection code for re-use between talk and panoptes clients.
+
 # 0.2.6
 
 * Add `client.workflow` to fetch a specific workflow.

data/lib/panoptes-client.rb

@@ -1 +1,2 @@
 require 'panoptes/client'
+require 'panoptes/talk_client'

data/lib/panoptes/client.rb

@@ -1,8 +1,4 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday/panoptes'
-
-require "panoptes/client/version"
+require "panoptes/concerns/common_client"
 require "panoptes/client/me"
 require "panoptes/client/projects"
 require "panoptes/client/subjects"
@@ -17,6 +13,7 @@ module Panoptes
     class ResourceNotFound < GenericError; end
     class ServerError < GenericError; end
 
+    include Panoptes::CommonClient
     include Panoptes::Client::Me
     include Panoptes::Client::Projects
     include Panoptes::Client::Subjects
@@ -24,29 +21,6 @@ module Panoptes
     include Panoptes::Client::UserGroups
     include Panoptes::Client::Workflows
 
-    # 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] Optional override for the API location to use. Defaults to the official production environment.
-    def initialize(auth: {}, url: "https://panoptes.zooniverse.org")
-      @conn = Faraday.new(url: url) do |faraday|
-        case
-        when auth[:token]
-          faraday.request :panoptes_access_token, url: url, access_token: auth[:token]
-        when auth[:client_id] && auth[:client_secret]
-          faraday.request :panoptes_client_credentials, url: 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
-
     def get(path, query = {})
       response = conn.get("/api" + path, query)
       handle_response(response)

data/lib/panoptes/client/discussions.rb

@@ -0,0 +1,19 @@
+module Panoptes
+  class Client
+    module Discussions
+      # Get list of talk discussions
+      #
+      # @param focus_id [Integer] filter by focussable id
+      # @param focus_type [String] filter by focussable type
+      # @return list of discussions
+      def discussions(focus_id:, focus_type:)
+        query = {}
+        query[:focus_id] = focus_id
+        query[:focus_type] = focus_type
+
+        response = get("/discussions", query)
+        response.fetch("discussions")
+      end
+    end
+  end
+end

data/lib/panoptes/client/version.rb

@@ -1,5 +1,5 @@
 module Panoptes
   class Client
-    VERSION = "0.2.6"
+    VERSION = "0.2.7"
   end
 end

data/lib/panoptes/concerns/common_client.rb

@@ -0,0 +1,77 @@
+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

data/lib/panoptes/talk_client.rb

@@ -0,0 +1,25 @@
+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
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panoptes-client
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -114,6 +114,7 @@ files:
 - bin/setup
 - lib/panoptes-client.rb
 - lib/panoptes/client.rb
+- lib/panoptes/client/discussions.rb
 - lib/panoptes/client/me.rb
 - lib/panoptes/client/projects.rb
 - lib/panoptes/client/subject_sets.rb
@@ -121,6 +122,8 @@ 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/talk_client.rb
 - panoptes-client.gemspec
 homepage: https://github.com/zooniverse/panoptes-client.rb
 licenses:
@@ -142,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: API wrapper for https://panoptes.zooniverse.org