psu_identity 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7996e867a943731e649e3cf0c2981fd08dd938e24f914bb8a12f1745bf7d605f
-  data.tar.gz: f771b556fb55e71d9ae6d0673e863dbf88fb7a1a173c224640111fa140488c92
+  metadata.gz: 6d739e41da59f566b5b558d4a61f1d12e818634e2f7de1d46ae5bf21622fbe0a
+  data.tar.gz: 6d86921f52e9abed163f3406c5aa916ad54758c0573372cf5edd973c426a5cd9
 SHA512:
-  metadata.gz: 362b2abff2b599aaae062a0b367c8afbd038e6cc7536476ed7ac1a710ae534f90fa25274ff9ebae21ded7c404de669766db274806ae0c7ae31cf3b8d4249adef
-  data.tar.gz: 6105dfa4398b1653a1621a84548f7ed3dee1caad9f05a746364eca6f527616d1beea6fbd9c27d277d38be8fc0e5c4fedf5403cbe0a739e1f9f74e3acd0a43773
+  metadata.gz: f65a3c573798e0d2ce97b5cff55af6fceeba88f87fca788b1cb1a5113e47922e2ee1cd428acee8d32412a890859ddc41198fa7a3fcabf287321fc0b82ad21f52
+  data.tar.gz: 3e6c1af64c775ceb1e4e81410b8d25a9b51c43eb754a260c0f43dacbf993ed5eeb9ba9967b11aff2d8dd92bdd9476c3310411ce446f37731aa0b153732da9b7b

data/.circleci/config.yml

@@ -5,7 +5,7 @@ orbs:
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.6.3-stretch-node
+      - image: cimg/ruby:3.1.3
     executor: ruby/default
     steps:
       - checkout
@@ -14,9 +14,9 @@ jobs:
           command: mkdir ./log
 
       - run:
-          name: "Install Bundler 2.1.4"
+          name: "Install Bundler 2.3.6"
           command: |
-            gem install bundler:2.1.4 &&
+            gem install bundler:2.3.6 &&
             bundle -v
 
       # An orb function for bundling
@@ -35,6 +35,8 @@ jobs:
       - run:
           name: "Rspec"
           command: |
+            export PSU_ID_OAUTH_CLIENT_ID=foo
+            export PSU_ID_OAUTH_CLIENT_SECRET=bar
             RAILS_ENV=test bundle exec rspec &&
             bin/cc-test-reporter format-coverage -t simplecov -o coverage/codeclimate.json coverage/.resultset.json &&
             bin/cc-test-reporter upload-coverage

data/.gitignore

@@ -8,9 +8,10 @@
 /tmp/
 .idea/
 log/
+.envrc
 
 # rspec failure tracking
 .rspec_status
 
 # ignore gem builds
-/psu_identity-*
+/psu_identity-*

data/.rubocop.yml

@@ -9,11 +9,19 @@ inherit_from:
   - .niftany/style.yml
   - .rubocop_todo.yml
 
+require: [rubocop-rspec, rubocop-performance]
+
 AllCops:
   DisplayCopNames: true
   NewCops: enable
 
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'psu_identity.gemspec'
+
+Style/OpenStructUse:
+  Exclude:
+    - 'lib/psu_identity/search_service/atomic_link.rb'
+    - 'spec/lib/psu_identity/search_service/atomic_link_spec.rb'

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+3.1.3

data/Gemfile.lock

@@ -1,16 +1,17 @@
 PATH
   remote: .
   specs:
-    psu_identity (0.3.0)
+    psu_identity (0.5.0)
       faraday (~> 1.0)
       json
