osu_validators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dee2a43e9e8fb575f9a21d813dbd16f5d8f8a2ca19af35e7bae49f0aebf74997
+  data.tar.gz: a32bed696953f14b54907f9886c5bab5a9532cdafec19277b3df3c5efa95e12d
+SHA512:
+  metadata.gz: 590e2055c2b4add0a51183c27c3e131ba97ca765b390f3dcfb347e7fcea3c477cc4d28d421204d87fd6755df2a0a25c17ec7c0a9cd714362436fd3263c93c907
+  data.tar.gz: 167230159136d25c1c4a11f1dfaaa813e04f052a309b45da331d9bd693856d3ad6260080499adb6185ec958757343224be7180401590f928a3bbe0f3a6890d56

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 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,58 @@
+# OSU Validators
+
+This gem contains rails `ActiveRecord` validations for a user's `emplid`, `email`, and
+`name.#`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'osu_validators'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install osu_validators
+```
+
+## Usage
+
+Assuming that a `User` record has a `emplid`, `email`, and `name_n` column:
+
+```ruby
+class User < ActiveRecord::Base
+  validates_emplid_of :emplid
+  validates_osu_email_of :email
+  validates_name_n_of :name_n
+end
+
+class User < ActiveRecord::Base
+  validates :emplid, emplid: true
+  validates :email, osu_email: true
+  validates :name_n, name_n: true
+end
+```
+
+There are also validations options for each validator: `allow_nil`,
+`allow_blank`, and `message`.
+
+```ruby
+class User < ActiveRecord::Base
+  validates_emplid_of :emplid, allow_nil: true
+  validates :email, osu_email: { allow_blank: true }
+  validates :name_n, name_n: { message: "custom error message" }
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on code.osu.edu at https://code.osu.edu/asctech/osu_validators. 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).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OsuValidators'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/osu_validators.rb

@@ -0,0 +1,9 @@
+require "osu_person"
+
+require "osu_validators/name_n_validator"
+require "osu_validators/osu_email_validator"
+require "osu_validators/osu_emplid_validator"
+
+module OsuValidators
+  # Your code goes here...
+end

data/lib/osu_validators/name_n_validator.rb

@@ -0,0 +1,28 @@
+module ActiveModel
+  module Validations
+    # Validates that a user's name and number follows the name.# format
+    class NameNValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if !!value && options[:allow_nil]
+        return if ::OSU::NameN.valid?(value)
+
+        error_message = options[:message] || "needs to be in the format name.#"
+
+        record.errors.add(
+          attribute,
+          :name_n,
+          message: error_message,
+          value: value
+        )
+      end
+    end
+
+    # Adds a convenience method for validating a name.#
+    module ClassMethods
+      def validates_name_n_of(*attribute_names)
+        validates_with NameNValidator, _merge_attributes(attribute_names)
+      end
+    end
+  end
+end

data/lib/osu_validators/osu_email_validator.rb

@@ -0,0 +1,28 @@
+module ActiveModel
+  module Validations
+    # Validates that a user's email follows the format of name.#@*.osu.edu
+    class OsuEmailValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if !!value && options[:allow_nil]
+        return if ::OSU::Email.valid?(value)
+
+        error_message = options[:message] || "needs to be in the format name.#@*.osu.edu"
+
+        record.errors.add(
+          attribute,
+          :osu_email,
+          message: error_message,
+          value: value
+        )
+      end
+    end
+
+    # Adds a convenience method for validating an osu email
+    module ClassMethods
+      def validates_osu_email_of(*attribute_names)
+        validates_with OsuEmailValidator, _merge_attributes(attribute_names)
+      end
+    end
+  end
+end

data/lib/osu_validators/osu_emplid_validator.rb

@@ -0,0 +1,28 @@
+module ActiveModel
+  module Validations
+    # Validate's that a user's emplid is an 8-9 digit string
+    class EmplidValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if !!value && options[:allow_nil]
+        return if ::OSU::Emplid.valid?(value)
+
+        error_message = options[:message] || "needs to be an 8-9 digit string"
+
+        record.errors.add(
+          attribute,
+          :emplid,
+          message: error_message,
+          value: value
+        )
+      end
+    end
+
+    # Adds a convenience method for validating an emplid
+    module ClassMethods
+      def validates_emplid_of(*attribute_names)
+        validates_with EmplidValidator, _merge_attributes(attribute_names)
+      end
+    end
+  end
+end

data/lib/osu_validators/version.rb

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

data/lib/tasks/osu_validators_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :osu_validators do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: osu_validators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ASCTech AppDev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: osu_person
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: sqlite3
+  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: rubocop-performance
+  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'
+- !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: 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: 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'
+description: Provides ActiveModel/ActiveRecord validators for OSU emails, name.#s,
+  and emplids.
+email:
+- appdev@asctech.osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/osu_validators.rb
+- lib/osu_validators/name_n_validator.rb
+- lib/osu_validators/osu_email_validator.rb
+- lib/osu_validators/osu_emplid_validator.rb
+- lib/osu_validators/version.rb
+- lib/tasks/osu_validators_tasks.rake
+homepage: https://code.osu.edu/asctech/osu_validators
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides ActiveModel/ActiveRecord validators for OSU emails, name.#s, and
+  emplids.
+test_files: []