panoptes-client 0.3.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e752ecee4ee1efa079e7f52cb213e084278edd61
-  data.tar.gz: 2bee1af072eba3bb0416c1f2ae04abb6b5429673
+  metadata.gz: 738ea26bbdcac1cfd64a537f11210c5dbce0fb18
+  data.tar.gz: 03143cbb89f128160b9659f744572d1bfa05986c
 SHA512:
-  metadata.gz: 95513c729ebbed6c985e3ee77b37842583ce1f55bcb1ac749eb7aad5c833444144d64f71d05aa8e8664d1ff1d8514a26b0616f7e33397cfbe39d769db279c0a7
-  data.tar.gz: 3f0639d4f6a50583680efac192eb6287968277a64626c062a2f5324704c2e34c410cc8ce8e5f3b46ba09d054ae6c17d51b3560a85ed85c56f96e22f63938278f
+  metadata.gz: 8570661b211f00b0f20ab1b076ab1c033d467c89a495e8b4062081e4c6eb246b57555c76ba449d5e16c08b1674b28a778740f11dbb88ec011f15e803c82e0e4a
+  data.tar.gz: fd0d5ebb58e5521b884abbe5723e2a09c6c69603f829d38b74e6f43fa40750662b646765edd37945f7e88b0f730ef7e45172ee7d53df4e890f7a3c7fd33b04c9

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.4.0
+
+* Additional methods for interacting with JWT
+* Refactored all authentication code into separate module
+
 # 0.3.8
 
 * Add client.subject(subject_id, *kwargs)

data/Gemfile

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

data/lib/panoptes/client.rb

@@ -1,6 +1,7 @@
 require 'panoptes/endpoints/json_api_endpoint'
 require 'panoptes/endpoints/json_endpoint'
 
+require 'panoptes/client/authentication'
 require 'panoptes/client/cellect'
 require 'panoptes/client/classifications'
 require 'panoptes/client/collections'
@@ -21,6 +22,7 @@ module Panoptes
     include Panoptes::Client::Me
 
     # Panoptes
+    include Panoptes::Client::Authentication
     include Panoptes::Client::Classifications
     include Panoptes::Client::Collections
     include Panoptes::Client::Projects
@@ -43,6 +45,7 @@ module Panoptes
     class ResourceNotFound < GenericError; end
     class ServerError < GenericError; end
     class NotLoggedIn < GenericError; end
+    class AuthenticationExpired < GenericError; end
 
     attr_reader :env, :auth, :panoptes, :talk, :cellect
 
@@ -61,28 +64,6 @@ module Panoptes
       )
     end
 
-    def current_user
-      raise NotLoggedIn unless @auth[:token]
-
-      payload, = JWT.decode @auth[:token], jwt_signing_public_key, algorithm: 'RS512'
-      payload.fetch('data')
-    end
-
-    def jwt_signing_public_key
-      @jwt_signing_public_key ||= OpenSSL::PKey::RSA.new(File.read(@public_key_path))
-    end
-
-    def public_key_for_env(env)
-      case env.to_s
-      when "staging"
-        File.expand_path(File.join("..", "..", "..", "data", "doorkeeper-jwt-staging.pub"), __FILE__)
-      when "production"
-        File.expand_path(File.join("..", "..", "..", "data", "doorkeeper-jwt-production.pub"), __FILE__)
-      else
-        nil
-      end
-    end
-
     def panoptes_url
       case env
       when :production, 'production'.freeze

data/lib/panoptes/client/authentication.rb

@@ -0,0 +1,86 @@
+require 'deprecate'
+
+module Panoptes
+  class Client
+    module Authentication
+      extend Gem::Deprecate
+
+      def jwt_payload
+        raise NotLoggedIn unless @auth[:token]
+        payload, = decode_token(@auth[:token])
+        payload
+      rescue JWT::ExpiredSignature
+        raise AuthenticationExpired
+      end
+
+      def token_contents
+        if !@payload.nil? && expiry_from_payload(@payload) > Time.now.utc
+          @payload.fetch('data', {})
+        elsif @payload.nil?
+          @payload = jwt_payload
+          @expires_at = expiry_from_payload(@payload)
+          @payload.fetch('data', ())
+        else
+          raise AuthenticationExpired
+        end
+      end
+
+      def token_expiry
+        @expires_at || expiry_from_payload(jwt_payload)
+      end
+
+      def authenticated?
+        !!token_contents['id']
+      end
+
+      def authenticated_user_login
+        raise NotLoggedIn unless authenticated?
+        token_contents.fetch('login', nil)
+      end
+
+      def authenticated_user_display_name
+        raise NotLoggedIn unless authenticated?
+        token_contents.fetch('dname', nil)
+      end
+
+      def authenticated_user_id
+        raise NotLoggedIn unless authenticated?
+        token_contents.fetch('id')
+      end
+
+      def authenticated_admin?
+        raise NotLoggedIn unless authenticated?
+        token_contents.fetch('admin', false)
+      end
+
+      def current_user
+        token_contents
+      end
+      deprecate :current_user, :token_contents, 2019, 7
+
+      def jwt_signing_public_key
+        @jwt_signing_public_key ||= OpenSSL::PKey::RSA.new(File.read(@public_key_path))
+      end
+
+      def expiry_from_payload(payload)
+        Time.at(payload.fetch('exp',0)).utc
+      end
+
+      def decode_token(token)
+        payload, = JWT.decode token, jwt_signing_public_key, algorithm: 'RS512'
+        payload
+      end
+
+      def public_key_for_env(env)
+        case env.to_s
+        when "staging"
+          File.expand_path(File.join("..","..", "..", "..", "data", "doorkeeper-jwt-staging.pub"), __FILE__)
+        when "production"
+          File.expand_path(File.join("..","..", "..", "..", "data", "doorkeeper-jwt-production.pub"), __FILE__)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/panoptes/client/comments.rb

@@ -7,7 +7,7 @@ module Panoptes
       # @param focus_type [String] filter by focussable type
       # @return list of discussions
       def create_comment(discussion_id:, body:)
-        user_id = current_user["id"]
+        user_id = token_contents["id"]
         response = talk.post("/comments", comments: {discussion_id: discussion_id, body: body, user_id: user_id})
         response.fetch("comments")[0]
       end

data/lib/panoptes/client/version.rb

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

data/panoptes-client.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "deprecate"
   spec.add_dependency "faraday"
   spec.add_dependency "faraday-panoptes", "~> 0.3.0"
   spec.add_dependency "jwt", "~> 1.5.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panoptes-client
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - Marten Veldthuis
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-21 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: deprecate
+  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
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,7 @@ files:
 - data/doorkeeper-jwt-staging.pub
 - lib/panoptes-client.rb
 - lib/panoptes/client.rb
+- lib/panoptes/client/authentication.rb
 - lib/panoptes/client/cellect.rb
 - lib/panoptes/client/classifications.rb
 - lib/panoptes/client/collections.rb
@@ -195,4 +210,3 @@ signing_key:
 specification_version: 4
 summary: API wrapper for https://panoptes.zooniverse.org
 test_files: []
-has_rdoc: