qa 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16b9b7d34d5db8f520bb0a0c3330f75b836d0d01
-  data.tar.gz: fcea780be638d13a57f4ccd539f3ce90c5fcca48
+  metadata.gz: 85e4df1dd651f734f74b024a0414e4d9f7a919ca
+  data.tar.gz: 8308624003069a7af0b16a5248683691acd4ccdc
 SHA512:
-  metadata.gz: 85bdd4ca0d32bb58b07326aad0a19721fc3efc8139a16af66d8ab54f2c132458a4205e185bf0f5f9038f33f6a5a72d6f964bec722f9a711f8a93c370899dd012
-  data.tar.gz: 1a7a76fdc4e0c1b8cb843f95d122f9c21785023779bf19b2ea078845c1aed829a8c9b9709f2947e26b5c81c5d5333f225a6a82995a483544cd39a6ed2bf8c4c9
+  metadata.gz: 579dbb01782116c072173f4ca96ae6b142f20a98161c308edb08365da03d52520123483d9d63ea4ed8159197fd94739a1483f91a965920f57aa432b4ef1eee25
+  data.tar.gz: 3ac918adcb01206d99ac08c97ef1e9185f6b2f35c9442fa4cabf2d86dad64ee892c11478488144b320c3da1a97aa2aca6cb4f6ad49ce49eec2d72903b71afcf4

data/README.md

@@ -148,6 +148,22 @@ Make sure you handle these correctly in your form.
 For more details on this OCLC API, see
 http://www.oclc.org/developer/develop/web-services/fast-api/assign-fast.en.html
 
+### Geonames
+Make sure you register an account and enable it to see search results.
+
+Ensure you can run a query like this:
+
+```
+http://api.geonames.org/searchJSON?q=port&&maxRows=10username=MY_ACCOUNT_NAME
+```
+
+Then you can set your username like this:
+
+```ruby
+Qa::Authorities::Geonames.username = 'myAccountName'
+
+```
+
 ### Local Authorities
 
 For simple use cases when you have a few terms that don't change very often.

data/app/controllers/qa/terms_controller.rb

@@ -1,6 +1,7 @@
-# This controller is used for all requests to all authorities. It will verify params and figure out
-# which class to instantiate based on the "vocab" param. All the authotirty classes inherit from a
-# super class so they implement the same methods.
+# This controller is used for all requests to all authorities. It will verify
+# params and figure out which class to instantiate based on the "vocab" param.
+# All the authority classes inherit from a super class so they implement the
+# same methods.
 
 class Qa::TermsController < ApplicationController
 

data/lib/qa/authorities.rb

@@ -4,6 +4,7 @@ module Qa::Authorities
   autoload :AuthorityWithSubAuthority
   autoload :Base
   autoload :Getty
+  autoload :Geonames
   autoload :Loc
   autoload :LocSubauthority
   autoload :Local

data/lib/qa/authorities/geonames.rb

@@ -0,0 +1,43 @@
+module Qa::Authorities
+  class Geonames < Base
+    include WebServiceBase
+
+    class_attribute :username
+
+    def search q
+      parse_authority_response(json(build_query_url(q)))
+    end
+
+    # get_json is not ideomatic, so we'll make an alias
+    def json(*args)
+      get_json(*args)
+    end
+
+    def build_query_url q
+      query = URI.escape(untaint(q))
+      "http://api.geonames.org/searchJSON?q=#{query}&username=#{username}&maxRows=10"
+    end
+
+    def untaint(q)
+      q.gsub(/[^\w\s-]/, '')
+    end
+
+    def find id
+      json(find_url(id))
+    end
+
+    def find_url id
+      "http://www.geonames.org/getJSON?geonameId=#{id}&username=#{username}"
+    end
+
+    private
+
+    # Reformats the data received from the service
+    def parse_authority_response(response)
+      response['geonames'].map do |result|
+        { 'id' => "http://sws.geonames.org/#{result['geonameId']}",
+          'label' => result['name'] }
+      end
+    end
+  end
+end

data/lib/qa/authorities/mesh.rb

@@ -3,7 +3,7 @@ module Qa::Authorities
 
     def search q
       begin
-        r = Qa::SubjectMeshTerm.where('term_lower LIKE ?', "#{@q}%").limit(10)
+        r = Qa::SubjectMeshTerm.where('term_lower LIKE ?', "#{q}%").limit(10)
         r.map { |t| {id: t.term_id, label: t.term} }
       end
     end

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/fixtures/geonames-find-response.json

