supplejack_api 1

data/spec/controllers/supplejack_api/application_controller_spec.rb

@@ -0,0 +1,133 @@
+# 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 ApplicationController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    before(:each) do
+      @controller = ApplicationController.new
+      allow(@controller).to receive(:render) { nil }
+      allow(RecordSchema).to receive(:roles) { { admin: double(:admin, admin: true) } }
+    end
+
+    describe '#authenticate_user!' do
+      before(:each) do
+        allow(@controller).to receive(:params) { { api_key: '12345' } }
+        allow(@controller).to receive(:request) { double(:request, ip: '1.1.1.1', format: :json) }
+        @user = FactoryGirl.create(:user)
+        allow(@user).to receive(:update_daily_activity) { nil }
+        allow(@controller).to receive(:current_user) { @user }
+      end
+
+      it 'should set the current_user' do
+        @controller.authenticate_user!
+        expect(@controller.current_user).to eq @user
+      end
+
+      it 'updates the tracked fields for the user' do
+        expect(@user).to receive(:update_tracked_fields)
+        @controller.authenticate_user!
+      end
+
+      it 'updates the daily activity for the user' do
+        expect(@user).to receive(:update_daily_activity)
+        @controller.authenticate_user!
+      end
+
+      it 'verifies the user limits' do
+        expect(@user).to receive(:check_daily_requests)
+        @controller.authenticate_user!
+      end
+
+      it 'saves the user' do
+        expect(@user).to receive(:save)
+        @controller.authenticate_user!
+      end
+
+      context 'user over daily requests limit' do
+        it 'returns a error message' do
+          allow(@user).to receive(:over_limit?) { true }
+          expect(@controller).to receive(:render).with({ json: { errors: 'You have reached your maximum number of api requests today' }, status: :forbidden })
+          @controller.authenticate_user!
+        end
+      end
+
+      context 'api_key not found' do
+        it 'returns a error message' do
+          allow(@controller).to receive(:current_user) {  nil }
+          expect(@controller).to receive(:render).with({ json: { errors: 'Invalid API Key' }, status: :forbidden})
+          @controller.authenticate_user!
+        end
+      end
+
+      context 'api key not provided' do
+        it 'returns a error message' do
+          allow(@controller).to receive(:params) {  { api_key: ''} }
+          expect(@controller).to receive(:render).with({ json: { errors: 'Please provide a API Key' }, status: :forbidden })
+          @controller.authenticate_user!
+        end
+      end
+
+      context 'wrong format' do
+        it 'returns a error message in the default format' do
+          allow(@controller).to receive(:params) { {} }
+          allow(@controller).to receive(:request) { double(:request, format: :css).as_null_object }
+          expect(@controller).to receive(:render).with({ json: { errors: 'Please provide a API Key' }, status: :forbidden })
+          @controller.authenticate_user!
+        end
+      end
+    end
+
+    describe "#authenticate_admin!" do
+      before {
+        allow(@controller).to receive(:request) { double(:request, :ip => "1.1.1.1", :format => :json)}
+      }
+
+      it "returns true when the admin authentication was successful" do
+        allow(@controller).to receive(:current_user) { double(:user, admin?: true, role: 'admin') }
+        expect(@controller.authenticate_admin!).to be_truthy
+      end
+
+      it "returns false when the admin authentication was not successful" do
+        allow(@controller).to receive(:current_user) { double(:user, admin?: false, role: 'developer') }
+        expect(@controller.authenticate_admin!).to be_falsey
+      end
+    end
+
+    describe "#find_user_set" do
+      context "current_user is a admin" do
+        before :each do
+          @user_set = double(:set).as_null_object
+          allow(@controller).to receive(:current_user) { double(:user, admin?: true, role: 'admin').as_null_object }
+          allow(@controller).to receive(:params) { {:id => "12345"} }
+        end
+
+        it "finds the set even if it's not owned by the current_user" do
+          expect(UserSet).to receive(:custom_find).with("12345") { @user_set }
+          @controller.find_user_set
+        end
+      end
+
+      # TODO: Move this to the app
+      # context "current_user has dnz role" do
+      #   before :each do
+      #     @user_set = double(:set).as_null_object
+      #     allow(@controller).to receive(:current_user) { double(:user, dnz?: true).as_null_object }
+      #     allow(@controller).to receive(:params) { {:id => "12345"} }
+      #   end
+
+      #   it "finds the set even if it's not owned by the current_user" do
+      #     expect(UserSet).to receive(:custom_find).with("12345") { @user_set }
+      #     @controller.find_user_set
+      #   end
+      # end
+    end
+  end
+end

