supplejack_api 1

data/spec/controllers/supplejack_api/metrics_api_controller_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module SupplejackApi
+  describe MetricsApiController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    def build_models
+      5.times do |n|
+        create(:daily_item_metric, date: Date.current - n.days)
+        create(:faceted_metrics, date: Date.current - n.days)
+        create(:usage_metrics, created_at: Date.current - n.days)
+      end
+    end
+
+    describe 'GET root' do
+      context "succesful requests" do
+        after do
+          expect(response.body).to match_response_schema('metrics/extended_response')
+        end
+
+        it 'retrieves a range of extended metrics, filtered against the facet parameter' do
+          create(:faceted_metrics, name: 'dc1', date: Date.yesterday)
+          create(:faceted_metrics, name: 'dc2', date: Date.yesterday)
+          create(:usage_metrics, record_field_value: 'dc1', date: Date.yesterday)
+          create(:usage_metrics, date: Date.yesterday)
+
+          get :root, version: 'v3', facets: 'dc1', start_date: Date.yesterday, end_date: Date.yesterday
+          json = JSON.parse(response.body)
+
+          expect(json.first['record'].count).to eq(1)
+          expect(json.first['view'].count).to eq(1)
+        end
+      end
+
+      context "failure requests" do
+        it 'responds with a 400 status if the facets parameter is missing' do
+          get :root, version: 'v3'
+
+          expect(response.status).to eq(400)
+        end
+
+        it 'responds with a 400 status if the number of facets requested is greater than 10' do
+          get :root, version: 'v3', facets: '1,2,3,4,5,6,7,8,9,10,11'
+
+          expect(response.status).to eq(400)
+        end
+      end
+    end
+
+    describe 'GET facets' do
+      before do
+        allow(SupplejackApi::FacetsHelper).to receive(:get_list_of_facet_values).with(any_args).and_return([
+          '1', '2', '3', '4', '5'
+        ])
+      end
+
+      after do
+        expect(response.body).to match_response_schema('metrics/facets_response')
+      end
+
+      it 'responds with a list of all facets' do
+        5.times{create(:faceted_metrics)}
+
+        get :facets, version: 'v3'
+        json = JSON.parse(response.body)
+
+        expect(json.length).to eq(5)
+      end
+    end
+  end
+end

data/spec/controllers/supplejack_api/partners_controller_spec.rb

@@ -0,0 +1,77 @@
+# 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 PartnersController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    describe "POST 'create'" do
+      it "creates a new partner" do
+        expect(Partner).to receive(:create).with("name" => "Statistics New Zealand").and_call_original
+        post :create, partner: FactoryGirl.attributes_for(:partner) 
+        expect(response).to be_success
+      end
+
+      it "returns the partner" do
+        post :create, partner: FactoryGirl.attributes_for(:partner)
+        expect(response.body).to include Partner.last.to_json
+      end
+
+      context "partner already exists" do
+        it "updates the partner" do
+          partner = FactoryGirl.create(:partner, name: 'partner1')
+          post :create, partner: {_id: partner.id, name: 'partner2'}
+          partner.reload
+          expect(partner.name).to eq 'partner2'
+        end
+      end
+    end
+
+    describe "GET 'show'" do
+      let(:partner) { FactoryGirl.create(:partner) }
+
+      it "finds the partner" do
+        expect(Partner).to receive(:find).with("1")
+        get :show, id: 1
+      end
+
+      it "returns the partner" do
+        allow(Partner).to receive(:find) {partner}
+        get :show, id: 1
+        expect(response.body).to eq partner.to_json
+      end
+    end
+
+    describe "GET 'index'" do
+      let(:partners) { [FactoryGirl.create(:partner), 
+                        FactoryGirl.create(:partner, name: "Down to the wire")] }
+
+      it "finds all partners" do
+        expect(Partner).to receive(:all) {partners}
+        get :index
+      end
+
+      it "returns the partners as a JSON array" do
+        allow(Partner).to receive(:all) {partners}
+        get :index
+        expect(response.body).to eq({partners: partners}.to_json)
+      end
+    end
+
+    describe "PUT 'update'" do
+      let(:partner) { FactoryGirl.create(:partner) }
+
+      it "finds and updates the partner" do
+        expect(Partner).to receive(:find).with(partner.id.to_s) {partner}
+        expect(partner).to receive(:update_attributes).with("name" => 'Down to the wire')
+        put :update, id: partner.id, partner: {name: 'Down to the wire'}
+      end
+    end
+  end
+end

data/spec/controllers/supplejack_api/records_controller_spec.rb

