supplejack_api 1

data/spec/models/fragment_spec.rb

@@ -0,0 +1,15 @@
+# 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 Fragment do
+    
+  end
+end
+

data/spec/models/site_activity_spec.rb

@@ -0,0 +1,103 @@
+# 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 SiteActivity do
+
+    let(:user) { create(:user) }
+
+    context 'validations' do
+      it 'should be invalid when there is a existing site_activity with the same date' do
+        SupplejackApi::SiteActivity.create(date: Date.today)
+        expect(SupplejackApi::SiteActivity.new(date: Date.today)).to_not be_valid
+      end
+    end
+    
+    describe '.generate_activity' do
+      ['user_sets', 'search', 'records'].each do |field|
+        it 'agregates #{field} totals across all users' do
+          create(:user_activity, user_id: user.id, field.to_sym => {'total' => 10})
+          create(:user_activity, user_id: user.id, field.to_sym => {'total' => 5})
+
+          site_activity = SupplejackApi::SiteActivity.generate_activity
+          expect(site_activity.send(field)).to eq 15
+        end
+      end
+
+      it 'only agregates user activities from the last 12 hours' do
+        create(:user_activity, user_id: user.id, :search => {'total' => 10}, created_at: Time.now-14.hours)
+        site_activity = SupplejackApi::SiteActivity.generate_activity
+        expect(site_activity.search).to eq 0
+      end
+
+      it 'stores yesterday\'s date' do
+        Timecop.freeze(Time.now) do
+          site_activity = SupplejackApi::SiteActivity.generate_activity
+          expect(site_activity.date).to eq Time.now.to_date
+        end
+      end
+
+      it 'adds up a grand total' do
+        create(:user_activity, user_id: user.id, :records => {'total' => 10})
+        create(:user_activity, user_id: user.id, :user_sets => {'total' => 5})
+
+        site_activity = SupplejackApi::SiteActivity.generate_activity
+        expect(site_activity.total).to eq 15
+      end
+
+      context 'specify a date in the past' do
+        before do 
+          create(:user_activity, user_id: user.id, :records => {'total' => 10}, created_at: Time.now - 26.hours)
+          create(:user_activity, user_id: user.id, :user_sets => {'total' => 5}, created_at: Time.now - 28.hours)
+        end
+
+        it 'generates the site activity for a day in the past' do
+          site_activity = SupplejackApi::SiteActivity.generate_activity(Time.now-24.hours)
+          expect(site_activity.total).to eq 15
+        end
+
+        it 'should add up user activity created after the date' do
+          create(:user_activity, user_id: user.id, :records => {'total' => 2}, created_at: Time.now)
+          site_activity = SupplejackApi::SiteActivity.generate_activity(Time.now-24.hours)
+          expect(site_activity.total).to eq 15
+        end
+
+        it 'should add source_clicks from SourceActivity to total and reset SourceActivity' do
+          allow(SourceActivity).to receive(:get_source_clicks) { 2 }
+          expect(SupplejackApi::SourceActivity).to receive(:reset)
+          site_activity = SupplejackApi::SiteActivity.generate_activity
+          expect(site_activity.total).to eq 2
+        end
+      end
+    end
+
+    describe '#activities' do
+      it 'should return only the custom fields' do
+        expect(SupplejackApi::SiteActivity.activities).to_not include '_id'
+      end
+
+      it 'should include date' do
+        expect(SupplejackApi::SiteActivity.activities).to include 'date'
+      end
+    end
+
+    describe '#calculate_total' do
+      let(:site_activity) { SupplejackApi::SiteActivity.new }
+
+      it 'adds up the totals from every activity' do
+        site_activity.search = 1
+        site_activity.records = 2
+        site_activity.user_sets = 3
+        site_activity.source_clicks = 3
+        site_activity.calculate_total
+        expect(site_activity.total).to eq 9
+      end
+    end
+  end
+end

data/spec/models/source_activity_spec.rb

