qa 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8158fccc9df38a91d74c1dbda277ce9308cf08c3
-  data.tar.gz: 28be737c24fc1cdd77fed1fc5da6216c68b675fd
+  metadata.gz: 69b198054c52dafc00d9cf83f2f61b5fdc3e55cb
+  data.tar.gz: 00aa3d111681efe0a1c068846190e41531155e21
 SHA512:
-  metadata.gz: d8e1fdedaa020bf6ffcac6bf1248729439d758be0966bb397aeaf05c54c681fd0f4f5e5c061e9b5ece5f8b8c9dc0494c6d1c9091c2f691e185256cb1cc42ec18
-  data.tar.gz: 49e4402ab1422fee3e78cc7fdf485175144642b26fc6697a64873877fbbdc6095ad011881e8c42a35c9fb21c5704a056443f0ce6bc7e26c14494c958007d6434
+  metadata.gz: c75338fdecba820602eb3c669065679a87387e80bf65e350fdc42d6224dc5eb152439198257b6da3eb38812a9e44e6764472fa3a8fff3f554e782b13da0e4c38
+  data.tar.gz: bcf795d36f8fc600dbc672d9884b4b37efd084ad9e12a7e53583b491cf122b1247f8335fdcfe216cfda6b2c3c326628ac27f2b6a375aa44feb783daf8ce0f2b5

data/lib/qa/authorities/discogs/discogs_utils.rb

@@ -55,6 +55,28 @@ module Qa::Authorities
         "http://id.loc.gov/ontologies/bibframe/Role"
       end
 
+      def format(tc)
+        return 'json' unless tc.params.key?('format')
+        return 'json' if tc.params['format'].blank?
+        tc.params['format']
+      end
+
+      def jsonld?(tc)
+        format(tc).casecmp?('jsonld')
+      end
+
+      def n3?(tc)
+        format(tc).casecmp?('n3')
+      end
+
+      def ntriples?(tc)
+        format(tc).casecmp?('ntriples')
+      end
+
+      def graph_format?(tc)
+        jsonld?(tc) || n3?(tc) || ntriples?(tc)
+      end
+
       def discogs_genres
         DISCOGS_GENRE_MAPPING
       end
@@ -63,6 +85,19 @@ module Qa::Authorities
         DISCOGS_FORMATS_MAPPING
       end
 
+      # @param json results
+      # @param json results
+      # @return [String] status information
+      def check_for_msg_response(release_resp, master_resp)
+        if release_resp.key?("message") && master_resp.key?("message")
+          "no responses"
+        elsif !release_resp.key?("message") && !master_resp.key?("message")
+          "two responses"
+        else
+          "mixed"
+        end
+      end
+
       # both the work and the instance require a statement for the release year
       # @param [Hash] the http response from discogs
       # @return [Array] rdf statements

data/lib/qa/authorities/discogs/generic_authority.rb

@@ -4,6 +4,7 @@ module Qa::Authorities
   class Discogs::GenericAuthority < Base
     include WebServiceBase
     include Discogs::DiscogsTranslation
+    include Discogs::DiscogsUtils
 
     class_attribute :discogs_secret, :discogs_key
     attr_accessor :primary_artists, :selected_format, :work_uri, :instance_uri
@@ -28,7 +29,14 @@ module Qa::Authorities
         Rails.logger.error "Questioning Authority tried to call Discogs, but no secret and/or key were set."
         return []
       end
-      parse_authority_response(json(build_query_url(q, tc.params["subauthority"])))
+      response = json(build_query_url(q, tc))
+      if tc.params["response_header"] == "true"
+        response_hash = {}
+        response_hash["results"] = parse_authority_response(response)
+        response_hash["response_header"] = build_response_header(response)
+        return response_hash
+      end
+      parse_authority_response(response)
     end
 
     # If the subauthority = "all" (though it shouldn't), call the fetch_discogs_results method to determine
@@ -52,9 +60,18 @@ module Qa::Authorities
     # @param [String] the query
     # @param [String] the subauthority
     # @return [String] the url
-    def build_query_url(q, subauthority)
+    def build_query_url(q, tc)
+      page = nil
+      per_page = nil
+      if tc.params["startRecord"].present?
+        page = (tc.params["startRecord"].to_i - 1) / tc.params["maxRecords"].to_i + 1
+        per_page = tc.params["maxRecords"]
+      else
+        page = tc.params["page"]
+        per_page = tc.params["per_page"]
+      end
       escaped_q = ERB::Util.url_encode(q)
-      "https://api.discogs.com/database/search?q=#{escaped_q}&type=#{subauthority}&key=#{discogs_key}&secret=#{discogs_secret}"
+      "https://api.discogs.com/database/search?q=#{escaped_q}&type=#{tc.params['subauthority']}&page=#{page}&per_page=#{per_page}&key=#{discogs_key}&secret=#{discogs_secret}"
     end
 
     # @param [String] the id of the selected item
@@ -86,19 +103,6 @@ module Qa::Authorities
         release_resp
       end
 
-      # @param json results
-      # @param json results
-      # @return [String] status information
-      def check_for_msg_response(release_resp, master_resp)
-        if release_resp.key?("message") && master_resp.key?("message")
-          "no responses"
-        elsif !release_resp.key?("message") && !master_resp.key?("message")
-          "two responses"
-        else
-          "mixed"
-        end
-      end
-
       # @param [Hash] the http response from discogs
       # @example returns parsed discogs data with context
       # [{
@@ -131,6 +135,19 @@ module Qa::Authorities
         end
       end
 
+      # @param [Hash] the http response from discogs
+      # @param [Class] QA::TermsController
+      # @example returns parsed discogs pagination data
+      def build_response_header(response)
+        start_record = (response['pagination']['page'] - 1) * response['pagination']['per_page'] + 1
+        rh_hash = {}
+        rh_hash['start_record'] = start_record
+        rh_hash['requested_records'] = response['pagination']['per_page']
+        rh_hash['retrieved_records'] = response['results'].length
+        rh_hash['total_records'] = response['pagination']['items']
+        rh_hash
+      end
+
       # @param [Hash] the results hash from the JSON returned by Discogs
       def build_uri(result)
         result['uri'].present? ? "https://www.discogs.com" + result['uri'].to_s : result['resource_url'].to_s
@@ -156,27 +173,5 @@ module Qa::Authorities
       def get_context_for_array(item)
         item.present? ? item : [""]
       end
-
-      def format(tc)
-        return 'json' unless tc.params.key?('format')
-        return 'json' if tc.params['format'].blank?
-        tc.params['format']
-      end
-
-      def jsonld?(tc)
-        format(tc).casecmp?('jsonld')
-      end
-
-      def n3?(tc)
-        format(tc).casecmp?('n3')
-      end
-
-      def ntriples?(tc)
-        format(tc).casecmp?('ntriples')
-      end
-
-      def graph_format?(tc)
-        jsonld?(tc) || n3?(tc) || ntriples?(tc)
-      end
   end
 end

data/lib/qa/version.rb

@@ -1,3 +1,3 @@
 module Qa
-  VERSION = "5.1.0".freeze
+  VERSION = "5.2.0".freeze
 end

data/spec/fixtures/discogs-search-response-per-page.json

@@ -0,0 +1 @@
+{"pagination": {"per_page": 10, "pages": 2, "page": 1, "urls": {"last": "https://api.discogs.com/database/search?q=james+taylor+new+moon+shine&secret=yNSnBqrCDUYmwfMheZdtdCDuaUgQRJTn&key=bXDsQzXjWPxUowNRUoxq&per_page=10&type=master&page=2", "next": "https://api.discogs.com/database/search?q=james+taylor+new+moon+shine&secret=yNSnBqrCDUYmwfMheZdtdCDuaUgQRJTn&key=bXDsQzXjWPxUowNRUoxq&per_page=10&type=master&page=2"}, "items": 17}, "results": [{"style": ["Acoustic", "Soft Rock"], "thumb": "https://img.discogs.com/PDVaKISZBGLJnTkHxLdacDZx8AY=/fit-in/150x150/filters:strip_icc():format(jpeg):mode_rgb():quality(40)/discogs-images/R-2304876-1521522385-7719.jpeg.jpg", "format": ["CD", "Album"], "country": "US", "barcode": ["0 7464-46038-2", "1A CK46038 01  B", "1A CK46038 10 B1", "CMU P 112"], "uri": "/James-Taylor-New-Moon-Shine/master/297372", "master_url": "https://api.discogs.com/masters/297372", "label": ["Columbia", "Skyline Studios", "Power Station", "A&M Studios", "Studio F", "Skyline Studios", "Sterling Sound"], "genre": ["Rock"], "catno": "CK 46038", "community": {"want": 224, "have": 761}, "year": "1991", "cover_image": "https://img.discogs.com/cr-KOWrcvF8_3z6kx3go4ikTOcw=/fit-in/600x597/filters:strip_icc():format(jpeg):mode_rgb():quality(90)/discogs-images/R-2304876-1521522385-7719.jpeg.jpg", "title": "James Taylor (2) - New Moon Shine", "resource_url": "https://api.discogs.com/masters/297372", "master_id": 297372, "type": "master", "id": 297372}, {"id": 123}, {"id":234},{"id":345},{"id": 456}, {"id": 567}, {"id": 678}, {"id": 789}, {"id": 890}, {"id": 901}]}

data/spec/fixtures/discogs-search-response-set-record.json