@@ -0,0 +1,143 @@
+# 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 RecordsController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    before {
+      @user = FactoryGirl.create(:user, authentication_token: 'apikey', role: 'developer')
+    }
+
+    describe 'GET index' do
+      before {
+        @search = RecordSearch.new
+        allow(@search).to receive(:valid?) { true }
+        allow(RecordSearch).to receive(:new) {@search}
+      }
+
+      it 'should initialize a new search instance' do
+        allow_any_instance_of(RecordSearch).to receive(:valid?) { false }
+        expect(RecordSearch).to receive(:new).with(hash_including(text: 'dogs')).and_return(@search)
+        get :index, api_key: 'apikey', text: "dogs", format: "json"
+        expect(assigns(:search)).to eq(@search)
+      end
+
+      it 'should set the request url on search object' do
+        allow_any_instance_of(RecordSearch).to receive(:valid?) { false }
+        allow(controller.request).to receive(:original_url).and_return('http://foo.com/blah')
+        expect(@search).to receive(:request_url=).with('http://foo.com/blah')
+        get :index, api_key: 'apikey', format: "json"
+      end
+
+      it 'should set the current_user on the search' do
+        allow_any_instance_of(RecordSearch).to receive(:valid?) { false }
+        expect(@search).to receive(:scope=).with(@user)
+        get :index, api_key: 'apikey', format: "json"
+      end
+
+      it 'renders a the solr error when the query is invalid' do
+        allow(RecordSearchSerializer).to receive(:new).and_raise(RSolr::Error::Http.new({}, {}))
+        allow(controller).to receive(:solr_error_message).and_return('Error')
+        get :index, api_key: 'apikey', format: 'json'
+        expect(response.body).to eq({errors: 'Error'}.to_json)
+      end
+
+      it "renders a error when the requested field doesn't exist" do
+        allow(RecordSearchSerializer).to receive(:new).and_raise(Sunspot::UnrecognizedFieldError.new('No field configured for Record with name "something"'))
+        get :index, api_key: 'apikey', format: 'json', and: {:something => true}
+        expect(response.body).to eq({:errors => 'No field configured for Record with name "something"'}.to_json)
+      end
+
+      it 'should return an error if the search request is invalid' do
+        allow(@search).to receive(:valid?) { false }
+        allow(@search).to receive(:errors) { ['The page parameter can not exceed 100,000'] }
+        get :index, api_key: 'apikey', page: 100001, format: 'json'
+        expect(response.body).to eq({errors: ['The page parameter can not exceed 100,000']}.to_json)
+      end
+    end
+
+    describe 'GET show' do
+      let(:developer_restriction) { double(:developer_restriction).as_null_object }
+
+      before(:each) do
+        @record = create(:record)
+        allow(controller).to receive(:current_user) { @user }
+        allow(RecordSchema).to receive(:roles) { {developer: developer_restriction} }
+      end
+
+      it 'should find the record and assign it' do
+        expect(Record).to receive(:custom_find).with('123', @user, {}).and_return(@record)
+        get :show, id: 123, search: {}, api_key: 'apikey', format: 'json'
+        expect(assigns(:record)).to eq(@record)
+      end
+
+      it 'renders a error when records is not found' do
+        allow(Record).to receive(:custom_find).and_raise(Mongoid::Errors::DocumentNotFound.new(Record, ['123'], ['123']))
+        get :show, id: 123, search: {}, api_key: 'apikey', format: 'json'
+        expect(response.body).to eq({:errors => 'Record with ID 123 was not found'}.to_json)
+      end
+
+      it 'merges the scope in the options' do
+        expect(Record).to receive(:custom_find).with('123', @user, {'and' => {'category' => 'Books'}}).and_return(@record)
+        get :show, id: 123, search: {and: {category: 'Books'}}, api_key: 'apikey', format: 'json'
+        expect(assigns(:record)).to eq(@record)
+      end
+    end
+
+    describe 'GET multiple' do
+      let(:developer_restriction) { double(:developer_restriction).as_null_object }
+
+      before(:each) do
+        @record = create(:record)
+        allow(controller).to receive(:current_user) { @user }
+        allow(RecordSchema).to receive(:roles) { {developer: developer_restriction} }
+      end
+
+      it 'should find multiple records and assign them' do
+        @records = [create(:record), create(:record)]
+        allow(Record).to receive(:find_multiple) { @records }
+        get :multiple, record_ids: [123, 124, 456], api_key: 'apikey', format: 'json'
+        expect(assigns(:records)).to eq(@records)
+      end
+    end
+
+    describe '#default_serializer_options' do
+      before(:each) do
+        @search = RecordSearch.new
+        allow(RecordSearch).to receive(:new) { @search }
+      end
+
+      it 'should return a hash with info for serialization' do
+        controller.default_serializer_options
+        expect(assigns(:search)).to eq(@search)
+      end
+
+      it 'should merge in the search fields' do
+        allow(@search).to receive(:field_list).and_return([:title, :description])
+        allow(@search).to receive(:group_list).and_return([:verbose])
+        expect(controller.default_serializer_options).to eq({fields: [:title, :description], groups: [:verbose]})
+      end
+    end
+
+    describe '#set_concept_param' do
+      it 'adds concept_id in the parameter' do
+        controller.params = { concept_id: 3 }
+        controller.send(:set_concept_param)
+        expect(controller.params[:and]).to eq({'concept_id' => 3})
+      end
+
+      it 'merges concept_id with existing "and" parameter' do
+        controller.params = { concept_id: 3, and: { category: 'Category A' } }
+        controller.send(:set_concept_param)
+        expect(controller.params[:and]).to eq({'concept_id' => 3, 'category' => 'Category A'})
+      end
+    end
+  end
+end

