qa 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baa2933a1667d50c0e0f463f3ca2f123f9b680b2
-  data.tar.gz: 5985db04fd4d2ea73fd11983897bf12e97bda22f
+  metadata.gz: 6edd488c2f33caee0d368664c08a2f4ea70f3b9e
+  data.tar.gz: 0bc9d51827a5ece5ce2bf71d8b184d232d859c6b
 SHA512:
-  metadata.gz: 3033b94db5f5b5a650d3b4ceac9ac4807c4e6aed62f3d4c7253149dbb44fd1d951d9f4462a383e527260120e83b636b34d85d16ee65a475467d7c2665b361409
-  data.tar.gz: d1804893f699995ac97ab3355f256b90899b1644e4dd59a0fc326539a8ed3389332dd813da2586672b8e6b0b752be2e31c39cbda3a5f1e16d44d96947daf0c94
+  metadata.gz: 592b389388e0fde9fd85996694ecb44a5bd477cbf78c4b10d066f757989a0d4a6d842d3832f8475bb4b77040afec66131db8ed8df52a4ae81de3789d7c7fffb1
+  data.tar.gz: 406889f087a33c4089b0f72e43e91f4a542e3569c29116f3657155f30a8591e6a8140c8785ec1fc70e9ac061b9dcb43c371a8b526ee15b5543dbe9fbcbe7b4e8

data/README.md

@@ -51,17 +51,17 @@ Start questioning your authorities!
 Return a complete list of terms:
 
     /qa/terms/:vocab
-    /qa/terms/:vocab/:sub_authority
+    /qa/terms/:vocab/:subauthority
 
 Return a set of terms matching a given query
 
     /qa/search/:vocab?q=search_term
-    /qa/search/:vocab/:sub_authority?q=search_term
+    /qa/search/:vocab/:subauthority?q=search_term
 
 Return the complete information for a specific term given its identifier
 
     /qa/show/:vocab/:id
-    /qa/show/:vocab/:sub_authority/:id
+    /qa/show/:vocab/:subauthority/:id
 
 ### JSON Results
 
@@ -136,7 +136,7 @@ authority YAML files are located in `config/authorities/`.  This location can be
 the `:local_path` entry in `config/authorities.yml`.  Relative paths are assumed to be relative to
 `Rails.root`.
 
-Local authority YAML files are named for the sub-authority they represent. The included example "states" sub-authority 
+Local authority YAML files are named for the sub-authority they represent. The included example "states" sub-authority
 is named states.yml.
 
 To create your own local authority, create a .yml file, place it in the configured directory and query it
@@ -148,19 +148,35 @@ using the file's name as the sub-authority.  For example, if I create `foo.yml`,
 
 ##### List of terms
 
-	:terms:
+	terms:
 		- Term 1
 		- Term 2
-		
+
 ##### List of id and term keys and, optionally, active key
 
-	:terms:
-		- :id: id1
-		  :term: Term 1
-		  :active: true
-		- :id: id2
-		  :term: Term 2
-		  :active: false
+	terms:
+		- id: id1
+		  term: Term 1
+		  active: true
+		- id: id2
+		  term: Term 2
+		  active: false
+
+
+#### Adding your own local authorities
+
+If you'd like to add your own local authority that isn't necessarily backed by yaml, create an initializer and tell the local authority about your custom sub-authority:
+
+```ruby
+Qa::Authorities::Local.register_subauthority('names', 'LocalNames')
+```
+
+The second argument is a name of a class that represents your local authority. Then when you go to:
+
+    /qa/search/local/names?q=Zoia
+
+You'll be searching with an instance of `LocalNames`
+
 
 ### Medical Subject Headings (MeSH)
 

data/app/controllers/qa/terms_controller.rb

@@ -30,15 +30,19 @@ class Qa::TermsController < ApplicationController
 
   def init_authority
     begin
-      klass = authority_class.constantize
+      mod = authority_class.constantize
     rescue NameError => e
       logger.warn "Unable to initialize authority #{authority_class}"
       head :not_found
       return
     end
