qa 0.3.0 → 0.4.0

data/lib/qa/authorities/loc_subauthority.rb

@@ -0,0 +1,90 @@
+module Qa::Authorities::LocSubauthority
+
+  def get_url_for_authority authority
+    case
+      when authorities.include?(authority)  then authority_base_url
+      when vocabularies.include?(authority) then vocab_base_url
+      when datatypes.include?(authority)    then datatype_base_url
+      when preservation.include?(authority) then vocab_preservation_base_url
+    end
+  end
+
+  def authorities
+    [
+      "subjects",
+      "names",
+      "classification",
+      "childrensSubjects",
+      "genreForms",
+      "performanceMediums"
+    ]
+  end
+
+  def vocabularies
+    [ 
+      "graphicMaterials",
+      "organizations",
+      "relators",
+      "countries",
+      "ethnographicTerms",
+      "geographicAreas",
+      "languages",
+      "iso639-1",
+      "iso639-2",
+      "iso639-5",
+      "preservation",
+      "actionsGranted",
+      "agentType"
+    ]
+  end
+
+  def datatypes
+    ["edtf"]
+  end
+
+  def preservation
+    [
+      "contentLocationType",
+      "copyrightStatus",
+      "cryptographicHashFunctions",
+      "environmentCharacteristic",
+      "environmentPurpose",
+      "eventRelatedAgentRole",
+      "eventRelatedObjectRole",
+      "eventType",
+      "formatRegistryRole",
+      "hardwareType",
+      "inhibitorTarget",
+      "inhibitorType",
+      "objectCategory",
+      "preservationLevelRole",
+      "relationshipSubType",
+      "relationshipType",
+      "rightsBasis",
+      "rightsRelatedAgentRole",
+      "signatureEncoding",
+      "signatureMethod",
+      "softwareType",
+      "storageMedium"
+    ]
+  end
+
+  private
+
+  def vocab_base_url
+    "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2F"
+  end
+
+  def authority_base_url
+    "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fauthorities%2F"
+  end
+
+  def datatype_base_url
+    "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fdatatypes%2F"
+  end
+
+  def vocab_preservation_base_url
+    "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2Fpreservation%2F"
+  end
+
+end

data/lib/qa/authorities/local.rb

@@ -1,39 +1,56 @@
 module Qa::Authorities
+  class Local < Base
 
-  class Local < Qa::Authorities::Base
-    extend Deprecation
+    include Qa::Authorities::LocalSubauthority
 
-    attr_accessor :results
+    def initialize *args
+      super
+      @sub_authority ||= args.first
+      raise "No sub-authority provided" if sub_authority.nil?
+    end
 
-    class << self
-      def sub_authority(name)
-        @sub_authorities ||= {}
-        raise ArgumentError, "Invalid sub-authority '#{name}'" unless Subauthority.names.include?(name)
-        @sub_authorities[name] ||= Subauthority.new(name)
-      end
+    def sub_authorities
+      names
+    end
 
