trogdir_models 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 544ab6bcbbe2b0def5475ea269782fc4d774d6f4
+  data.tar.gz: 9c6d1ccb7ce16b62426c2e10c49b2d0d268fd4ed
+SHA512:
+  metadata.gz: 2ef7fd02dd8257dbac93ecef8b123f6cb3de96e2eeb28b4fb5edcfec4e3e1152c0cee988b8e8ded8cd5b0d24f94e0004f05aada87a85f59c5b5d36e0c457669c
+  data.tar.gz: 3b0895645d120ce3de7bee1de8d22ff5b112b209ff45da2ee26c108ddede90ea6bcb27b26ad3fe1e6fed7be739b05136b53243696ccfa824371047f946e1ef27

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 by Biola University
+
+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,3 @@
+Trogdir Models [![Build Status](https://travis-ci.org/biola/trogdir-models.png)](https://travis-ci.org/biola/trogdir-models)
+==============
+A set of shared [Mongoid](http://mongoid.org) models for the Trogdir directory project.

data/lib/trogdir/address.rb

@@ -0,0 +1,21 @@
+class Address
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  TYPES = [:home]
+
+  embedded_in :person
+
+  field :type, type: Symbol
+  field :street_1, type: String
+  field :street_2, type: String
+  field :city, type: String
+  field :state, type: String
+  field :zip, type: String
+  field :country, type: String
+
+  validates :type, presence: true, inclusion: { in: Address::TYPES }
+  validates :street_1, presence: true
+
+  track_history track_create: true, track_destroy: true
+end

data/lib/trogdir/change_sync.rb

@@ -0,0 +1,7 @@
+class ChangeSync
+  include Mongoid::Document
+
+  belongs_to :changeset
+  belongs_to :syncinator
+  embeds_many :sync_logs
+end

data/lib/trogdir/changeset.rb

@@ -0,0 +1,7 @@
+class Changeset
+  include Mongoid::History::Tracker
+
+  has_many :change_syncs
+
+  alias :person :trackable_root
+end

data/lib/trogdir/concerns/employee.rb

@@ -0,0 +1,11 @@
+module Employee
+  extend ActiveSupport::Concern
+
+  included do
+    field :department, type: String
+    field :title, type: String
+    field :employee_type, type: Symbol
+    field :full_time, type: Boolean
+    field :pay_type, type: Symbol
+  end
+end

data/lib/trogdir/concerns/student.rb

@@ -0,0 +1,13 @@
+module Student
+  extend ActiveSupport::Concern
+
+  included do
+    # On-Campus Residence
+    field :residence, type: String
+    field :floor, type: Integer
+    field :wing, type: String
+
+    # Academic
+    field :majors, type: Array
+  end
+end

data/lib/trogdir/email.rb

@@ -0,0 +1,17 @@
+class Email
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  embedded_in :person
+
+  TYPES = [:university, :personal]
+
+  field :type, type: Symbol
+  field :address, type: String
+  field :primary, type: Boolean
+
+  validates :type, presence: true, inclusion: { in: Email::TYPES }
+  validates :address, presence: true, email: true
+
+  track_history track_create: true, track_destroy: true
+end

data/lib/trogdir/id.rb

@@ -0,0 +1,25 @@
+class ID
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  TYPES = [:biola_id, :netid, :banner, :google_apps]
+  DEFAULT_TYPE = :netid
+
+  embedded_in :person
+  field :type, type: Symbol
+  field :identifier
+
+  validates :type, presence: true, inclusion: { in: ID::TYPES }
+  validates :identifier, presence: true
+  validate do |id|
+    if Person.where(:id.ne => id.person.try(:id), 'ids.identifier' => id.identifier, 'ids.type' => id.type).count > 0
+      id.errors.add :identifier, 'must be unique'
+    end
+  end
+
+  track_history track_create: true, track_destroy: true
+
+  def to_s
+    identifier
+  end
+end

data/lib/trogdir/person.rb

@@ -0,0 +1,43 @@
+class Person
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+  include Student
+  include Employee
+
+  embeds_many :ids, class_name: 'ID'
+  embeds_many :emails
+  embeds_many :photos
+  embeds_many :phones
+  embeds_many :addresses
+  has_many :changesets, as: :changeable
+
+  # Names
+  field :first_name, type: String
+  field :preferred_name, type: String
+  field :middle_name, type: String
+  field :last_name, type: String
+  field :display_name, type: String
+
+  # Demographic
+  field :gender, type: Symbol
+  field :partial_ssn, type: String
+  field :birth_date, type: Date
+
+  # Groups and permissions
+  field :entitlements, type: Array
+  field :affiliations, type: Array
+
+  # Options
+  field :privacy, type: Boolean
+  field :enabled, type: Boolean # TODO: figure out if tihs is necessary
+
+  validates :first_name, :last_name, presence: true
+
+  track_history track_create: true
+
+  def email
+    emails.where(primary: true).first
+  end
+
+  delegate :address, to: :email, prefix: true, allow_nil: true
+end

data/lib/trogdir/phone.rb

@@ -0,0 +1,17 @@
+class Phone
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  TYPES = [:office, :home, :cell]
+
+  embedded_in :person
+
+  field :type, type: Symbol
+  field :number, type: String
+  field :primary, type: Boolean
+
+  validates :type, presence: true, inclusion: { in: Phone::TYPES }
+  validates :number, presence: true
+
+  track_history track_create: true, track_destroy: true
+end

data/lib/trogdir/photo.rb

@@ -0,0 +1,19 @@
+class Photo
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  TYPES = [:id_card]
+
+  embedded_in :person
+
+  field :type, type: Symbol
+  field :url, type: String
+  field :height, type: Integer
+  field :width, type: Integer
+
+  validates :type, presence: true, inclusion: { in: Photo::TYPES }
+  validates :url, :height, :width, presence: true
+  validates :url, absolute_uri: true
+
+  track_history track_create: true, track_destroy: true
+end

data/lib/trogdir/sync_log.rb

@@ -0,0 +1,13 @@
+class SyncLog
+  include Mongoid::Document
+
+  belongs_to :change_sync
+
+  field :started_at, type: Time
+  field :errored_at, type: Time
+  field :succeeded_at, type: Time
+  field :action, type: Symbol
+  field :message, type: String
+
+  validates :started_at, presence: true
+end

data/lib/trogdir/syncinator.rb

@@ -0,0 +1,41 @@
+require 'securerandom'
+
+class Syncinator
+  include Mongoid::Document
+
+  FIXNUM_MAX = (2**(0.size * 8 -2) -1)
+
+  has_many :change_syncs
+
+  field :name, type: String
+  field :slug, type: String
+  field :access_id, type: Integer
+  field :secret_key, type: String
+  field :queue_changes, type: Boolean
+  field :active, type: Boolean
+
+  attr_readonly :slug, :access_id, :secret_key
+
+  validates :name, :slug, :access_id, :secret_key, presence: true
+  validates :name, :slug, :access_id, :secret_key, uniqueness: true
+
+  before_validation :set_default_slug, :set_access_id, :set_secret_key, on: :create
+
+  def to_s
+    name
+  end
+
+  private
+
+  def set_default_slug
+    self.slug ||= name.parameterize
+  end
+
+  def set_access_id
+    self.access_id = rand(FIXNUM_MAX)
+  end
+
+  def set_secret_key
+    self.secret_key = SecureRandom.hex(64)
+  end
+end

data/lib/trogdir/validators/absolute_uri_validator.rb

@@ -0,0 +1,13 @@
+require 'uri'
+
+class AbsoluteUriValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    begin
+      unless URI.parse(value).absolute?
+        record.errors[attribute] << 'is not an absolute URL'
+      end
+    rescue URI::InvalidURIError => error
+      record.errors[attribute] << 'is not a valid URL'
+    end
+  end
+end

data/lib/trogdir/validators/email_validator.rb

@@ -0,0 +1,40 @@
+# From: https://gist.github.com/jcf/1188367
+
+require 'mail'
+
+class EmailValidator < ActiveModel::EachValidator
+  attr_reader :record, :attribute, :value, :email, :tree
+
+  def validate_each(record, attribute, value)
+    @record, @attribute, @value = record, attribute, value
+
+    @email = Mail::Address.new(value)
+    @tree  = email.__send__(:tree)
+
+    add_error unless valid?
+  rescue Mail::Field::ParseError
+    add_error
+  end
+
+  private
+
+  def valid?
+    !!(domain_and_address_present? && domain_has_more_than_one_atom?)
+  end
+
+  def domain_and_address_present?
+    email.domain && email.address == value
+  end
+
+  def domain_has_more_than_one_atom?
+    tree.domain.dot_atom_text.elements.length > 1
+  end
+
+  def add_error
+    if message = options[:message]
+      record.errors[attribute] << message
+    else
+      record.errors.add(attribute, :invalid)
+    end
+  end
+end

data/lib/trogdir_models.rb

@@ -0,0 +1,31 @@
+module TrogdirModels
+  # For sharing factories with apps that use the gem
+  def self.load_factories
+    FactoryGirl.definition_file_paths += [File.expand_path('../../spec/factories',  __FILE__)]
+  end
+end
+
+# Models
+require 'mongoid'
+autoload :Person, 'trogdir/person'
+autoload :ID, 'trogdir/id'
+autoload :Email, 'trogdir/email'
+autoload :Photo, 'trogdir/photo'
+autoload :Phone, 'trogdir/phone'
+autoload :Address, 'trogdir/address'
+autoload :Changeset, 'trogdir/changeset'
+autoload :Syncinator, 'trogdir/syncinator'
+autoload :ChangeSync, 'trogdir/change_sync'
+autoload :SyncLog, 'trogdir/sync_log'
+
+# Concerns
+require 'active_support/concern'
+autoload :Student, 'trogdir/concerns/student'
+autoload :Employee, 'trogdir/concerns/employee'
+
+require 'active_model/validations'
+autoload :EmailValidator, 'trogdir/validators/email_validator'
+autoload :AbsoluteUriValidator, 'trogdir/validators/absolute_uri_validator'
+
+require 'mongoid-history'
+Mongoid::History.tracker_class_name = :changeset

data/lib/trogdir_models/version.rb

@@ -0,0 +1,3 @@
+module TrogdirModels
+  VERSION = '0.1.0'
+end

data/spec/factories/address_factory.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  factory :address do
+    type :home
+    street_1 { Faker::Address.street_address }
+    city { Faker::Address.city }
+    state { Faker::Address.state_abbr }
+    zip { Faker::Address.zip }
+    country { Faker::Address.country }
+  end
+end

data/spec/factories/email_factory.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :email do
+    type :university
+    address { Faker::Internet.email }
+    primary false
+  end
+end

data/spec/factories/id_factory.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :id, class: ID do
+    type { :netid }
+    person
+    identifier { Faker::Internet.user_name }
+  end
+end

data/spec/factories/person_factory.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory :person do
+    first_name { Faker::Name.first_name }
+    preferred_name { first_name }
+    last_name { Faker::Name.last_name }
+    display_name { "#{first_name} #{last_name}"}
+    gender { [:male, :female].sample }
+    partial_ssn { 1234 }
+    birth_date { 20.years.ago }
+    entitlements []
+    affiliations []
+    privacy false
+    enabled true
+  end
+end

data/spec/factories/phone_factory.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :phone do
+    type :office
+    number { Faker::PhoneNumber.phone_number }
+  end
+end

data/spec/factories/photo_factory.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :photo do
+    type :id_card
+    url { Faker::Internet.url }
+    height 100
+    width 100
+  end
+end

data/spec/factories/syncinator_factory.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :syncinator do
+    name { Faker::Company.catch_phrase }
+    queue_changes true
+    active true
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: trogdir_models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Crownoble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid-history
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A shared set of Mongoid models for the Trogdir directory project
+email: adam.crownoble@biola.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/trogdir/address.rb
+- lib/trogdir/change_sync.rb
+- lib/trogdir/changeset.rb
+- lib/trogdir/concerns/employee.rb
+- lib/trogdir/concerns/student.rb
+- lib/trogdir/email.rb
+- lib/trogdir/id.rb
+- lib/trogdir/person.rb
+- lib/trogdir/phone.rb
+- lib/trogdir/photo.rb
+- lib/trogdir/sync_log.rb
+- lib/trogdir/syncinator.rb
+- lib/trogdir/validators/absolute_uri_validator.rb
+- lib/trogdir/validators/email_validator.rb
+- lib/trogdir_models.rb
+- lib/trogdir_models/version.rb
+- spec/factories/address_factory.rb
+- spec/factories/email_factory.rb
+- spec/factories/id_factory.rb
+- spec/factories/person_factory.rb
+- spec/factories/phone_factory.rb
+- spec/factories/photo_factory.rb
+- spec/factories/syncinator_factory.rb
+homepage: https://github.com/biola/trogdir-models
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Shared models for the Trogdir directory
+test_files: []