qa 0.10.1 → 0.10.2

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

@@ -2,7 +2,7 @@ module Qa::Authorities
   class Getty::AAT < Base
     include WebServiceBase
 
-    def search q
+    def search(q)
       parse_authority_response(json(build_query_url(q)))
     end
 
@@ -11,8 +11,7 @@ module Qa::Authorities
       get_json(*args)
     end
 
-    def build_query_url q
-      query = URI.escape(sparql(untaint(q)))
+    def build_query_url(q)
       "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q))}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
     end
 
@@ -25,32 +24,32 @@ module Qa::Authorities
                  gvp:prefLabelGVP [skosxl:literalForm ?name].
               FILTER regex(?name, \"#{search}\", \"i\") .
             } ORDER BY ?name"
+      sparql
     end
 
     def untaint(q)
       q.gsub(/[^\w\s-]/, '')
     end
 
-    def find id
+    def find(id)
       json(find_url(id))
     end
 
-    def find_url id
+    def find_url(id)
       "http://vocab.getty.edu/aat/#{id}.json"
     end
 
     def request_options
-      { accept: 'application/sparql-results+json'}
+      { accept: 'application/sparql-results+json' }
     end
 
     private
 
-    # Reformats the data received from the Getty service
-    def parse_authority_response(response)
-      response['results']['bindings'].map do |result|
-        { 'id' => result['s']['value'], 'label' => result['name']['value'] }
+      # Reformats the data received from the Getty service
+      def parse_authority_response(response)
+        response['results']['bindings'].map do |result|
+          { 'id' => result['s']['value'], 'label' => result['name']['value'] }
+        end
       end
-    end
-
   end
 end

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

@@ -2,7 +2,7 @@ module Qa::Authorities
   class Getty::TGN < Base
     include WebServiceBase
 
-    def search q
+    def search(q)
       parse_authority_response(json(build_query_url(q)))
     end
 
@@ -11,11 +11,11 @@ module Qa::Authorities
       get_json(*args)
     end
 
-    def build_query_url q
+    def build_query_url(q)
       query = URI.escape(sparql(untaint(q)))
       # Replace ampersands, otherwise the query will fail
       # Gsub hack to convert the encoded regex in the REPLACE into a form Getty understands
-      "http://vocab.getty.edu/sparql.json?query=#{query.gsub('&','%26').gsub(',[%5E,]+,[%5E,]+$','%2C[^%2C]%2B%2C[^%2C]%2B%24')}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
+      "http://vocab.getty.edu/sparql.json?query=#{query.gsub('&', '%26').gsub(',[%5E,]+,[%5E,]+$', '%2C[^%2C]%2B%2C[^%2C]%2B%24')}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
     end
 
     # Use a regex to exclude the continent and 'world' from the query
@@ -25,12 +25,12 @@ module Qa::Authorities
       search = untaint(q)
       if search.include?(' ')
         ex = "(("
-        search.split(' ').each do | i |
+        search.split(' ').each do |i|
           ex += "regex(CONCAT(?name, ', ', REPLACE(str(?par), \",[^,]+,[^,]+$\", \"\")), \"#{i}\",\"i\" ) && "
         end
         ex = ex[0..ex.length - 4]
         ex += ') && ('
-        search.split(' ').each do | i |
+        search.split(' ').each do |i|
           ex += "regex(?name, \"#{i}\",\"i\" ) || "
         end
         ex = ex[0..ex.length - 4]
@@ -48,33 +48,33 @@ module Qa::Authorities
                   gvp:parentString ?par .
               FILTER #{ex} .
             } ORDER BY ?name ASC(?par)"
+      sparql
     end
 
     def untaint(q)
       q.gsub(/[^\w\s-]/, '')
     end
 
-    def find id
+    def find(id)
       json(find_url(id))
     end
 
-    def find_url id
+    def find_url(id)
       "http://vocab.getty.edu/tgn/#{id}.json"
     end
 
     def request_options