@@ -0,0 +1 @@
+{"timezone":{"gmtOffset":10,"timeZoneId":"Pacific/Port_Moresby","dstOffset":10},"bbox":{"east":147.24973454378284,"south":-9.512216673431235,"north":-9.37405361970154,"west":147.10970149137341},"asciiName":"Port Moresby","countryId":"2088628","fcl":"P","srtm3":79,"countryCode":"PG","adminId1":"2089856","lat":"-9.44314","fcode":"PPLC","continentCode":"OC","adminCode1":"20","lng":"147.17972","geonameId":2088122,"toponymName":"Port Moresby","population":283733,"wikipediaURL":"en.wikipedia.org/wiki/Port_Moresby","adminName5":"","adminName4":"","adminName3":"","alternateNames":[{"name":"ፖርት ሞርስቢ","lang":"am"},{"name":"포트모르즈비","lang":"ko"},{"name":"ポートモレスビー","lang":"ja"},{"name":"พอร์ตมอร์สบี","lang":"th"},{"name":"http://en.wikipedia.org/wiki/Port_Moresby","lang":"link"},{"name":"http://ru.wikipedia.org/wiki/%D0%9F%D0%BE%D1%80%D1%82-%D0%9C%D0%BE%D1%80%D1%81%D0%B1%D0%B8","lang":"link"},{"name":"POM","lang":"iata"},{"name":"Pò Moresbi","lang":"ht"},{"name":"Port-Moresbo","lang":"eo"},{"name":"Port Moresby","lang":"cs"},{"name":"Port Moresby","lang":"da"},{"name":"Port Moresby","lang":"de"},{"name":"Port Moresby","lang":"en"},{"name":"Port Moresby","lang":"et"},{"name":"Port Moresby","lang":"eu"},{"name":"Port Moresby","lang":"fi"},{"name":"Port Moresby","lang":"fr"},{"name":"Port Moresby","lang":"id"},{"name":"Port Moresby","lang":"io"},{"name":"Port Moresby","lang":"it"},{"name":"Port Moresby","lang":"nl"},{"name":"Port Moresby","lang":"pl"},{"name":"Port Moresby","lang":"pt"},{"name":"Port Moresby","lang":"sk"},{"name":"Port Moresby","lang":"sv"},{"name":"Portmorsbi","lang":"lv"},{"name":"Port Morsbi","lang":"az"},{"name":"Port Morsbis","lang":"lt"},{"name":"Portus Moresbiensis","lang":"la"},{"name":"Pot Mosbi","lang":"tpi"},{"name":"Puerto Moresby","lang":"es"},{"name":"بورت مورسبي","lang":"ar"},{"name":"پۆرت مۆرسبی","lang":"ckb"},{"name":"پورت مورسبی","lang":"fa"},{"name":"پورٹ مورسبی","lang":"ur"},{"name":"صوبہ پورٹ مورسبائی","lang":"pnb"},{"name":"مورېسبى پورتى","lang":"ug"},{"name":"פורט מורסבי","lang":"he"},{"name":"Πορτ Μόρεσμπι","lang":"el"},{"name":"Горад Порт-Морсбі","lang":"be"},{"name":"Порт Морсби","lang":"bg"},{"name":"Порт Морсби","lang":"mk"},{"name":"Порт Морсби","lang":"sah"},{"name":"Порт Морсби","lang":"sr"},{"name":"Порт-Морсби","lang":"mrj"},{"name":"Порт-Морсби","lang":"ru"},{"name":"Порт-Морсбі","lang":"uk"},{"name":"པོ་རོ་ཊི་མོ་རེ་སི་བི།","lang":"bo"},{"name":"Պորտ Մորսբի","lang":"hy"},{"name":"პორტ-მორზბი","lang":"ka"},{"name":"पोर्ट मॉरेस्बी","lang":"mr"},{"name":"पोर्ट मोरेस्बी","lang":"hi"},{"name":"ਪੋਰਟ ਮੋਰੈਸਬੀ","lang":"pa"},{"name":"莫尔兹比港","lang":"zh"},{"name":"莫尔兹比港","lang":"zh-CN"}],"adminName2":"","name":"Port Moresby","fclName":"city, village,...","countryName":"Papua New Guinea","fcodeName":"capital of a political entity","adminName1":"National Capital"}

data/spec/fixtures/geonames-response.json

