qa 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5243eb90da94a9c62eb091f5ae6f6d0552887328fda21adf61e814a45b48c52
-  data.tar.gz: ba091c8b6a42ee2a899fd60268952e8752bd5dbda825f7c631c293b085899406
+  metadata.gz: 3fb01e5ca2c9435b8c22af76ace78a1486d2ad22ee54f0a8e1a40ba24b64e218
+  data.tar.gz: '0825479f37ac4eb299c944981fff9b670e8efd86eb8b05c3341f7d2a9300361c'
 SHA512:
-  metadata.gz: 3e8bcb1894706a6aa6b54a409b33474a6f07603b3299df98236c8d03c8e3bd53b9ff04a420e8e720a8ab526c8fcc169cb123232dc98447e881d4550ffa13d0fb
-  data.tar.gz: b091c31f1abba47d48207a4e02e01936ba5c2b6d89c98d4c105839886c33d2e0c03b514ef096e226d089d0518364d596a45c463774f4d80c249ee016e00d4172
+  metadata.gz: 80792bf55b1f8cf6f7401657d7b7844fbeff0dbc4e4597e16869a63a65a6cf1e271d88d631bd0dd9f4f8dbcdda2caadac47974d8d282f21ee1696308022bb201
+  data.tar.gz: 7d700e24566d6047cb061731e941affa72d3c260eb7822c421421986127ddfd819f2d6d4cd1c968cd9e527b3276c392a7403564ebce8e5ee4210fb86863072d0

data/README.md

@@ -1,6 +1,6 @@
 # Questioning Authority
 
-Code: [![Gem Version](https://badge.fury.io/rb/qa.png)](http://badge.fury.io/rb/qa) [![Build Status](https://circleci.com/gh/samvera/questioning_authority.svg?style=svg)](https://circleci.com/gh/samvera/questioning_authority) [![Coverage Status](https://coveralls.io/repos/github/samvera/questioning_authority/badge.svg?branch=master)](https://coveralls.io/github/samvera/questioning_authority?branch=master)
+Code: [![Gem Version](https://badge.fury.io/rb/qa.png)](http://badge.fury.io/rb/qa) [![Build Status](https://circleci.com/gh/samvera/questioning_authority.svg?style=svg)](https://circleci.com/gh/samvera/questioning_authority) [![Coverage Status](https://coveralls.io/repos/github/samvera/questioning_authority/badge.svg?branch=main)](https://coveralls.io/github/samvera/questioning_authority?branch=main)
 
 Docs: [![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md) [![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
 
@@ -145,6 +145,12 @@ rake ci
 
 Commit your features into a new branch and submit a pull request.
 
+## Contributing 
+
+If you're working on PR for this project, create a feature branch off of `main`. 
+
+This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and [language recommendations](https://github.com/samvera/maintenance/blob/main/templates/CONTRIBUTING.md#language).  Please ***do not*** create a branch called `master` for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.
+
 ## Compatibility
 
 - Ruby 2.5 or the latest 2.4 version is recommended. Later versions may also work.
@@ -169,7 +175,7 @@ Questioning Authority is a Core Component of the Samvera community. The document
   github_changelog_generator --user samvera --project questioning_authority --token YOUR_GITHUB_TOKEN_HERE
   ```
 
-5. Commit these changes to the master branch
+5. Commit these changes to the main branch
 
 6. Run `rake release`
 

data/app/controllers/qa/terms_controller.rb

@@ -27,12 +27,21 @@ class Qa::TermsController < ::ApplicationController
   end
 
   # If the subauthority supports it, return all the information for a given term
+  # Expects id to be part of the request path (e.g. http://my.app/qa/show/auth/subauth/{:id})
   def show
     term = @authority.method(:find).arity == 2 ? @authority.find(params[:id], self) : @authority.find(params[:id])
     cors_allow_origin_header(response)
     render json: term, content_type: content_type_for_format
   end
 
+  # If the subauthority supports it, return all the information for a given term
+  # Expects uri to be a request parameter (e.g. http://my.app/qa/show/auth/subauth?uri={:uri})
+  def fetch
+    term = @authority.method(:find).arity == 2 ? @authority.find(params[:uri], self) : @authority.find(params[:uri])
+    cors_allow_origin_header(response)
+    render json: term, content_type: content_type_for_format
+  end
+
   def check_vocab_param
     return if params[:vocab].present?
     msg = "Required param 'vocab' is missing or empty"

data/config/routes.rb

@@ -9,6 +9,8 @@ Qa::Engine.routes.draw do
   get "/search/:vocab(/:subauthority)", controller: :terms, action: :search
   get "/show/:vocab/:id", controller: :terms, action: :show
   get "/show/:vocab/:subauthority/:id", controller: :terms, action: :show
+  get "/fetch/:vocab", controller: :terms, action: :fetch
+  get "/fetch/:vocab/:subauthority", controller: :terms, action: :fetch
 
   match "/search/linked_data/:vocab(/:subauthority)", to: 'application#options', via: [:options]
   match "/show/linked_data/:vocab/:id", to: 'application#options', via: [:options]
@@ -17,4 +19,6 @@ Qa::Engine.routes.draw do
   match "/search/:vocab(/:subauthority)", to: 'application#options', via: [:options]
   match "/show/:vocab/:id", to: 'application#options', via: [:options]
   match "/show/:vocab/:subauthority/:id", to: 'application#options', via: [:options]
+  match "/fetch/:vocab", to: 'application#options', via: [:options]
+  match "/fetch/:vocab/:subauthority", to: 'application#options', via: [:options]
 end

data/lib/qa/authorities/local/file_based_authority.rb

@@ -8,13 +8,14 @@ module Qa::Authorities
     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
+        { id: res[:id], label: res[:term], uri: res.fetch(:uri, nil) }.compact.with_indifferent_access
       end
     end
 
     def all
       terms.map do |res|
-        { id: res[:id], label: res[:term], active: res.fetch(:active, true) }.with_indifferent_access
+        { id: res[:id], label: res[:term], active: res.fetch(:active, true), uri: res.fetch(:uri, nil) }
+          .compact.with_indifferent_access
       end
     end
 

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "5.6.0".freeze
+  VERSION = "5.7.0".freeze
 end

data/spec/controllers/terms_controller_spec.rb

@@ -253,4 +253,33 @@ describe Qa::TermsController, type: :controller do
       end
     end
   end
+
+  describe "#fetch" do
+    context "with supported authorities" do
+      it "returns an individual state term" do
+        get :fetch, params: { vocab: "local", subauthority: "authority_U", uri: "http://my.domain/terms/a2" }
+        expect(response).to be_successful
+      end
+
+      context 'when cors headers are enabled' do
+        before do
+          Qa.config.enable_cors_headers
+        end
+        it 'Access-Control-Allow-Origin is *' do
+          get :fetch, params: { vocab: "local", subauthority: "authority_U", uri: "http://my.domain/terms/a2" }
+          expect(response.headers['Access-Control-Allow-Origin']).to eq '*'
+        end
+      end
+
+      context 'when cors headers are disabled' do
+        before do
+          Qa.config.disable_cors_headers
+        end
+        it 'Access-Control-Allow-Origin is not present' do
+          get :fetch, params: { vocab: "local", subauthority: "authority_U", uri: "http://my.domain/terms/a2" }
+          expect(response.headers.key?('Access-Control-Allow-Origin')).to be false
+        end
+      end
+    end
+  end
 end

data/spec/fixtures/authorities/authority_U.yml

@@ -0,0 +1,13 @@
+:terms:
+    - :id: A1
+      :term: Abc Term A1
+      :uri: http://my.domain/terms/a1
+      :active: true
+    - :id: A2
+      :term: Term A2
+      :uri: http://my.domain/terms/a2
+      :active: false
+    - :id: A3
+      :term: Abc Term A3
+      :uri: http://my.domain/terms/a3
+      :active: true

data/spec/lib/authorities/{file_based_authority_spec.rb → local/file_based_authority_spec.rb}

@@ -5,6 +5,7 @@ describe Qa::Authorities::Local::FileBasedAuthority do
   let(:authority_b) { Qa::Authorities::Local.subauthority_for("authority_B") }
   let(:authority_c) { Qa::Authorities::Local.subauthority_for("authority_C") }
   let(:authority_d) { Qa::Authorities::Local.subauthority_for("authority_D") }
+  let(:authority_u) { Qa::Authorities::Local.subauthority_for("authority_U") }
 
   describe "#all" do
     let(:expected) do
@@ -35,6 +36,16 @@ describe Qa::Authorities::Local::FileBasedAuthority do
         expect(authority_c.all).to eq(expected)
       end
     end
+    context "when terms have uris" do
+      let(:expected) do
+        [{ 'id' => "A1", 'label' => "Abc Term A1", 'active' => true, 'uri' => 'http://my.domain/terms/a1' },
+         { 'id' => "A2", 'label' => "Term A2", 'active' => false, 'uri' => 'http://my.domain/terms/a2' },
+         { 'id' => "A3", 'label' => "Abc Term A3", 'active' => true, 'uri' => 'http://my.domain/terms/a3' }]
+      end
+      it "sets the id to be same as the label" do
+        expect(authority_u.all).to eq(expected)
+      end
+    end
     context "YAML file is malformed" do
       it "raises an error" do
         expect { authority_d.all }.to raise_error Psych::SyntaxError

data/spec/lib/authorities/local_spec.rb

@@ -33,7 +33,9 @@ describe Qa::Authorities::Local do
 
   describe "#names" do
     it "returns a list of yaml files" do
-      expect(described_class.names).to include("authority_A", "authority_B", "authority_C", "authority_D", "states")
+      expect(described_class.names)
+        .to include("authority_A", "authority_B", "authority_C",
+                    "authority_D", "authority_U", "states")
     end
 
     context "when the path doesn't exist" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.7.0
 platform: ruby
 authors:
 - Stephen Anderson
@@ -16,7 +16,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-import
@@ -479,6 +479,7 @@ files:
 - spec/fixtures/authorities/authority_B.yml
 - spec/fixtures/authorities/authority_C.yml
 - spec/fixtures/authorities/authority_D.yml
+- spec/fixtures/authorities/authority_U.yml
 - spec/fixtures/authorities/linked_data/lod_encoding_config.json
 - spec/fixtures/authorities/linked_data/lod_full_config.json
 - spec/fixtures/authorities/linked_data/lod_full_config_1_0.json
@@ -559,7 +560,6 @@ files:
 - spec/lib/authorities/crossref_spec.rb
 - spec/lib/authorities/discogs/generic_authority_spec.rb
 - spec/lib/authorities/discogs_spec.rb
-- spec/lib/authorities/file_based_authority_spec.rb
 - spec/lib/authorities/geonames_spec.rb
 - spec/lib/authorities/getty/aat_spec.rb
 - spec/lib/authorities/getty/tgn_spec.rb
@@ -572,12 +572,13 @@ files:
 - spec/lib/authorities/linked_data/search_query_spec.rb
 - spec/lib/authorities/linked_data/term_config_spec.rb
 - spec/lib/authorities/loc_spec.rb
+- spec/lib/authorities/local/file_based_authority_spec.rb
+- spec/lib/authorities/local/mysql_table_based_authority_spec.rb
+- spec/lib/authorities/local/table_based_authority_spec.rb
 - spec/lib/authorities/local_spec.rb
 - spec/lib/authorities/mesh_spec.rb
-- spec/lib/authorities/mysql_table_based_authority_spec.rb
 - spec/lib/authorities/oclcts_spec.rb
 - spec/lib/authorities/space_fix_encoder.rb
-- spec/lib/authorities/table_based_authority_spec.rb
 - spec/lib/authorities/tgnlang_spec.rb
 - spec/lib/authorities_loc_subauthorities.rb
 - spec/lib/configuration_spec.rb
@@ -662,16 +663,16 @@ test_files:
 - spec/lib/authorities/tgnlang_spec.rb
 - spec/lib/authorities/crossref_spec.rb
 - spec/lib/authorities/oclcts_spec.rb
-- spec/lib/authorities/file_based_authority_spec.rb
+- spec/lib/authorities/local/file_based_authority_spec.rb
+- spec/lib/authorities/local/table_based_authority_spec.rb
+- spec/lib/authorities/local/mysql_table_based_authority_spec.rb
 - spec/lib/authorities/space_fix_encoder.rb
 - spec/lib/authorities/assign_fast_spec.rb
-- spec/lib/authorities/table_based_authority_spec.rb
 - spec/lib/authorities/getty/tgn_spec.rb
 - spec/lib/authorities/getty/ulan_spec.rb
 - spec/lib/authorities/getty/aat_spec.rb
 - spec/lib/authorities/discogs_spec.rb
 - spec/lib/authorities/mesh_spec.rb
-- spec/lib/authorities/mysql_table_based_authority_spec.rb
 - spec/lib/authorities/local_spec.rb
 - spec/lib/authorities/discogs/generic_authority_spec.rb
 - spec/lib/authorities/geonames_spec.rb
@@ -750,6 +751,7 @@ test_files:
 - spec/fixtures/authorities/authority_D.yml
 - spec/fixtures/authorities/authority_A.yml
 - spec/fixtures/authorities/authority_C.yml
+- spec/fixtures/authorities/authority_U.yml
 - spec/fixtures/authorities/authority_B.yml
 - spec/fixtures/geonames-response.json
 - spec/fixtures/tgn-response.txt