data/spec/controllers/supplejack_api/set_items_controller_spec.rb

@@ -0,0 +1,78 @@
+# 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 SetItemsController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    before {
+      @user = FactoryGirl.create(:user, authentication_token: "abc123")
+      allow(controller).to receive(:authenticate_user!) { true }
+      allow(controller).to receive(:current_user) { @user }
+      @user_set = FactoryGirl.create(:user_set_with_set_item)
+      @set_item = @user_set.set_items.first
+      allow(controller.current_user.user_sets).to receive(:custom_find) { @user_set }
+      allow(RecordSchema).to receive(:roles) { { developer: double(:developer) } }
+    }
+
+    describe "POST 'create'" do
+      it 'creates the set item through the @user_set' do
+        create(:record_with_fragment, record_id: 12345)
+        expect(@user_set.set_items).to receive(:build).with({'record_id' => '12345'}) { @set_item }
+        expect(@user_set).to receive(:save).and_return(true)
+        post :create, user_set_id: @user_set.id, record: { record_id: '12345' }, format: :json
+      end
+
+      context 'Set Interactions' do
+        before do
+          @user = FactoryGirl.create(:user, authentication_token: "abc123", role: 'admin')
+          allow(controller).to receive(:current_user) { @user }
+        end
+
+        it "creates a new Set Interaction model to log the interaction" do
+          create(:record_with_fragment, record_id: 12, display_collection: 'test')
+
+          post :create, user_set_id: @user_set.id, record: {record_id: 12}
+
+          expect(InteractionModels::Set.first).to be_present
+          expect(InteractionModels::Set.first.facet).to eq('test')
+        end
+      end
+    end
+    
+    describe "DELETE 'destroy'" do
+      before(:each) do
+        allow(@user_set.set_items).to receive(:find_by_record_id) { @set_item }
+      end
+
+      it 'finds the @set_item through the user_set' do
+        expect(@user_set.set_items).to receive(:find_by_record_id).with('12')
+        delete :destroy, user_set_id: @user_set.id, id: '12', format: :json
+      end
+
+      it 'destroys the @set_item' do
+        expect(@set_item).to receive(:destroy)
+        delete :destroy, user_set_id: @user_set.id, id: '12', format: :json
+      end
+
+      context 'it doesn\'t find the set_item' do
+        before(:each) do
+          allow(@user_set.set_items).to receive(:find_by_record_id) { nil }
+        end
+
+        it 'returns a 404' do
+          delete :destroy, user_set_id: @user_set.id, id: '12'
+          expect(response.code).to eq '404'
+          expect(response.body).to eq({errors: 'The record with id: 12 was not found.'}.to_json)
+        end
+      end
+    end
+
+  end
+end

data/spec/controllers/supplejack_api/sources_controller_spec.rb

