authpds 0.1.2 → 0.2.0

data/lib/authpds/institution.rb

@@ -1,44 +0,0 @@
-class Institution < Struct.new(:display_name, :name, :default, :parent_institution, 
-  :ip_addresses, :login, :layouts, :views, :controllers, :models)
-  require 'ipaddr'
-
-  # Better initializer than Struct gives us, take a hash instead
-  # of an ordered array. :services=>[] is an array of service ids,
-  # not actual Services!
-  def initialize(h={})
-    members.each {|m| self.send( ("#{m}=").to_sym , (h.delete("#{m}".to_sym) || h.delete("#{m}"))) }
-    # If the institution is named default, take that as an
-    # indication that it's the default institution
-    self.default= true if name == "default" or name == "DEFAULT"
-    self.default= false unless default
-    # Log the fact that there are left overs in the hash
-    # Rails.logger.warn("The following institution settings were ignored: #{h.inspect}.") unless h.empty?
-  end
-
-  # Instantiates a new copy of all services included in this institution,
-  # returns an array. 
-  def instantiate_services!
-    services.collect {|s|  }
-  end
-  
-  # Check the list of IP addresses for the given IP
-  def includes_ip?(prospective_ip_address)
-    return false if ip_addresses.nil?
-    ip_prospect = IPAddr.new(prospective_ip_address)
-    ip_addresses.each do |ip_address|
-      ip_range = (ip_address.match(/[\-\*]/)) ? 
-        (ip_address.match(/\-/)) ? 
-          (IPAddr.new(ip_address.split("-")[0])..IPAddr.new(ip_address.split("-")[1])) :
-            (IPAddr.new(ip_address.gsub(/\*/, "0"))..IPAddr.new(ip_address.gsub(/\*/, "255"))) :
-              IPAddr.new(ip_address).to_range
-      return true if ip_range === ip_prospect unless ip_range.nil?
-    end
-    return false;
-  end
-  
-  def to_h
-    h = {}
-    members.each {|m| h[m.to_sym] = self.send(m)}
-    h
-  end
-end

data/lib/authpds/institution_list.rb

@@ -1,75 +0,0 @@
-class InstitutionList
-  include Singleton # get the instance with InstitutionList.instance
-  @@institutions_yaml_path = nil
-
-  def initialize
-    @institutions = nil
-  end
-
-  # Used for initialization and testing
-  def self.yaml_path=(path)
-    @@institutions_yaml_path = path
-    self.instance.reload
-  end
-  
-  def self.institutions_defined?
-    return !@@institutions_yaml_path.nil?
-  end
-
-  # Returns an Institution
-  def get(name)
-    return institutions[name]
-  end
-
-  # Returns an array of Institutions
-  def defaults
-    return institutions.values.find_all {|institution| institution.default === true}
-  end
-
-  # Returns an array of Institutions
-  def institutions_with_ip(ip)
-    return institutions.values.find_all { |institution| institution.includes_ip?(ip) }
-  end
-
-  # Reload institutions from the YAML file.
-  def reload
-    @institutions = nil
-    institutions
-    true
-  end
-
-  # Load institutions from the YAML file and return as a hash.
-  def institutions
-    unless @institutions
-      raise ArgumentError.new("institutions_yaml_path was not specified.") if @@institutions_yaml_path.nil?
-      raise NameError.new(
-        "The file #{@@institutions_yaml_path} does not exist. "+
-        "In order to use the institution feature you must create the file."
-      ) unless File.exists?(@@institutions_yaml_path)
-      institutions_hash = YAML.load_file( @@institutions_yaml_path )
-      institutions_with_parents = {}
-      # Prepare institution definitions
-      institutions_hash.each do |name, definition|
-        definition["name"] = name
-        definition["default"] = false unless definition.key?("default")
-        institutions_with_parents[name] = definition if definition.key?("parent_institution")
-      end
-      # Handle inheritance for institutions
-      institutions_with_parents.each do |name, definition|
-        institutions_hash[name] =  merge_with_parent(institutions_hash, definition)
-      end
-      # Turn the institution definitions to Institutions
-      @institutions = {}
-      institutions_hash.each do |name, definition|
-        @institutions[name] = Institution.new(definition)
-      end
-    end
-    return @institutions
-  end
-  
-  private 
-  def merge_with_parent(institutions, child)
-    parent = institutions[child["parent_institution"]]
-    return (parent["parent_institution"].nil?) ? parent.merge(child) : merge_with_parent(institutions, parent).merge(child)
-  end
-end

data/test/support/config/institutions2.yml

@@ -1,352 +0,0 @@
-# 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:
-  display_name: "NYU Libraries"
-  layouts: 
-    resolve: layouts/nyu/resolve
-    search: layouts/nyu/search
-  login:
-    link_code: NYU
-  views:
-    tabs_partial: search/nyu/tabs
-    tip1_partial: search/nyu/tip1
-    tip2_partial: search/nyu/tip2
-    sfx_base_url: http://sfx.library.nyu.edu/sfxlcl41?
-  services:
-    # Priority 2
-    NYU_Primo:
-      type: PrimoService
-      priority: 2 # After SFX, to get SFX metadata enhancement
-      status: active
-      base_url: http://bobcatdev.library.nyu.edu
-      vid: NYU
-      institution: NYU
-      holding_search_institution: NYU
-      holding_search_text: Search for this title in BobCat.
-      suppress_holdings: [ !ruby/regexp '/\$\$LBWEB/', !ruby/regexp '/\$\$LNWEB/', !ruby/regexp '/\$\$LTWEB/', !ruby/regexp '/\$\$LWEB/', !ruby/regexp '/\$\$1Restricted Internet Resources/' ]
-      ez_proxy: !ruby/regexp '/https\:\/\/ezproxy\.library\.nyu\.edu\/login\?url=/'
-      service_types:
-        - primo_source
-        - holding_search
-        - fulltext
-        - table_of_contents
-        - referent_enhance
-        - cover_image
-    # Priority 3
-    # First half of Amazon, run in foreground, get metadata and cover images.
-    Amazon:
-      disabled: true
-      display_name: Amazon.com
-      type: Amazon
-      url: http://webservices.amazon.com/onca/xml
-      api_key: 1ZQ8VEWY2A7VSJ93CW82
-      secret_key: jZNsa8uaOxo2mj1TvHQVDs464TcPEvuidSF/xepO
-      associate_tag: nyli0a-20
-      priority: 3
-      service_types:
-        - referent_enhance
-        - cover_image
-    # Priority a: Background
-    NYU_Primo_Source:
-      type: PrimoSource
-      priority: a
-      status: active
-      base_url: http://bobcatdev.library.nyu.edu
-      vid: NYU
-    # Priority c: Background          
-    # Second half of Amazon. It's Slow to lookup highlighted_link and search_inside
-    # availability, so we do it in a bg wave.  
-    Amazon_bg:
-      type: Amazon
-      disabled: true        
-      api_key: 1ZQ8VEWY2A7VSJ93CW82
-      secret_key: jZNsa8uaOxo2mj1TvHQVDs464TcPEvuidSF/xepO
-      associate_tag: nyli0a-20
-      priority: c        
-      make_aws_call: false
-      service_types:
-        - abstract
-        - highlighted_link
-        - search_inside
-        - excerpts
-    CoverThing:
-      type: CoverThing
-      disabled: true        
-      developer_key: 0db3ae0934bc35aed93ea676c883128c
-      priority: c
-      # Pre-empted by says if we already have a cover_image response
-      # from somewhere else that runs earlier, don't run this. 
-      preempted_by:
-        existing_type: cover_image
-    ElsevierCover:
-      type: ElsevierCover
-      priority: c
-    UlrichsCover:
-      type: UlrichsCover
-      priority: c      
-    GoogleBookSearch:
-      type: GoogleBookSearch
-      disabled: true
-      priority: c        
-      api_key: AIzaSyADjP7PRPsGaPYJB9tvfm8ZSpdmhUsCR1w
-    Ulrichs:
-      display_name: "Ulrich's Directory"
-      type: UlrichsLink
-      priority: c
-    IsbnDb:
-      display_name: isbndb.com
-      disabled: true
-      type: IsbnDb
-      priority: c
-      access_key: 9FAOAU2Z
-    InternetArchive:
-      display_name: the Internet Archive
-      type: InternetArchive
-      priority: c
-      # disable audio results? uncomment:
-      #num_results_for_types:
-      #  audio: 0
-    ScopusCitations:
-      type: Scopus
-      priority: c
-      json_api_key: yI7GR2aKR1n9ZvMd36rrd1zASdGJYJ
-      # partner_id: YOUR_SCOPUS_PARTNER_ID
-      # link_salt_key: "YOUR_SCOPUS_LINK_SALT_KEY"
-    # Web of Knowledge API has no api key, but your
-    # IP needs to be registered with them. See source docs
-    # for how. 
-    IsiCitations:
-      type: Isi
-      priority: c
-    # Thomson JCR LAMR api has no api key, but your
-    # IP needs to be registered with them. Same registraiton
-    # as for ISI WoK generally. 
-    Jcr:
-      type: Jcr
-      priority: c
-    # Priority d
-    HathiTrust:
-      type: HathiTrust
-      priority: d
-      # Uncomment to link through this 'internal' URL instead
-      # of following permalinks. jrochkind does this to use
-      # a WAYFless shibboleth login with EZProxy. 
-      #direct_link_base: 'https://babel.hathitrust.org/shcgi/'
-      #
-      # This next says:
-      # Don't add HathiTrust fulltext if there's already a
-      # GoogleBookSearch fulltext. Still add other HT response
-      # types. 
-      # preempted_by:
-      #   self_type: fulltext
-      #   existing_service: GoogleBookSearch
-      #   existing_type: fulltext
-    EmailExport:
-      type: EmailExport
-      priority: d
-    TxtHoldingExport:
-      type: TxtHoldingExport
-      priority: d
-    # Worldcat scraper can be quite slow, move it to wave 'd' to avoid
-    # holding up wave 'c'
-    Worldcat:
-      display_name: OCLC Worldcat.org
-      type: Worldcat
-      priority: d
-      # suppress_precheck says don't actually screen-scrape to
-      # see if the link is good, just link blindly. Mostly works
-      # for WorldCat, avoids the performance hit. 
-      suppress_precheck: true
-    WorldcatIdentities:
-      type: WorldcatIdentities
-      priority: d
-      # Turn off certain response types:
-      #note_types: false
-      #wikipedia_link: false
-      #openurl_widely_held: false
-      #require_identifier: true
-    # GPO is kind of experimental, it doesn't work great, but IF an 
-    # OpenURL includes a sudoc call number or other GPO identifiers,
-    # will try to link to full text via GPO catalog scrape. 
-    Gpo:
-      type: Gpo
-      disabled: true
-      priority: e
-      #preempted_by:
-      #  - existing_type: fulltext
-      #  - existing_type: fulltext_title_level
-    ####
-    # Link out filters: Effect what happens when a user clicks
-    # on an Umlaut link to a third party source. Link out filters
-    # can operate to change where link goes or execute side effects
-    # on click. 
-    ####
-    # Redirect outgoing links through EZProxy                
-    EZProxy:
-      type: Ezproxy
-      disabled: true
-      task: link_out_filter  
-      proxy_server:  HOSTNAME_OF_YOUR_EZPROXY
-      # By default, will pre-check with EZProxy api and
-      # only send links through EZProxy that are proxyable.
-      # requires proxy_password to be set. 
-      # optionally, set precheck_with_api false, and the EZProxy
-      # api won't be used, ALL links go through EZProxy. You may
-      # have EZProxy itself set to transparently redirect non-proxyable
-      # URLs back to non-proxied version.
-      #
-      #precheck_with_api: false
-      priority: 5
-      proxy_password: YOUR_EZPROXY_API_PWD
-      # Want to exclude certain hostnames from being directed through EZProxy?
-      # list them in array here:
-      #exclude: [ host.unversity.edu, otherhost.somewhere.com]
-    # Use of SFX api means that SFX can no longer keep statistics on
-    # clickthroughs. This link out filter will attempt to fake SFX into
-    # thinking a direct click happened when user clicks on an SFX link
-    # via Umlaut.  This is VERY fragile logic, required reverse engineering
-    # SFX and faking it out, still doesn't work all the time. But works
-    # much of the time. 
-    SFX_backchannel_record:
-      disabled: true
-      type: SfxBackchannelRecord
-      priority: 6
-
-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.*.*'
-  services:
-    NYU_SFX:
-      name: Get It @ NYU
-      display_name: Get It @ NYU
-      type: Sfx
-      base_url: http://sfx.library.nyu.edu/sfxlcl41
-      priority: 1
-      status: active
-      click_passthrough: false
-      sfx_requests_expire_crontab: '00 00 * * 00' 
-      sfx_timeout: 9
-      extra_targets_of_interest:
-        ISI_RESEARCHSOFT_EXPORT_TOOL: export_citation
-        REFWORKS_EXPORT_TOOL: export_citation
-        ASK_A_LIBRARIAN_LCL: help
-        COMMENTS_ABOUT_BOBCAT_LCL: help
-
-NYUAD:
-  display_name: NYU Abu Dhabi Library
-  parent_institution: NYU 
-  resolve_layout: layouts/nyuad/resolve
-  search_layout: layouts/nyuad/search
-  views:
-    tabs_partial: search/nyuad/tabs
-    tip1_partial: search/nyuad/tip1
-    tip2_partial: search/nyu/tip2
-    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:
-  display_name: The Cooper Union Library
-  resolve_layout: layouts/cu/resolve
-  search_layout: layouts/cu/search
-  login:
-    link_code: CU
-  views:
-    tabs_partial: search/cu/tabs
-    sfx_base_url: http://sfx.library.nyu.edu/sfxcooper?
-  ip_addresses:
-    - 199.98.16.0-199.98.31.255 
-  services:
-    # CU SFX service.
-    CU_SFX:
-      name: Get It @ Cooper Union
-      display_name: Get It @ Cooper Union
-      type: Sfx
-      base_url: http://sfx.library.nyu.edu/sfxcooper
-      priority: 1
-      status: active
-      click_passthrough: false
-      sfx_requests_expire_crontab: '00 00 * * 00' 
-      sfx_timeout: 9
-      extra_targets_of_interest:
-          CAPTURE_CITATION: export_citation
-
-NS:
-  display_name: New School Libraries
-  resolve_layout: layouts/cu/resolve
-  search_layout: layouts/cu/search
-  login:
-    link_code: NS
-  views:
-    tabs_partial: search/ns/tabs
-    sfx_base_url: http://sfx4.library.newschool.edu/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
-  services:
-    NS_SFX:
-      name: Get It @ New School Libraries
-      display_name: Get It @ New School Libraries
-      type: Sfx
-      base_url: http://sfx4.library.newschool.edu/ns
-      priority: 1
-      status: active
-      click_passthrough: true
-      sfx_requests_expire_crontab: '00 00 * * 00' 
-      sfx_timeout: 9
-      extra_targets_of_interest:
-        ISI_RESEARCHSOFT_EXPORT_TOOL: export_citation
-        REFWORKS_EXPORT_TOOL: export_citation
-    #    ISI_WEB_OF_SCIENCE: export_citation
-    #    BX_RECOMMENDER_SERVICE: help
-        ASK_A_LIBRARIAN_LCL: help
-        COMMENTS_ABOUT_BOBCAT_LCL: help
-
-NYSID:
-  login:
-    link_code: NYSID
-  resolve_layout: layouts/nysid/resolve
-  search_layout: layouts/nysid/search
-  display_name: New York School of Interior Design Library
-  ip_addresses:
-    - 128.122.0.1