panoptes-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e14cb30ccee15fa76cda0c518922656836d0d93b
+  data.tar.gz: 1a3f10411d2b2af8d5fe6fc59bdee1530ff710dd
+SHA512:
+  metadata.gz: 10f646ab177e8b1aba85325d257663c5511dde849f64e007bbddb8690456cce219372bd7d79603edf24a2779bce1ed430fd6cbad44b7eb88d983458e611e28b1
+  data.tar.gz: 90b6210095edf89c56eb0d68a3b7d5548d38f62012641f77f7eae61114e1c0048a37020b9881294f682484683956a0c3cb28cf10e64b6f4dd9b5f21864044976

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.envrc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at marten@veldthuis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in panoptes-client.gemspec
+gemspec
+
+gem 'pry'
+
+group :test do
+  gem 'vcr'
+  gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Zooniverse
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'panoptes-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install panoptes-client
+
+## Usage
+
+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).
+
+## Contributing
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/panoptes/client.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/panoptes'
+
+require "panoptes/client/version"
+require "panoptes/client/me"
+require "panoptes/client/projects"
+require "panoptes/client/subjects"
+require "panoptes/client/user_groups"
+
+module Panoptes
+  class Client
+    include Panoptes::Client::Me
+    include Panoptes::Client::Projects
+    include Panoptes::Client::Subjects
+    include Panoptes::Client::UserGroups
+
+    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: token
+        when auth[:client_id] && auth[:client_secret]
+          faraday.request :panoptes_client_credentials, url: url, client_id: client_id, client_secret: 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 = {})
+      conn.get("/api" + path, query).body
+    end
+
+    def post(path, body = {})
+      conn.post("/api" + path, body).body
+    end
+
+    # Get a path and perform automatic depagination
+    def paginate(path, resource: nil)
+      resource = path.split("/").last if resource.nil?
+      data = last_response = get(path)
+
+      while next_path = last_response["meta"][resource]["next_href"]
+        last_response = get(next_path)
+        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
+  end
+end

data/lib/panoptes/client/me.rb

@@ -0,0 +1,9 @@
+module Panoptes
+  class Client
+    module Me
+      def me
+        get("/me")["users"][0]
+      end
+    end
+  end
+end

data/lib/panoptes/client/projects.rb

@@ -0,0 +1,12 @@
+module Panoptes
+  class Client
+    module Projects
+      def projects(search: nil)
+        params = {}
+        params[:search] = search if search
+
+        get("/projects", params)["projects"]
+      end
+    end
+  end
+end

data/lib/panoptes/client/subjects.rb

@@ -0,0 +1,12 @@
+module Panoptes
+  class Client
+    module Subjects
+      def retire_subject(workflow_id, subject_id)
+        post("/workflows/#{workflow_id}/retired_subjects", {
+          admin: true,
+          subject_id: subject_id
+        })
+      end
+    end
+  end
+end

data/lib/panoptes/client/user_groups.rb

@@ -0,0 +1,11 @@
+module Panoptes
+  class Client
+    module UserGroups
+      def create_user_group(name)
+        post("/user_groups", user_groups: {
+          name: name
+        })["user_groups"][0]
+      end
+    end
+  end
+end

data/lib/panoptes/client/version.rb

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

data/panoptes-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'panoptes/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "panoptes-client"
+  spec.version       = Panoptes::Client::VERSION
+  spec.authors       = ["Marten Veldthuis"]
+  spec.email         = ["marten@veldthuis.com"]
+
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday-panoptes", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: panoptes-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marten Veldthuis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-panoptes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- marten@veldthuis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/panoptes/client.rb
+- lib/panoptes/client/me.rb
+- lib/panoptes/client/projects.rb
+- lib/panoptes/client/subjects.rb
+- lib/panoptes/client/user_groups.rb
+- lib/panoptes/client/version.rb
+- panoptes-client.gemspec
+homepage: https://github.com/zooniverse/panoptes-client.rb
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: API wrapper for https://panoptes.zooniverse.org
+test_files: []