data/spec/controllers/supplejack_api/concepts_controller_spec.rb

@@ -0,0 +1,83 @@
+# 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 ConceptsController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    before { @user = FactoryGirl.create(:user, authentication_token: 'apikey', role: 'developer') }
+
+    describe 'GET show' do
+      before {
+        @concept = FactoryGirl.create(:concept)
+        allow(controller).to receive(:current_user) { @user }
+      }
+
+      it 'should find the concept and assign it' do
+        expect(Concept).to receive(:custom_find).with('123', @user, {}).and_return(@concept)
+        get :show, id: 123, search: {}, api_key: 'abc123', format: "json"
+        expect(assigns(:concept)).to eq(@concept)
+      end
+
+      it 'renders a error when records is not found' do
+        allow(Concept).to receive(:custom_find).and_raise(Mongoid::Errors::DocumentNotFound.new(Concept, ['123'], ['123']))
+        get :show, id: 123, search: {}, api_key: 'abc123', :format => 'json'
+        expect(response.body).to eq({:errors => 'Concept with ID 123 was not found'}.to_json)
+      end
+    end
+
+    # describe 'GET index' do
+    #   before {
+    #     @search = ConceptSearch.new
+    #     allow(@search).to receive(:valid?) { false }
+    #     allow(@search).to receive(:new) { @search }
+    #   }
+
+    #   it 'initializes a new search instance' do
+    #     expect(ConceptSearch).to receive(:new).with(hash_including(text: 'dogs')).and_return(@search)
+    #     get :index, api_key: 'apikey', text: 'dogs'
+    #     expect(assigns(:search)).to eq(@search)
+    #   end
+
+    #   it 'sets the request url on search object' do
+    #     allow_any_instance_of(ConceptSearch).to receive(:valid?) { false }
+    #     allow(controller.request).to receive(:original_url).and_return('http://foo.com/blah')
+    #     get :index, api_key: 'apikey', format: "json"
+    #     expect(assigns(:search).request_url).to eq 'http://foo.com/blah'
+    #   end
+
+    #   it 'should set the current_user on the search' do
+    #     allow_any_instance_of(ConceptSearch).to receive(:valid?) { false }
+    #     get :index, api_key: 'apikey', format: "json"
+    #     expect(assigns(:search).scope).to eq @user
+    #   end
+
+    #   it 'renders a the solr error when the query is invalid' do
+    #     allow(ConceptSearchSerializer).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(ConceptSearchSerializer).to receive(:new).and_raise(Sunspot::UnrecognizedFieldError.new('No field configured for Concept with name "something"'))
+    #     get :index, api_key: 'apikey', format: 'json', and: { something: true }
+    #     expect(response.body).to eq({ errors: 'No field configured for Concept with name "something"' }.to_json)
+    #   end
+
+    #   it 'should return an error if the search request is invalid' do
+    #     allow_any_instance_of(ConceptSearch).to receive(:valid?) { false }
+    #     allow_any_instance_of(ConceptSearch).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
+
+  end
+end

data/spec/controllers/supplejack_api/concerns/records_controller_metrics_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe ApplicationController, type: :controller do
+
+class DummySearch < BasicObject
+  def initialize(results)
+    @results = results
+  end
+
+  def results
+    @results
+  end
+
+  def valid?
+    true
+  end
+end
+
+controller do
+  include SupplejackApi::Concerns::RecordsControllerMetrics
+
+  def index
+    @search = DummySearch.new(SupplejackApi::Record.all.to_a)
+    render nothing: true
+  end
+
+  def show
+    @record = SupplejackApi::Record.first
+    render nothing: true
+  end
+end
+
+  before do
+    create(:record_with_fragment)
+  end
+
+  describe 'GET#index' do
+    it 'creates an interation model when ignore_metrics is not set' do
+      get :index
+      expect(SupplejackApi::InteractionModels::Record.first.request_type).to eq "search"
+    end
+
+    it 'does not create an interaction model when ignore_metrics :true' do
+      get :index, ignore_metrics: true
+      expect(SupplejackApi::InteractionModels::Record.count).to eq 0
+    end
+  end
+
+  describe 'GET#show' do
+    it 'creates an interaction model when ignore_metrics is not set' do
+      get :show, id: 1
+      expect(SupplejackApi::InteractionModels::Record.first.request_type).to eq "get"
+    end
+
+    it 'does not create an interaction model when ignore_metrics :true' do
+      get :show, id: 1, ignore_metrics: true
+      expect(SupplejackApi::InteractionModels::Record.count).to eq 0
+    end
+  end
+end

data/spec/controllers/supplejack_api/harvester/concepts_controller_spec.rb

@@ -0,0 +1,57 @@
+# 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 Harvester::ConceptsController, type: :controller do
+    # routes { SupplejackApi::Engine.routes }
+
+    # let(:concept) { FactoryGirl.build(:concept) }
+
+    # describe "POST create" do
+    #   before(:each) do
+    #     allow(Concept).to receive(:find_or_initialize_by_identifier) { concept }
+    #   end
+
+    #   context "preview is false" do
+    #     it "finds or initializes a concept by identifier" do
+    #       expect(Concept).to receive(:find_or_initialize_by_identifier).with("internal_identifier" => "1234") { concept }
+    #       post :create, concept: {internal_identifier: "1234"}
+    #       expect(assigns(:concept)).to eq concept
+    #     end
+    #   end
+
+    #   context "preview is true" do
+    #     it "finds or initializes a preview record by identifier" do
+    #       expect(PreviewRecord).to receive(:find_or_initialize_by_identifier).with("internal_identifier" => "1234") { concept }
+    #       post :create, concept: {internal_identifier: "1234"}, preview: true
+    #       expect(assigns(:concept)).to eq concept
+    #     end
+    #   end
+    # end
+
+    # describe "PUT update" do
+    #   let(:concept) { double(:concept).as_null_object }
+
+    #   before do
+    #     allow(Concept).to receive(:custom_find) { concept }
+    #   end
+
+    #   it 'finds the record and assigns it' do
+    #     expect(Concept).to receive(:custom_find).with('123', nil, {status: :all}) { concept }
+    #     put :update, id: 123, concept: { status: 'supressed' }, format: :json
+    #     expect(assigns(:concept)).to eq(concept)
+    #   end
+
+    #   it "updates the status of the record" do
+    #     expect(concept).to receive(:update_attribute).with(:status, 'supressed')
+    #     put :update, id: 123, concept: { status: 'supressed' }, format: :json
+    #   end
+    # end
+  end
+end

data/spec/controllers/supplejack_api/harvester/records_controller_spec.rb

