panoptes-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e14cb30ccee15fa76cda0c518922656836d0d93b
-  data.tar.gz: 1a3f10411d2b2af8d5fe6fc59bdee1530ff710dd
+  metadata.gz: 5b5b3c142ba8e87d827573a68e823684e2314893
+  data.tar.gz: 6540b9be36075308a0880ea4c4aad04f8bc894c0
 SHA512:
-  metadata.gz: 10f646ab177e8b1aba85325d257663c5511dde849f64e007bbddb8690456cce219372bd7d79603edf24a2779bce1ed430fd6cbad44b7eb88d983458e611e28b1
-  data.tar.gz: 90b6210095edf89c56eb0d68a3b7d5548d38f62012641f77f7eae61114e1c0048a37020b9881294f682484683956a0c3cb28cf10e64b6f4dd9b5f21864044976
+  metadata.gz: 40a3849e1e980634d7e53e7d307692b68db87a0de96fb613b403ed24924ce9fc8760c04fe5ada8ed47690012a5f4f26e874098788bb70afa0f9c149cefeefe9e
+  data.tar.gz: d4b003226c3dfc8d80426ecf57be03f5d4d5a74d6e988a58f9a90a4e58365957bb823d54f83fa07b35ddce314e905925d4056961d89cd6a4f6472a4b1df2fe41

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.1.1
+
+* Added wrapper file so Bundler's automatic require works.
+
+# 0.1.0
+
+* Initial release. Supports only a small amount of API calls (apart from the generic get/post calls).

data/README.md

@@ -1,34 +1,34 @@
 # Panoptes::Client
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/panoptes/client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[![Build Status](https://travis-ci.org/zooniverse/panoptes-client.rb.svg?branch=master)](https://travis-ci.org/zooniverse/panoptes-client.rb)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/zooniverse/panoptes-client.rb/)
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'panoptes-client'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+## Usage
 
-    $ gem install 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.
 
-## Usage
+**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`.**
 
-TODO: Write usage instructions here
 
 ## 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 |
+-----------------------------|-------|
+| `ZOONIVERSE_CLIENT_ID`     | The application id |
+| `ZOONIVERSE_CLIENT_SECRET` | The application secret |
+| `ZOONIVERSE_ACCESS_TOKEN`  | An OAuth access token for the API |
+
+We recommend [Direnv](https://github.com/direnv/direnv) as good utility to allow you to specify environment variables per directory.
 
 ## Contributing
 

data/Rakefile

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

data/lib/panoptes-client.rb

@@ -0,0 +1 @@
+require 'panoptes/client'

data/lib/panoptes/client.rb

@@ -15,6 +15,13 @@ module Panoptes
     include Panoptes::Client::Subjects
     include Panoptes::Client::UserGroups
 
+    # 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
@@ -40,12 +47,12 @@ module Panoptes
     end
 
     # Get a path and perform automatic depagination
-    def paginate(path, resource: nil)
+    def paginate(path, query, resource: nil)
       resource = path.split("/").last if resource.nil?
-      data = last_response = get(path)
+      data = last_response = get(path, query)
 
       while next_path = last_response["meta"][resource]["next_href"]
-        last_response = get(next_path)
+        last_response = get(next_path, query)
         if block_given?
           yield data, last_response
         else

data/lib/panoptes/client/projects.rb

@@ -1,11 +1,16 @@
 module Panoptes
   class Client
     module Projects
+      # Fetches the list of all projects.
+      #
+      # @see http://docs.panoptes.apiary.io/#reference/projects/project-collection/list-all-projects
+      # @param search [String] filter projects using full-text search on names (amongst others)
+      # @return [Array] the list of projects
       def projects(search: nil)
         params = {}
         params[:search] = search if search
 
-        get("/projects", params)["projects"]
+        paginate("/projects", params)["projects"]
       end
     end
   end

data/lib/panoptes/client/subjects.rb

@@ -1,6 +1,12 @@
 module Panoptes
   class Client
     module Subjects
+      # Retire a subject for a workflow
+      #
+      # @todo Add this endpoint to the Apiary docs and add a see-reference here.
+      # @param workflow_id [Integer] the ID of a workflow
+      # @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)
         post("/workflows/#{workflow_id}/retired_subjects", {
           admin: true,

data/lib/panoptes/client/user_groups.rb

@@ -1,6 +1,11 @@
 module Panoptes
   class Client
     module UserGroups
+      # Creates a new user group and puts the current user in it as the initial member.
+      #
+      # @see http://docs.panoptes.apiary.io/#reference/user-group/usergroup-collection/create-a-user-group
+      # @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: {
           name: name

data/lib/panoptes/client/version.rb

@@ -1,5 +1,5 @@
 module Panoptes
   class Client
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/panoptes-client.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   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 "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panoptes-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - marten@veldthuis.com
@@ -90,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -97,6 +112,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/panoptes-client.rb
 - lib/panoptes/client.rb
 - lib/panoptes/client/me.rb
 - lib/panoptes/client/projects.rb
@@ -129,3 +145,4 @@ signing_key:
 specification_version: 4
 summary: API wrapper for https://panoptes.zooniverse.org
 test_files: []
+has_rdoc: