supplejack_api 1

data/spec/models/supplejack_api/search_spec.rb

@@ -0,0 +1,243 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  describe Search do
+  	before {
+      @search = Search.new
+      Sunspot.session = SunspotMatchers::SunspotSessionSpy.new(Sunspot.session)
+      @session = Sunspot.session
+
+      allow(Search).to receive(:role_collection_restrictions) { [] }
+    }
+
+  	describe '#facet_list' do
+  		before {
+        @search = RecordSearch.new
+        allow(@search).to receive(:model_class) { Record }
+      }
+
+      it 'should return a array of facets' do
+        @search.options[:facets] = 'name, address'
+        expect(@search.facet_list).to eq [:name, :address]
+      end
+
+      it 'should discard any fields not configured as facets' do
+        @search.options[:facets] = 'name, address, other_facet'
+        expect(@search.facet_list).to eq [:name, :address]
+      end
+    end
+
+    describe '#field_list' do
+    	before {
+        @search = RecordSearch.new
+        allow(@search).to receive(:schema_class) { RecordSchema }
+      }
+
+      it 'should return a array of fields' do
+        @search.options[:fields] = 'name, address'
+        expect(@search.field_list).to eq [:name, :address]
+      end
+
+      it 'should only return valid fields' do
+        @search.options[:fields] = 'name, something_else'
+        expect(@search.field_list).to eq [:name]
+      end
+    end
+
+    describe '#group_list' do
+    	before {
+        @search = RecordSearch.new
+        allow(@search).to receive(:model_class) { Record }
+      }
+
+	    it 'gets the groups from the fields list' do
+	      @search.options[:fields] = "content_partner, core"
+	      expect(@search.group_list).to eq [:core]
+	    end
+	  end
+
+	  describe '#query_fields' do
+      it 'returns nil when no query fields were specified' do
+        @search = Search.new
+        expect(@search.query_fields).to be_nil
+      end
+
+      it 'returns the query fields from the params' do
+        @search = Search.new(query_fields: [:collection])
+        expect(@search.query_fields).to eq([:collection])
+      end
+
+      it 'supports the query_fields as comma separated string' do
+        @search = Search.new(query_fields: 'collection, creator, publisher')
+        expect(@search.query_fields).to eq([:collection, :creator, :publisher])
+      end
+
+      it 'converts an array of strings to symbols' do
+        @search = Search.new(query_fields: ['collection','creator'])
+        expect(@search.query_fields).to eq([:collection, :creator])
+      end
+
+      it 'returns nil when query_fields is an empty string' do
+        @search = Search.new(query_fields: '')
+        expect(@search.query_fields).to be_nil
+      end
+
+      it 'returns nil when query_fields is an empty array' do
+        @search = Search.new(query_fields: [])
+        expect(@search.query_fields).to be_nil
+      end
+    end
+
+    describe '#extract_range' do
+      it 'extracts the dates from [1900 TO 2000] and return a range' do
+        expect(@search.extract_range('[1900 TO 2000]')).to eq(1900..2000)
+      end
+
+      it 'doesn\'t match non numbers' do
+        expect(@search.extract_range('[asdasd TO asdads]')).to eq '[asdasd TO asdads]'
+      end
+
+      it 'returns the current value if is not a range and converts it to int' do
+        expect(@search.extract_range('1900')).to eq 1900
+      end
+    end
+
+     describe '#to_proper_value' do
+      it 'returns false for "false" string' do
+        expect(@search.to_proper_value('active?', 'false')).to be_falsey
+      end
+
+      it 'returns true for "true" string' do
+        expect(@search.to_proper_value('active?', 'true')).to be_truthy
+      end
+
+      it 'returns nil if is a "nil" string' do
+        expect(@search.to_proper_value('active?', 'nil')).to be_nil
+      end
+
+      it 'returns nil if is a "null" string' do
+        expect(@search.to_proper_value('active?', 'null')).to be_nil
+      end
+
+      it 'returns the value unchanged' do
+        expect(@search.to_proper_value('label', 'Black')).to eq('Black')
+      end
+
+      it 'should strip any white space' do
+        expect(@search.to_proper_value('label', ' Black Label ')).to eq('Black Label')
+      end
+    end
+
+    describe '#text' do
+      it 'downcases the text string' do
+        expect(Search.new(text: 'McDowall').text).to eq 'mcdowall'
+      end
+
+      ['AND', 'OR', 'NOT'].each do |operator|
+        it "downcases everything except the #{operator} operators" do
+          expect(Search.new(text: "McDowall #{operator} Dogs").text).to eq "mcdowall #{operator} dogs"
+        end
+      end
+    end
+
+    describe '#solr_search_object' do
+      it 'memoizes the solr search object' do
+        sunspot_mock = double(:solr).as_null_object
+        expect(@search).to receive(:execute_solr_search).once.and_return(sunspot_mock)
+        @search.solr_search_object
+        expect(@search.solr_search_object).to eq(sunspot_mock)
+      end
+
+      it 'sets the solr request parameters when debug=true' do
+        @search.options[:debug] = 'true'
+        allow(@search).to receive(:execute_solr_search) { double(:solr_request, query: double(:query, to_params: {param1: 1})) }
+        @search.solr_search_object
+        expect(@search.solr_request_params).to eq({:param1 => 1})
+      end
+
+      it "doesn't set the solr request parameters" do
+        allow(@search).to receive(:execute_solr_search) { double(:solr_request, query: double(:query, to_params: {param1: 1})) }
+        @search.solr_search_object
+        expect(@search.solr_request_params).to be_nil
+      end
+
+      it 'returns a empty hash when solr request fails' do
+        @search.options[:debug] = 'true'
+        allow(@search).to receive(:execute_solr_search) { {} }
+        expect(@search.solr_search_object).to eq({})
+      end
+    end
+
+    describe '#solr_error_message' do
+      before {
+        @error = double(:error, response: {status: 400, body: 'Solr error'})
+        allow(@error).to receive(:parse_solr_error_response) { 'Solr error' }
+      }
+
+      it 'returns a hash with the solr error title and description' do
+        expect(@search.solr_error_message(@error)).to eq({title: '400 Bad Request', body: 'Solr error'})
+      end
+    end
+
+    describe '#method_missing' do
+	    it 'delegates any missing method to the solr_search_object' do
+	      sso = double(:sso, something_missing: [], hits: [])
+	      allow(@search).to receive(:solr_search_object).and_return(sso)
+	      expect(sso).to receive(:something_missing)
+	      @search.something_missing
+	    end
+
+	    it 'returns nil when solr request failed' do
+	      allow(@search).to receive(:solr_search_object).and_return({})
+	      expect(@search.something_missing).to be_nil
+	    end
+	  end
+
+	  describe '#solr_error_message' do
+      before(:each) do
+        @error = double(:error, response: {status: 400, body: 'Solr error'})
+        allow(@error).to receive(:parse_solr_error_response) { 'Solr error' }
+      end
+
+      it 'returns a hash with the solr error title and description' do
+        expect(@search.solr_error_message(@error)).to eq({:title => '400 Bad Request', :body => 'Solr error'})
+      end
+    end
+
+    describe '#solr_search_object' do
+      it 'memoizes the solr search object' do
+        sunspot_mock = double(:solr).as_null_object
+        expect(@search).to receive(:execute_solr_search).once.and_return(sunspot_mock)
+        @search.solr_search_object
+        expect(@search.solr_search_object).to eq(sunspot_mock)
+      end
+
+      it 'sets the solr request parameters when debug=true' do
+        @search.options[:debug] = 'true'
+        allow(@search).to receive(:execute_solr_search) { double(:solr_request, query: double(:query, to_params: {param1: 1})) }
+        @search.solr_search_object
+        expect(@search.solr_request_params).to eq({:param1 => 1})
+      end
+
+      it "doesn't set the solr request parameters" do
+        allow(@search).to receive(:execute_solr_search) { double(:solr_request, query: double(:query, to_params: {param1: 1})) }
+        @search.solr_search_object
+        expect(@search.solr_request_params).to be_nil
+      end
+
+      it 'returns a empty hash when solr request fails' do
+        @search.options[:debug] = 'true'
+        allow(@search).to receive(:execute_solr_search) { {} }
+        expect(@search.solr_search_object).to eq({})
+      end
+    end
+
+  end
+end

data/spec/models/supplejack_api/set_item_spec.rb

@@ -0,0 +1,123 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government, 
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details. 
+# 
+# Supplejack was created by DigitalNZ at the National Library of NZ and 
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  describe SetItem do
+  
+  	let(:user_set) { FactoryGirl.build(:user_set) }
+    let(:set_item) { user_set.set_items.build(record_id: 10, position: 1) }
+    
+    before(:each) do
+      allow(user_set).to receive(:record) {double(:record, record_id: 4321)}
+      allow(user_set).to receive(:update_record)
+    end
+
+    context "validations" do
+      it "should not be valid without a record_id" do
+        set_item.record_id = nil
+        expect(set_item).to_not be_valid
+      end
+
+      it "should not be valid when record_id is not a number" do
+        set_item.record_id = "abc"
+        expect(set_item).to_not be_valid
+      end
+
+      it "should be valid when the record_id is a number in string format" do
+        set_item.record_id = "1234"
+        expect(set_item.record_id).to eq 1234
+        expect(set_item).to be_valid
+      end
+
+      it "should not be valid when the record_id already exists in another set item" do
+        user_set.set_items.build(record_id: 2, position: 1)
+        user_set.save
+        set_item = user_set.set_items.build(record_id: 2, position: 2)
+        expect(set_item).to_not be_valid
+      end
+
+      it "should not be valid when trying to add a set to itself" do
+        allow(user_set).to receive(:record) {double(:record, record_id: 1234)}
+        user_set.set_items.build(record_id: 1234, position: 1)    
+        set_item = user_set.set_items.first
+        expect(set_item).to_not be_valid
+      end
+
+      it "should allow set_item to be added to user_set without an associated Record" do
+        allow(user_set).to receive(:record)
+        user_set.set_items.build(record_id: 1234, position: 1)    
+        set_item = user_set.set_items.first
+        expect(set_item).to be_valid
+      end
+    end
+
+    context "callbacks" do
+      it "calls set_position before_validation" do
+        set_item = user_set.set_items.build(record_id: 20)
+        expect(set_item).to receive(:set_position)
+        set_item.save
+      end
+    end
+
+    it "delegates record fields to the :record object" do
+      set_item.record = FactoryGirl.create(:record, record_id: 5)
+      set_item.record.fragments.create(name: "Ben", address: "Wellington")
+      set_item.record.save
+
+      expect(set_item.name).to eq "Ben"
+      expect(set_item.address).to eq "Wellington"
+    end
+
+    it "returns nil for any record field if the record doesn't exist" do
+      [:name, :address].each do |attr|
+        expect(set_item.send(attr)).to be_nil
+      end
+    end
+
+    describe "#set_position" do
+      context "with a set item" do
+        before(:each) do
+          user_set.set_items.build(record_id: 1, position: 1)
+          user_set.save
+        end
+        
+        it "positions the set item at the end" do
+          set_item = user_set.set_items.build(record_id: 2)
+          set_item.set_position
+          expect(set_item.position).to eq 2
+        end
+
+        it "doesn't override the position when already set" do
+          set_item = user_set.set_items.build(record_id: 2, position: 4)
+          set_item.set_position
+          expect(set_item.position).to eq 4
+        end
+      end
+
+      context "without set items" do
+        it "sets the position to 1" do
+          set_item = user_set.set_items.build(record_id: 2)
+          set_item.set_position
+          expect(set_item.position).to eq 1
+        end
+      end
+    end
+
+    describe "#reindex_record" do
+      let(:record) {double(:record)}
+
+      it "finds the record and calls index" do
+        expect(Record).to receive(:custom_find).with(set_item.record_id) {record}
+        expect(record).to receive(:index)
+        set_item.reindex_record
+      end
+    end
+
+  end
+end

