faraday-panoptes 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9b626bfae3343ec615dfd0dfc13a024655d2635
-  data.tar.gz: 8ef9c0f1c59c4aaaeb88e0609ff89295b4c621b0
+SHA256:
+  metadata.gz: 077ad6c0c7d63af21648067c7e831ca6466883168bf8436b68cf83e9aa49a56c
+  data.tar.gz: ed0af98fc264667e80d0312719ef9c5add62179226437caa21e9f68d8f4dcb89
 SHA512:
-  metadata.gz: 4de3a792e8e88f01feee12262538759732053b02173b9227886e87f1e2937a293b894286362fa16d86e97d4e99884bb49cbb87d9385e2169e9dd0ba8dd1396a3
-  data.tar.gz: cc29dc5309c8806b177b3136f7466ccccb3a30b87978ee4ed7855427a83c558b10a3b18eb7b38a8c4e90b3b7ed12679d9820fbf87be67516df8bf2e05839f101
+  metadata.gz: d37c4d84ff2d20861c080e252c4abede36aeb1bf3282e111bd34266f196a0491e092a90d094e14c1c54e976e4ed6b7de5d801f9a7e533de3262f69f60516af2f
+  data.tar.gz: 671fe25d112f6a5dc73b92150238f522a6727ea492808ac27858cef0e3c4ce6e256ef9260a6be77d0cff269673727f8c409d51dbc7fc188a517615db88d644bf

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 0.2.0
+
+* Provides Faraday middleware which just sets the OAuth access token in the correct header
+
+# 0.1.0
+
+* Initial release.
+* Provides Faraday middleware which will request access tokens using application key/secret and refresh them when needed.
+* Provides Faraday middleware which will set correct headers for version 1 of the API.

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.7-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get -y upgrade && \
+    apt-get install --no-install-recommends -y \
+      build-essential \
+      # git is required for installing gems
+      git && \
+      apt-get clean && rm -rf /var/lib/apt/lists/*
+
+ADD ./Gemfile /app/
+ADD ./faraday-panoptes.gemspec /app/
+ADD ./ /app
+
+# ensure we use a newer version of rubygems / bundler
+RUN gem update --system
+
+RUN bundle config --global jobs `cat /proc/cpuinfo | grep processor | wc -l | xargs -I % expr % - 1`
+RUN bundle install

data/README.md

@@ -7,6 +7,8 @@ api_client = Faraday.new(url: "https://panoptes.zooniverse.org") do |faraday|
   faraday.request :panoptes_client_credentials, url: 'https://panoptes.zooniverse.org', client_id: 'APPLICATION_ID', client_secret: 'APPLICATION_SECRET'
   faraday.request :panoptes_api_v1
   faraday.response :json
+
+  faraday.adapter Faraday.default_adapter # WITHOUT THIS LINE NOTHING WILL HAPPEN
 end
 
 response = api_client.get("/api/projects/1")
@@ -33,10 +35,22 @@ Or install it yourself as:
 
 ## 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 `bundle exec rspec` 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).
 
+Use docker & compose to setup the dev env
+
+```shell
+$ docker-compose build
+```
+
+Run a bash shell inside the new container
+
+```shell
+$ docker-compose run --service-ports --rm faraday-panoptes bash
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/faraday-panoptes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/Rakefile

@@ -1,10 +1 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default => :test

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  faraday-panoptes:
+    build:
+      context: .
+    volumes:
+      - ./:/app
+      - gem_cache:/usr/local/bundle
+
+volumes:
+  gem_cache:

data/faraday-panoptes.gemspec

@@ -19,11 +19,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'faraday_middleware', '~> 0.10'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "openssl"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "jwt"
 end

data/lib/faraday/panoptes/access_token_authentication.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Faraday
+  module Panoptes
+    class AccessTokenAuthentication < Faraday::Middleware
+      dependency do
+        require 'json' unless defined?(::JSON)
+      end
+
+      def initialize(app, url:, access_token:)
+        super(app)
+        @access_token = access_token
+      end
+
+      def call(env)
+        env[:request_headers]["Authorization"] = authorization_header
+        @app.call(env)
+      end
+
+      def authorization_header
+        "Bearer #{access_token}"
+      end
+
+      def access_token
+        @access_token
+      end
+    end
+  end
+end

data/lib/faraday/panoptes/client_credentials_authentication.rb

@@ -3,6 +3,10 @@ require 'faraday_middleware'
 
 module Faraday
   module Panoptes
+
+    class CredentialsOAuthError < StandardError
+    end
+
     class ClientCredentialsAuthentication < Faraday::Middleware
       dependency do
         require 'json' unless defined?(::JSON)
@@ -13,6 +17,7 @@ module Faraday
         @client_id = client_id
         @client_secret = client_secret
         @conn = Faraday.new(url: url)
+        @current_token = nil
       end
 
       def call(env)
@@ -45,6 +50,8 @@ module Faraday
           grant_type: 'client_credentials',
           client_id: @client_id,
           client_secret: @client_secret)
+
+        raise CredentialsOAuthError.new "Failed to obtain access token" if result.status == 401 or result.status == 422 or result.body.empty?
         JSON.parse(result.body)
       end
     end

data/lib/faraday/panoptes/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Panoptes
-    VERSION = "0.1.0"
+    VERSION = "0.4.0"
   end
 end

data/lib/faraday/panoptes.rb

@@ -1,10 +1,12 @@
 require "faraday/panoptes/version"
 require 'faraday/panoptes/api_v1'
+require 'faraday/panoptes/access_token_authentication'
 require 'faraday/panoptes/client_credentials_authentication'
 
 module Faraday
   module Panoptes
     Faraday::Request.register_middleware \
+      panoptes_access_token: lambda { AccessTokenAuthentication },
       panoptes_client_credentials: lambda { ClientCredentialsAuthentication },
       panoptes_api_v1: lambda { ApiV1 }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-panoptes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marten Veldthuis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,58 +16,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   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: '10.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,17 +158,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/run_tests_CI.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - faraday-panoptes.gemspec
 - lib/faraday/panoptes.rb
+- lib/faraday/panoptes/access_token_authentication.rb
 - lib/faraday/panoptes/api_v1.rb
 - lib/faraday/panoptes/client_credentials_authentication.rb
 - lib/faraday/panoptes/version.rb
@@ -120,7 +181,7 @@ homepage: https://github.com/zooniverse/faraday-panoptes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,10 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Faraday middleware for talking to the Panoptes API
 test_files: []
-has_rdoc: 

data/.travis.yml

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