ucb_orgs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4844c4ae70974f3946582344232605c9dc93f00
+  data.tar.gz: b0e1d755652ff7172cd099a43e1053f2021a9f6b
+SHA512:
+  metadata.gz: 1ef72e2169fdfacd5dc7cb455477a6f3846991c02fe0eb077aadf52c6268398e0175835812f7481788f3a70ed0b6d6b783d36f90958b8f0ff7b3ad224f184300
+  data.tar.gz: ca8feca9fab74d14d98f140444fb6d4804b847352a20ad148136b625c0d5b178e5429765cb04e8538989d0b9f31568758117818fa195729f4e553101ff942606

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

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

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 ucb_orgs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Darin Wilson
+
+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,77 @@
+# UcbOrgs
+
+The ucb_orgs gem is a Rails plugin that provides a model and backing database table for UC Berkeley org units.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ucb_orgs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ucb_orgs
+
+Once you've installed the gem, you'll need to setup the database table and install the org unit data.
+
+To add the migrations to your app, run:
+
+```
+rake ucb_orgs:install
+```
+
+Then run `rake db:migrate` as usual.
+
+To load the most recent org unit data, run:
+
+```
+rake ucb_orgs:update
+```
+
+## Updating
+
+To update your local database with the most recent version of the org chart, run:
+
+```
+rake ucb_orgs:update
+```
+
+This can safely be run as often as needed.
+
+## Data Model
+
+Org units are hierarchical, and each `OrgUnit` record contains the org unit's code, its level in the hierarchy, and the codes of the org units above it.
+
+For example:
+
+Code | Name | Level | Level_2 | Level_3 | Level_4 | Level_5 | Level_6
+----- | ----- | ----- | ----- | ----- | ----- | ----- | -----
+AZRAD	| Shared Services Research Admin | 5 |CAMSU	| VCBAS	| AZCSS	| AZRAD
+
+This org unit is at level 5, so the record contains the org units for levels 2, 3, and 4 above.
+
+There is exactly one org unit at level one, UCBKL, which represents the entire campus.
+
+## Usage
+
+The org unit model will be available in your code as `UcbOrgs::OrgUnit.` This is an ordinary ActiveRecord model, so all of the usual methods are available to you.
+
+If you'd like to add or override methods in the model, create `org_unit.rb` in your `models` directory and set it up like this:
+
+```ruby
+class OrgUnit < ApplicationRecord
+  include UcbOrgs::Concerns::OrgUnit
+
+  # add customized behavior here
+
+end
+```
+
+You can name it anything you like, just make sure you have the `include` statement shown above.
+

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 "ucb_orgs"
+
+# 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/ucb_orgs/concerns/org_unit.rb

@@ -0,0 +1,45 @@
+module UcbOrgs
+  module Concerns
+    module OrgUnit
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def load_from_csv(csv_filename)
+          CSV.foreach(csv_filename, headers: true) do |row|
+            org_unit = UcbOrgs::OrgUnit.find_or_create_by(code: row['CODE'])
+            org_unit.update_attributes(
+              name:  row['NAME'],
+              level:  row['LEVEL'].to_i,
+              level_2:  row['LEVEL_2'],
+              level_3:  row['LEVEL_3'],
+              level_4:  row['LEVEL_4'],
+              level_5:  row['LEVEL_5'],
+              level_6:  row['LEVEL_6']
+            )
+          end
+        end
+
+        # Returns an Array of org codes consisting of the given org and all child orgs. "org" can also
+        # be a list of orgs. The result will have all duplicate org codes filtered out.
+        def org_with_children(org)
+          orgs = Array(org)
+          return [] if orgs.empty?
+          orgs_str = orgs.reduce("(") { |res,org| res + "'#{org}'," }.chop + ")"
+          # TODO we can clean this up with "or" queries in Rails 5
+          UcbOrgs::OrgUnit
+            .where(
+              "code IN #{orgs_str}" +
+              "OR level_2 IN #{orgs_str}" +
+              "OR level_3 IN #{orgs_str}" +
+              "OR level_4 IN #{orgs_str}" +
+              "OR level_5 IN #{orgs_str}" +
+              "OR level_6 IN #{orgs_str}"
+            )
+            .uniq
+            .pluck(:code)
+        end
+      end
+    end
+  end
+end

data/lib/ucb_orgs/migrations/20171211220534_create_org_units.rb

@@ -0,0 +1,23 @@
+class CreateOrgUnits < ActiveRecord::Migration[5.1]
+  def up
+    create_table :org_units do |t|
+      t.string :code
+      t.string :name
+      t.integer :level
+      t.string :level_2
+      t.string :level_3
+      t.string :level_4
+      t.string :level_5
+      t.string :level_6
+
+      t.timestamps
+    end
+
+    add_index :org_units, :code, unique: true
+
+  end
+
+  def down
+    drop_table :org_units
+  end
+end

data/lib/ucb_orgs/org_unit.rb

@@ -0,0 +1,14 @@
+require "csv"
+
+module UcbOrgs
+
+  class OrgUnit < ActiveRecord::Base
+    include UcbOrgs::Concerns::OrgUnit
+
+    # Don't add anything else here - any other functionality should be added to
+    # UcbOrgs::Concerns::OrgUnit. This will make it easier for host apps to
+    # customize the class as needed. See:
+    # http://edgeguides.rubyonrails.org/engines.html#implementing-decorator-pattern-using-activesupport-concern
+  end
+
+end

data/lib/ucb_orgs/railtie.rb

@@ -0,0 +1,5 @@
+class UcbOrgs::Railtie < Rails::Railtie
+  rake_tasks do
+    load "ucb_orgs/tasks/ucb_orgs.rake"
+  end
+end

data/lib/ucb_orgs/syncer.rb