@@ -0,0 +1 @@
+{"totalResultsCount":12041,"geonames":[{"countryId":"2088628","adminCode1":"20","countryName":"Papua New Guinea","fclName":"city, village,...","countryCode":"PG","lng":"147.17972","fcodeName":"capital of a political entity","toponymName":"Port Moresby","fcl":"P","name":"Port Moresby","fcode":"PPLC","geonameId":2088122,"lat":"-9.44314","adminName1":"National Capital","population":283733},{"countryId":"934292","adminCode1":"18","countryName":"Mauritius","fclName":"city, village,...","countryCode":"MU","lng":"57.49889","fcodeName":"capital of a political entity","toponymName":"Port Louis","fcl":"P","name":"Port Louis","fcode":"PPLC","geonameId":934154,"lat":"-20.16194","adminName1":"Port Louis","population":155226},{"countryId":"3723988","adminCode1":"11","countryName":"Haiti","fclName":"city, village,...","countryCode":"HT","lng":"-72.335","fcodeName":"capital of a political entity","toponymName":"Port-au-Prince","fcl":"P","name":"Port-au-Prince","fcode":"PPLC","geonameId":3718426,"lat":"18.53917","adminName1":"Ouest","population":1234742},{"countryId":"2134431","adminCode1":"18","countryName":"Vanuatu","fclName":"city, village,...","countryCode":"VU","lng":"168.32188","fcodeName":"capital of a political entity","toponymName":"Port-Vila","fcl":"P","name":"Port Vila","fcode":"PPLC","geonameId":2135171,"lat":"-17.73381","adminName1":"Shefa","population":35901},{"countryId":"2328926","adminCode1":"50","countryName":"Nigeria","fclName":"city, village,...","countryCode":"NG","lng":"7.0134","fcodeName":"seat of a first-order administrative division","toponymName":"Port Harcourt","fcl":"P","name":"Port Harcourt","fcode":"PPLA","geonameId":2324774,"lat":"4.77742","adminName1":"Rivers","population":1148665},{"countryId":"357994","adminCode1":"19","countryName":"Egypt","fclName":"city, village,...","countryCode":"EG","lng":"32.28412","fcodeName":"seat of a first-order administrative division","toponymName":"Port Said","fcl":"P","name":"Port Said","fcode":"PPLA","geonameId":358619,"lat":"31.25654","adminName1":"Port Said","population":538378},{"countryId":"3042362","adminCode1":"6417228","countryName":"Guernsey","fclName":"city, village,...","countryCode":"GG","lng":"-2.53527","fcodeName":"capital of a political entity","toponymName":"Saint Peter Port","fcl":"P","name":"St Peter Port","fcode":"PPLC","geonameId":3042287,"lat":"49.45981","adminName1":"St Peter Port","population":16488},{"countryId":"3573591","adminCode1":"05","countryName":"Trinidad and Tobago","fclName":"city, village,...","countryCode":"TT","lng":"-61.51889","fcodeName":"capital of a political entity","toponymName":"Port of Spain","fcl":"P","name":"Port of Spain","fcode":"PPLC","geonameId":3573890,"lat":"10.66668","adminName1":"City of Port of Spain","population":49031},{"countryId":"2400553","adminCode1":"08","countryName":"Gabon","fclName":"city, village,...","countryCode":"GA","lng":"8.78151","fcodeName":"seat of a first-order administrative division","toponymName":"Port-Gentil","fcl":"P","name":"Port-Gentil","fcode":"PPLA","geonameId":2396518,"lat":"-0.71933","adminName1":"Ogooué-Maritime","population":109163},{"countryId":"366755","adminCode1":"36","countryName":"Sudan","fclName":"city, village,...","countryCode":"SD","lng":"37.21644","fcodeName":"seat of a first-order administrative division","toponymName":"Port Sudan","fcl":"P","name":"Port Sudan","fcode":"PPLA","geonameId":377039,"lat":"19.61745","adminName1":"Red Sea","population":489725}]}