+      oauth2
       rake (>= 12.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
@@ -43,10 +44,19 @@ GEM
     faraday-retry (1.0.3)
     hashdiff (1.0.1)
     json (2.5.1)
+    jwt (2.3.0)
     method_source (1.0.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
     multipart-post (2.1.1)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -54,10 +64,11 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
+    public_suffix (5.0.1)
+    rack (2.2.6.4)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -75,32 +86,33 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.22.1)
+    rubocop (1.48.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
-      parser (>= 3.0.1.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
     rubocop-performance (1.11.5)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rspec (2.5.0)
       rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (2.1.0)
-    vcr (6.0.0)
-    webmock (3.14.0)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -109,16 +121,16 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  pry-byebug
+  pry-byebug (~> 3.9)
   psu_identity!
   rspec (~> 3.0)
-  rspec-its
-  rubocop (~> 1.22)
+  rspec-its (~> 1.3)
+  rubocop (~> 1.28)
   rubocop-performance (~> 1.11)
   rubocop-rspec (~> 2.5)
   simplecov (= 0.17)
-  vcr
-  webmock
+  vcr (~> 6.1)
+  webmock (~> 3.18)
 
 BUNDLED WITH
-   2.2.29
+   2.3.6

data/lib/psu_identity/directory_service/client.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'ostruct'
+
+# @abstract Client for querying Penn State's directory-service API: https://directory-service.k8s.psu.edu/directory-service-web/resources
+module PsuIdentity::DirectoryService
+  class Error < StandardError; end
+
+  class NotFound < StandardError; end
+
+  class Client
+    attr_reader :base_url
+
+    # @param [String] base_url
+    def initialize(base_url: '/directory-service-web/resources')
+      @base_url = base_url
+    end
+
+    # @param [Hash] args of options to pass to the endpoint
+    # @option args [String] :userid of the person
+    def userid(userid)
+      process_userid_response connection.get("#{base_url}/people/#{userid}")
+    end
+
+    private
+
+      def process_userid_response(response)
+        raise NotFound if response.status == 404
+
+        raise Error.new(response.body) unless response.success?
+
+        snake_cased_response = JSON.parse(response.body).transform_keys { |str| StringHelpers.underscore(str).to_sym }
+        to_struct = Struct.new(*snake_cased_response.keys)
+        to_struct.new(*snake_cased_response.values)
+      rescue JSON::ParserError
+      end
+
+      def connection
+        @connection ||= Faraday.new(url: endpoint, headers: auth_headers) do |conn|
+          conn.adapter :net_http
+        end
+      end
+
+      def auth_headers
+        { 'Authorization' => "Bearer #{token}" }
+      end
+
+      def token
+        oauth_client = OAuth2::Client.new(client_id,
+                                          client_secret, site: oauth_endpoint,
+                                                         authorize_url: '/oauth/api/authz',
+                                                         token_url: '/oauth/api/token')
+        oauth_token = oauth_client.client_credentials.get_token
+        oauth_token.token
+      end
+
+      def client_id
+        @client_id ||= ENV.fetch('PSU_ID_OAUTH_CLIENT_ID')
+      end
+
+      def client_secret
+        @client_secret ||= ENV.fetch('PSU_ID_OAUTH_CLIENT_SECRET')
+      end
+
+      def oauth_endpoint
+        @oauth_endpoint ||= ENV.fetch('PSU_ID_OAUTH_ENDPOINT', 'https://acceptance-oauth2-server.qa.k8s.psu.edu')
+      end
+
+      def endpoint
+        @endpoint ||= ENV.fetch('DIRECTORY_SERVICE_ENDPOINT', 'https://acceptance-directory-service.qa.k8s.psu.edu')
+      end
+  end
+end

data/lib/psu_identity/string_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module StringHelpers
+  def self.underscore(str)
+    str
+      .to_s
+      .gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
+  end
+end

data/lib/psu_identity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PsuIdentity
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

data/lib/psu_identity.rb

@@ -7,8 +7,10 @@ require 'ostruct'
 module PsuIdentity
   class Error < StandardError; end
 
+  require 'psu_identity/directory_service/client'
   require 'psu_identity/search_service/atomic_link'
   require 'psu_identity/search_service/client'
   require 'psu_identity/search_service/person'
+  require 'psu_identity/string_helpers'
   require 'psu_identity/version'
 end

data/psu_identity.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Gem for interfacing with psu's search-service"
   spec.homepage      = 'https://github.com/psu-libraries/psu_identity'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.3')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.3')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,15 +25,17 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'faraday', '~> 1.0'
   spec.add_dependency 'json'
+  spec.add_dependency 'oauth2'
   spec.add_dependency 'rake', '>= 12.0'
 
-  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec-its'
-  spec.add_development_dependency 'rubocop', '~> 1.22'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
   spec.add_development_dependency 'rubocop-performance', '~> 1.11'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
   spec.add_development_dependency 'simplecov', '=0.17'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr', '~> 6.1'
+  spec.add_development_dependency 'webmock', '~> 3.18'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psu_identity
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alex Kiessling
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +70,16 @@ dependencies:
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -84,30 +98,30 @@ dependencies:
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -154,30 +168,30 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.18'
 description: Gem for interfacing with psu's search-service
 email:
 - ajkiessl@gmail.com
@@ -207,16 +221,19 @@ files:
 - bin/console
 - bin/setup
 - lib/psu_identity.rb
+- lib/psu_identity/directory_service/client.rb
 - lib/psu_identity/search_service/atomic_link.rb
 - lib/psu_identity/search_service/client.rb
 - lib/psu_identity/search_service/person.rb
+- lib/psu_identity/string_helpers.rb
 - lib/psu_identity/version.rb
 - psu_identity.gemspec
 homepage: https://github.com/psu-libraries/psu_identity
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -224,15 +241,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.3
+      version: 3.1.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Gem for interfacing with psu's search-service
 test_files: []