qa 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 873698ac06d737a85d38e567cfbc86a237c11726
+  data.tar.gz: aca833c7eaaf7b53e5181f9705828e6bdd64267d
+SHA512:
+  metadata.gz: 48ff5de3dabe9ff003cd066d67ded425ac5782ecc5f493d41879832ab0d9bf047118f96b10d091656af0a866e1169e896a86d15958014b15091e1b3f6004d356
+  data.tar.gz: 860a602fc303ec68bdd76f7651a5d193c97ac2656fa281ee83b7c998acb9461d4800f73bd8c8a1d63b53591b446f315cff64854694fbda8e87f93d6b897f3e43

data/app/controllers/qa/terms_controller.rb

@@ -6,50 +6,57 @@ class Qa::TermsController < ApplicationController
 
   before_action :check_search_params, only:[:search]
   before_action :check_vocab_param, :check_authority, :check_sub_authority
-  
+
   #search that returns all results
   def index
     #initialize the authority and run the search. if there's a sub-authority and it's valid, include that param
-    @authority = authority_class.constantize.new(params[:q], params[:sub_authority])
-    
-    #parse the results
-    @authority.parse_authority_response
-    
+    @authority = authority_class.constantize.new
+    @authority.search(params[:q], params[:sub_authority])
+
     respond_to do |format|
-      format.html { render :layout => false, :text => @authority.results }
-      format.json { render :layout => false, :text => @authority.results }
+      format.html { render :layout => false, json: @authority.results }
+      format.json { render :layout => false, json: @authority.results }
       format.js   { render :layout => false, :text => @authority.results }
     end
   end
-  
+
   def search
-    
     #convert wildcard to be URI encoded
     params[:q].gsub!("*", "%2A")
-   
+
     #initialize the authority and run the search. if there's a sub-authority and it's valid, include that param
-    @authority = authority_class.constantize.new(params[:q], params[:sub_authority])
-    
-    #parse the results
-    @authority.parse_authority_response
-    
+    @authority = authority_class.constantize.new
+    @authority.search(params[:q], params[:sub_authority])
+
     respond_to do |format|
-      format.html { render :layout => false, :text => @authority.results }
-      format.json { render :layout => false, :text => @authority.results }
+      format.html { render :layout => false, :text => @authority.results.to_json }
+      format.json { render :layout => false, :text => @authority.results.to_json }
       format.js   { render :layout => false, :text => @authority.results }
     end
 
   end
 
+  def show
+    check_sub_authority
+    authority = authority_class.constantize.new
+    result = authority.get_full_record(params[:id], params[:sub_authority])
+
+    respond_to do |format|
+      format.html { render :layout => false, :text => result.to_json }
+      format.json { render :layout => false, :text => result.to_json }
+      format.js   { render :layout => false, :text => result }
+    end
+  end
+
   def check_vocab_param
     unless params[:vocab].present?
-      redirect_to :status => 400
+      head :bad_request
     end
   end
-  
+
   def check_search_params
     unless params[:q].present? && params[:vocab].present?
-      redirect_to :status => 400
+      head :bad_request
     end
   end
 
@@ -57,13 +64,13 @@ class Qa::TermsController < ApplicationController
     begin
       authority_class.constantize
     rescue
-      redirect_to :status => 400
-    end 
+      head :bad_request
+    end
   end
 
   def check_sub_authority
     unless params[:sub_authority].nil?
-      redirect_to :status => 400 unless authority_class.constantize.authority_valid?(params[:sub_authority])
+      head :bad_request unless authority_class.constantize.authority_valid?(params[:sub_authority])
     end
   end
 

data/config/routes.rb

@@ -4,4 +4,6 @@ Qa::Engine.routes.draw do
   match "/terms/:vocab" => "terms#index", :via=>:get
   match "/terms/:vocab/:sub_authority" => "terms#index", :via=>:get
   match "/terms" => "terms#index", :via=>:get
+  match "/show/:vocab/:id" => "terms#show", :via=>:get
+  match "/show/:vocab/:sub_authority/:id" => "terms#show", :via=>:get
 end

data/lib/qa/authorities.rb

@@ -5,8 +5,10 @@ module Qa::Authorities
   autoload :Lcsh
   autoload :Loc
   autoload :Local
+  autoload :Subauthority, 'qa/authorities/local/subauthority'
   autoload :Mesh
   autoload :MeshTools
   autoload :Oclcts
   autoload :Tgnlang
-end
+  autoload :WebServiceBase
+end