@@ -0,0 +1,56 @@
+# 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 SourceActivity do
+		describe '#increment' do
+			context 'SourceActivity doesn\'t exist' do
+				it 'creates a SourceActivity with source activity of 1' do
+					SupplejackApi::SourceActivity.increment
+					expect(SupplejackApi::SourceActivity.get_source_clicks).to eq 1
+				end	
+			end
+
+			context 'SourceActivity exists' do
+				before {
+					SupplejackApi::SourceActivity.create(source_clicks: 12)
+				}
+
+				it 'increments source activity' do
+					SupplejackApi::SourceActivity.increment
+					expect(SupplejackApi::SourceActivity.get_source_clicks).to eq 13
+				end	
+			end
+		end
+
+		describe '#get_source_clicks' do
+			it 'returns the source_clicks count if SourceActive exists' do
+				SupplejackApi::SourceActivity.increment
+				expect(SupplejackApi::SourceActivity.get_source_clicks).to eq 1
+			end
+
+			it 'returns nil if no SourceActivity' do
+				expect(SupplejackApi::SourceActivity.get_source_clicks).to be_nil
+			end
+		end
+
+		describe '#reset' do
+			it 'deletes first instance of SourceActivity if exists' do
+				SupplejackApi::SourceActivity.increment
+				SupplejackApi::SourceActivity.reset
+				expect(SupplejackApi::SourceActivity.count).to be 0
+			end
+
+			it 'handles no source activity' do
+				2.times { SupplejackApi::SourceActivity.reset }
+			end
+		end
+
+	end
+end

data/spec/models/source_authority_spec.rb

@@ -0,0 +1,42 @@
+# 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 SourceAuthority do
+    let(:source_authority) { create(:source_authority) }
+
+    subject { source_authority }
+
+    it { should be_stored_in :source_authorities }
+    it { should be_timestamped_document }
+    it { should be_timestamped_document.with(:created) }
+    it { should be_timestamped_document.with(:updated) }
+
+    it { should belong_to(:concept) }
+
+    describe 'fields' do
+      context '.model fields' do
+        %w(concept_type internal_identifier concept_score source_id source_name url).each do |field|
+          it "responds to #{field} field" do
+            expect(source_authority.respond_to?(field)).to be_truthy
+          end
+        end
+      end
+
+      context '.schema fields' do
+        ConceptSchema.fields.each do |name, field|
+          it "sets the #{name} field from the schema" do
+            expect(source_authority.respond_to?(name)).to be_truthy
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/models/supplejack_api/api_concept/concept_fragment_spec.rb

@@ -0,0 +1,189 @@
+# 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 ApiConcept
+    describe ConceptFragment do
+
+      # let!(:concept) { FactoryGirl.build(:concept, concept_id: 1234) }
+      # let!(:fragment) { concept.fragments.build(priority: 0) }
+      # let(:fragment_class) { ConceptFragment }
+
+      # before { concept.save }
+
+      # describe 'schema_class' do
+      #   it 'should return ConceptSchema' do
+      #     expect(ConceptFragment.schema_class).to eq ConceptSchema
+      #   end
+      # end
+
+      # describe 'build_mongoid_schema' do
+      #   before do
+      #     allow(ConceptSchema).to receive(:fields) do
+      #       {
+      #         title: double(:field, name: :title, type: :string).as_null_object,
+      #         count: double(:field, name: :count, type: :integer).as_null_object,
+      #         date: double(:field, name: :date, type: :datetime).as_null_object,
+      #         is_active: double(:field, name: :is_active, type: :boolean).as_null_object,
+      #         subject: double(:field, name: :subject, type: :string, multi_value: true).as_null_object,
+      #         sort_date: double(:field, name: :sort_date, type: :string, store: false).as_null_object,
+      #       }
+      #     end
+      #     allow(fragment_class).to receive(:field)
+
+      #     allow(ConceptSchema).to receive(:mongo_indexes) do
+      #       {
+      #         count_date: double(:mongo_index, name: :count_date, fields: [{ count: 1, date: 1 }], index_options: {background: true}).as_null_object
+      #       }
+      #     end
+      #     allow(fragment_class).to receive(:mongo_indexes)
+      #   end
+
+      #   after do
+      #     fragment_class.build_mongoid_schema
+      #   end
+
+      #   context 'creating fields' do
+      #     it 'defines a string field' do
+      #       expect(fragment_class).to receive(:field).with(:title, type: String)
+      #     end
+
+      #     it 'defines a integer field' do
+      #       expect(fragment_class).to receive(:field).with(:count, type: Integer)
+      #     end
+
+      #     it 'defines a datetime field' do
+      #       expect(fragment_class).to receive(:field).with(:date, type: DateTime)
+      #     end
+
+      #     it 'defines a boolean field' do
+      #       expect(fragment_class).to receive(:field).with(:is_active, type: Boolean)
+      #     end
+
+      #     it 'defines a multivalue field' do
+      #       expect(fragment_class).to receive(:field).with(:subject, type: Array)
+      #     end
+
+      #     it 'does not define a field with stored false' do
+      #       expect(fragment_class).to_not receive(:field).with(:sort_date, anything)
+      #     end
+      #   end
+
+      #   context 'creating indexes' do
+      #     it 'should create a single field index' do
+      #       expect(fragment_class).to receive(:index).with({:count=>1, :date=>1}, {:background=>true})
+      #     end
+      #   end
+      # end
+
+      # describe '.mutable_fields' do
+      #   {description: String, sameAs: Array, dateOfDeath: DateTime}.each do |name, type|
+      #     it 'should return a hash that includes the key #{name} and value #{type}' do
+      #       expect(fragment_class.mutable_fields[name.to_s]).to eq type
+      #     end
+      #   end
+
+      #   it 'should not include the source_id' do
+      #     expect(fragment_class.mutable_fields).to_not have_key('source_id')
+      #   end
+
+      #   it 'should memoize the mutable_fields' do
+      #     fragment_class.class_variable_set('@@mutable_fields', nil)
+      #     expect(fragment_class).to receive(:fields).once.and_return({})
+      #     fragment_class.mutable_fields
+      #     fragment_class.mutable_fields
+      #     fragment_class.class_variable_set('@@mutable_fields', nil)
+      #   end
+      # end
+
+      # context 'default scope' do
+      #   it 'should order the fragments from lower to higher priority' do
+      #     fragment3 = concept.fragments.create(priority: 3)
+      #     fragment1 = concept.fragments.create(priority: 1)
+      #     fragment_1 = concept.fragments.create(priority: -1)
+      #     concept.reload
+      #     expect(concept.fragments.map(&:priority)).to eq [-1, 0, 1, 3]
+      #   end
+      # end
+
+      # describe '#primary?' do
+      #   it 'returns true when priority is 0' do
+      #     fragment.priority = 0
+      #     expect(fragment.primary?).to be_truthy
+      #   end
+
+      #   it 'returns false when priority is 1' do
+      #     fragment.priority = 1
+      #     expect(fragment.primary?).to be_falsey
+      #   end
+      # end
+
+      # describe '#clear_attributes' do
+      #   let(:concept) { FactoryGirl.create(:concept) }
+      #   let(:fragment) { concept.fragments.create(gender: 'male') }
+
+      #   it 'clears the existing gender' do
+      #     fragment.clear_attributes
+      #     expect(fragment.gender).to be_nil
+      #   end
+      # end
+
+      # describe '#update_from_harvest' do
+      #   it 'updates the label with the value' do
+      #     fragment.update_from_harvest({label: 'John Smith'})
+      #     expect(fragment.label).to eq 'John Smith'
+      #   end
+
+      #   it 'handles nil values' do
+      #     fragment.update_from_harvest(nil)
+      #   end
+
+      #   it 'ignores invalid fields' do
+      #     fragment.update_from_harvest({invalid_field: 'http://yahoo.com'})
+      #     expect(fragment['invalid_field']).to be_nil
+      #   end
+
+      #   it 'stores uniq values for each field' do
+      #     fragment.update_from_harvest({isRelatedTo: ['Jim', 'Bob', 'Jim']})
+      #     expect(fragment.isRelatedTo).to eq ['Jim', 'Bob']
+      #   end
+
+      #   it 'updates the updated_at even if the attributes didn\'t change' do
+      #     new_time = Time.now + 1.day
+      #     Timecop.freeze(new_time) do
+      #       fragment.update_from_harvest({})
+      #       expect(fragment.updated_at.to_i).to eq(new_time.to_i)
+      #     end
+      #   end
+
+      #   it 'uses the attribute setters for strings' do
+      #     expect(fragment).to receive('label=').with('John Smith')
+      #     fragment.update_from_harvest({:label => 'John Smith'})
+      #   end
+
+      #   it 'uses the attribute setters for Arrays' do
+      #     expect(fragment).to receive('isRelatedTo=').with(['Jim', 'Bob'])
+      #     fragment.update_from_harvest({:isRelatedTo => ['Jim', 'Bob']})
+      #   end
+
+      #   it 'stores the first element in the array for non array fields' do
+      #     fragment.update_from_harvest({label: ['John Smith', 'Jim Bob']})
+      #     expect(fragment.label).to eq 'John Smith'
+      #   end
+
+      #   it 'should set the source_id' do
+      #     fragment.update_from_harvest({source_id: ['census']})
+      #     expect(fragment.source_id).to eq 'census'
+      #   end
+      # end
+
+
+    end
+  end
+end

