qa 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8822d1805cf5688f8efa87ccabaf20d5e84a07dd
-  data.tar.gz: 97edb3df48fa497fafaa6e82c7a98b793cbe952b
+  metadata.gz: 5476914ef50c24ee9e61ae4de9b22256afb74f14
+  data.tar.gz: 14ccb1b89224b5f8b7c92c795ace430059d8f869
 SHA512:
-  metadata.gz: 4f271ed20bc568662f0f74a84804b6eb23c659f9894dc0719bd567210b501dec1a93c733d51aee9260519ee59ae1518e07726eaa56ad2716af0e3bd1adc20a5e
-  data.tar.gz: eb5de6d6f4f892d8661568a6e889cb22ca408acc2957a19a308261763383ab34fc1661dc35b2758775dcdde92d0f0d59b4c7f7867a4a8f77ecddf7d266778022
+  metadata.gz: fedee18c0bfe503d1cc4d9f2d67515a012d28e826bcd0aa64e01e0802649923c1c92529104d52ba8fd2c2ac9b4504a76bf23f72b0670e345ef6dce3a2af231da
+  data.tar.gz: 112f321514ff9bb46fc832f0b3cdb8a60dcc0283f68afc530b0ddafaf156e7501e7d52d7139aa07f1435c3c7fb330d6ac16f0773511c761f6e2f7dbff4c984fd

data/README.md

@@ -1,6 +1,6 @@
 # Questioning Authority
 