@@ -0,0 +1,138 @@
+# 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 Harvester::RecordsController, type: :controller do
+    routes { SupplejackApi::Engine.routes }
+
+    let(:record) { FactoryGirl.build(:record) }
+
+    describe "POST create" do
+      before(:each) do
+        allow(Record).to receive(:find_or_initialize_by_identifier) { record }
+      end
+
+      context "preview is false" do
+        it "finds or initializes a record by identifier" do
+          expect(Record).to receive(:find_or_initialize_by_identifier).with("internal_identifier" => "1234") { record }
+          post :create, record: {internal_identifier: "1234"}
+          expect(assigns(:record)).to eq record
+        end
+      end
+
+      context "preview is true" do
+        it "finds or initializes a preview record by identifier" do
+          expect(PreviewRecord).to receive(:find_or_initialize_by_identifier).with("internal_identifier" => "1234") { record }
+          post :create, record: {internal_identifier: "1234"}, preview: true
+          expect(assigns(:record)).to eq record
+        end
+      end
+
+      context "record has a priority other then 0" do
+        it "creates or updates the fragment" do
+          rec = {
+            "internal_identifier" => "1234",
+            "title" => "Hi",
+            "priority" => "10"
+          }
+          expect(record).to receive(:create_or_update_fragment).with(rec)
+          post :create, record: rec
+        end
+      end
+
+      it "sets the status based on the required fragments" do
+        expect(record).to receive(:set_status).with(['ndha_rights'])
+        post :create, record: {"internal_identifier" => "1234"}, required_fragments: ['ndha_rights']
+      end
+
+      it "saves the record" do
+        expect(record).to receive(:save)
+        post :create, record: {"internal_identifier" => "1234"}
+      end
+
+      it "unsets null fields" do
+        expect(record).to receive(:unset_null_fields)
+        post :create, record: {"internal_identifier" => "1234"}
+      end
+    end
+
+    describe "PUT delete" do
+      it "should find the record by internal_identifier" do
+        expect(Record).to receive(:where).with({internal_identifier: "abc123"}) { [record] }
+        put :delete, id: "abc123"
+        expect(assigns(:record)).to eq record
+      end
+
+      it "should update the records status attribute to deleted" do
+        allow(Record).to receive(:where) { [record] }
+        expect(record).to receive(:update_attribute).with(:status, "deleted")
+        put :delete, id: "abc123"
+      end
+
+      it "handles a nil record" do
+        allow(Record).to receive(:where) { [] }
+        expect { put :delete, id: "abc123" }.to_not raise_exception
+      end
+    end
+
+    describe "DELETE flush" do
+      before do
+        allow(Record).to receive(:flush_old_records)
+      end
+
+      it "calls flush_old_records" do
+        expect(Resque).to receive(:enqueue).with(FlushOldRecordsWorker, 'tapuhi', 'abc123')
+        delete :flush, source_id: 'tapuhi', job_id: 'abc123'
+      end
+
+      it "returns a 204" do
+        delete :flush, source_id: 'tapuhi', job_id: 'abc123'
+        expect(response.code).to eq '204'
+      end
+    end
+
+    describe 'GET #show' do
+      it 'should find the record by internal_identifier' do
+        expect(Record).to receive(:where).with({ record_id: 'abc123' }) { [record] }
+        get :show, id: 'abc123'
+      end
+
+      it 'should assign the record to @record' do
+        allow(Record).to receive(:where) { [record] }
+        get :show, id: 'abc123'
+        expect(assigns(:record)).to eq record
+      end
+
+      it 'should handle a nil record' do
+        allow(Record).to receive(:where) { [] }
+        expect { get :show, id: 'abc123' }.to_not raise_exception
+      end
+    end
+
+    describe "PUT update" do
+      let(:record) { double(:record).as_null_object }
+
+      before do
+        allow(controller).to receive(:authenticate_user!) { true }
+        allow(Record).to receive(:custom_find) { record }
+      end
+
+      it 'finds the record and asigns it' do
+        expect(Record).to receive(:custom_find).with('123', nil, {status: :all}) { record }
+        put :update, id: 123, record: { status: 'supressed' }, format: :json
+        expect(assigns(:record)).to eq(record)
+      end
+
+      it "updates the status of the record" do
+        expect(record).to receive(:update_attribute).with(:status, 'supressed')
+        put :update, id: 123, record: { status: 'supressed' }, format: :json
+      end
+    end
+  end
+end