@@ -0,0 +1,161 @@
+# 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 SourcesController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    let(:partner) { FactoryGirl.create(:partner) }
+
+    describe 'POST "create"' do
+      it 'creates a new source' do
+        expect(Source).to receive(:create).with('name' => 'Sample source', 'source_id' => '1234', "partner_id" => partner.id.to_s)
+        post :create, partner_id: partner, source: FactoryGirl.attributes_for(:source)
+        expect(response).to be_success
+      end
+
+      it 'returns the source' do
+        post :create, partner_id: partner, source: FactoryGirl.attributes_for(:source)
+        partner.reload
+        expect(response.body).to include Source.last.to_json
+      end
+
+      context "source all ready exists" do
+        it "updates the source" do
+          source = partner.sources.create(FactoryGirl.attributes_for(:source, name: "source_1"))
+          post :create, partner_id: partner, source: {_id: source.id, name: 'source2'}
+          source.reload
+          expect(source.name).to eq 'source2'
+        end
+      end
+    end
+
+    describe 'GET "show"' do
+      before(:each )do
+        Source.create(FactoryGirl.attributes_for(:source))
+      end
+
+      it 'assigns the source' do
+        get :show, id: Source.last
+        expect(assigns(:source)).to eq Source.last
+      end
+
+      it 'returns the source' do
+        get :show, id: Source.last
+        expect(response.body).to include Source.last.to_json
+      end
+    end
+
+    describe 'GET "index"' do
+      let(:sources) { [FactoryGirl.build(:source)] }
+
+      it 'assigns all sources' do
+        expect(Source).to receive(:all) { sources }
+        get :index
+        expect(assigns(:sources)).to eq sources
+      end
+
+      it 'returns all sources' do
+        expect(Source).to receive(:all) { sources }
+        get :index
+        expect(response.body).to include sources.to_json
+      end
+
+      context "search" do
+
+        let(:suppressed_source) { FactoryGirl.build(:source)  }
+
+        it "searches the sources if params source is defined" do
+          expect(Source).to receive(:where).with("status" => "suppressed") { [suppressed_source] }
+          get :index, source: { status: "suppressed" }
+        end
+      end
+    end
+
+    describe 'PUT "update"' do
+      let(:source) { FactoryGirl.create(:source) }
+
+      it 'finds and update source' do
+        put :update, id: source.id, source: {status: "suppressed"}
+        expect(assigns(:source).status).to eq 'suppressed'
+      end
+
+      it 'returns the source' do
+        put :update,id: source.id, source: {status: "suppressed"}
+        expect(response.body).to include 'suppressed'
+      end
+    end
+
+    describe 'GET "reindex"' do
+
+      before(:each) do
+        @source = Source.create(FactoryGirl.attributes_for(:source))
+      end
+
+      it "enqueues the job with the source_id and date if given" do
+        date = Time.now
+        expect(Resque).to receive(:enqueue).with(IndexSourceWorker, @source.source_id, date.to_s)
+        get :reindex, id: @source.id, date: date
+      end
+
+    end
+
+    describe 'GET "link_check_records"' do
+      let(:records) { [ double(:record, source_url: 'http://1'), 
+                        double(:record, source_url: 'http://2'), 
+                        double(:record, source_url: 'http://3'), 
+                        double(:record, source_url: 'http://4')] }
+
+      let(:source) { FactoryGirl.build(:source) }
+
+      before do
+        allow(controller).to receive(:first_two_records).with(anything,:oldest) {records[0..1]}
+        allow(controller).to receive(:first_two_records).with(anything,:latest) {records[2..3]}
+        allow(Source).to receive(:find) { source }
+      end
+
+      it "should asign the oldest two records by syndication_date" do
+        expect(controller).to receive(:first_two_records).with(source.source_id,:oldest) {records[0..1]}
+        get :link_check_records, id: source.id
+        expect(assigns(:records)).to include('http://1', 'http://2')
+      end
+
+      it "should asign the latest two records by syndication_date" do
+        expect(controller).to receive(:first_two_records).with(source.source_id,:latest) {records[2..3]}
+        get :link_check_records, id: source.id
+        expect(assigns(:records)).to include('http://3', 'http://4')
+      end
+    end
+
+    describe "#first_two_records" do
+      let(:asc_relation) {double(:asc_relation)} 
+      let(:sorted_relation) {double(:sorted_relation)} 
+
+      let(:records) { [ double(:record, source_url: 'http://1'), 
+                        double(:record, source_url: 'http://2'), 
+                        double(:record, source_url: 'http://3'), 
+                        double(:record, source_url: 'http://4')] }
+
+      before do
+        expect(Record).to receive(:where).with({"fragments.source_id" => "tapuhi", :status => 'active'}) { asc_relation }
+        expect(sorted_relation).to receive(:limit).with(2) { records[0..1] }
+      end
+
+      it "should get the oldest two records by syndication_date" do
+        expect(asc_relation).to receive(:sort).with("fragments.syndication_date" => 1) { sorted_relation }
+        expect(controller.send(:first_two_records, 'tapuhi', :oldest)).to eq (records[0..1])
+      end
+
+      it "should get the latest two records by syndication_date" do
+        expect(asc_relation).to receive(:sort).with("fragments.syndication_date" => -1) { sorted_relation }
+        expect(controller.send(:first_two_records, 'tapuhi', :latest)).to eq (records[0..1])
+      end
+    end
+  end
+end