-[![Build Status](https://travis-ci.org/projecthydra/questioning_authority.png?branch=master)](https://travis-ci.org/projecthydra/questioning_authority) [![Gem Version](https://badge.fury.io/rb/qa.png)](http://badge.fury.io/rb/qa)
+[![Build Status](https://travis-ci.org/projecthydra-labs/questioning_authority.png?branch=master)](https://travis-ci.org/projecthydra-labs/questioning_authority) [![Gem Version](https://badge.fury.io/rb/qa.png)](http://badge.fury.io/rb/qa)
 
 You should question your authorities.
 
@@ -28,7 +28,7 @@ as return a complete list of terms.
 Some authorities, such as Library of Congress, allow sub-authorities which is an additional parameter that
 further defines the kind of authority to use with the context of a larger one.
 
-## How do use this?
+## How do I use this?
 
 Add the gem to your Gemfile
 
@@ -111,19 +111,38 @@ QA then presents this data to you in JSON format:
         etc...
     ]
 
-# Local Authority Files
+### Local Authorities
 
-### YAML file of terms
+For simple use cases when you have a few terms that don't change very often.
 
-#### Location and Naming Convention
+Run the generator to install configuration files and an example authority.
 
-Local authorities are specified in YAML files, one for each sub-authority.  By default, local
-authority YAML files are located in config/authorities/ .  This location can be changed by editing
-the :local_path entry in config/authorities.yml.  Relative paths are assumed to be relative to
-Rails.root.
+    rails generate qa:local
 
-Local authority YAML files are named for the sub-authority they represent.  For example, a YAML file
-for the "states" sub-authority would be named states.yml.
+This will install a sample states authority file that lists all the states in the U.S.  To query it,
+
+    /qa/search/local/states?q=Nor
+
+Results are in JSON.
+
+    [{"id":"NC","label":"North Carolina"},{"id":"ND","label":"North Dakota"}]
+
+The entire list can also be returned using:
+
+    /qa/terms/local/states/
+
+Local authorities are stored as YAML files, one for each sub-authority.  By default, local
+authority YAML files are located in `config/authorities/`.  This location can be changed by editing
+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 
+is named states.yml.
+
+To create your own local authority, create a .yml file, place it in the configured directory and query it
+using the file's name as the sub-authority.  For example, if I create `foo.yml`, I would then search it using:
+
+    /qa/search/local/foo?q=search_term
 
 #### Supported formats
 
@@ -174,9 +193,9 @@ 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.
 
-## Dependencies and Compatability
+## Compatability
 
-Rails 4
+Currently, it is compatible with Rails 4.0 and 4.1 under both Ruby 2.0 and 2.1.
 
 # Help 
 

data/lib/generators/qa/install/USAGE

@@ -1,5 +1,7 @@
 Description:
     Installs QA into your rails application.
+      * adds the routes to your config/routes file
+      * adds the oclcts config file for using that authority
 
 Example:
     rails generate qa:install

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

@@ -7,7 +7,8 @@ class Qa::InstallGenerator < Rails::Generators::Base
     end
   end
 
-  def copy_configs
+  def copy_oclcts_configs
     copy_file "config/oclcts-authorities.yml", "config/oclcts-authorities.yml"
   end
+
 end

data/lib/generators/qa/local/USAGE

@@ -0,0 +1,5 @@
+Description:
+  Installs the configuration files for local authorities.  Includes an example states.yml file for reference.
+
+Example:
+    rails generate qa:local

data/lib/generators/qa/local/local_generator.rb

@@ -0,0 +1,9 @@
+class Qa::LocalGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_local_authority_configs
+    copy_file "config/authorities.yml", "config/authorities.yml"
+    directory "config/authorities"
+  end
+
+end

data/lib/generators/qa/local/templates/config/authorities.yml

@@ -0,0 +1 @@
+:local_path: "config/authorities"

data/lib/generators/qa/local/templates/config/authorities/states.yml

@@ -0,0 +1,101 @@
+:terms:
+    - :id: AL
+      :term: Alabama
+    - :id: AK
+      :term: Alaska
+    - :id: AZ
+      :term: Arizona
+    - :id: AR
+      :term: Arkansas
+    - :id: CA
+      :term: California
+    - :id: CO
+      :term: Colorado
+    - :id: CT
+      :term: Connecticut
+    - :id: DE
+      :term: Delaware
+    - :id: FL
+      :term: Florida
+    - :id: GA
+      :term: Georgia
+    - :id: HI
+      :term: Hawaii
+    - :id: ID
+      :term: Idaho
+    - :id: IL
+      :term: Illinois
+    - :id: IN
+      :term: Indiana
+    - :id: IA
+      :term: Iowa
+    - :id: KS
+      :term: Kansas
+    - :id: KY
+      :term: Kentucky
+    - :id: LA
+      :term: Louisana
+    - :id: ME
+      :term: Maine
+    - :id: MD
+      :term: Maryland
+    - :id: MA
+      :term: Massachusetts
+    - :id: MI
+      :term: Michigan
+    - :id: MN
+      :term: Minnesota
+    - :id: MS
+      :term: Mississippi
+    - :id: MO
+      :term: Missouri
+    - :id: MT
+      :term: Montana
+    - :id: NE
+      :term: Nebraska
+    - :id: NV
+      :term: Nevada
+    - :id: NH
+      :term: New Hampshire
+    - :id: NJ
+      :term: New Jersey
+    - :id: NM
+      :term: New Mexico
+    - :id: NY
+      :term: New York
+    - :id: NC
+      :term: North Carolina
+    - :id: ND
+      :term: North Dakota
+    - :id: OH
+      :term: Ohio
+    - :id: OK
+      :term: Oklahoma
+    - :id: OR
+      :term: Oregon
+    - :id: PA
+      :term: Pennsylvania
+    - :id: RI
+      :term: Rhode Island
+    - :id: SC
+      :term: Sourth Carolina
+    - :id: SD
+      :term: South Dakota
+    - :id: TN
+      :term: Tennessee
+    - :id: TX
+      :term: Texas
+    - :id: UT
+      :term: Utah
+    - :id: VT
+      :term: Vermont
+    - :id: VA
+      :term: Virginia
+    - :id: WA
+      :term: Washington
+    - :id: WV
+      :term: West Virginia
+    - :id: WI
+      :term: Wisconsin
+    - :id: WY
+      :term: Wyoming

data/lib/qa/authorities/local.rb

@@ -3,6 +3,8 @@ module Qa::Authorities
   class Local < Qa::Authorities::Base
     extend Deprecation
 
+    attr_accessor :results
+
     class << self
       def sub_authority(name)
         @sub_authorities ||= {}
@@ -22,7 +24,7 @@ module Qa::Authorities
     delegate :sub_authority, to: self
 
     def search(q, sub_authority)
-      sub_authority(sub_authority).search(q)
+      @results = sub_authority(sub_authority).search(q)
     end
 
     def full_record(id, sub_authority)

data/lib/qa/version.rb

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

data/spec/controllers/terms_controller_spec.rb

@@ -32,7 +32,7 @@ describe Qa::TermsController do
 
     end
 
-    context "with successful queries" do
+    context "with a successful query" do
 
       before :each do
         stub_request(:get, "http://id.loc.gov/search/?format=json&q=").
@@ -60,9 +60,19 @@ describe Qa::TermsController do
 
     end
 
-    describe "#show" do
-      it "the path resolves"
+    context "when returning all terms" do
+
+      it "should return all local authority state terms" do
+        get :index, { :vocab => "local", :sub_authority => "states" }
+        response.should be_success
+      end
+
     end
 
   end
+
+  describe "#show" do
+    it "the path resolves"
+  end
+
 end

data/spec/internal/Gemfile

@@ -1,36 +1,30 @@
 source 'https://rubygems.org'
 
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.0.5'
 
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.1.1'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3'
-
 # Use SCSS for stylesheets
-gem 'sass-rails', '~> 4.0.2'
-
+gem 'sass-rails', '~> 4.0.3'
 # Use Uglifier as compressor for JavaScript assets
 gem 'uglifier', '>= 1.3.0'
-
 # Use CoffeeScript for .js.coffee assets and views
 gem 'coffee-rails', '~> 4.0.0'
-
 # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-# gem 'therubyracer', platforms: :ruby
+# gem 'therubyracer',  platforms: :ruby
 
 # Use jquery as the JavaScript library
 gem 'jquery-rails'
-
 # Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
 gem 'turbolinks'
-
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem 'jbuilder', '~> 1.2'
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0',          group: :doc
 
-group :doc do
-  # bundle exec rake doc:rails generates the API under doc/api.
-  gem 'sdoc', require: false
-end
+# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+gem 'spring',        group: :development
 
 # Use ActiveModel has_secure_password
 # gem 'bcrypt', '~> 3.1.7'
@@ -39,8 +33,9 @@ end
 # gem 'unicorn'
 
 # Use Capistrano for deployment
-# gem 'capistrano', group: :development
+# gem 'capistrano-rails', group: :development
 
 # Use debugger
 # gem 'debugger', group: [:development, :test]
+
         gem 'qa', :path => '/Users/awead/Projects/Github/projecthydra-labs/questioning_authority'

data/spec/internal/Gemfile.lock

@@ -1,44 +1,46 @@
 PATH
   remote: /Users/awead/Projects/Github/projecthydra-labs/questioning_authority
   specs:
-    qa (0.1.0)
+    qa (0.2.1)
       activerecord-import
       deprecation
       nokogiri (~> 1.6.0)
-      rails (~> 4.0.0)
+      rails (>= 3.2.13, < 5.0)
       rest-client
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.0.5)
-      actionpack (= 4.0.5)
+    actionmailer (4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
       mail (~> 2.5.4)
-    actionpack (4.0.5)
-      activesupport (= 4.0.5)
-      builder (~> 3.1.0)
-      erubis (~> 2.7.0)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.5)
-      activesupport (= 4.0.5)
-      builder (~> 3.1.0)
-    activerecord (4.0.5)
-      activemodel (= 4.0.5)
-      activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.5)
-      arel (~> 4.0.0)
-    activerecord-deprecated_finders (1.0.3)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
     activerecord-import (0.5.0)
       activerecord (>= 3.0)
-    activesupport (4.0.5)
+    activesupport (4.1.1)
       i18n (~> 0.6, >= 0.6.9)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    arel (4.0.2)
-    builder (3.1.4)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
     coffee-rails (4.0.1)
       coffee-script (>= 2.2.0)
       railties (>= 4.0.0, < 5.0)
@@ -52,9 +54,9 @@ GEM
     execjs (2.2.0)
     hike (1.2.3)
     i18n (0.6.9)
-    jbuilder (1.5.3)
-      activesupport (>= 3.0.0)
-      multi_json (>= 1.2.0)
+    jbuilder (2.1.1)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
     jquery-rails (3.1.0)
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
@@ -64,7 +66,7 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.25.1)
     mini_portile (0.6.0)