-      def sub_authorities
-        Subauthority.names
+    def search(q)
+      r = q.blank? ? [] : terms.select { |term| /\b#{q.downcase}/.match(term[:term].downcase) }
+      r.map do |res|
+        { :id => res[:id], :label => res[:term] }.with_indifferent_access
       end
+    end
 
-      def terms(sub_authority)
-        sub_authority(sub_authority).terms
+    def all
+      terms.map do |res|
+        { :id => res[:id], :label => res[:term] }.with_indifferent_access
       end
     end
 
-    delegate :sub_authority, to: self
+    def find(id)
+      terms.find { |term| term[:id] == id } || {}
+    end
+
+    private 
 
-    def search(q, sub_authority)
-      @results = sub_authority(sub_authority).search(q)
+    def terms
+      sub_authority_hash = YAML.load(File.read(sub_authority_filename))
+      terms = sub_authority_hash.with_indifferent_access.fetch(:terms, [])
+      normalize_terms(terms)
     end
 
-    def full_record(id, sub_authority)
-      sub_authority(sub_authority).full_record(id)
+    def sub_authority_filename
+      File.join(sub_authorities_path, "#{sub_authority}.yml")
     end
 
-    def get_full_record(id, sub_authority)
-      Deprecation.warn(Local, "get_full_record is deprecated and will be removed in 0.1.0. Use full_record instead", caller)
-      full_record(id, sub_authority)
+    def normalize_terms(terms)
+      terms.map do |term|
+        if term.is_a? String
+          { :id => term, :term => term }.with_indifferent_access
+        else
+          term[:id] ||= term[:term]
+          term
+        end
+      end
     end
 
   end

data/lib/qa/authorities/local_subauthority.rb

@@ -0,0 +1,18 @@
+module Qa::Authorities::LocalSubauthority
+
+  # Path to sub-authority files is either the full path to a directory or
+  # the path to a directory relative to the Rails application
+  def sub_authorities_path
+    if AUTHORITIES_CONFIG[:local_path].starts_with?(File::Separator)
+      AUTHORITIES_CONFIG[:local_path]
+    else
+      File.join(Rails.root, AUTHORITIES_CONFIG[:local_path])
+    end
+  end
+
+  # Local sub-authorities are any YAML files in the sub_authorities_path
+  def names
+    Dir.entries(sub_authorities_path).map { |f| File.basename(f, ".yml") if f.match(/yml$/) }.compact
+  end
+
+end

data/lib/qa/authorities/mesh.rb

@@ -1,32 +1,25 @@
 module Qa::Authorities
-  class Mesh
-    extend Deprecation
+  class Mesh < Base
 
-    def results
-      @results ||= begin
-                     r = Qa::SubjectMeshTerm.where('term_lower LIKE ?', "#{@q}%").limit(10)
-                     r.map { |t| {id: t.term_id, label: t.term} }
-                   end
+    def search q
+      begin
+        r = Qa::SubjectMeshTerm.where('term_lower LIKE ?', "#{@q}%").limit(10)
+        r.map { |t| {id: t.term_id, label: t.term} }
+      end
     end
 
-    def search(q, sub_authority=nil)
-      @q = q
+    def find id
+      begin
+        r = Qa::SubjectMeshTerm.where(term_id: id).limit(1).first
+        r.nil? ? nil : {id: r.term_id, label: r.term, synonyms: r.synonyms}
+      end
     end
 
-    def full_record(id)
-      @results ||= begin
-                     r = Qa::SubjectMeshTerm.where(term_id: id).limit(1).first
-                     r.nil? ? nil : {id: r.term_id, label: r.term, synonyms: r.synonyms}
-                   end
-    end
-
-    def get_full_record(id)
-      Deprecation.warn(Mesh, "get_full_record is deprecated and will be removed in 0.1.0. Use full_record instead", caller)
-      full_record(id)
-    end
-
-    # satisfy TermsController
-    def parse_authority_response
+    def all
+      begin
+        r = Qa::SubjectMeshTerm.all
+        r.map { |t| {id: t.term_id, label: t.term} }
+      end
     end
     
   end

data/lib/qa/authorities/mesh_tools/mesh_data_parser.rb

@@ -35,31 +35,6 @@ module Qa::Authorities
         return result
       end
 
-      ### XXX: delete everything below?
-
-      def self.get_synonyms(record)
-        return [] if record['ENTRY'].blank?
-        record['ENTRY'].map { |synonym| synonym.split('|').first }
-      end
-
-      def self.get_print_synonyms(record)
-        return [] if record['PRINT ENTRY'].blank?
-        record['PRINT ENTRY'].map { |synonym| synonym.split('|').first }
-      end
-
-      def self.get_description(record)
-        return [] if record['MS'].blank?
-        record['MS']
-      end
-
-      def self.get_tree(record)
-        return [] if record['MN'].blank?
-        record['MN']
-      end
-
-      def self.get_term(record)
-        record['MH'].first
-      end
     end
   end
 end

data/lib/qa/authorities/mesh_tools/mesh_importer.rb

@@ -34,8 +34,6 @@ module Qa::Authorities
         record[field].map { |s| s.split('|').first }
       end
 
-      def tree_number_to_term_list
-      end
     end
   end
 end

data/lib/qa/authorities/oclcts.rb

@@ -2,26 +2,22 @@ require 'open-uri'
 require 'nokogiri'
 
 module Qa::Authorities
-  class Oclcts < Qa::Authorities::Base
-    extend Deprecation
+  class Oclcts < WebServiceBase
   
     SRU_SERVER_CONFIG = YAML.load_file(Rails.root.join("config", "oclcts-authorities.yml"))
-    
-    attr_accessor :sub_authority
 
-    def initialize
+    def initialize *args
+      super
+      @sub_authority ||= args.first
+      raise "No sub-authority provided" if sub_authority.nil?
     end
 
-    def self.authority_valid?(sub_authority)
-      self.sub_authorities.include?(sub_authority)
+    def sub_authorities
+      SRU_SERVER_CONFIG["authorities"].map { |sub_authority| sub_authority[0] }
     end
 
-    def self.sub_authorities
-      @sub_authorities ||= SRU_SERVER_CONFIG["authorities"].map { |sub_authority| sub_authority[0] }
-    end
-
-    def search(q, sub_authority=nil)
-      raw_response = get_raw_response("prefix-query", q, sub_authority)
+    def search q
+      get_raw_response("prefix-query", q)
       r = Array.new
       raw_response.xpath('sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData', 'sru' => 'http://www.loc.gov/zing/srw/').each do |record|
         r.append({"id" => record.xpath('Zthes/term/termId').first.content, "label" => record.xpath('Zthes/term/termName').first.content})
@@ -29,19 +25,16 @@ module Qa::Authorities
       r
     end
 
-    def full_record(id, sub_authority)
-      raw_response = get_raw_response("id-lookup", id, sub_authority)
-      parse_full_record(raw_response, id)
+    def find id
+      get_raw_response("id-lookup", id)
+      parse_full_record(id)
     end
 
-    def get_full_record(id, sub_authority)
-      Deprecation.warn(Oclcts, "get_full_record is deprecated and will be removed in 0.1.0. Use full_record instead", caller)
-      full_record(id, sub_authority)
-    end
+    private
 
-    def parse_full_record(raw_xml, id)
+    def parse_full_record id
       a = {}
-      zthes_record = raw_xml.xpath("sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData/Zthes/term[termId='#{id}']", 'sru' => 'http://www.loc.gov/zing/srw/')
+      zthes_record = raw_response.xpath("sru:searchRetrieveResponse/sru:records/sru:record/sru:recordData/Zthes/term[termId='#{id}']", 'sru' => 'http://www.loc.gov/zing/srw/')
       zthes_record.children.each do |child|
         if (child.is_a? Nokogiri::XML::Element) && (!child.children.nil?) && (child.children.size == 1) && (child.children.first.is_a? Nokogiri::XML::Text)
           a[child.name] = child.children.first.to_s
@@ -50,9 +43,9 @@ module Qa::Authorities
       a
     end
 
-    def get_raw_response(query_type, id, sub_authority)
+    def get_raw_response query_type, id
       query_url = SRU_SERVER_CONFIG["url-pattern"][query_type].gsub("{query}", id).gsub("{id}", id).gsub("{authority-id}", sub_authority)
-      Nokogiri::XML(open(query_url))
+      @raw_response = Nokogiri::XML(open(query_url))
     end
   end
 end

data/lib/qa/authorities/tgnlang.rb

@@ -1,15 +1,10 @@
 require 'nokogiri'
 
 module Qa::Authorities
-  class Tgnlang
-    attr_accessor :response
-    extend Deprecation
+  class Tgnlang < Base
 
-    def initialize
-    end
-
-    def search(q, sub_authority='')
-      self.response = getTgnLang(q)
+    def search(q)
+      getTgnLang(q)
     end
 
     def getTgnLang(q)
@@ -39,16 +34,7 @@ module Qa::Authorities
         end
     end
 
-    def results
-      self.response
-    end
-
-    def get_full_record(id, sub_authority)
-      Deprecation.warn(Tgnlang, "get_full_record is deprecated and will be removed in 0.1.0. Use full_record instead", caller)
-      full_record(id, sub_authority)
-    end
-
-    def full_record(id, sub_authority)
+    def find(id)
       id = id.downcase
       Tgnlang.languages.each do |h|
         if h["label"].downcase == id

data/lib/qa/authorities/web_service_base.rb

@@ -1,20 +1,13 @@
 require 'rest_client'
-require 'deprecation'
 
 module Qa::Authorities
-  class WebServiceBase
-    attr_accessor :response, :raw_response
+  class WebServiceBase < Base
+    attr_accessor :raw_response
 
     # mix-in to retreive and parse JSON content from the web
     def get_json(url)
       r = RestClient.get url, {accept: :json}
-      self.response = JSON.parse(r)
-    end
-
-    # This method should be removed
-    # use #response instead
-    def results
-      self.response
+      JSON.parse(r)
     end
   end
 end

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/controllers/terms_controller_spec.rb

@@ -1,78 +1,127 @@
 require 'spec_helper'
 
-describe Qa::TermsController do
+describe Qa::TermsController, :type => :controller do
 
   before do
     @routes = Qa::Engine.routes
   end
 
-  describe "#index" do
+  describe "#check_vocab_param" do
+    it "should return 404 if the vocabulary is missing" do
+      get :search, { :q => "a query", :vocab => "" }
+      expect(response.code).to eq("404")
+    end
+  end
 
-    context "with errors" do
+  describe "#check_query_param" do
+    it "should return 404 if the query is missing" do
+      get :search, { :q => "", :vocab => "tgnlang" }
+      expect(response.code).to eq("404")
+    end
+  end
 
-      it "should return 400 if no vocabulary is specified" do
-        get :index, { :vocab => nil}
-        expect(response.code).to  eq("400")
+  describe "#init_authority" do
+    context "when the authority does not exist" do
+      it "should return 404" do
+        get :search, { :q => "a query", :vocab => "non-existent-authority" }
+        expect(response.code).to eq("404")
       end
-
-      it "should return 400 if no query is specified" do
-        get :index, { :q => nil}
-        expect(response.code).to eq("400")
+    end
+    context "when a sub-authority does not exist" do
+      it "should return 404 if a sub-authority does not exist" do
+        get :search, { :q => "a query", :vocab => "loc", :sub_authority => "non-existent-subauthority" }
+        expect(response.code).to eq("404")
       end
-
-      it "should return 400 if vocabulary is not valid" do
-        get :index, { :q => "foo", :vocab => "bar" }
-        expect(response.code).to eq("400")
+    end
+    context "when a sub-authority is absent" do
+      it "should return 404 for LOC" do
+        get :search, { :q => "a query", :vocab => "loc" }
+        expect(response.code).to eq("404")
       end
-
-      it "should return 400 if sub_authority is not valid" do
-        get :index, { :q => "foo", :vocab => "loc", :sub_authority => "foo" }
-        expect(response.code).to eq("400")
+      it "should return 404 for oclcts" do
+        get :search, { :q => "a query", :vocab => "oclcts" }
+        expect(response.code).to eq("404")
       end
+    end
+  end
+
+  describe "#search" do
 
+    before :each do
+      stub_request(:get, "http://id.loc.gov/search/?format=json&q=Berry&q=cs:http://id.loc.gov/authorities/names").
+        with(:headers => {'Accept'=>'application/json'}).
+        to_return(:body => webmock_fixture("loc-names-response.txt"), :status => 200)
     end
 
-    context "with a successful query" do
+    it "should return a set of terms for a tgnlang query" do
+      get :search, {:q => "Tibetan", :vocab => "tgnlang" }
+      expect(response).to be_success
+    end
 
-      before :each do
-        stub_request(:get, "http://id.loc.gov/search/?format=json&q=").
-          with(:headers => {'Accept'=>'application/json'}).
-          to_return(:body => webmock_fixture("loc-response.txt"), :status => 200)
-        stub_request(:get, "http://id.loc.gov/search/?format=json&q=cs:http://id.loc.gov/vocabulary/relators").
-          with(:headers => {'Accept'=>'application/json'}).
-          to_return(:body => webmock_fixture("loc-response.txt"), :status => 200)
-      end
+    it "should not return 404 if sub_authority is valid" do
+      get :search, { :q => "Berry", :vocab => "loc", :sub_authority => "names" }
+      expect(response).to be_success
+    end
 
-      it "should return a set of terms for a tgnlang query" do
-        get :index, {:q => "Tibetan", :vocab => "tgnlang" }
+  end
+
+  describe "#index" do
+
+    context "with supported authorities" do
+      it "should return all local authority state terms" do
+        get :index, { :vocab => "local", :sub_authority => "states" }
         expect(response).to be_success
       end
+      it "should return all MeSH terms" do
+        get :index, { :vocab => "mesh" }
+        expect(response).to be_success
+      end
+    end
 
-      it "should not return 400 if vocabulary is valid" do
-        get :index, { :q => "foo", :vocab => "loc" }
-        expect(response.code).to_not eq("400")
+    context "when the authority does not support #all" do
+      it "should return null for tgnlang" do
+        get :index, { :vocab => "tgnlang" }
+        expect(response.body).to eq("null")
       end
+      it "should return null for oclcts" do
+        get :index, { :vocab => "oclcts", :sub_authority => "mesh" }
+        expect(response.body).to eq("null")
+      end
+      it "should return null for LOC authorities" do
+        get :index, { :vocab => "loc", :sub_authority => "relators" }
+        expect(response.body).to eq("null")
+      end
+    end
+
+  end
+
+  describe "#show" do
+
+    context "with supported authorities" do
 
-      it "should not return 400 if sub_authority is valid" do
-        get :index, { :q => "foo", :vocab => "loc", :sub_authority => "relators" }
-        expect(response.code).to_not eq("400")
+      before do
+        stub_request(:get, "http://id.loc.gov/authorities/subjects/sh85077565.json").
+          with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'User-Agent'=>'Ruby'}).
+          to_return(:status => 200, :body => webmock_fixture("loc-names-response.txt"), :headers => {})
       end
 
-    end
+      it "should return an individual state term" do
+        get :show, { :vocab => "local", :sub_authority => "states", id: "OH" }
+        expect(response).to be_success
+      end
 
-    context "when returning all terms" do
+      it "should return an individual MeSH term" do
+        get :show, { vocab: "mesh", id: "D000001" }
+        expect(response).to be_success
+      end
 
-      it "should return all local authority state terms" do
-        get :index, { :vocab => "local", :sub_authority => "states" }
-        response.should be_success
+      it "should return an individual subject term" do
+        get :show, { vocab: "loc", sub_authority: "subjects", id: "sh85077565" }
+        expect(response).to be_success
       end
 
     end
 
   end
 
-  describe "#show" do
-    it "the path resolves"
-  end
-
 end