data/lib/qa/authorities/base.rb

@@ -2,21 +2,13 @@ require 'curl'
 
 module Qa::Authorities
   class Base
-    attr_accessor :response, :query_url, :raw_response
 
-    def initialize(q, sub_authority='')
-      # Implement Me and set self.query_url
-
-      if self.query_url == nil
-        raise Exception 'query url in your authorities lib is not set (implement in initialize)'
-      end
-
-      #Default implementation assumed query_url is set
-      http = Curl.get(self.query_url) do |http|
-        http.headers['Accept'] = 'application/json'
-      end
+    # do an autocomplete search
+    def search(query, sub_authority=nil)
+    end
 
-      self.raw_response = JSON.parse(http.body_str)
+    # return information on a specific record
+    def get_full_record(id, sub_authority=nil)
     end
 
     def self.authority_valid?(sub_authority)
@@ -27,24 +19,5 @@ module Qa::Authorities
       [] #Overwrite if you have sub_authorities
     end
 
-    def parse_authority_response
-      # Overwrite me unless your raw response needs no parsing
-      self.response = self.raw_response
-
-    end
-
-    def get_full_record(id)
-      # implement me
-      {"id"=>id}.to_json
-    end
-
-    # Parse the result from LOC, and return an JSON array of terms that match the query.
-    def results
-      self.response.to_json
-    end
-
-    # TODO: there's other info in the self.response that might be worth making access to, such as
-    # RDF links, etc.
-
   end
 end

data/lib/qa/authorities/lcsh.rb

@@ -1,46 +1,41 @@
 require 'uri'
 
 module Qa::Authorities
-  class Lcsh < Qa::Authorities::Base
-
-    # Initialze the Lcsh class with a query and get the http response from LOC's server.
-    # This is set to a JSON object
-    def initialize(q, sub_authority='')
-      self.query_url= "http://id.loc.gov/authorities/suggest/?q=" + q
+  class Lcsh < Qa::Authorities::WebServiceBase
 
+    def initialize
       super
     end
 
-    # Format response to the correct JSON structure
-    def parse_authority_response
-      self.response = build_response
-    end
-
-    def query
-      self.raw_response[0]
-    end
-
-    def suggestions
-      self.raw_response[1]
+    def search(q, sub_authority='')
+      query_url = "http://id.loc.gov/authorities/suggest/?q=" + q
+      json_terms = get_json(query_url)
+      self.response = build_response(json_terms)
     end
 
-    def urls_for_suggestions
-      self.raw_response[3]
+    def get_full_record(id, sub_authority)
     end
 
     private
 
-    def build_response a = Array.new
-      self.suggestions.each_index do |i|
-        a << {"id"=>get_id_from_url(urls_for_suggestions[i]), "label"=>suggestions[i]}
+    def build_response(json_response)
+      a = Array.new
+      suggests = json_response[1].each
+      urls = json_response[3].each
+      loop do
+        begin
+          a << {"id"=>get_id_from_url(urls.next), "label"=>suggests.next }
+        rescue StopIteration
+          break
+        end
       end
-      return a
+      self.response = a
     end
 
-    def get_id_from_url url
+    def get_id_from_url(url)
       uri = URI(url)