-    minitest (4.7.5)
+    minitest (5.3.5)
     multi_json (1.10.1)
     nokogiri (1.6.2.1)
       mini_portile (= 0.6.0)
@@ -72,17 +74,19 @@ GEM
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (4.0.5)
-      actionmailer (= 4.0.5)
-      actionpack (= 4.0.5)
-      activerecord (= 4.0.5)
-      activesupport (= 4.0.5)
+    rails (4.1.1)
+      actionmailer (= 4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      activemodel (= 4.1.1)
+      activerecord (= 4.1.1)
+      activesupport (= 4.1.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.0.5)
-      sprockets-rails (~> 2.0.0)
-    railties (4.0.5)
-      actionpack (= 4.0.5)
-      activesupport (= 4.0.5)
+      railties (= 4.1.1)
+      sprockets-rails (~> 2.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.3.2)
@@ -99,12 +103,13 @@ GEM
     sdoc (0.4.0)
       json (~> 1.8)
       rdoc (~> 4.0, < 5.0)
+    spring (1.1.3)
     sprockets (2.11.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sprockets-rails (2.0.1)
+    sprockets-rails (2.1.3)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       sprockets (~> 2.8)
@@ -117,8 +122,9 @@ GEM
       polyglot (>= 0.3.1)
     turbolinks (2.2.2)
       coffee-rails
-    tzinfo (0.3.39)
-    uglifier (2.5.0)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+    uglifier (2.5.1)
       execjs (>= 0.3.0)
       json (>= 1.8.0)
 
@@ -127,12 +133,13 @@ PLATFORMS
 
 DEPENDENCIES
   coffee-rails (~> 4.0.0)
-  jbuilder (~> 1.2)
+  jbuilder (~> 2.0)
   jquery-rails
   qa!
-  rails (= 4.0.5)
-  sass-rails (~> 4.0.2)
-  sdoc
+  rails (= 4.1.1)
+  sass-rails (~> 4.0.3)
+  sdoc (~> 0.4.0)
+  spring
   sqlite3
   turbolinks
   uglifier (>= 1.3.0)