psu_identity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fde76b0c826c4dbbac7534e1d80455b59e824bb3385a9e7385d616507f30287b
+  data.tar.gz: 1cb6ed09a07d49f2310c73dce435ebbb51faa49bc5ceb2469fdbd8b4d9933221
+SHA512:
+  metadata.gz: f00301b1728c9f85af29f7ca02c32d08c2e16856f3ac4de06939e8bf0e1fb3d89ae9c892e7113b90d32a42304929680e770633b77cf613f0ecbe0b5668db02a8
+  data.tar.gz: 001ddfe28b43841a3c7ce0443064ac509665cf21f2454dbcca0e821b600b36ba419a3d7c06b84a4bd5833a406aa177acad0d963d61a4f186aaed7ae6cdcbb485

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+log/
+
+# rspec failure tracking
+.rspec_status
+
+# ignore gem builds
+/psu_identity-*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ajkiessl@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in psu_identity.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem 'faraday', '~> 0.17.0'
+
+group :test do
+  # Rspec and packages
+  gem "rspec", "~> 3.0"
+  gem 'rspec-its'
+  # Mock external requests
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    psu_identity (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    vcr (5.1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (~> 0.17.0)
+  psu_identity!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-its
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alex Kiessling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# PsuIdentity
+
+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/psu_identity`. 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 'psu_identity'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install psu_identity
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/psu_identity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/psu_identity/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PsuIdentity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/psu_identity/blob/master/CODE_OF_CONDUCT.md).

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 "psu_identity"
+
+# 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(__FILE__)

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/penn_state.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module PennState
+end

data/lib/penn_state/search_service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'penn_state'
+
+module PennState::SearchService
+  require 'penn_state/search_service/client'
+  require 'penn_state/search_service/person'
+  require 'penn_state/search_service/atomic_link'
+end

data/lib/penn_state/search_service/atomic_link.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+module PennState::SearchService
+  class AtomicLink < OpenStruct
+    def to_s
+      href
+    end
+  end
+end

data/lib/penn_state/search_service/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'faraday'
+
+# @abstract Client for querying Penn State's identity API: https://identity.apps.psu.edu/search-service/resources
+module PennState::SearchService
+  class Client
+    class Error < StandardError; end
+
+    attr_reader :base_url
+
+    # @param [String] base_url
+    def initialize(base_url: '/search-service/resources')
+      @base_url = base_url
+    end
+
+    # @param [Hash] args of options to pass to the endpoint
+    # @option args [String] :text to search for
+    def search(**args)
+      process_response connection.get("#{base_url}/people", args)
+    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/#{userid}")
+    end
+
+    private
+
+    # @return Array<PennState::SearchService::Person>
+    def process_response(response)
+      raise Error.new(response.body) unless response.success?
+
+      JSON.parse(response.body).map { |result| Person.new(result) }
+    rescue JSON::ParserError
+      []
+    end
+
+    # @return [PennState::SearchService::Person, nil]
+    def process_userid_response(response)
+      return if response.status == 404
+
+      raise Error.new(response.body) unless response.success?
+
+      Person.new(JSON.parse(response.body))
+    rescue JSON::ParserError
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: endpoint) do |conn|
+        conn.adapter :net_http
+      end
+    end
+
+    def endpoint
+      @endpoint ||= ENV.fetch('IDENTITY_ENDPOINT', 'https://identity.apps.psu.edu')
+    end
+  end
+end

data/lib/penn_state/search_service/person.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module PennState::SearchService
+  class Person
+    attr_reader :data
+
+    # @param [Hash] data parsed from the json reponse from the API
+    def initialize(data = {})
+      @data = data
+    end
+
+    def psu_id
+      data['psuid']
+    end
+
+    def user_id
+      data['userid']
+    end
+
+    def cpr_id
+      data['cprid']
+    end
+
+    def given_name
+      data['givenName']
+    end
+
+    def middle_name
+      data['middleName']
+    end
+
+    def family_name
+      data['familyName']
+    end
+    alias :surname :family_name
+
+    def honorific_suffix
+      data['honorificSuffix']
+    end
+
+    def preferred_given_name
+      data['preferredGivenName']
+    end
+
+    def preferred_middle_name
+      data['preferredMiddleName']
+    end
+
+    def preferred_family_name
+      data['preferredFamilyName']
+    end
+
+    def preferred_honorific_suffix
+      data['preferredHonorificSuffix']
+    end
+
+    def active?
+      data['active'] == 'true'
+    end
+
+    def conf_hold?
+      data['confHold'] == 'true'
+    end
+
+    def university_email
+      data['universityEmail']
+    end
+
+    def other_email
+      data['otherEmail']
+    end
+
+    def affiliation
+      data.fetch('affiliation', [])
+    end
+
+    def display_name
+      data['displayName']
+    end
+
+    def link
+      AtomicLink.new(data['link'])
+    end
+  end
+end

data/lib/psu_identity.rb

@@ -0,0 +1,8 @@
+require "psu_identity/version"
+
+module PsuIdentity
+  class Error < StandardError; end
+  VERSION = '0.1.0'
+
+  require 'penn_state'
+end

data/lib/psu_identity/version.rb

@@ -0,0 +1,3 @@
+module PsuIdentity
+  VERSION = "0.1.0"
+end

data/psu_identity.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/psu_identity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "psu_identity"
+  spec.version       = PsuIdentity::VERSION
+  spec.authors       = ["Alex Kiessling"]
+  spec.email         = ["ajkiessl@gmail.com"]
+
+  spec.summary       = %q{Gem for interfacing with psu's search-service}
+  spec.description   = %q{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.3.0")
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: psu_identity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kiessling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-07 00:00:00.000000000 Z
+dependencies: []
+description: Gem for interfacing with psu's search-service
+email:
+- ajkiessl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/penn_state.rb
+- lib/penn_state/search_service.rb
+- lib/penn_state/search_service/atomic_link.rb
+- lib/penn_state/search_service/client.rb
+- lib/penn_state/search_service/person.rb
+- lib/psu_identity.rb
+- lib/psu_identity/version.rb
+- psu_identity.gemspec
+homepage: https://github.com/psu-libraries/psu_identity
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Gem for interfacing with psu's search-service
+test_files: []