data/spec/models/supplejack_api/source_spec.rb

@@ -0,0 +1,22 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government, 
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details. 
+# 
+# Supplejack was created by DigitalNZ at the National Library of NZ and 
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  describe Source do
+  
+  	describe '.suppressed' do
+  		let!(:active_source) { FactoryGirl.create(:source, status: 'active') }
+  		let!(:suppressed_source) { FactoryGirl.create(:source, status: 'suppressed') }
+  
+  		it 'should return all the suppressed sources' do
+  		  expect(Source.suppressed.to_a).to eq [suppressed_source]
+  		end
+  	end
+  end
+end

data/spec/models/supplejack_api/support/fragment_helpers_spec.rb

@@ -0,0 +1,216 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'spec_helper'
+
+module SupplejackApi
+  module Support
+    describe FragmentHelpers do
+      let(:record) { FactoryGirl.build(:record_with_fragment, record_id: 1234) }
+
+      describe '#before_save' do
+        it 'should call merge_fragments' do
+          expect(record).to receive(:merge_fragments)
+          record.save
+        end
+      end
+
+      describe "valiations" do
+        it "should be valid" do
+          expect(record).to be_valid
+        end
+
+        context "duplicate source_ids" do
+          before do
+            record.fragments << FactoryGirl.build(:record_fragment, source_id: 'source_name')
+          end
+
+          it "should not be valid" do
+            expect(record).to_not be_valid
+          end
+        end
+      end
+
+      describe "#source_ids" do
+        it "should return an array with a single source_id" do
+          expect(record.source_ids).to eq ['source_name']
+        end
+
+        context "multiple fragments" do
+          before do
+            record.fragments << FactoryGirl.build(:record_fragment, source_id: 'another_source')
+          end
+
+          it "should return an array with the source_ids" do
+            expect(record.source_ids).to eq ['source_name', "another_source"]
+          end
+        end
+      end
+
+      describe "#duplicate_source_ids?" do
+        it "should return false" do
+          expect(record.duplicate_source_ids?).to be_falsey
+        end
+
+        context "duplicate source_ids" do
+          before do
+            record.fragments << FactoryGirl.build(:record_fragment, source_id: 'source_name')
+          end
+
+          it "should return true" do
+            expect(record.duplicate_source_ids?).to be_truthy
+          end
+        end
+      end
+
+      describe '#primary_fragment' do
+        let(:record) { FactoryGirl.build(:record) }
+        before { record.save }
+
+        it 'returns the fragment with priority 0' do
+          fragment1 = record.fragments.create(name: 'John', priority: 1)
+          fragment0 = record.fragments.create(name: 'John', priority: 0)
+          expect(record.primary_fragment).to eq fragment0
+        end
+
+        it 'returns a new fragment with priority 0' do
+          expect(record.primary_fragment).to be_a ApiRecord::RecordFragment
+          expect(record.primary_fragment.priority).to eq 0
+        end
+
+        it 'should build a primary fragment with default attributes' do
+          expect(record.primary_fragment(name: 'John').name).to eq 'John'
+        end
+      end
+
+      describe 'merge_fragments' do
+        let(:record) { FactoryGirl.build(:record_with_fragment) }
+        let(:primary) { record.fragments.first }
+        let(:secondary) { record.fragments.last }
+
+        it 'should delete any existing merged fragment' do
+          record.merged_fragment = FactoryGirl.build(:record_fragment)
+          record.save
+          expect(record.merged_fragment).to be_nil
+        end
+
+        context 'one fragment' do
+          it 'should not save the merged fragment' do
+            record.merge_fragments
+            expect(record.merged_fragment).to be_nil
+          end
+        end
+
+        context 'multiple fragments' do
+          before(:each) do
+            record.fragments << FactoryGirl.build(:record_fragment, name: 'James Smith', email: ['jamessmith@example.com'], source_id: 'another_source')
+            record.save!
+          end
+
+          it 'unsets the priority field' do
+            record.save
+            expect(record.merged_fragment.priority).to be_nil
+          end
+
+          context 'single value fields' do
+            it 'should store the first non-nil value of the field' do
+              primary.name = nil
+              record.save
+              expect(record.merged_fragment.name).to eq 'James Smith'
+            end
+          end
+
+          context 'multi-value fields' do
+            it 'should store the merged values of the field' do
+              expect(record.merged_fragment.email).to eq ['johndoe@example.com', 'jamessmith@example.com']
+            end
+
+            it 'should not return duplicate values' do
+              primary.email = ['johndoe@example.com', 'jamessmith@example.com']
+              record.save
+              expect(record.merged_fragment.email).to eq ['johndoe@example.com', 'jamessmith@example.com']
+            end
+
+            it 'should not return nil values' do
+              secondary.email = nil
+              record.save
+              expect(record.merged_fragment.email).to eq ['johndoe@example.com']
+            end
+          end
+        end
+      end
+
+      describe '#method_missing' do
+        let(:record) { FactoryGirl.create(:record_with_fragment) }
+
+        context 'no fragments' do
+          let(:record) { FactoryGirl.create(:record) }
+
+          it 'should return nil' do
+            expect(record.nz_citizen).to be_nil
+          end
+        end
+
+        context 'single fragment' do
+          it 'should return a single value field from merged_fragment' do
+            expect(record.name).to eq 'John Doe'
+          end
+
+          it 'returns an array for an empty mutli-value field' do
+            expect(record.contact).to eq []
+          end
+        end
+
+        context 'multiple fragments' do
+          before(:each) do
+            record.fragments << FactoryGirl.build(:record_fragment, email: ['jamessmith@example.com'], source_id: 'another_source')
+            record.save!
+          end
+
+          it 'should return a single value field from merged_fragment' do
+            expect(record.name).to eq 'John Doe'
+          end
+
+          it 'should return the multi-value field values from merged_fragment' do
+            expect(record.email).to eq ['johndoe@example.com', 'jamessmith@example.com']
+          end
+        end
+
+        # context "namespaced field names" do
+        #   it "should translate namespaced field names into their stored field name" do
+        #     record.fragments.first.stub(:dc_name) { 'Joe Bloggs' }
+        #     record.public_send(:'dc:name')).to eq 'Joe Bloggs'
+        #   end
+        # end
+      end
+
+      describe '#sorted_fragments' do
+        it 'returns a list of fragments sorted by priority' do
+          record.fragments.build(priority: 10)
+          record.fragments.build(priority: -1)
+          record.fragments.build(priority: 5)
+
+          expect(record.sorted_fragments.map(&:priority)).to eq [-1,0,5,10]
+        end
+      end
+
+      describe '#find_fragment' do
+        before { record.save }
+
+        let!(:fragment) { record.fragments.create(source_id: 'thumbnails_enrichment') }
+
+        it 'should find a fragment by source_id' do
+          expect(record.find_fragment('thumbnails_enrichment')).to eq fragment
+        end
+
+        it "should return nil when it doesn't find a fragment" do
+          expect(record.find_fragment('nlnzcat')).to be_nil
+        end
+      end
+    end
+  end
+end