@@ -0,0 +1,83 @@
+module UcbOrgs
+  class SyncError < StandardError
+    attr_reader :item
+    attr_reader :source_error
+
+    def initialize(item, source_error)
+      @item = item
+      @source_error = source_error
+    end
+
+    def error_details
+      "#{source_error} : #{source_error.backtrace.first}"
+    end
+  end
+
+  # Syncs the org units to the LDAP tree
+  #
+  # Since ldap is definitive and we don't keep org history,
+  # delete any department row that wasn't found in ldap.
+  #
+  # Most of this code was lifted wholesale from APBears
+  class Syncer
+    attr_accessor :ldap_org_entries
+
+    class << self
+      def sync
+        UcbOrgs::Syncer.new.sync
+      end
+    end
+
+    def sync
+      UCB::LDAP::Org.root_node  # force load of whole tree
+      self.ldap_org_entries = UCB::LDAP::Org.flattened_tree
+
+      sync_orgs
+      delete_not_found_in_ldap
+    end
+
+    private
+
+    def sync_orgs
+      ldap_org_entries.each_with_index do |ldap_org_entry, index|
+        begin
+          sync_org(ldap_org_entry, index)
+        rescue Exception => e
+          raise UcbOrgs::SyncError.new(ldap_org_entry.try(:code), e)
+        end
+      end
+    end
+
+    def delete_not_found_in_ldap
+      codes_found_in_ldap = ldap_org_entries.map(&:code)
+      codes_found_in_db = UcbOrgs::OrgUnit.all.map(&:code)
+      codes_to_delete = codes_found_in_db - codes_found_in_ldap
+
+      UcbOrgs::OrgUnit
+        .where(code: codes_to_delete)
+        .delete_all
+    end
+
+    def sync_org(ldap_org_entry, index)
+      UcbOrgs::OrgUnit.find_or_initialize_by(code: ldap_org_entry.code).tap do |dept|
+        dept.update_attributes!(
+          code: nb_to_string(ldap_org_entry.code),
+          name: nb_to_string(ldap_org_entry.name),
+          level: ldap_org_entry.level,
+          level_2: nb_to_string(ldap_org_entry.level_2_code),
+          level_3: nb_to_string(ldap_org_entry.level_3_code),
+          level_4: nb_to_string(ldap_org_entry.level_4_code),
+          level_5: nb_to_string(ldap_org_entry.level_5_code),
+          level_6: nb_to_string(ldap_org_entry.level_6_code)
+        )
+      end
+    end
+
+    # Net-Ldap returns Net::BER::BerIdentifiedString.
+    # Explicityly confert to String.
+    def nb_to_string(nb)
+      nb.nil? ? nil : nb.to_s
+    end
+
+  end
+end

data/lib/ucb_orgs/tasks/ucb_orgs.rake

@@ -0,0 +1,44 @@
+require "ucb_orgs/syncer"
+
+namespace :ucb_orgs do
+  desc "Installs migrations to the current project"
+  task :install do
+    puts "Checking for new migrations..."
+    migrations_to_add = new_migrations()
+    if migrations_to_add.empty?
+      puts "No new migrations"
+    else
+      migrations_to_add.each do |migration|
+        FileUtils.cp("#{migration_source_dir}/#{migration}", migration_target_dir)
+      end
+      puts "\nMigrations installed - ready to run \"rake db:migrate\""
+    end
+  end
+
+  desc "Downloads org unit source file, and loads it into the database"
+  task update: :environment do
+    puts "Updating org units..."
+    begin
+      UcbOrgs::Syncer.sync
+      puts "Done."
+    rescue Exception => e
+      msg = e.respond_to?(:error_details) ? e.error_details : e.to_s
+      puts "Unable to complete sync: #{msg}"
+    end
+  end
+
+  def migration_source_dir
+    "#{File.dirname(__FILE__)}/../migrations/"
+  end
+
+  def migration_target_dir
+    "#{Rails.root}/db/migrate"
+  end
+
+  def new_migrations
+    already_installed = Dir.entries(migration_target_dir)
+    Dir.entries(migration_source_dir).reject do |m|
+      already_installed.include?(m)
+    end
+  end
+end

data/lib/ucb_orgs/version.rb

@@ -0,0 +1,3 @@
+module UcbOrgs
+  VERSION = "0.0.1"
+end

data/lib/ucb_orgs.rb

@@ -0,0 +1,7 @@
+require "ucb_orgs/version"
+require "ucb_orgs/concerns/org_unit"
+require "ucb_orgs/org_unit"
+require "ucb_orgs/railtie" if defined?(Rails)
+
+module UcbOrgs
+end

data/ucb_orgs.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ucb_orgs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ucb_orgs"
+  spec.version       = UcbOrgs::VERSION
+  spec.authors       = ["Darin Wilson"]
+  spec.email         = ["darinwilson@gmail.com"]
+
+  spec.summary       = %q{Rails extension that manages UCB org unit data}
+  spec.homepage      = "https://github.com/ucb-ist-eas/ucb_orgs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "ucb_ldap"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: ucb_orgs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Darin Wilson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ucb_ldap
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- darinwilson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ucb_orgs.rb
+- lib/ucb_orgs/concerns/org_unit.rb
+- lib/ucb_orgs/migrations/20171211220534_create_org_units.rb
+- lib/ucb_orgs/org_unit.rb
+- lib/ucb_orgs/railtie.rb
+- lib/ucb_orgs/syncer.rb
+- lib/ucb_orgs/tasks/ucb_orgs.rake
+- lib/ucb_orgs/version.rb
+- ucb_orgs.gemspec
+homepage: https://github.com/ucb-ist-eas/ucb_orgs
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails extension that manages UCB org unit data
+test_files: []