samvera / questioning_authority Goto Github PK

Given that I have a local sub_authority list "Foo",
I should be able to retrieve all the entries in the list that start with "bar".

We can render errors, even in JSON:

render :json => { :errors => @authority.errors.full_messages }, :status => 422

Given that I have a local authority "Foo"
containing term with id "abc",
I should be able to retrieve the full record for that term.

Currently, this is just a plain Rails application. It needs to be restructured as an engine plugin so folks can include it in their existing rails apps.

The spec tests currently fail under Ruby 1.9 with some seg. faults and other nasty errors. We could chase them down and see about fixing them, or take the easy way out and just drop support for Ruby 1.9.

We can then focus on testing against forthcoming versions such as 2.1.0 and 2.1.1.

When called at the root level (i.e., without a vocab), it should return a list of authorities and sub-authorities (where applicable).
When called for a particular vocab, it should return a description of the authority if available and a list of sub-authorities of that authority (if any).
When called for a vocab and sub-authority, it should return a description of the sub-authority (if any).

Hi! We developed & maintain the Getty endpoint, and luc:term should only include terms (which includes pref & altLabels, minus any " (qualifier)". You can see the props that are navigated to collect FTS text here: http://vocab.getty.edu/doc/#FTS_Insert_Queries.

You write "The full text index matches on fields besides the term, so we filter to ensure the match is in the term" and do a REGEX on pref|altLabel, and then DISTINCT since there are multiple altLabels. This query is quite complex and a bit more expensive than it needs to be.

If you provide some testing examples, we'll fix the problem "matches on fields besides the term".

For AAT, you seem to want prefLabel only. I wrote in the support forum "I think that if we make an index by prefLabels only, that would resolve most problems. But is this what you need? Eg it won't find "frostbiting" aka "frostbite boating".
If you want an extra index by prefLabel only, let me know (but it'll also have more languages than EN)

This may be a bigger question than we want to try to tackle this week but I'm wondering if it would make the app/engine more versatile if our Authorities returned the actual objects (e.g., arrays, hashes) rather than json. The consumer could then convert them to json if that's the format they needed. Or perhaps a "format" parameter could be used to specify "json" or "raw"(?), with one or the other being the default if "format" wasn't specified. Thoughts on this? Worth considering?

Unsure of which exact change is causing this issue but having to version my code to use the 0.5.0 release to avoid the below. Perhaps there was an API change that isn't documented? (It doesn't look like the CHANGELOG was ever updated for the 0.6.0 release).

In 0.5.0, doing:
authority_check = Qa::Authorities::Loc.subauthority_for('relators')
authority_result = authority_check.search(URI.escape('Photographer'))

Returns:
[{"id"=>"info:lc/vocabulary/relators/pht", "label"=>"Photographer"}]

Meanwhile, in 0.6.0, that same code of:
authority_check = Qa::Authorities::Loc.subauthority_for('relators')
authority_result = authority_check.search(URI.escape('Photographer'))

Returns:
[{"id"=>"info:lc/vocabulary/relators/cst", "label"=>"Costume designer"}, {"id"=>"info:lc/vocabulary/relators/clr", "label"=>"Colorist"}, {"id"=>"info:lc/vocabulary/relators/scl", "label"=>"Sculptor"}, {"id"=>"info:lc/vocabulary/relators/prs", "label"=>"Production designer"}, {"id"=>"info:lc/vocabulary/relators/dis", "label"=>"Dissertant"}, {"id"=>"info:lc/vocabulary/relators/arr", "label"=>"Arranger"}, {"id"=>"info:lc/vocabulary/relators/wdc", "label"=>"Woodcutter"}, {"id"=>"info:lc/vocabulary/relators/cre", "label"=>"Creator"}, {"id"=>"info:lc/vocabulary/relators/act", "label"=>"Actor"}, {"id"=>"info:lc/vocabulary/relators/cas", "label"=>"Caster"}, {"id"=>"info:lc/vocabulary/relators/pop", "label"=>"Printer of plates"}, {"id"=>"info:lc/vocabulary/relators/res", "label"=>"Researcher"}, {"id"=>"info:lc/vocabulary/relators/len", "label"=>"Lender"}, {"id"=>"info:lc/vocabulary/relators/clt", "label"=>"Collotyper"}, {"id"=>"info:lc/vocabulary/relators/rpt", "label"=>"Reporter"}, {"id"=>"info:lc/vocabulary/relators/elg", "label"=>"Electrician"}, {"id"=>"info:lc/vocabulary/relators/mdc", "label"=>"Metadata contact"}, {"id"=>"info:lc/vocabulary/relators/rdd", "label"=>"Radio director"}, {"id"=>"info:lc/vocabulary/relators/bnd", "label"=>"Binder"}, {"id"=>"info:lc/vocabulary/relators/art", "label"=>"Artist"}]

Of note, while I get a response, there is no "Photographer" role returned.

Any help would be appreciated as to why the above code works differently in 0.5.0 compared to 0.6.0. Thanks!

Given that I have a term that does not have an id,
it should set the id to be the same as the label.

The application has more routes than it needs. The /terms/:id routes should be removed. Maybe others.

$ rake routes
Prefix Verb   URI Pattern                             Controller#Action
          GET    /search/:vocab(.:format)                terms#search
          GET    /search/:vocab/:sub_authority(.:format) terms#search
          GET    /terms/:vocab(.:format)                 terms#index
          GET    /terms/:vocab/:sub_authority(.:format)  terms#index
    terms GET    /terms(.:format)                        terms#index
          POST   /terms(.:format)                        terms#create
 new_term GET    /terms/new(.:format)                    terms#new
edit_term GET    /terms/:id/edit(.:format)               terms#edit
     term GET    /terms/:id(.:format)                    terms#show
          PATCH  /terms/:id(.:format)                    terms#update
          PUT    /terms/:id(.:format)                    terms#update
          DELETE /terms/:id(.:format)                    terms#destroy

Required by TermsController. Example in loc.rb.

Once we have our tests properly using Webmock, we should have Webmock prevent all http requests by default.

I installed questioning_authority into my app and when I try to load the mesh vocabulary I get an error:

MESH_FILE=path/to/mesh.txt rake mesh:import
rake mesh:import
rake aborted!
Don't know how to build task 'mesh:import'

I'm following the instructions on the Readme. Perhaps it's wrong?
https://github.com/projecthydra/questioning_authority/blob/8319e5d8a97d98e749290c67f782f4f8cd794c2f/README.md#loading-terms

[moved from README.md file]

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'

Add a typeahead field to search the "states" sub_authority of the "local" vocabulary.

Given that I have a local sub_authority list "Foo",
then it should return an empty array if no values match the query string.

As a systems librarian at an undisclosed institution, I would like to be able to use the OpenAGRIS to suggest keywords for topics related to agriculture, forestry, fisheries, environment.

See http://aims.fao.org/openagris

Not sure why this was described by the original group that evaluated Questioning Authority but it was identified and not done.

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Given a yaml file that has a list of terms as strings,
it should treat the strings as labels.

We can render errors, even in JSON:

render :json => { :errors => @authority.errors.full_messages }, :status => 422

Local authority search should not be case-sensitive.

TermController currently requires a query parameter (q) to be present (i.e., have a value). Remove this requirement so that its absence signals that all terms in the vocabulary (and sub_authority, if pertinent) are returned.

The documentation including the tutorial has todos/ is empty

each term in the list is a hash that conforms to the following specification:

• It must have an ID
• It must have a label
• It may have additional fields, such as URI, and authority name.

We should return an empty json response if the query is null.

At this point the service doesn't generate the full item record. The implementation of this method should be completed.

Why use a fixed XML file for TGN languages? (BTW there's no list of "TGN languages": the languages are used across all Getty vocabs. You can use the following queries to get up to date lists from SPARQL:

• full list of languages: http://vocab.getty.edu/queries#Languages_and_ISO_Codes
• languages currently used in Getty vocabs (and thus having assigned lang tag): http://vocab.getty.edu/queries#Language_URLs

(Of course, you can add prefLabelGVP in the query).
Cheers!

Ultimately we will run rspec with webmock disabled as a way to verify that all the services we support are online and haven't changed. Make sure the rspec test coverage includes this.

Given that I have a local authority "Foo",
for each term, it should be possible to indicate whether it is active or not.

We should be able to add:

LCMPT - http://id.loc.gov/authorities/performanceMediums
AFSET - http://id.loc.gov/vocabulary/ethnographicTerms

No such file or directory - /Users/coblej/Sites/questioning_authority/#{Rails.root}/config/authorities

On Travis-CI, the build failed with Ruby 1.9.3 but worked with 2.0. Locally, it works with 1.9.3. I think there might be some weird things going on with WebMock as I did see some issues with tests failing locally but had difficulty replicating.

[moved from README.md file]

The LCSH authority is a bit misleading because it's searching all the LOC authorities and not just subject headings. It's functionality is also covered by the subjects sub-authority under the LOC class.

Removing the LCSH class would clear up the confusion. If we need to retain the original functionality of the LCSH class, then we can add another option to Loc that uses the same url in the current LCSH class.

Setup / Expected

The documentation gives the following example:

/qa/search/loc/subjects?q=History--

QA then presents this data to you in JSON format:

[
    {"id":"info:lc/authorities/subjects/sh2008121753","label":"History--Philosophy--History--20th century"},
    {"id":"info:lc/authorities/subjects/sh2008121752","label":"History--Philosophy--History--19th century"},
    etc...
]

Actual

The data actually returned is more like the following

[
    {"id":"info:lc/authorities/subjects/sh85111862","label":"Reconstruction (U.S. history, 1865-1877)"},
    {"id":"info:lc/authorities/subjects/sh85061255","label":"History publishing"},
    etc...
    {"id":"info:lc/authorities/subjects/sh85068444","label":"Islamic Empire"},
]

The Issue

A "--" does not seem to be processed correctly. For example, searching for "History Philosophy" will return results more like the first example. As is, about half of the results currently do not contain the word "history" nor any "--". I have no yet done appropriate research into details of this behavior besides noticing it during recent testing.

Added config/authorities/countries.yml,

If want to retrieve a complete list:
http://localhost:3000/qa/terms/local/countries

I got the following error:

Started GET "/qa/terms/local/countries" for 127.0.0.1 at 2014-06-10 16:20:29 -0700
(developer) Callback phase initiated.
Processing by Qa::TermsController#index as HTML
Parameters: {"vocab"=>"local", "sub_authority"=>"countries"}
Completed 500 Internal Server Error in 1ms

NoMethodError (undefined method `results' for #Qa::Authorities::Local:0x007fe1289b8848)

Given that I have a local authority list "Foo",
I should be able to retrieve all the entries in that list.