@@ -0,0 +1 @@
+{"pagination": {"per_page": 5, "pages": 4, "page": 4, "urls": {"prev": "https://api.discogs.com/database/search?q=james+taylor+new+moon+shine&secret=yNSnBqrCDUYmwfMheZdtdCDuaUgQRJTn&key=bXDsQzXjWPxUowNRUoxq&per_page=5&type=master&page=3", "first": "https://api.discogs.com/database/search?q=james+taylor+new+moon+shine&secret=yNSnBqrCDUYmwfMheZdtdCDuaUgQRJTn&key=bXDsQzXjWPxUowNRUoxq&per_page=5&type=master&page=1"}, "items": 17}, "results": [{"style": ["Big Band"], "thumb": "https://img.discogs.com/discogs-images/R-5420943-1507027002-2700.jpeg.jpg", "format": ["CD", "Compilation", "Limited Edition", "Box Set"], "country": "US", "barcode": [], "uri": "/Stan-Kenton-The-Complete-Capitol-Studio-Recordings-Of-Stan-Kenton-1943-47/master/866349", "master_url": "https://api.discogs.com/masters/866349", "label": ["Mosaic Records", "CEMA Special Markets"], "genre": ["Jazz"], "catno": "MD7-163", "community": {"want": 36, "have": 70}, "year": "1995", "cover_image": "https://img.discogs.com/2700.jpeg.jpg", "title": "Stan Kenton - The Complete Capitol Studio Recordings Of Stan Kenton 1943-47", "resource_url": "https://api.discogs.com/masters/866349", "master_id": 866349, "type": "master", "id": 866349}, {"style": ["Prog Rock", "Classic Rock"], "thumb": "https://img.discogs.com/discogs-images/R-1570546-1229281515.jpeg.jpg", "format": ["CD", "Album", "Reissue", "Remastered", "Box Set", "Compilation"], "country": "Europe", "uri": "/Pink-Floyd-Oh-By-The-Way/master/437149", "master_url": "https://api.discogs.com/masters/437149", "label": ["EMI", "EMI", "EMI", "EMI"], "genre": ["Rock", "Pop"], "catno": "50999 511267 2 8", "community": {"want": 0, "have": 0}, "year": "2007", "cover_image": "https://img.discogs.com/discogs-images/R-1570546-1229281515.jpeg.jpg", "title": "Pink Floyd - Oh By The Way", "resource_url": "https://api.discogs.com/masters/437149", "master_id": 437149, "type": "master", "id": 437149}]}

data/spec/lib/authorities/discogs/generic_authority_spec.rb

@@ -9,8 +9,26 @@ describe Qa::Authorities::Discogs::GenericAuthority do
   let(:authority) { described_class.new "all" }
 
   describe "#build_query_url" do
-    subject { authority.build_query_url("foo", 'master') }
-    it { is_expected.to eq 'https://api.discogs.com/database/search?q=foo&type=master&key=dummy_key&secret=dummy_secret' }
+    context "build_query_url startRecord" do
+      subject { authority.build_query_url("foo", tc) }
+      let(:tc) { instance_double(Qa::TermsController) }
+      before do
+        allow(Qa::TermsController).to receive(:new).and_return(tc)
+        allow(tc).to receive(:params).and_return('startRecord' => "16", 'maxRecords' => "5", 'subauthority' => "master")
+      end
+
+      it { is_expected.to eq 'https://api.discogs.com/database/search?q=foo&type=master&page=4&per_page=5&key=dummy_key&secret=dummy_secret' }
+    end
+    context "build_query_url per_page" do
+      subject { authority.build_query_url("foo", tc) }
+      let(:tc) { instance_double(Qa::TermsController) }
+      before do
+        allow(Qa::TermsController).to receive(:new).and_return(tc)
+        allow(tc).to receive(:params).and_return('page' => "1", 'per_page' => "10", 'subauthority' => "master")
+      end
+
+      it { is_expected.to eq 'https://api.discogs.com/database/search?q=foo&type=master&page=1&per_page=10&key=dummy_key&secret=dummy_secret' }
+    end
   end
 
   describe "#find_url" do
@@ -263,7 +281,7 @@ describe Qa::Authorities::Discogs::GenericAuthority do
       context "with subauthority all" do
         let(:tc) { instance_double(Qa::TermsController) }
         let :results do
-          stub_request(:get, "https://api.discogs.com/database/search?q=melody+gardot+who+will+comfort+me+over+the+rainbo&type=all&key=dummy_key&secret=dummy_secret")
+          stub_request(:get, "https://api.discogs.com/database/search?q=melody+gardot+who+will+comfort+me+over+the+rainbo&type=all&page=&per_page=&key=dummy_key&secret=dummy_secret")
             .to_return(status: 200, body: webmock_fixture("discogs-search-response-no-subauth.json"))
           authority.search("melody gardot who will comfort me over the rainbo", tc)
         end
