qa 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a931f43dc836c7a6c3549214432edc8edced5aa
-  data.tar.gz: 21320a07cbd96a225e366691a597e69d88b3b5d2
+  metadata.gz: 8822d1805cf5688f8efa87ccabaf20d5e84a07dd
+  data.tar.gz: 97edb3df48fa497fafaa6e82c7a98b793cbe952b
 SHA512:
-  metadata.gz: 437eed2438b6c61245496ca8082693ba7ffb35bb6a0f464bb5dbf5c869c87bac1890490c58ef7e4f7364b31a588f5614a1e06a8609e74dcabf9e2f5be6d882b2
-  data.tar.gz: a65f9e0c31b21174f37aa7e55a5e9509abdb67dfb8f382eafdd1bc17c484dabc08b77f9fc95c046cea019a27b802c7d8962a325ff8631c41c04ff85fafc78b97
+  metadata.gz: 4f271ed20bc568662f0f74a84804b6eb23c659f9894dc0719bd567210b501dec1a93c733d51aee9260519ee59ae1518e07726eaa56ad2716af0e3bd1adc20a5e
+  data.tar.gz: eb5de6d6f4f892d8661568a6e889cb22ca408acc2957a19a308261763383ab34fc1661dc35b2758775dcdde92d0f0d59b4c7f7867a4a8f77ecddf7d266778022

data/README.md

@@ -34,9 +34,15 @@ Add the gem to your Gemfile
 
     gem 'qa'
 
-Add the engine to your config/routes.rb file
+Run bundler
 
-    mount Qa::Engine => '/qa'
+    bundle install
+
+Install the gem to your application
+
+    rails generate qa:install
+
+This will copy over some additional config files and add the engine's routes to your `config/route.rb`.
 
 Start questioning your authorities!
 
@@ -137,14 +143,16 @@ for the "states" sub-authority would be named states.yml.
 		  :term: Term 2
 		  :active: false
 
-# Medical Subject Headings (MeSH)
+# Experimental Features
+
+## Medical Subject Headings (MeSH)
 
 Provides autocompletion of [MeSH terms](http://www.nlm.nih.gov/mesh/introduction.html). This
 implementation is simple, and only provides *descriptors* and does not implement *qualifiers* (in
 the technical MeSH sense of these terms). The terms are stored in a local database, which is then
 queried to provide the suggestions.
 
-## Loading Terms
+### Loading Terms
 
 To import the mesh terms into the local database, first download the MeSH descriptor dump in ASCII
 format  (see [http://www.nlm.nih.gov/mesh/filelist.html][]). Once you have this file, the rake task
@@ -154,25 +162,10 @@ format  (see [http://www.nlm.nih.gov/mesh/filelist.html][]). Once you have this
 
 This may take a few minutes to finish.
 
-# TODOs
-
-* Provide show method to TermsController to return individual terms
-
-check the issue list for more...
-
-# Known Issues
-
-Some users have reported errors resulting from the curb gem.  When performing queries, the application will crash with the error:
-
-    Trace/BPT trap: 5
-
-The solution is to install the curb gem from the master branch on Github.  To do this, add the following line to the Gemfile of your
-application:
-
-    gem 'curb', github: 'taf2/curb'
-
 # Developer Notes
 
+[How to Contribute](./CONTRIBUTING.md)
+
 To develop this gem, clone the repository, then run:
 
     bundle install
@@ -181,7 +174,15 @@ To develop this gem, clone the repository, then run:
 This will install the gems, create a dummy application under spec/internal and run the tests.  After you've made changes, remove the entire spec/internal
 directory so that further tests and run against a new dummy application.
 
-# Authors
+## Dependencies and Compatability
+
+Rails 4
+
+# Help 
+
+For help with Questioning Authority, contact <hydra-tech@googlegroups.com>.
+
+# Original Authors
 
 * [Stephen Anderson](https://github.com/scande3)
 * [Don Brower](https://github.com/dbrower)
@@ -195,4 +196,3 @@ directory so that further tests and run against a new dummy application.
 ### Special thanks to...
 
 [Jeremy Friesen](https://github.com/jeremyf) who gave us the name for our gem.
-

data/Rakefile

@@ -1,10 +1,13 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-
-Dir.glob('tasks/*.rake').each { |r| import r }
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'engine_cart/rake_task'
 
-ENV["RAILS_ROOT"] ||= 'spec/internal'
+RSpec::Core::RakeTask.new(:spec)
 
-require 'rspec/core/rake_task'
+desc "Run continuous integration build"
+task :ci => ['engine_cart:generate'] do
+  Rake::Task['spec'].invoke
+end
 
-task :default => [:spec]
+task :default => :ci

data/lib/generators/qa/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Installs QA into your rails application.
+
+Example:
+    rails generate qa:install

data/lib/generators/qa/install/install_generator.rb

@@ -0,0 +1,13 @@
+class Qa::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def inject_routes
+    insert_into_file "config/routes.rb", :after => ".draw do" do
+      %{\n  mount Qa::Engine => '/qa'\n}
+    end
+  end
+
+  def copy_configs
+    copy_file "config/oclcts-authorities.yml", "config/oclcts-authorities.yml"
+  end
+end

data/lib/generators/qa/install/templates/config/oclcts-authorities.yml

@@ -0,0 +1,24 @@
+url-pattern:
+  prefix-query: http://tspilot.oclc.org/{authority-id}/?query=oclcts.rootHeading+exact+%22{query}*%22&version=1.1&operation=searchRetrieve&recordSchema=http%3A%2F%2Fzthes.z3950.org%2Fxml%2F1.0%2F&maximumRecords=10&startRecord=1&resultSetTTL=300&recordPacking=xml&recordXPath=&sortKeys=
+  id-lookup: http://tspilot.oclc.org/{authority-id}/?query=dc.identifier+exact+%22{id}%22&version=1.1&operation=searchRetrieve&recordSchema=http%3A%2F%2Fzthes.z3950.org%2Fxml%2F1.0%2F&maximumRecords=10&startRecord=1&resultSetTTL=300&recordPacking=xml&recordXPath=&sortKeys=
+authorities:
+  lcgft:
+    name: Library of Congress Genre/Form Terms for Library and Archival Materials (LCGFT)
+  bisacsh:
+    name: Book Industry Study Group Subject Headings (BISAC®). Used with permission.
+  fast:
+    name: Faceted Application of Subject Terminology (FAST subject headings)
+  gsafd:
+    name: Form and genre headings for fiction and drama
+  lcshac:
+    name: Library of Congress AC Subject Headings
+  lcsh:
+    name: Library of Congress Subject Headings
+  mesh:
+    name: Medical Subject Headings (MeSH®)
+  lctgm:
+    name: "Thesaurus for graphic materials: TGM I, Subject terms"
+  gmgpc:
+    name: "Thesaurus for graphic materials: TGM II, Genre terms"
+  meta:
+    name: Controlled Vocabulary Metadata

data/lib/qa/authorities/loc.rb

@@ -15,7 +15,8 @@ module Qa::Authorities
         @response = nil
         return
       end
-      q += '*'
+
+      q = URI.escape(q)
       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)
@@ -89,26 +90,42 @@ module Qa::Authorities
       @sub_authorities ||= sub_authority_table.keys
     end
 
+    def parse_authority_response(raw_responses)
+      raw_responses.select {|response| response[0] == "atom:entry"}.map do |response|
+        loc_response_to_qa(response_to_struct(response))
+      end
+    end
 
-    def parse_authority_response(raw_response)
-      result = []
-      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
+    # 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
-
-        id ||= label
-        result << {"id"=>id, "label"=>label}
       end
-      result
+
+      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
 
     def find_record_in_response(raw_response, id)

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/spec/controllers/terms_controller_spec.rb

@@ -2,37 +2,37 @@ require 'spec_helper'
 
 describe Qa::TermsController do
 
-  before :each do
+  before do
     @routes = Qa::Engine.routes
   end
 
   describe "#index" do
 
-    describe "error checking" do
+    context "with errors" do
 
       it "should return 400 if no vocabulary is specified" do
         get :index, { :vocab => nil}
-        response.code.should == "400"
+        expect(response.code).to  eq("400")
       end
 
       it "should return 400 if no query is specified" do
         get :index, { :q => nil}
-        response.code.should == "400"
+        expect(response.code).to eq("400")
       end
 
       it "should return 400 if vocabulary is not valid" do
         get :index, { :q => "foo", :vocab => "bar" }
-        response.code.should == "400"
+        expect(response.code).to eq("400")
       end
 
       it "should return 400 if sub_authority is not valid" do
         get :index, { :q => "foo", :vocab => "loc", :sub_authority => "foo" }
-        response.code.should == "400"
+        expect(response.code).to eq("400")
       end
 
     end
 
-    describe "successful queries" do
+    context "with successful queries" do
 
       before :each do
         stub_request(:get, "http://id.loc.gov/search/?format=json&q=").
@@ -45,17 +45,17 @@ describe Qa::TermsController do
 
       it "should return a set of terms for a tgnlang query" do
         get :index, {:q => "Tibetan", :vocab => "tgnlang" }
-        response.should be_success
+        expect(response).to be_success
       end
 
       it "should not return 400 if vocabulary is valid" do
         get :index, { :q => "foo", :vocab => "loc" }
-        response.code.should_not == "400"
+        expect(response.code).to_not eq("400")
       end
 
       it "should not return 400 if sub_authority is valid" do
         get :index, { :q => "foo", :vocab => "loc", :sub_authority => "relators" }
-        response.code.should_not == "400"
+        expect(response.code).to_not eq("400")
       end
 
     end

data/spec/fixtures/loc-response.txt

@@ -43,7 +43,7 @@
                 "xmlns:opensearch" : "http://a9.com/-/spec/opensearch/1.1/"
             }
             ,
-                "1"
+                "2"
             ],
                             [
             "opensearch:startIndex",
@@ -72,6 +72,89 @@
             {
                 "xmlns:atom" : "http://www.w3.org/2005/Atom"
             }
+            ,
+                "Haw, Lily, 1890?-1915"
+            ],
+                            [
+            "atom:link",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom", 
+                "rel" : "alternate", 
+                "href" : "http://id.loc.gov/authorities/names/n2008008718"
+            }
+            
+            ],
+                            [
+            "atom:link",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom", 
+                "rel" : "alternate", 
+                "type" : "application/rdf+xml", 
+                "href" : "http://id.loc.gov/authorities/names/n2008008718.rdf"
+            }
+            
+            ],
+                            [
+            "atom:link",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom", 
+                "rel" : "alternate", 
+                "type" : "application/json", 
+                "href" : "http://id.loc.gov/authorities/names/n2008008718.json"
+            }
+            
+            ],
+                            [
+            "atom:id",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom"
+            }
+            ,
+                "info:lc/authorities/names/n2008008718"
+            ],
+                            [
+            "atom:author",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom"
+            }
+            ,
+                        [
+            "atom:name",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom"
+            }
+            ,
+                "Library of Congress"
+            ]
+            ],
+                            [
+            "atom:updated",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom"
+            }
+            ,
+                "2008-03-05T00:00:00-04:00"
+            ],
+                            [
+            "dcterms:created",
+            {
+                "xmlns:dcterms" : "http://purl.org/dc/terms/"
+            }
+            ,
+                "2008-02-05T00:00:00-04:00"
+            ]
+            ],
+            [
+            "atom:entry",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom"
+            }
+            ,
+                        [
+            "atom:title",
+            {
+                "xmlns:atom" : "http://www.w3.org/2005/Atom"
+            }
             ,
                 "Hawaii"
             ],
@@ -144,4 +227,4 @@
                 "1970-01-01T00:00:00-04:00"
             ]
             ]
-            ]
+            ]

data/spec/internal/Gemfile

@@ -1,13 +1,13 @@
 source 'https://rubygems.org'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.0.3'
+gem 'rails', '4.0.5'
 
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3'
 
 # Use SCSS for stylesheets
-gem 'sass-rails', '~> 4.0.0'
+gem 'sass-rails', '~> 4.0.2'
 
 # Use Uglifier as compressor for JavaScript assets
 gem 'uglifier', '>= 1.3.0'
@@ -33,7 +33,7 @@ group :doc do
 end
 
 # Use ActiveModel has_secure_password
-# gem 'bcrypt-ruby', '~> 3.1.2'
+# gem 'bcrypt', '~> 3.1.7'
 
 # Use unicorn as the app server
 # gem 'unicorn'
@@ -43,6 +43,4 @@ end
 
 # Use debugger
 # gem 'debugger', group: [:development, :test]
-gem 'qa', :path=>'../../../questioning_authority'
-gem 'rspec-rails'
-gem 'webmock'
+        gem 'qa', :path => '/Users/awead/Projects/Github/projecthydra-labs/questioning_authority'

data/spec/internal/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
-  remote: ../../../questioning_authority
+  remote: /Users/awead/Projects/Github/projecthydra-labs/questioning_authority
   specs:
-    qa (0.0.3)
+    qa (0.1.0)
       activerecord-import
       deprecation
       nokogiri (~> 1.6.0)
@@ -11,35 +11,33 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.0.3)
-      actionpack (= 4.0.3)
+    actionmailer (4.0.5)
+      actionpack (= 4.0.5)
       mail (~> 2.5.4)
-    actionpack (4.0.3)
-      activesupport (= 4.0.3)
+    actionpack (4.0.5)
+      activesupport (= 4.0.5)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.3)
-      activesupport (= 4.0.3)
+    activemodel (4.0.5)
+      activesupport (= 4.0.5)
       builder (~> 3.1.0)
-    activerecord (4.0.3)
-      activemodel (= 4.0.3)
+    activerecord (4.0.5)
+      activemodel (= 4.0.5)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.3)
+      activesupport (= 4.0.5)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activerecord-import (0.4.1)
+    activerecord-import (0.5.0)
       activerecord (>= 3.0)
-    activesupport (4.0.3)
-      i18n (~> 0.6, >= 0.6.4)
+    activesupport (4.0.5)
+      i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    addressable (2.3.5)
     arel (4.0.2)
-    atomic (1.1.15)
     builder (3.1.4)
     coffee-rails (4.0.1)
       coffee-script (>= 2.2.0)
@@ -48,13 +46,10 @@ GEM
       coffee-script-source
       execjs
     coffee-script-source (1.7.0)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
     deprecation (0.1.0)
       activesupport
-    diff-lcs (1.2.5)
     erubis (2.7.0)
-    execjs (2.0.2)
+    execjs (2.2.0)
     hike (1.2.3)
     i18n (0.6.9)
     jbuilder (1.5.3)
@@ -68,51 +63,39 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.25.1)
-    mini_portile (0.5.2)
+    mini_portile (0.6.0)
     minitest (4.7.5)
-    multi_json (1.8.4)
-    nokogiri (1.6.1)
-      mini_portile (~> 0.5.0)
-    polyglot (0.3.4)
+    multi_json (1.10.1)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    polyglot (0.3.5)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (4.0.3)
-      actionmailer (= 4.0.3)
-      actionpack (= 4.0.3)
-      activerecord (= 4.0.3)
-      activesupport (= 4.0.3)
+    rails (4.0.5)
+      actionmailer (= 4.0.5)
+      actionpack (= 4.0.5)
+      activerecord (= 4.0.5)
+      activesupport (= 4.0.5)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.0.3)
+      railties (= 4.0.5)
       sprockets-rails (~> 2.0.0)
-    railties (4.0.3)
-      actionpack (= 4.0.3)
-      activesupport (= 4.0.3)
+    railties (4.0.5)
+      actionpack (= 4.0.5)
+      activesupport (= 4.0.5)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.1.1)
+    rake (10.3.2)
     rdoc (4.1.1)
       json (~> 1.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    rspec-rails (2.14.1)
-      actionpack (>= 3.0)
-      activemodel (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    safe_yaml (1.0.1)
-    sass (3.2.14)
-    sass-rails (4.0.1)
+    sass (3.2.19)
+    sass-rails (4.0.3)
       railties (>= 4.0.0, < 5.0)
-      sass (>= 3.1.10)
-      sprockets-rails (~> 2.0.0)
+      sass (~> 3.2.0)
+      sprockets (~> 2.8, <= 2.11.0)
+      sprockets-rails (~> 2.0)
     sdoc (0.4.0)
       json (~> 1.8)
       rdoc (~> 4.0, < 5.0)
@@ -126,22 +109,18 @@ GEM
       activesupport (>= 3.0)
       sprockets (~> 2.8)
     sqlite3 (1.3.9)
-    thor (0.18.1)
-    thread_safe (0.2.0)
-      atomic (>= 1.1.7, < 2)
+    thor (0.19.1)
+    thread_safe (0.3.4)
     tilt (1.4.1)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    turbolinks (2.2.1)
+    turbolinks (2.2.2)
       coffee-rails
-    tzinfo (0.3.38)
-    uglifier (2.4.0)
+    tzinfo (0.3.39)
+    uglifier (2.5.0)
       execjs (>= 0.3.0)
       json (>= 1.8.0)
-    webmock (1.17.4)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
@@ -151,11 +130,9 @@ DEPENDENCIES
   jbuilder (~> 1.2)
   jquery-rails
   qa!
-  rails (= 4.0.3)
-  rspec-rails
-  sass-rails (~> 4.0.0)
+  rails (= 4.0.5)
+  sass-rails (~> 4.0.2)
   sdoc
   sqlite3
   turbolinks
   uglifier (>= 1.3.0)
-  webmock