-      { accept: 'application/sparql-results+json'}
+      { accept: 'application/sparql-results+json' }
     end
 
     private
 
-    # Reformats the data received from the service
-    # Adds the parentString, minus the contintent and 'World' for disambiguation
-    def parse_authority_response(response)
-      response['results']['bindings'].map do |result|
-        { 'id' => result['s']['value'], 'label' => result['name']['value']  + ' (' + result['par']['value'].gsub(/\,[^\,]+\,[^\,]+$/, '') + ')' }
+      # Reformats the data received from the service
+      # Adds the parentString, minus the contintent and 'World' for disambiguation
+      def parse_authority_response(response)
+        response['results']['bindings'].map do |result|
+          { 'id' => result['s']['value'], 'label' => result['name']['value'] + ' (' + result['par']['value'].gsub(/\,[^\,]+\,[^\,]+$/, '') + ')' }
+        end
       end
-    end
-
   end
 end

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

@@ -2,7 +2,7 @@ module Qa::Authorities
   class Getty::Ulan < Base
     include WebServiceBase
 
-    def search q
+    def search(q)
       parse_authority_response(json(build_query_url(q)))
     end
 
@@ -11,10 +11,9 @@ module Qa::Authorities
       get_json(*args)
     end
 
-    def build_query_url q
-      query = URI.escape(sparql(untaint(q)))
-      # Replace ampersands, otherwise the query will fail
-      "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q)).gsub('&','%26')}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
+    # Replace ampersands, otherwise the query will fail
+    def build_query_url(q)
+      "http://vocab.getty.edu/sparql.json?query=#{URI.escape(sparql(q)).gsub('&', '%26')}&_implicit=false&implicit=true&_equivalent=false&_form=%2Fsparql"
     end
 
     def sparql(q)
@@ -22,7 +21,7 @@ module Qa::Authorities
       # if more than one term is supplied, check both preferred and alt labels
       if search.include?(' ')
         ex = "("
-        search.split(' ').each do | i |
+        search.split(' ').each do |i|
           ex += "regex(CONCAT(?name, ' ', ?alt), \"#{i}\",\"i\" ) && "
         end
         ex = ex[0..ex.length - 4]
@@ -39,33 +38,33 @@ module Qa::Authorities
                  skos:altLabel ?alt .
               FILTER #{ex} .
             } ORDER BY ?name"
+      sparql
     end
 
     def untaint(q)
       q.gsub(/[^\w\s-]/, '')
     end
 
-    def find id
+    def find(id)
       json(find_url(id))
     end
 
-    def find_url id
+    def find_url(id)
       "http://vocab.getty.edu/ulan/#{id}.json"
     end
 
     def request_options
-      { accept: 'application/sparql-results+json'}
+      { accept: 'application/sparql-results+json' }
     end
 
     private
 
-    # Reformats the data received from the Getty service
-    # Add the bio for disambiguation
-    def parse_authority_response(response)
-      response['results']['bindings'].map do |result|
-        { 'id' => result['s']['value'], 'label' => result['name']['value'] + ' (' + result['bio']['value'] + ')' }
+      # Reformats the data received from the Getty service
+      # Add the bio for disambiguation
+      def parse_authority_response(response)
+        response['results']['bindings'].map do |result|
+          { 'id' => result['s']['value'], 'label' => result['name']['value'] + ' (' + result['bio']['value'] + ')' }
+        end
       end
-    end
-
   end
 end

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

@@ -7,65 +7,64 @@ module Qa::Authorities
 
     include WebServiceBase
 
-    def search q
+    def search(q)
       @raw_response = get_json(build_query_url(q))
       parse_authority_response
     end
 
-    def build_query_url q
+    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"
+      "http://id.loc.gov/search/?q=#{escaped_query}&q=#{authority_fragment}&format=json"
     end
 
-    def find id
+    def find(id)
       get_json(find_url(id))
     end
 
-    def find_url id
+    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))
+      # 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
-    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]
+      # 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)
+        contents = 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
+          case key
           when 'title', 'id', 'name', 'updated', 'created'
             result[key] = val
           when 'link'
             result["links"] ||= []
             result["links"] << [info["type"], info["href"]]
+          end
         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
+        OpenStruct.new(contents)
+      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

data/lib/qa/authorities/loc_subauthority.rb

@@ -1,11 +1,9 @@
 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
+  def get_url_for_authority(authority)
+    if authorities.include?(authority) then authority_base_url
+    elsif vocabularies.include?(authority) then vocab_base_url
+    elsif datatypes.include?(authority)    then datatype_base_url
+    elsif preservation.include?(authority) then vocab_preservation_base_url
     end
   end
 
@@ -71,20 +69,19 @@ module Qa::Authorities::LocSubauthority
 
   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 vocab_base_url
+      "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2F"
+    end
 
-  def datatype_base_url
-    "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fdatatypes%2F"
-  end
+    def authority_base_url
+      "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fauthorities%2F"
+    end
 
-  def vocab_preservation_base_url
-    "cs%3Ahttp%3A%2F%2Fid.loc.gov%2Fvocabulary%2Fpreservation%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

@@ -7,58 +7,59 @@ module Qa::Authorities
     autoload :TableBasedAuthority
     autoload :MysqlTableBasedAuthority
 
-    def self.config
-      @config
-    end
+    class << self
+      attr_reader :config
 
-    def self.load_config(file)
-      @config = YAML.load_file(file)
-    end
+      def load_config(file)
+        @config = YAML.load_file(file)
+      end
 
-    # 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 self.subauthorities_path
-      if config[:local_path].starts_with?(File::Separator)
-        config[:local_path]
-      else
-        File.join(Rails.root, config[:local_path])
+      # 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 subauthorities_path
+        if config[:local_path].starts_with?(File::Separator)
+          config[:local_path]
+        else
+          File.join(Rails.root, config[:local_path])
+        end
       end
-    end
 
-    # Local sub-authorities are any YAML files in the subauthorities_path
-    def self.names
-      unless Dir.exists? subauthorities_path
-        raise Qa::ConfigDirectoryNotFound, "There's no directory at #{subauthorities_path}. You must create it in order to use local authorities"
+      # Local sub-authorities are any YAML files in the subauthorities_path
+      def names
+        unless Dir.exist? subauthorities_path
+          raise Qa::ConfigDirectoryNotFound, "There's no directory at #{subauthorities_path}. You must create it in order to use local authorities"
+        end
+        Dir.entries(subauthorities_path).map { |f| File.basename(f, ".yml") if f =~ /yml$/ }.compact
       end
-      Dir.entries(subauthorities_path).map { |f| File.basename(f, ".yml") if f.match(/yml$/) }.compact
-    end
 
-    def self.subauthority_for(subauthority)
-      validate_subauthority!(subauthority)
-      registry.instance_for(subauthority)
-    end
+      def subauthority_for(subauthority)
+        validate_subauthority!(subauthority)
+        registry.instance_for(subauthority)
+      end
 
-    def self.registry
-      @registry ||= begin
-        Registry.new do |reg|
-          register_defaults(reg)
+      def registry
+        @registry ||= begin
+          Registry.new do |reg|
+            register_defaults(reg)
+          end
         end
       end
-    end
 
-    def self.register_subauthority(subauthority, class_name)
-      registry.add(subauthority, class_name)
-    end
+      def register_subauthority(subauthority, class_name)
+        registry.add(subauthority, class_name)
+      end
 
-    def self.subauthorities
-      registry.keys
-    end
+      def subauthorities
+        registry.keys
+      end
+
+      private
 
-    private
-      def self.register_defaults(reg)
-        names.each do |name|
-          reg.add(name, 'Qa::Authorities::Local::FileBasedAuthority')
+        def register_defaults(reg)
+          names.each do |name|
+            reg.add(name, 'Qa::Authorities::Local::FileBasedAuthority')
+          end
         end
-      end
+    end
   end
 end