-    args = [params[:sub_authority]].compact
     begin
-      @authority = klass.new(*args)
+      @authority = if mod.kind_of? Class
+        mod.new
+      else
+        raise Qa::MissingSubAuthority, "No sub-authority provided" if params[:subauthority].blank?
+        mod.subauthority_for(params[:subauthority])
+      end
     rescue Qa::InvalidSubAuthority, Qa::MissingSubAuthority => e
       logger.warn e.message
       head :not_found

data/config/routes.rb

@@ -1,6 +1,6 @@
 Qa::Engine.routes.draw do
-  get "/terms/:vocab(/:sub_authority)",  controller: :terms, action: :index
-  get "/search/:vocab(/:sub_authority)", controller: :terms, action: :search
+  get "/terms/:vocab(/:subauthority)",  controller: :terms, action: :index
+  get "/search/:vocab(/:subauthority)", controller: :terms, action: :search
   get "/show/:vocab/:id",                controller: :terms, action: :show
-  get "/show/:vocab/:sub_authority/:id", controller: :terms, action: :show
+  get "/show/:vocab/:subauthority/:id", controller: :terms, action: :show
 end

data/lib/qa.rb

@@ -10,9 +10,9 @@ module Qa
   # Raised when the configuration directory for local authorities doesn't exist
   class ConfigDirectoryNotFound < StandardError; end
 
-  # Raised when a sub_authority is not passed into an authority
+  # Raised when a subauthority is not passed into an authority
   class MissingSubAuthority < ArgumentError; end
 
-  # Raised when a sub_authority is not valid
+  # Raised when a subauthority is not valid
   class InvalidSubAuthority < ArgumentError; end
 end

data/lib/qa/authorities/authority_with_sub_authority.rb

@@ -1,17 +1,26 @@
 module Qa::Authorities
-  class AuthorityWithSubAuthority < Base
-    attr_reader :sub_authority
+  module AuthorityWithSubAuthority
 
-    # Registers the authority and its sub-authority if it has one
-    def initialize(sub_authority=nil)
-      @sub_authority = sub_authority
-      raise Qa::MissingSubAuthority, "No sub-authority provided" if sub_authority.nil?
-      raise Qa::InvalidSubAuthority, "Unable to initialize sub-authority #{sub_authority} for #{self.class.name}" unless sub_authorities.include?(sub_authority)
+    def new(subauthority=nil)
+      raise "Initializing with as sub authority is removed. use #{self.class}.subauthority_for(#{subauthority.inspect}) instead"
+    end
+
+    def subauthority_for(subauthority)
+      validate_subauthority!(subauthority)
+      subauthority_class(subauthority).new
+    end
+
+    def subauthority_class(name)
+      [self, name].join('::').classify.constantize
+    end
+
+    def validate_subauthority!(subauthority)
+      raise Qa::InvalidSubAuthority, "Unable to initialize sub-authority #{subauthority} for #{self}. Valid sub-authorities are #{subauthorities.inspect}" unless subauthorities.include?(subauthority)
     end
 
     # By default, an authority has no subauthorities unless they
     # are defined by the subclassed authority.
-    def sub_authorities
+    def subauthorities
       []
     end
   end

data/lib/qa/authorities/base.rb

@@ -18,7 +18,7 @@ module Qa::Authorities
     def find id
     end
 
-    def full_record id, sub_authority=nil
+    def full_record id, subauthority=nil
       Deprecation.warn(".full_record is deprecated. Use .find instead")
       find(id)
     end

data/lib/qa/authorities/getty.rb

@@ -1,63 +1,17 @@
 require 'uri'
 
 module Qa::Authorities
-  class Getty < AuthorityWithSubAuthority
-    include WebServiceBase
+  module Getty
+    require 'qa/authorities/getty/aat'
+    extend AuthorityWithSubAuthority
 