@@ -286,7 +304,7 @@ describe Qa::Authorities::Discogs::GenericAuthority do
       context "with subauthority master" do
         let(:tc) { instance_double(Qa::TermsController) }
         let :results do
-          stub_request(:get, "https://api.discogs.com/database/search?q=wes+montgomery+tequila+bumpin'+on+sunse&type=master&key=dummy_key&secret=dummy_secret")
+          stub_request(:get, "https://api.discogs.com/database/search?q=wes+montgomery+tequila+bumpin'+on+sunse&type=master&page=&per_page=&key=dummy_key&secret=dummy_secret")
             .to_return(status: 200, body: webmock_fixture("discogs-search-response-subauth.json"))
           authority.search("wes montgomery tequila bumpin' on sunse", tc)
         end
@@ -305,6 +323,46 @@ describe Qa::Authorities::Discogs::GenericAuthority do
         end
       end
 
+      context "with setRecord and maxRecords" do
+        let(:tc) { instance_double(Qa::TermsController) }
+        let :results do
+          stub_request(:get, "https://api.discogs.com/database/search?q=james+taylor+new+moon+shine&type=master&page=4&per_page=5&key=dummy_key&secret=dummy_secret")
+            .to_return(status: 200, body: webmock_fixture("discogs-search-response-set-record.json"))
+          authority.search("james taylor new moon shine", tc)
+        end
+        before do
+          allow(Qa::TermsController).to receive(:new).and_return(tc)
+          allow(tc).to receive(:params).and_return('subauthority' => "master", 'startRecord' => 16, 'maxRecords' => 5, 'response_header' => 'true')
+        end
+
+        it "has id and label keys" do
+          expect(results['response_header']['start_record']).to eq 16
+          expect(results['response_header']['requested_records']).to eq 5
+          expect(results['response_header']['retrieved_records']).to eq 2
+          expect(results['response_header']['total_records']).to eq 17
+        end
+      end
+
+      context "with page and per_page" do
+        let(:tc) { instance_double(Qa::TermsController) }
+        let :results do
+          stub_request(:get, "https://api.discogs.com/database/search?q=james+taylor+new+moon+shine&type=master&page=1&per_page=10&key=dummy_key&secret=dummy_secret")
+            .to_return(status: 200, body: webmock_fixture("discogs-search-response-per-page.json"))
+          authority.search("james taylor new moon shine", tc)
+        end
+        before do
+          allow(Qa::TermsController).to receive(:new).and_return(tc)
+          allow(tc).to receive(:params).and_return('subauthority' => "master", 'page' => 1, 'per_page' => 10, 'response_header' => 'true')
+        end
+
+        it "has id and label keys" do
+          expect(results['response_header']['start_record']).to eq 1
+          expect(results['response_header']['requested_records']).to eq 10
+          expect(results['response_header']['retrieved_records']).to eq 10
+          expect(results['response_header']['total_records']).to eq 17
+        end
+      end
+
       context "when authentication isn't set" do
         let(:tc) { instance_double(Qa::TermsController) }
         let :results do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qa
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Stephen Anderson
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-import
@@ -92,16 +92,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rdf
   requirement: !ruby/object:Gem::Requirement
@@ -455,6 +461,8 @@ files:
 - spec/fixtures/discogs-id-not-found-release.json
 - spec/fixtures/discogs-search-response-no-auth.json
 - spec/fixtures/discogs-search-response-no-subauth.json
+- spec/fixtures/discogs-search-response-per-page.json
+- spec/fixtures/discogs-search-response-set-record.json
 - spec/fixtures/discogs-search-response-subauth.json
 - spec/fixtures/funders-find-response.json
 - spec/fixtures/funders-noquery.json
@@ -633,6 +641,7 @@ test_files:
 - spec/lib/services/rdf_authority_parser_spec.rb
 - spec/fixtures/lod_lang_search_enesfrde.rdf.xml
 - spec/fixtures/oclcts-response-mesh-3.txt
+- spec/fixtures/discogs-search-response-set-record.json
 - spec/fixtures/loc-names-response.txt
 - spec/fixtures/oclcts-response-mesh-2.txt
 - spec/fixtures/lod_loc_term_bad_id.rdf.xml
@@ -653,6 +662,7 @@ test_files:
 - spec/fixtures/getty-aat-find-response.json
 - spec/fixtures/lod_lang_term_enfr_noalt.rdf.xml
 - spec/fixtures/assign-fast-noresults.json
+- spec/fixtures/discogs-search-response-per-page.json
 - spec/fixtures/getty-error-response.txt
 - spec/fixtures/lod_loc_term_found.rdf.xml
 - spec/fixtures/lod_lang_term_enfr.rdf.xml