-      return uri.path.split(/\//).last
+      return uri.path.split('/').last
     end
 
   end
-end
+end

data/lib/qa/authorities/loc.rb

@@ -1,200 +1,160 @@
 require 'uri'
 
 module Qa::Authorities
-  class Loc < Qa::Authorities::Base
+  class Loc < Qa::Authorities::WebServiceBase
 
     # Initialze the Loc class with a query and get the http response from LOC's server.
     # This is set to a JSON object
-    def initialize(q, sub_authority='')
+    def initialize
+    end
+
+    def search(q, sub_authority=nil)
+      if ! (sub_authority.nil?  || Loc.sub_authorities.include?(sub_authority))
+        @raw_response = nil
+        @response = nil
+        return
+      end
       q += '*'
-      authority_url = sub_authorityURL(sub_authority)
-      self.query_url =  "http://id.loc.gov/search/?q=#{q}&q=#{authority_url}&format=json"
+      authority_fragment = sub_authorityURL(sub_authority)
+      query_url =  "http://id.loc.gov/search/?q=#{q}&q=#{authority_fragment}&format=json"
+      @raw_response = get_json(query_url)
+      @response = parse_authority_response(@raw_response)
+    end
 
-      super
+    def self.sub_authority_table
+      @sub_authority_table ||=
+        begin
+          vocab_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2F'
+          authority_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fauthorities%2F'
+          datatype_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fdatatypes%2F'
+          vocab_preservation_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2Fpreservation%2F'
+          {
+            'subjects' => authority_base_url,
+            'names' => authority_base_url,
+            'classification' => authority_base_url,
+            'childrensSubjects' => authority_base_url,
+            'genreForms' => authority_base_url,
+            'graphicMaterials' => vocab_base_url,
+            'organizations' => vocab_base_url,
+            'relators' => vocab_base_url,
+            'countries' => vocab_base_url,
+            'geographicAreas' => vocab_base_url,
+            'languages' => vocab_base_url,
+            'iso639-1' => vocab_base_url,
+            'iso639-2' => vocab_base_url,
+            'iso639-5' => vocab_base_url,
+            'edtf' => datatype_base_url,
+            'preservation' => vocab_base_url,
+            'actionsGranted' => vocab_base_url,
+            'agentType' => vocab_base_url,
+            'contentLocationType' => vocab_preservation_base_url,
+            'copyrightStatus' => vocab_preservation_base_url,
+            'cryptographicHashFunctions' => vocab_preservation_base_url,
+            'environmentCharacteristic' => vocab_preservation_base_url,
+            'environmentPurpose' => vocab_preservation_base_url,
+            'eventRelatedAgentRole' => vocab_preservation_base_url,
+            'eventRelatedObjectRole' => vocab_preservation_base_url,
+            'eventType' => vocab_preservation_base_url,
+            'formatRegistryRole' => vocab_preservation_base_url,
+            'hardwareType' => vocab_preservation_base_url,
+            'inhibitorTarget' => vocab_preservation_base_url,
+            'inhibitorType' => vocab_preservation_base_url,
+            'objectCategory' => vocab_preservation_base_url,
+            'preservationLevelRole' => vocab_preservation_base_url,
+            'relationshipSubType' => vocab_preservation_base_url,
+            'relationshipType' => vocab_preservation_base_url,
+            'rightsBasis' => vocab_preservation_base_url,
+            'rightsRelatedAgentRole' => vocab_preservation_base_url,
+            'signatureEncoding' => vocab_preservation_base_url,
+            'signatureMethod' => vocab_preservation_base_url,
+            'softwareType' => vocab_preservation_base_url,
+            'storageMedium' => vocab_preservation_base_url
+          }
+        end
     end
 
+
     def sub_authorityURL(sub_authority)
-      vocab_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2F'
-      authority_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fauthorities%2F'
-      datatype_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fdatatypes%2F'
-      vocab_preservation_base_url = 'cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2Fpreservation%2F'
-
-      case sub_authority
-        when 'subjects'
-          return authority_base_url + URI.escape(sub_authority)
-        when 'names'
-          return authority_base_url + URI.escape(sub_authority)
-        when 'classification'
-          return authority_base_url + URI.escape(sub_authority)
-        when 'childrensSubjects'
-          return authority_base_url + URI.escape(sub_authority)
-        when 'genreForms'
-          return authority_base_url + URI.escape(sub_authority)
-        when 'graphicMaterials'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'organizations'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'relators'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'countries'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'geographicAreas'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'languages'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'iso639-1'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'iso639-2'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'iso639-5'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'edtf'
-          return datatype_base_url + URI.escape(sub_authority)
-        when 'preservation'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'actionsGranted'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'agentType'
-          return vocab_base_url + URI.escape(sub_authority)
-        when 'contentLocationType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'copyrightStatus'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'cryptographicHashFunctions'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'environmentCharacteristic'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'environmentPurpose'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'eventRelatedAgentRole'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'eventRelatedObjectRole'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'eventType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'formatRegistryRole'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'hardwareType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'inhibitorTarget'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'inhibitorType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'objectCategory'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'preservationLevelRole'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'relationshipSubType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'relationshipType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'rightsBasis'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'rightsRelatedAgentRole'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'signatureEncoding'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'signatureMethod'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'softwareType'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        when 'storageMedium'
-          return vocab_preservation_base_url + URI.escape(sub_authority)
-        else
-          return ''
-      end
+      base_url = Loc.sub_authority_table[sub_authority]
+      return "" if base_url.nil?
+      base_url + URI.escape(sub_authority)
+    end
+
+    def self.authority_valid?(authority)
+      self.sub_authorities.include?(authority)
     end
 
     def self.sub_authorities
-      ['iso639-2', 'subjects', 'names', 'classification', 'childrensSubjects', 'genreForms', 'graphicMaterials', 'organizations', 'relators', 'countries', 'geographicAreas', 'languages', 'iso639-5', 'edtf', 'preservation', 'actionsGranted', 'agentType', 'contentLocationType', 'copyrightStatus', 'cryptographicHashFunctions', 'environmentCharacteristic', 'environmentPurpose', 'eventRelatedAgentRole', 'eventRelatedObjectRole', 'eventType', 'formatRegistryRole', 'hardwareType', 'inhibitorTarget', 'inhibitorType', 'objectCategory', 'preservationLevelRole', 'relationshipSubType', 'relationshipType', 'rightsBasis', 'rightsRelatedAgentRole', 'signatureEncoding', 'signatureMethod', 'softwareType', 'storageMedium']
+      @sub_authorities ||= sub_authority_table.keys
     end
 
 
-    def parse_authority_response
+    def parse_authority_response(raw_response)
       result = []
-      self.raw_response.each do |single_response|
-        if single_response[0] == "atom:entry"
-          id = nil
-          label = ''
-          single_response.each do |result_part|
-            if(result_part[0] == 'atom:title')
-              label = result_part[2]
-            end
-
-            if(result_part[0] == 'atom:id')
-              id = result_part[2]
-            end
-
+      raw_response.each do |single_response|
+        next if single_response[0] != "atom:entry"
+        id = nil
+        label = ''
+        single_response.each do |result_part|
+          case result_part[0]
+          when 'atom:title'
+            label = result_part[2]
+          when 'atom:id'
+            id = result_part[2]
           end
-
-          id ||= label
-          result << {"id"=>id, "label"=>label}
-
         end
+
+        id ||= label
+        result << {"id"=>id, "label"=>label}
       end
-      self.response = result
+      result
     end
 
-    def get_full_record(id)
-      full_record = nil
-      parsed_result = {}
-      self.raw_response.each do |single_response|
-        if single_response[0] == "atom:entry"
-
-          single_response.each do |result_part|
-            if(result_part[0] == 'atom:title')
-              if id == result_part[2]
-                full_record = single_response
-              end
-            end
-
-            if(result_part[0] == 'atom:id')
-              if id == result_part[2]
-                full_record = single_response
-              end
-            end
-
+    def find_record_in_response(raw_response, id)
+      raw_response.each do |single_response|
+        next if single_response[0] != "atom:entry"
+        single_response.each do |result_part|
+          if (result_part[0] == 'atom:title' ||
+              result_part[0] == 'atom:id') && id == result_part[2]
+            return single_response
           end
-
         end
       end
+      return nil
+    end
 
+    def get_full_record(id, sub_authority)
+      search(id, sub_authority)
+      full_record = find_record_in_response(@raw_response, id)
 
-      if full_record != nil
-        full_record.each do |section|
-          if section.class == Array
-            label = section[0].split(':').last.to_s
-            case label
-              when 'title'
-                parsed_result[label] = section[2]
-              when 'link'
-                if section[1]['type'] != nil
-                  parsed_result[label + "||#{section[1]['type']}"] = section[1]["href"]
-                else
-                  parsed_result[label] = section[1]["href"]
-                end
-              when 'id'
-                parsed_result[label] = section[2]
-              when 'author'
-                author_list = []
-                #FIXME: Find example with two authors to better understand this data.
-                author_list << section[2][2]
-                parsed_result[label] = author_list
-              when 'updated'
-                parsed_result[label] = section[2]
-              when 'created'
-                parsed_result[label] = section[2]
-            end
+      if full_record.nil?
+        # record not found
+        return {}
+      end
 
+      parsed_result = {}
+      full_record.each do |section|
+        if section.class == Array
+          label = section[0].split(':').last.to_s
+          case label
+          when 'title', 'id', 'updated', 'created'
+            parsed_result[label] = section[2]
+          when 'link'
+            if section[1]['type'] != nil
+              parsed_result[label + "||#{section[1]['type']}"] = section[1]["href"]
+            else
+              parsed_result[label] = section[1]["href"]
+            end
+          when 'author'
+            author_list = []
+            #FIXME: Find example with two authors to better understand this data.
+            author_list << section[2][2]
+            parsed_result[label] = author_list
           end
         end
-      else
-        raise Exception 'Lookup without using a result search first not implemented yet'
       end
-
       parsed_result
-
     end
 
   end
-end
+end