-    def sub_authorities
+    def self.subauthorities
       [ "aat" ]
     end
 
-    def search q
-      parse_authority_response(json(build_query_url(q)))
+    def self.subauthority_class(_)
+      AAT
     end
-
-    # get_json is not ideomatic, so we'll make an alias
-    def json(*args)
-      get_json(*args)
-    end
-
-    def build_query_url q
-      query = URI.escape(sparql(untaint(q)))
-      "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q))}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
-    end
-
-    def sparql(q)
-      search = untaint(q)
-      # The full text index matches on fields besides the term, so we filter to ensure the match is in the term.
-      sparql = "SELECT ?s ?name {
-              ?s a skos:Concept; luc:term \"#{search}\";
-                 skos:inScheme <http://vocab.getty.edu/#{@sub_authority}/> ;
-                 gvp:prefLabelGVP [skosxl:literalForm ?name].
-              FILTER regex(?name, \"#{search}\", \"i\") .
-            } LIMIT 10"
-    end
-
-    def untaint(q)
-      q.gsub(/[^\w\s-]/, '')
-    end
-
-    def find id
-      json(find_url(id))
-    end
-
-    def find_url id
-      "http://vocab.getty.edu/#{@sub_authority}/#{id}.json"
-    end
-
-    def request_options
-      { accept: 'application/sparql-results+json'}
-    end
-
-    private
-
-    # Reformats the data received from the LOC service
-    def parse_authority_response(response)
-      response['results']['bindings'].map do |result|
-        { 'id' => result['s']['value'], 'label' => result['name']['value'] }
-      end
-    end
-
   end
 end
 

data/lib/qa/authorities/getty/aat.rb

@@ -0,0 +1,55 @@
+module Qa::Authorities
+  class Getty::AAT < Base
+    include WebServiceBase
+    def search q
+      parse_authority_response(json(build_query_url(q)))
+    end
+
+    # get_json is not ideomatic, so we'll make an alias
+    def json(*args)
+      get_json(*args)
+    end
+
+    def build_query_url q
+      query = URI.escape(sparql(untaint(q)))
+      "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q))}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
+    end
+
+    def sparql(q)
+      search = untaint(q)
+      # The full text index matches on fields besides the term, so we filter to ensure the match is in the term.
+      sparql = "SELECT ?s ?name {
+              ?s a skos:Concept; luc:term \"#{search}\";
+                 skos:inScheme <http://vocab.getty.edu/aat/> ;
+                 gvp:prefLabelGVP [skosxl:literalForm ?name].
+              FILTER regex(?name, \"#{search}\", \"i\") .
+            } LIMIT 10"
+    end
+
+    def untaint(q)
+      q.gsub(/[^\w\s-]/, '')
+    end
+
+    def find id
+      json(find_url(id))
+    end
+
+    def find_url id
+      "http://vocab.getty.edu/aat/#{id}.json"
+    end
+
+    def request_options
+      { accept: 'application/sparql-results+json'}
+    end
+
+    private
+
+    # Reformats the data received from the LOC service
+    def parse_authority_response(response)
+      response['results']['bindings'].map do |result|
+        { 'id' => result['s']['value'], 'label' => result['name']['value'] }
+      end
+    end
+
+  end
+end

data/lib/qa/authorities/loc.rb

@@ -1,73 +1,18 @@
 require 'uri'
 
 module Qa::Authorities
-  class Loc < AuthorityWithSubAuthority
-    include WebServiceBase
-    include LocSubauthority
+  module Loc
+    extend AuthorityWithSubAuthority
 
