osu_person 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55c98b37673df08d5247b9da14f3168fc5c68f1cec43830c1be52744256dcd1c
+  data.tar.gz: 863dbb3f877a9faff06edd9a5bd4d172822de92adbfd17bc6e4f28375b0cd3bb
+SHA512:
+  metadata.gz: 885f7f9fe12e24ac1a147f3704c47374d4d4ac1fa5e921e85ecb5b87dd854d5e7ed435601ff6913327768f0a25b00bc5326561da8a340c8b0abfccc76d3c7a27
+  data.tar.gz: eecccd229857062b7e645ea67d6376387d3ed122867432a48f6ba15233801b9e78a0ca0b8500f4a83a25c7c57ffb6c22ed1efecb59f22e04f0b6a32bbf351041

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,56 @@
+stages:
+  - build
+  - analysis
+  - security-scan-failure
+  - test
+
+variables: &vars
+  GEM: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG
+
+osu_person:
+  stage: build
+  image: docker:latest
+  tags: [build]
+  except: [schedules]
+  before_script: []
+  script: docker build -t $GEM . && docker push $GEM
+  retry: 2
+  variables:
+    <<: *vars
+    GIT_STRATEGY: clone
+
+.analysis: &analysis
+  stage: analysis
+  image: $GEM
+  tags: [test]
+
+bundle-audit:
+  <<: *analysis
+  script: bundle exec bundle-audit check --update
+
+rubocop:
+  <<: *analysis
+  except: [schedules]
+  script: bundle exec rubocop
+
+rubycritic:
+  <<: *analysis
+  script: bundle exec rubycritic --no-browser -s 90
+
+notify slack:
+  stage: security-scan-failure
+  image: code.osu.edu:5000/asctech/docker/ci/slack
+  tags: [docker]
+  only: [schedules]
+  when: on_failure
+  before_script: []
+  script: nightly-security-scan-failure
+  variables:
+    CHANNEL: asctech-developers
+    GIT_STRATEGY: none
+
+rspec:
+  stage: test
+  image: $GEM
+  tags: [test]
+  script: bundle exec rspec

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,4 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.5

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 mueller.128@osu.edu. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM code.osu.edu:5000/asctech/docker/ruby:2.5
+
+ENV GEM_DIR=/gem \
+    VERSION_DIR=lib/osu/person
+
+RUN yum -y update && \
+  useradd --user-group deploy && \
+  mkdir -p ${GEM_DIR} && \
+  chown -R deploy:deploy ${GEM_DIR} /usr/local/bundle
+
+USER deploy
+WORKDIR ${GEM_DIR}
+COPY --chown=deploy:deploy Gemfile* ${GEM_DIR}/
+COPY --chown=deploy:deploy *.gemspec ${GEM_DIR}/
+COPY --chown=deploy:deploy ${VERSION_DIR}/version.rb ${GEM_DIR}/${VERSION_DIR}/version.rb
+RUN ls -al
+
+RUN bundle install
+
+COPY --chown=deploy:deploy . ${GEM_DIR}/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in osu_person.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    osu_person (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bundler-audit (0.6.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    flay (2.12.0)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.2)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    path_expander (1.0.3)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    reek (4.8.2)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    ruby_parser (3.11.0)
+      sexp_processor (~> 4.9)
+    rubycritic (3.5.2)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (= 2.4.3)
+      parser (~> 2.5.0)
+      rainbow (~> 3.0)
+      reek (~> 4.4)
+      ruby_parser (~> 3.8)
+      tty-which (~> 0.3.0)
+      virtus (~> 1.0)
+    sexp_processor (4.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tty-which (0.3.0)
+    unicode-display_width (1.4.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  bundler-audit
+  osu_person!
+  rake
+  rspec
+  rubocop
+  rubycritic
+  simplecov
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kurt Mueller
+
+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,51 @@
+# OSU Person
+
+This gem contains logic for validating an osu person's email and name.#. It also
+can strip a name.# from an osu email address.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'osu_person'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install osu_person
+
+## Usage
+
+```ruby
+  OSU::Email.valid?("buckeye.614@osu.edu") # => true
+  OSU::Email.valid?("buckeye@osu.edu") # => false
+
+  OSU::Email.new("buckeye.614@osu.edu").name_n # => 'buckeye.614'
+  OSU::Email.new("buckeye@osu.edu") # => # => raises InvalidEmailError
+
+  OSU::NameN.valid?("buckeye.614") # => true
+  OSU::NameN.valid?("buckeye-.614") # => false
+```
+
+## 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 code.osu.edu at https://code.osu.edu/asctech/osu_person. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the OsuPerson project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://code.osu.edu/asctech/osu_person/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 'osu_person'
+
+# 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/osu/email.rb

@@ -0,0 +1,30 @@
+module OSU
+  # Validates an osu email. Can also strip a name.# from an osu email.
+  class Email
+    VALID_EMAIL =
+      /\A(?<name_n>[a-z]([a-z-]*[a-z])?\.[1-9]\d*)@([a-z]+\.|)osu.edu\z/i
+
+    def self.valid?(email)
+      case email
+      when VALID_EMAIL then true
+      else false
+      end
+    end
+
+    attr_reader :email
+
+    def initialize(email)
+      unless self.class.valid?(email)
+        raise InvalidEmailError, 'Email must resemble name.#@osu.edu'
+      end
+
+      @email = email.downcase
+    end
+
+    def name_n
+      VALID_EMAIL.match(email)['name_n']
+    end
+
+    class InvalidEmailError < ArgumentError; end
+  end
+end

data/lib/osu/name_n.rb

@@ -0,0 +1,13 @@
+module OSU
+  # Validates a name.#
+  class NameN
+    VALID_NAME_N = /\A(?<name_n>[a-z]([a-z-]*[a-z])?\.[1-9]\d*)\z/i
+
+    def self.valid?(name_n)
+      case name_n
+      when VALID_NAME_N then true
+      else false
+      end
+    end
+  end
+end

data/lib/osu/person/version.rb

@@ -0,0 +1,5 @@
+module OSU
+  module Person
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/osu.rb

@@ -0,0 +1,7 @@
+require 'osu/person/version'
+
+module OSU
+  # Shell module used for namespacing.
+  module Person
+  end
+end

data/osu_person.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'osu/person/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'osu_person'
+  spec.version     = OSU::Person::VERSION
+  spec.authors     = ['Kurt Mueller']
+  spec.email       = ['mueller.128@osu.edu']
+
+  spec.summary     = "Validate an ohio state person's email, name.#, & emplid."
+  spec.description = "Validate an ohio state person's email, name.#, & emplid."
+  spec.homepage    = 'https://code.osu.edu/asctech/osu_person'
+  spec.license     = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubycritic'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: osu_person
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kurt Mueller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  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: 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: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubycritic
+  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: simplecov
+  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'
+description: Validate an ohio state person's email, name.#, & emplid.
+email:
+- mueller.128@osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/osu.rb
+- lib/osu/email.rb
+- lib/osu/name_n.rb
+- lib/osu/person/version.rb
+- osu_person.gemspec
+homepage: https://code.osu.edu/asctech/osu_person
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Validate an ohio state person's email, name.#, & emplid.
+test_files: []