data/spec/lib/authorities/geonames_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Qa::Authorities::Geonames do
+
+  before do
+    described_class.username = 'dummy'
+  end
+
+  let(:authority) { described_class.new }
+
+  describe "#build_query_url" do
+    subject { authority.build_query_url("foo") }
+    it { is_expected.to eq 'http://api.geonames.org/searchJSON?q=foo&username=dummy&maxRows=10' }
+  end
+
+  describe "#find_url" do
+    subject { authority.find_url("1028772") }
+    it { is_expected.to eq "http://www.geonames.org/getJSON?geonameId=1028772&username=dummy" }
+  end
+
+  describe "#search" do
+    context "authorities" do
+      before do
+        stub_request(:get, /api\.geonames\.org.*/).
+            to_return(:body => webmock_fixture("geonames-response.json"), status: 200)
+      end
+
+      subject { authority.search('whatever') }
+
+      it "has id and label keys" do
+        expect(subject.first).to eq("id" => 'http://sws.geonames.org/2088122',
+                                    "label" => "Port Moresby")
+        expect(subject.last).to eq("id" => 'http://sws.geonames.org/377039',
+                                   "label" => "Port Sudan")
+        expect(subject.size).to eq(10)
+      end
+    end
+  end
+
+  describe "#untaint" do
+    subject { authority.untaint(value) }
+
+    context "with a good string" do
+      let(:value) { 'Cawood' }
+      it { is_expected.to eq 'Cawood' }
+    end
+
+    context "bad stuff" do
+      let(:value) { './"' }
+      it { is_expected.to eq '' }
+    end
+  end
+
+  describe "#find" do
+    context "using a subject id" do
+      before do
+        stub_request(:get, "http://www.geonames.org/getJSON?geonameId=2088122&username=dummy").
+            to_return(status: 200, body: webmock_fixture("geonames-find-response.json"))
+      end
+      subject { authority.find("2088122") }
+
+      it "returns the complete record for a given subject" do
+        expect(subject['geonameId']).to eq 2088122
+        expect(subject['name']).to eq "Port Moresby"
+      end
+    end
+  end
+end

data/spec/lib/authorities/mesh_spec.rb

@@ -30,9 +30,11 @@ describe Qa::Authorities::Mesh do
     let(:m) { Qa::Authorities::Mesh.new }
 
     it "handles queries" do
-      results = m.search('mr')
+      results = m.search('mr ')
+      expect(results.length).to eq(2)
       expect(results).to include( {id: '1', label: 'Mr Plow'} )
-      expect(results.length).to eq(3)
+      expect(results).to include( {id: '2', label: 'Mr Snow'} )
+      expect(results).not_to include( {id: '3', label: 'Mrs Fields'} )
     end
 
     it "returns individual records" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Stephen Anderson
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -218,6 +218,7 @@ files:
 - lib/qa/authorities/assign_fast_subauthority.rb
 - lib/qa/authorities/authority_with_sub_authority.rb
 - lib/qa/authorities/base.rb
+- lib/qa/authorities/geonames.rb
 - lib/qa/authorities/getty.rb
 - lib/qa/authorities/getty/aat.rb
 - lib/qa/authorities/getty/tgn.rb
@@ -251,6 +252,8 @@ files:
 - spec/fixtures/authorities/authority_B.yml
 - spec/fixtures/authorities/authority_C.yml
 - spec/fixtures/authorities/authority_D.yml
+- spec/fixtures/geonames-find-response.json
+- spec/fixtures/geonames-response.json
 - spec/fixtures/getty-aat-find-response.json
 - spec/fixtures/getty-tgn-find-response.json
 - spec/fixtures/getty-ulan-find-response.json
@@ -266,6 +269,7 @@ files:
 - spec/fixtures/ulan-response.txt
 - spec/lib/authorities/assign_fast_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
 - spec/lib/authorities/getty/ulan_spec.rb
@@ -303,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: You should question your authorities.
@@ -318,6 +322,8 @@ test_files:
 - spec/fixtures/authorities/authority_B.yml
 - spec/fixtures/authorities/authority_C.yml
 - spec/fixtures/authorities/authority_D.yml
+- spec/fixtures/geonames-find-response.json
+- spec/fixtures/geonames-response.json
 - spec/fixtures/getty-aat-find-response.json
 - spec/fixtures/getty-tgn-find-response.json
 - spec/fixtures/getty-ulan-find-response.json
@@ -333,6 +339,7 @@ test_files:
 - spec/fixtures/ulan-response.txt
 - spec/lib/authorities/assign_fast_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
 - spec/lib/authorities/getty/ulan_spec.rb
@@ -350,3 +357,4 @@ test_files:
 - spec/routing/route_spec.rb
 - spec/spec_helper.rb
 - spec/test_app_templates/lib/generators/test_app_generator.rb
+has_rdoc: