institutions 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Scot Dalton
+
+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.rdoc

@@ -0,0 +1,23 @@
+= Institutions
+{<img src="https://secure.travis-ci.org/scotdalton/institutions.png?branch=master" alt="Build Status" />}[https://travis-ci.org/scotdalton/institutions]
+{<img src="https://gemnasium.com/scotdalton/institutions.png" alt="Dependency Status" />}[https://gemnasium.com/scotdalton/institutions]
+{<img src="https://codeclimate.com/badge.png" alt="Code Climage" />}[https://codeclimate.com/github/scotdalton/institutions]
+
+This gem provides a mechanism for creating Institutions from a hash of Institutional data elements.
+
+== Institutions Basics
+=== Getting institutions
+Institutions reads in YAML files and creates a Hash of Institution instances 
+with the Institution#code as the Hash key.
+  require 'institutions'
+  institutions = Institutions.institutions
+
+=== Setting load paths
+Specify additional directories to search for institutional YAMLs.
+  require 'institutions'
+  Institutions.loadpaths << File.join("path", "to", "new", "load", "directory")
+
+=== Setting file name
+Specify additional YAML file names that contain institutions.
+  require 'institutions'
+  Institutions.filenames << "my_institution.yml"

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+require 'rake/testtask'
+require 'git'
+require 'fileutils'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Institutions'
+  rdoc.options << '--line-numbers'
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Push latest RDocs to gh-pages."
+task :ghpages => [:rerdoc] do
+  g = Git.open(Dir.pwd)
+  g.checkout(g.branch('gh-pages'))
+  g.pull("origin", "gh-pages")
+  FileUtils.rm_r("rdocs", :force => true)
+  Dir.mkdir("rdocs")
+  FileUtils.mv(Dir.glob("html/*"), "./rdocs", :force => true)
+  FileUtils.rm_r("html", :force => true)
+  g.add(".")
+  g.commit_all("Update gh-pages.")
+  g.push("origin", "gh-pages")
+  g.checkout(g.branch('master'))
+end
+
+task :default => :test

data/institutions.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "institutions/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "institutions"
+  s.version     = Institutions::VERSION
+  s.authors     = ["Scot Dalton"]
+  s.email       = ["scotdalton@gmail.com"]
+  s.homepage    = "https://github.com/scotdalton/institutions"
+  s.summary     = "Abstract mechanism for setting up Institutions (whatever that means)."
+  s.description = "Abstract mechanism for setting up Institutions with arbitrary data elements."
+
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency "require_all", "~> 1.2.1"
+  s.add_dependency "ipaddr_range_set", "~> 0.9.1"
+  s.add_dependency "git", "~> 1.2.5"
+  s.add_dependency "rdoc"
+  s.add_dependency "rake"
+end

data/lib/institutions/institution/auth.rb

@@ -0,0 +1,6 @@
+module Institutions#:no_doc
+  module Auth#:no_doc
+    # Auth attributes
+    attr_reader :auth
+  end
+end

data/lib/institutions/institution/core.rb

@@ -0,0 +1,52 @@
+module Institutions#:no_doc
+  module Core#:no_doc
+    # Required attributes
+    attr_reader :code, :name
+    alias :display_name :name
+
+    # Optional core attributes
+    attr_reader :default
+    alias :default? :default
+
+    #
+    # Creates a new Institution object from the given code, name and hash.
+    #
+    # The optional +hash+, if given, will generate additional attributes and values.
+    # 
+    # 
+    # For example:
+    #
+    #   require 'institutions'
+    #   hash = { "attribute1" => "My first attribute.", :array_attribute => [1, 2] }
+    #   institution = Institutions::Institution.new("my_inst", "My Institution", hash)
+    #
+    #   p institution        # -> <Institutions::Institution @code=:my_inst @name="My Institution" @attribute1=My first attribute." @array_attribute=[1, 2] @default=false>
+    #
+    def initialize(code, name, h={})
+      # Set the required attributes
+      set_required_attributes code, name
+      # Merge in the optional hash attribute
+      merge h unless h.nil?
+      # If the institution is named default, take that as an
+      # indication that it's the default institution
+      @default = true if (name.eql? "default" or name.eql? "DEFAULT") 
+      # If default was never set, explicitly set default as false.
+      @default = false if default.nil?
+    end
+
+    # 
+    # Sets the required attributes.
+    # Raises an ArgumentError specifying the missing arguments if they are nil.
+    # 
+    def set_required_attributes(code, name)
+      missing_arguments = []
+      missing_arguments << :code if code.nil?
+      missing_arguments << :name if name.nil?
+      raise ArgumentError.new("Cannot create the Institution based on the given arguments (:code => #{code.inspect}, :name => #{name.inspect}).\n"+
+        "The following arguments cannot be nil: #{missing_arguments.inspect}") unless missing_arguments.empty?
+      # Set the instance variables
+      @code, @name = code.to_sym, name
+    end
+    private :set_required_attributes
+  end
+end

data/lib/institutions/institution/ip_addresses.rb

@@ -0,0 +1,39 @@
+module Institutions#:no_doc
+  module IpAddresses#:no_doc
+    require 'ipaddr_range_set'
+    attr_reader :ip_addresses
+    
+    def ip_addresses=(args)
+      args.collect! do |arg|
+        arg.match(/-/) ? convert_to_range(arg) : arg
+      end
+      @ip_addresses = IPAddrRangeSet.new(*args)
+    end
+    protected :ip_addresses=
+    
+    def ip_addresses_add(arg1, arg2)
+      arg1.add(arg2)
+    end
+    protected :ip_addresses_add
+    
+    def convert_to_range(s)
+      s.split("-")[0]...s.split("-")[1]
+    end
+    private :convert_to_range
+
+    #
+    # Returns a +boolean+ indicating whether the candidate IP 
+    # address is in the Institution's IP range.
+    # Example:
+    #
+    #   require 'institutions'
+    #   institution = Institution.new("my_inst", "My Institution", "ip_addresses" => ["127.0.0.1", 127.0.0.2"])
+    #   data.includes_ip?("127.0.0.1")   # => true
+    #   data.includes_ip?("127.0.0.3")   # => false
+    # 
+    def includes_ip?(candidate)
+      return false if ip_addresses.nil?
+      return ip_addresses.include? candidate
+    end
+  end
+end

data/lib/institutions/institution/merge.rb

@@ -0,0 +1,85 @@
+module Institutions#:no_doc
+  module Merge#:no_doc
+    #
+    # Merges the given arguments into the Institution.
+    # Internally uses a "recursive merge" algorithm to
+    # preserve as much of the original Institution as possible.
+    # Assumes the argument has a to_hash method
+    # Example.
+    #
+    #   require 'institutions'
+    #   hash1 = { "string_attribute" => "first string",
+    #             :nested_hash_attribute => {
+    #               :h1 => {:h1_2 => "first12"},
+    #               :h2 => {:h2_1 => "first21", :h2_2 => "first22"}},
+    #             :array_attribute => [1, 2, 4] }
+    #   institution1 = Institutions::Institution.new("first_inst", "First Institution", hash1)
+    #   p institution1        # -> #<Institutions::Institution @code=:first_inst, @name="First Institution", @array_attribute=[1, 2, 4], @default=false, @string_attribute="first string", @nested_hash_attribute={:h1=>{:h1_2=>"first12"}, :h2=>{:h2_1=>"first21", :h2_2=>"first22"}}>
+    #   hash2 = { "string_attribute" => "second string",
+    #             :nested_hash_attribute => {:h1 => {
+    #               :h1_2 => "second12"},
+    #               :h2 => {:h2_2 => "second22"}},
+    #             :array_attribute => [1, 2, 3], :default => true }
+    #   institution2 = Institutions::Institution.new("second_inst", "Second Institution", hash2)
+    #   p institution2        # -> <Institutions::Institution @code=:second_inst, @name="Second Institution", @array_attribute=[1, 2, 3], @default=true, @string_attribute="second string", @nested_hash_attribute={:h1=>{:h1_2=>"second12"}, :h2=>{:h2_2=>"second22"}}>
+    #   institution1.merge(institution2)
+    #   p institution1        # -> #<Institutions::Institution @code=:first_inst, @name="First Institution", @array_attribute=[1, 2, 4, 3], @default=true, @string_attribute="second string", @nested_hash_attribute={:h1=>{:h1_2=>"second12"}, :h2=>{:h2_1=>"first21", :h2_2=>"second22"}}>
+    #
+    def merge(arg={})
+      arg.to_hash.each do |key, value|
+        next unless valid_instance_variable? key
+        instance_variable = instance_variablize(key)
+        if instance_variable_defined? instance_variable
+          instance_variable_set(instance_variable, deep_merge(instance_variable_get(instance_variable), value, key))
+        else
+          writer_method = "#{key}=".to_sym
+          if respond_to? writer_method
+            send writer_method, value
+          else
+            next if [:code, :name].include? key.to_sym
+            # Set each hash value as an instance variable, but don't overwrite code or name values.
+            instance_variable_set(instance_variable, value)
+          end
+        end
+      end
+    end
+
+    #
+    # Recursively merges Hash (or any Object that can be converted to a Hash),
+    # Array and attributes that have implemented an :attribute_add method.
+    #
+    def deep_merge(arg1, arg2, key=nil)
+      # Attempt deep merge if the two arguments are
+      # instances of the same class.
+      if arg1.class == arg2.class
+        # Preserve arg1's :code and :name.
+        if (not key.nil?) and [:code, :name].include? key.to_sym
+          return arg1
+        # Recursively call deep merge for Hash objects.
+        elsif arg1.respond_to? :to_hash
+          r = {}
+          return arg1.to_hash.merge(arg2.to_hash) do |key, oldval, newval|
+            r[key] = deep_merge(oldval, newval, key)
+          end
+        # Concatenate Arrays and return uniq elements.
+        elsif arg1.instance_of? Array
+          return arg1.concat(arg2).uniq
+        # If Institutions responds to the :key_add method,
+        # go ahead and use that to add the Objects together.
+        elsif respond_to? "#{key}_add".to_sym
+          return send "#{key}_add".to_sym, arg1, arg2
+        end
+      end
+      # NOTE: Commenting this out since I'm not sure this is desirable functionality.
+      # If the two args aren't the same class, but arg1 is
+      # Array, append arg2 to arg1.
+      # if arg1.instance_of? Array
+      #   return arg1.dup<<arg2
+      # end
+      # We tried.
+      # If all else fails just replace arg1 with arg2.
+      return arg2
+    end
+    protected :deep_merge
+  end
+end

data/lib/institutions/institution/mvc.rb

@@ -0,0 +1,6 @@
+module Institutions#:no_doc
+  module Mvc#:no_doc
+    # MVC pattern attributes
+    attr_reader :models, :views, :controllers
+  end
+end

data/lib/institutions/institution/parents.rb

@@ -0,0 +1,15 @@
+module Institutions#:no_doc
+  module Parents#:no_doc
+    # Parents attributes
+    attr_reader :parent_code
+    
+    # 
+    # Merges the given parent into the Institution.
+    # Assumes the parent has a to_hash method
+    # 
+    def merge_parent(parent={})
+      # Use the parent as the base and merge in the current institution
+      merge(deep_merge(parent.to_hash, to_hash))
+    end
+  end
+end

data/lib/institutions/institution/services.rb

@@ -0,0 +1,6 @@
+module Institutions#:no_doc
+  module Services#:no_doc
+    # Services attributes
+    attr_reader :services
+  end
+end

data/lib/institutions/institution/util.rb

@@ -0,0 +1,65 @@
+module Institutions#:no_doc
+  module Util#:no_doc
+    #
+    # Converts the Institution to a hash with keys representing
+    # each Institutional attribute (as symbols) and their corresponding values.
+    # Example:
+    #
+    #   require 'institutions'
+    #   institution = Institution.new("my_inst", "My Institution")
+    #   data.to_hash   # => {:code => "my_inst", :name => "My Institution", :default => false }
+    #
+    def to_hash
+      hash = {}
+      instance_variables.each do |inst_var|
+        hash[hash_keyize(inst_var)] = instance_variable_get(inst_var)
+      end
+      hash
+    end
+
+    # 
+    # Dynamically sets attr_readers for elements
+    # 
+    def method_missing(method, *args, &block)
+      instance_variable = instance_variablize(method)
+      if instance_variable_defined? instance_variable
+        self.class.send :attr_reader, method.to_sym
+        instance_variable_get instance_variable
+      else
+        super
+      end
+    end
+
+    # 
+    # Tells users that we respond to missing methods
+    # if they are instance variables.
+    # 
+    def respond_to_missing?(method, include_private = false)
+      # Short circuit if we have invalid instance variable name,
+      # otherwise we get an exception that we don't need.
+      return super unless valid_instance_variable? method
+      if instance_variable_defined? instance_variablize(method)
+        true
+      else
+        super
+      end
+    end
+    
+    def valid_instance_variable?(id)
+      id.to_sym.id2name.match(/[\@\=\?+]/).nil?
+    end
+
+    # Convert s to an instance variable
+    def instance_variablize(s)
+      "@#{s.to_sym.id2name.downcase}".to_sym
+    end
+    private :instance_variablize
+
+    # Convert s to a hash key
+    def hash_keyize(s)
+      # Remove beginning '@' and convert to symbol for hash keys.
+      s.to_s.sub(/^@/,'').to_sym
+    end
+    private :instance_variablize
+  end
+end

data/lib/institutions/institution.rb

@@ -0,0 +1,29 @@
+module Institutions#:no_doc
+  #
+  # = institution.rb: Institution
+  #
+  # Author:: Scot Dalton
+  #
+  # An Institution represents an administrative unit and its unique configuration data.
+  # Institutions are necessarily abstract and fairly flexible to accomodate the myriad
+  # needs of applications. An institution only requires a code and name to be instantiated.
+  #
+  # == Examples:
+  #
+  #   require 'institutions'
+  #   hash = { "attribute1" => "My first attribute.", :array_attribute => [1, 2] }
+  #   institution = Institutions::Institution.new("my_inst", "My Institution", hash)
+  #
+  #   p institution   # -> #<Institutions::Institution @code=:my_inst, @name="My Institution", @attribute1="My first attribute.", @array_attribute=[1, 2], @default=false>
+  # 
+  class Institution
+    include Core
+    include Auth
+    include IpAddresses
+    include Merge
+    include Mvc
+    include Parents
+    include Services
+    include Util
+  end
+end

data/lib/institutions/version.rb

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

data/lib/institutions.rb

@@ -0,0 +1,99 @@
+# Order of paths, then order of files dictates overrides.
+
+module Institutions
+  require 'require_all'
+  require_rel 'institutions'
+
+  # Default paths/files for the module.
+  DEFAULT_LOADPATHS = [
+    (defined?(Rails) and Rails.root) ? 
+      "#{Rails.root}/config" : "./config" ]
+  DEFAULT_FILENAMES = ["institutions.yml"]
+
+  def self.loadpaths
+    @loadpaths ||= DEFAULT_LOADPATHS.dup
+  end
+
+  def self.filenames
+    @filenames ||= DEFAULT_FILENAMES.dup
+  end
+
+  # Intended for internal use only.
+  def self.loadfiles
+    loadfiles = []
+    if loadfiles.empty?
+      loadpaths.each do |loadpath|
+        filenames.each do |filename|
+          loadfile = File.join(loadpath, filename)
+          loadfiles<< loadfile if File.exists?(loadfile)
+        end
+      end
+    end
+    loadfiles
+  end
+
+  def self.reload
+    @institutions = nil
+    institutions
+  end
+
+  # Returns an Array of Institutions
+  def self.defaults
+    return institutions.values.find_all { |institution| institution.default? }
+  end
+
+  # Returns an Array of Institutions that contain the given IP.
+  def self.with_ip(ip)
+    return institutions.values.find_all { |institution| institution.includes_ip?(ip) }
+  end
+
+  #
+  # Returns a Hash of Institution instances with the Institution#code as the Hash key.
+  # Load file order can be change by the calling application by using Array methods.
+  # The default load file in Rails apps is
+  #   "#{Rails.root}/config/institutions.yml"
+  # and if not Rails
+  #   "./config/institutions.yml"
+  # To manipulate load path order and/or add directories to the path
+  #   Institutions.loadpaths << File.join("path", "to", "new", "load", "directory")
+  # To manipulate file name order and/or add file names
+  #   Institutions.filenames << "newfile.yml"
+  # 
+  def self.institutions
+    unless @institutions
+      raise NameError.new("No load path was specified.") if loadpaths.nil?
+      raise NameError.new("No files named #{filenames} exist to load in the configured load paths, #{loadpaths}. ") if filenames.empty?
+      @institutions = {}
+      loadfiles.each do |loadfile|
+        # Loop through institutions in the yaml
+        YAML.load_file(loadfile).each_pair do |code, elements|
+          code = code.to_sym
+          # Merge the new elements or add a new Institution
+          @institutions.has_key?(code) ?
+            @institutions[code].merge(elements) :
+              @institutions[code] = 
+                Institution.new(code, elements["name"] ? elements["name"] : code, elements)
+        end
+      end
+      # Handle inheritance for institutions
+      merge_parents
+    end
+    @institutions
+  end
+
+  def self.empty?
+    institutions.empty?
+  end
+
+  def self.institutions?
+    (not empty?)
+  end
+
+  # Handle inheritance for institutions
+  def self.merge_parents
+    @institutions.each do |key, institution|
+      parent_code = institution.parent_code
+      institution.merge_parent(@institutions[parent_code]) if parent_code
+    end
+  end
+end

data/test/config/institutions.yml

@@ -0,0 +1,89 @@
+# Configure what service plugins are used by Umlaut. This skeleton file
+# has been generated into your app to help you get started. 
+#
+# If a service has "disabled:true", it's currently turned off. 
+#
+# Some services require local api key or connection details as config.
+# Most services take other options for custom configuration too, not
+# all options are neccesarily listed as examples here, see source
+# or source-generated docs for more info.   
+default:
+  name: NYU Libraries
+  auth:
+    link_code: NYU
+  views:
+    dir: nyu
+    sfx_base_url: http://sfx.library.nyu.edu/sfxlcl41?
+NYU:
+  parent_institution: default
+  ip_addresses:
+    - 128.122.0.0-128.122.149.239
+    - 172.26.*.*
+    - 172.27.*.*
+    - 172.22.88.*
+    - 216.165.*.*
+    - 128.238.*.*
+NYUAD:
+  name: NYU Abu Dhabi Library
+  parent_institution: NYU 
+  views:
+    dir: nyuad
+    sfx_base_url: http://sfx.library.nyu.edu/sfxlcl41?
+  ip_addresses:
+    - 192.168.224.0/23
+    - 192.168.226.0/24
+    - 192.168.227.0/25
+    - 192.168.227.128/26
+    - 172.25.79.0/26
+    - 172.26.240.0/22
+    - 172.30.60.0/24
+    - 172.27.240.0/22
+    - 172.29.252.0/24
+    - 172.29.120.0/23
+    - 192.168.192.0/23
+    - 192.168.195.0/25
+    - 172.25.76.0/23
+    - 172.26.232.0/22
+    - 172.30.58.0/24
+    - 172.27.232.0/22
+    - 172.29.250.0/24
+    - 172.29.116.0/23
+    - 192.168.194.0/24
+    - 172.25.78.0/26
+    - 172.26.236.0/22
+    - 172.30.59.0/24
+    - 172.27.236.0/22
+    - 172.29.251.0/24
+    - 172.29.118.0/23
+CU:
+  name: The Cooper Union Library
+  login:
+    link_code: CU
+  views:
+    dir: cu
+    sfx_base_url: http://sfx.library.nyu.edu/sfxcooper?
+  controllers:
+    searcher: SearchMethods::Sfx4Solr::CU
+  ip_addresses:
+    - 199.98.16.0-199.98.31.255 
+NS:
+  name: New School Libraries
+  login:
+    link_code: NS
+  views:
+    dir: ns
+    sfx_base_url: http://sfx4.library.newschool.edu/ns?
+  controllers:
+    searcher: SearchMethods::Sfx4Solr::NS
+  ip_addresses:
+    - 149.31.0.0-149.31.255.255
+    - 69.64.210.46
+    - 69.64.210.50
+    - 69.64.210.42
+    - 69.193.198.126
+NYSID:
+  login:
+    link_code: NYSID
+  name: New York School of Interior Design Library
+  ip_addresses:
+    - 128.122.0.1

data/test/config/overwrite.yml

@@ -0,0 +1,4 @@
+NS:
+  views:
+    tag: ns tag
+    

data/test/institution/auth_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AuthTest < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/institution/core_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class CoreTest < Test::Unit::TestCase
+  def test_new
+    hash = { "first" => "My first attribute.", :array_attribute => [1, 2] }
+    assert_nothing_raised {
+      institution = Institutions::Institution.new("my_inst", "My Institution", hash)
+    }
+  end
+
+  def test_new_no_hash
+    assert_nothing_raised {
+      institution = Institutions::Institution.new("my_inst", "My Institution")
+    }
+  end
+
+  def test_new_nil_hash
+    assert_nothing_raised {
+      institution = Institutions::Institution.new("my_inst", "My Institution", nil)
+    }
+  end
+
+  def test_new_nil_code
+    assert_raise(ArgumentError) {
+      institution = Institutions::Institution.new(nil, "My Institution")
+    }
+  end
+
+  def test_new_nil_name
+    assert_raise(ArgumentError) {
+      institution = Institutions::Institution.new("my_inst", nil)
+    }
+  end
+end

data/test/institution/ip_addresses_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class IpAddressesTest < Test::Unit::TestCase
+  def setup
+    @hash = { "ip_addresses" => ["134.122.0.0-134.122.149.239",
+      "134.22.88.*", "134.165.*.*", "134.238.*.*", "134.168.224.0/23"] }
+  end
+  
+  def test_ip_addresses
+    assert_nothing_raised {
+      institution = Institutions::Institution.new("my_inst", "My Institution", @hash)
+    }
+  end
+  
+  def test_include_ip?
+    institution = Institutions::Institution.new("my_inst", "My Institution", @hash)
+    assert institution.includes_ip? "134.165.4.1"
+    assert institution.includes_ip? "134.168.224.255"
+    assert institution.includes_ip? "134.122.21.12"
+  end
+end

data/test/institution/merge_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class MergeTest < Test::Unit::TestCase
+  def test_merge
+    hash1 = { "string_attribute" => "first string", :nested_hash_attribute => {:h1 => {:h1_2 => "first12"}, 
+      :h2 => {:h2_1 => "first21", :h2_2 => "first22"}}, :array_attribute => [1, 2, 4] }
+    institution1 = Institutions::Institution.new("first_inst", "First Institution", hash1)
+    assert_equal(:first_inst, institution1.code)
+    assert_equal("First Institution", institution1.name)
+    assert_equal({:h1 => {:h1_2 => "first12"}, :h2 => {:h2_1 => "first21", :h2_2 => "first22"}}, 
+      institution1.nested_hash_attribute)
+    assert_equal([1,2,4], institution1.array_attribute)
+    assert_equal("first string", institution1.string_attribute)
+    assert_equal(false, institution1.default)
+    hash2 = { "string_attribute" => "second string", :nested_hash_attribute => {:h1 => {:h1_2 => "second12"}, 
+      :h2 => {:h2_2 => "second22"}}, :array_attribute => [1, 2, 3], :default => true }
+    institution2 = Institutions::Institution.new("second_inst", "Second Institution", hash2)
+    assert_equal(:second_inst, institution2.code)
+    assert_equal("Second Institution", institution2.name)
+    assert_equal({:h1 => {:h1_2 => "second12"}, :h2 => {:h2_2 => "second22"}}, 
+      institution2.nested_hash_attribute)
+    assert_equal([1,2,3], institution2.array_attribute)
+    assert_equal("second string", institution2.string_attribute)
+    assert_equal(true, institution2.default)
+    institution1.merge(institution2)
+    assert_equal(:first_inst, institution1.code)
+    assert_equal("First Institution", institution1.name)
+    assert_equal({:h1 => {:h1_2 => "second12"}, :h2 => {:h2_1 => "first21", :h2_2 => "second22"}},
+      institution1.nested_hash_attribute)
+    assert_equal([1,2,3,4], institution1.array_attribute.sort)
+    assert_equal("second string", institution1.string_attribute)
+    assert_equal(true, institution1.default)
+  end
+end

data/test/institution/mvc_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class MvcTest < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/institution/parents_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class ParentsTest < Test::Unit::TestCase
+  def test_parent
+    hash = { "first" => "My first attribute.", :array_attribute => [1, 2] }
+    institution = Institutions::Institution.new("my_inst", "My Institution", hash)
+    parent_hash = { "first" => "parent first", :array_attribute => [1, 2, 3], :inherited_trait => "inherited" }
+    parent_institution = Institutions::Institution.new("parent", "My Parent Institution", parent_hash)
+    institution.merge_parent(parent_institution)
+    assert_equal("My first attribute.", institution.first)
+    assert_equal("inherited", institution.inherited_trait)
+  end
+end

data/test/institution/services_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ServicesTest < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/institution/util_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class UtilTest < Test::Unit::TestCase
+  def test_missing_method
+    hash = { "an_attr" => "My first attribute.", :some_numbers => [1, 2] }
+    institution = Institutions::Institution.new("my_inst", "My Institution", hash)
+    assert_nothing_raised {
+      institution.an_attr
+    }
+    assert_equal("My first attribute.", institution.an_attr)
+    assert_equal([1, 2], institution.some_numbers)
+  end
+end

data/test/institution_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class InstitutionTest < Test::Unit::TestCase
+  def test_class
+    assert_kind_of Class, Institutions::Institution
+  end
+end

data/test/institutions_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class InstitutionsTest < Test::Unit::TestCase
+  def setup
+    # Undo any instance variable settings.
+    Institutions.send(:instance_variable_set, :@loadpaths, nil)
+    assert_equal(Institutions::DEFAULT_LOADPATHS, Institutions.loadpaths)
+    Institutions.send(:instance_variable_set, :@filenames, nil)
+    assert_equal(Institutions::DEFAULT_FILENAMES, Institutions.filenames)
+    Institutions.send(:instance_variable_set, :@institutions, nil)
+    assert_nil(Institutions.send(:instance_variable_get, :@institutions))
+  end
+  
+  def test_module
+    assert_kind_of Module, Institutions
+  end
+  
+  def test_path
+    assert_equal Institutions::DEFAULT_LOADPATHS, Institutions.loadpaths
+    Institutions.loadpaths << File.join("../config")
+    assert_equal Institutions::DEFAULT_LOADPATHS.concat(["../config"]), Institutions.loadpaths
+  end
+  
+  def test_institutions
+    Institutions.loadpaths << File.join("test", "config")
+    institutions = Institutions.institutions
+  end
+  
+  def test_institutions_overwrite
+    Institutions.loadpaths << File.join("test", "config")
+    Institutions.filenames << "overwrite.yml"
+    institutions = Institutions.institutions
+    assert_equal "ns", institutions[:NS].views["dir"]
+    assert_equal "ns tag", institutions[:NS].views["tag"]
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift("#{File.dirname(__FILE__)}/..")
+require 'test/unit'
+require File.expand_path("../../lib/institutions.rb",  __FILE__)

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: institutions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scot Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: ipaddr_range_set
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Abstract mechanism for setting up Institutions with arbitrary data elements.
+email:
+- scotdalton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- institutions.gemspec
+- lib/institutions.rb
+- lib/institutions/institution.rb
+- lib/institutions/institution/auth.rb
+- lib/institutions/institution/core.rb
+- lib/institutions/institution/ip_addresses.rb
+- lib/institutions/institution/merge.rb
+- lib/institutions/institution/mvc.rb
+- lib/institutions/institution/parents.rb
+- lib/institutions/institution/services.rb
+- lib/institutions/institution/util.rb
+- lib/institutions/version.rb
+- test/config/institutions.yml
+- test/config/overwrite.yml
+- test/institution/auth_test.rb
+- test/institution/core_test.rb
+- test/institution/ip_addresses_test.rb
+- test/institution/merge_test.rb
+- test/institution/mvc_test.rb
+- test/institution/parents_test.rb
+- test/institution/services_test.rb
+- test/institution/util_test.rb
+- test/institution_test.rb
+- test/institutions_test.rb
+- test/test_helper.rb
+homepage: https://github.com/scotdalton/institutions
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -78613404009586632
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -78613404009586632
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Abstract mechanism for setting up Institutions (whatever that means).
+test_files:
+- test/config/institutions.yml
+- test/config/overwrite.yml
+- test/institution/auth_test.rb
+- test/institution/core_test.rb
+- test/institution/ip_addresses_test.rb
+- test/institution/merge_test.rb
+- test/institution/mvc_test.rb
+- test/institution/parents_test.rb
+- test/institution/services_test.rb
+- test/institution/util_test.rb
+- test/institution_test.rb
+- test/institutions_test.rb
+- test/test_helper.rb