data/spec/models/supplejack_api/api_record/record_fragment_spec.rb

@@ -0,0 +1,189 @@
+# 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 ApiRecord
+    describe RecordFragment do
+
+  		let!(:record) { FactoryGirl.build(:record, record_id: 1234) }
+      let!(:fragment) { record.fragments.build(priority: 0) }
+      let(:fragment_class) { RecordFragment }
+
+      before { record.save }
+
+      describe 'schema_class' do
+      	it 'should return RecordSchema' do
+      		expect(RecordFragment.schema_class).to eq RecordSchema
+      	end
+      end
+
+      describe 'build_mongoid_schema' do
+        before do
+          allow(RecordSchema).to receive(:fields) do
+            {
+              title: double(:field, name: :title, type: :string).as_null_object,
+              count: double(:field, name: :count, type: :integer).as_null_object,
+              date: double(:field, name: :date, type: :datetime).as_null_object,
+              is_active: double(:field, name: :is_active, type: :boolean).as_null_object,
+              subject: double(:field, name: :subject, type: :string, multi_value: true).as_null_object,
+              sort_date: double(:field, name: :sort_date, type: :string, store: false).as_null_object,
+            }
+          end
+          allow(fragment_class).to receive(:field)
+
+          allow(RecordSchema).to receive(:mongo_indexes) do
+            {
+              count_date: double(:mongo_index, name: :count_date, fields: [{ count: 1, date: 1 }], index_options: {background: true}).as_null_object
+            }
+          end
+          allow(fragment_class).to receive(:mongo_indexes)
+        end
+
+        after do
+          fragment_class.build_mongoid_schema
+        end
+
+        context 'creating fields' do
+          it 'defines a string field' do
+            expect(fragment_class).to receive(:field).with(:title, type: String)
+          end
+
+          it 'defines a integer field' do
+            expect(fragment_class).to receive(:field).with(:count, type: Integer)
+          end
+
+          it 'defines a datetime field' do
+            expect(fragment_class).to receive(:field).with(:date, type: DateTime)
+          end
+
+          it 'defines a boolean field' do
+            expect(fragment_class).to receive(:field).with(:is_active, type: Boolean)
+          end
+
+          it 'defines a multivalue field' do
+            expect(fragment_class).to receive(:field).with(:subject, type: Array)
+          end
+
+          it 'does not define a field with stored false' do
+            expect(fragment_class).to_not receive(:field).with(:sort_date, anything)
+          end
+        end
+
+        context 'creating indexes' do
+          it 'should create a single field index' do
+            expect(fragment_class).to receive(:index).with({:count=>1, :date=>1}, {:background=>true})
+          end
+        end
+      end
+
+      describe '.mutable_fields' do
+        {name: String, email: Array, nz_citizen: Boolean}.each do |name, type|
+          it 'should return a hash that includes the key #{name} and value #{type}' do
+            type = Mongoid::Boolean if type == Boolean
+            expect(fragment_class.mutable_fields[name.to_s]).to eq type
+          end
+        end
+
+        it 'should not include the source_id' do
+          expect(fragment_class.mutable_fields).to_not have_key('source_id')
+        end
+
+        it 'should memoize the mutable_fields' do
+          fragment_class.class_variable_set('@@mutable_fields', nil)
+          allow(fragment_class).to receive(:fields).once.and_return({})
+          fragment_class.mutable_fields
+          fragment_class.mutable_fields
+          fragment_class.class_variable_set('@@mutable_fields', nil)
+        end
+      end
+
+      context 'default scope' do
+        it 'should order the fragments from lower to higher priority' do
+          fragment3 = record.fragments.create(priority: 3)
+          fragment1 = record.fragments.create(priority: 1)
+          fragment_1 = record.fragments.create(priority: -1)
+          record.reload
+          expect(record.fragments.map(&:priority)).to eq [-1, 0, 1, 3]
+        end
+      end
+
+      describe '#primary?' do
+        it 'returns true when priority is 0' do
+          fragment.priority = 0
+          expect(fragment.primary?).to be_truthy
+        end
+
+        it 'returns false when priority is 1' do
+          fragment.priority = 1
+          expect(fragment.primary?).to be_falsey
+        end
+      end
+
+      describe '#clear_attributes' do
+        let(:record) { FactoryGirl.create(:record) }
+        let(:fragment) { record.fragments.create(nz_citizen: true) }
+
+        it 'clears the existing nz_citizen' do
+          fragment.clear_attributes
+          expect(fragment.nz_citizen).to be_nil
+        end
+      end
+
+      describe '#update_from_harvest' do
+        it 'updates the name with the value' do
+          fragment.update_from_harvest({name: 'John Smith'})
+          expect(fragment.name).to eq 'John Smith'
+        end
+
+        it 'handles nil values' do
+          fragment.update_from_harvest(nil)
+        end
+
+        it 'ignores invalid fields' do
+          fragment.update_from_harvest({invalid_field: 'http://yahoo.com'})
+          expect(fragment['invalid_field']).to be_nil
+        end
+
+        it 'stores uniq values for each field' do
+          fragment.update_from_harvest({children: ['Jim', 'Bob', 'Jim']})
+          expect(fragment.children).to eq ['Jim', 'Bob']
+        end
+
+        it 'updates the updated_at even if the attributes didn\'t change' do
+          new_time = Time.now + 1.day
+          Timecop.freeze(new_time) do
+            fragment.update_from_harvest({})
+            expect(fragment.updated_at.to_i).to eq(new_time.to_i)
+          end
+        end
+
+        it 'uses the attribute setters for strings' do
+          allow(fragment).to receive('name=').with('John Smith')
+          fragment.update_from_harvest({:name => 'John Smith'})
+        end
+
+        it 'uses the attribute setters for Arrays' do
+          allow(fragment).to receive('children=').with(['Jim', 'Bob'])
+          fragment.update_from_harvest({:children => ['Jim', 'Bob']})
+        end
+
+        it 'stores the first element in the array for non array fields' do
+          fragment.update_from_harvest({name: ['John Smith', 'Jim Bob']})
+          expect(fragment.name).to eq 'John Smith'
+        end
+
+        it 'should set the source_id' do
+          fragment.update_from_harvest({source_id: ['census']})
+          expect(fragment.source_id).to eq 'census'
+        end
+      end
+
+    end
+  end
+end