-    def sub_authorities
-      authorities + vocabularies + datatypes + preservation
-    end
-
-    def search q
-      @raw_response = get_json(build_query_url(q))
-      parse_authority_response
-    end
-
-    def build_query_url q
-      escaped_query = URI.escape(q)
-      authority_fragment = get_url_for_authority(sub_authority) + URI.escape(sub_authority)
-      return "http://id.loc.gov/search/?q=#{escaped_query}&q=#{authority_fragment}&format=json"
-    end
-
-    def find id
-      get_json(find_url(id))
-    end
-
-    def find_url id
-      "http://id.loc.gov/authorities/#{@sub_authority}/#{id}.json"
+    require 'qa/authorities/loc/generic_authority'
+    def self.subauthority_for(subauthority)
+      validate_subauthority!(subauthority)
+      GenericAuthority.new(subauthority)
     end
 
-    private
-
-    # Reformats the data received from the LOC service
-    def parse_authority_response
-      @raw_response.select {|response| response[0] == "atom:entry"}.map do |response|
-        loc_response_to_qa(response_to_struct(response))
-      end
-    end
-
-    # Converts most of the atom data into an OpenStruct object.
-    #
-    # Note that this is a pretty naive conversion.  There should probably just
-    # be a class that properly translates and stores the various pieces of
-    # data, especially if this logic could be useful in other auth lookups.
-    def response_to_struct response
-      result = response.each_with_object({}) do |result_parts, result|
-        next unless result_parts[0]
-        key = result_parts[0].sub('atom:', '').sub('dcterms:', '')
-        info = result_parts[1]
-        val = result_parts[2]
-
-        case key
-          when 'title', 'id', 'name', 'updated', 'created'
-            result[key] = val
-          when 'link'
-            result["links"] ||= []
-            result["links"] << [info["type"], info["href"]]
-        end
-      end
-
-      OpenStruct.new(result)
-    end
-
-    # Simple conversion from LoC-based struct to QA hash
-    def loc_response_to_qa data
-      {
-        "id" => data.id || data.title,
-        "label" => data.title
-      }
+    extend LocSubauthority
+    def self.subauthorities
+      authorities + vocabularies + datatypes + preservation
     end
-
   end
 end

data/lib/qa/authorities/loc/generic_authority.rb

@@ -0,0 +1,71 @@
+module Qa::Authorities
+  class Loc::GenericAuthority < Base
+    attr_reader :subauthority
+    def initialize(subauthority)
+      @subauthority = subauthority
+    end
+
+    include WebServiceBase
+
+    def search q
+      @raw_response = get_json(build_query_url(q))
+      parse_authority_response
+    end
+
+    def build_query_url q
+      escaped_query = URI.escape(q)
+      authority_fragment = Loc.get_url_for_authority(subauthority) + URI.escape(subauthority)
+      return "http://id.loc.gov/search/?q=#{escaped_query}&q=#{authority_fragment}&format=json"
+    end
+
+    def find id
+      get_json(find_url(id))
+    end
+
+    def find_url id
+      "http://id.loc.gov/authorities/#{@subauthority}/#{id}.json"
+    end
+
+    private
+
+    # Reformats the data received from the LOC service
+    def parse_authority_response
+      @raw_response.select {|response| response[0] == "atom:entry"}.map do |response|
+        loc_response_to_qa(response_to_struct(response))
+      end
+    end
+
+    # Converts most of the atom data into an OpenStruct object.
+    #
+    # Note that this is a pretty naive conversion.  There should probably just
+    # be a class that properly translates and stores the various pieces of
+    # data, especially if this logic could be useful in other auth lookups.
+    def response_to_struct response
+      result = response.each_with_object({}) do |result_parts, result|
+        next unless result_parts[0]
+        key = result_parts[0].sub('atom:', '').sub('dcterms:', '')
+        info = result_parts[1]
+        val = result_parts[2]
+
+        case key
+          when 'title', 'id', 'name', 'updated', 'created'
+            result[key] = val
+          when 'link'
+            result["links"] ||= []
+            result["links"] << [info["type"], info["href"]]
+        end
+      end
+
+      OpenStruct.new(result)
+    end
+
+    # Simple conversion from LoC-based struct to QA hash
+    def loc_response_to_qa data
+      {
+        "id" => data.id || data.title,
+        "label" => data.title
+      }
+    end
+
+  end
+end