supplejack_api 1

data/spec/serializers/supplejack_api/search_serializer_spec.rb

@@ -0,0 +1,90 @@
+# 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 SearchSerializer do
+  
+    def facet_row(value, count)
+      double(:facet_row, value: value, count: count)
+    end
+
+    def facet_objects
+      [
+        double(:facet, name: :full_name ,rows: [ 
+          facet_row('Nick Miller', 123), 
+          facet_row('Winston Bishop', 10) 
+        ]),
+        double(:facet, name: :coffee ,rows: [ 
+          facet_row('Dark', 3022), 
+          facet_row('Mid', 104),
+          facet_row('Light', 11)
+        ])
+      ]
+    end
+
+    before {
+      @facets = facet_objects
+      @search = double(:search, results: [], total: 10, per_page: 20, page: 1, facets: @facets, 
+        request_url: "http://foo.com/records", collation: 'whanganui').as_null_object 
+      
+      # Test using RecordSearchSerializer
+      @serializer = RecordSearchSerializer.new(@search)
+    }
+
+    describe '#json_facets' do
+      it 'returns a hash of facets' do
+        expect(@serializer.json_facets).to be_a(Hash)
+      end
+      
+      it 'should have two facets' do
+        expect(@serializer.json_facets.size).to eq(2)
+      end
+      
+      it 'returns facets with name as key' do
+        expect(@serializer.json_facets.keys).to include(:full_name, :coffee)
+      end
+      
+      it 'returns each facet as a hash' do
+        expect(@serializer.json_facets[:full_name]).to be_a(Hash)
+      end
+      
+      it 'returns facet-values and their counts' do
+        expect(@serializer.json_facets[:full_name]).to include('Nick Miller' => 123, 'Winston Bishop' => 10)
+      end
+    end
+
+    describe '#xml_facets' do
+      it 'returns a array of facets' do
+        expect(@serializer.xml_facets).to be_a(Array)
+      end
+      
+      it 'should have two facets' do
+        expect(@serializer.xml_facets.size).to eq(2)
+      end
+      
+      it 'includes the name of each facet' do
+        facet = @serializer.xml_facets.first
+        expect(facet[:name]).to eq 'full_name'
+      end
+      
+      it 'each facet should have a array of values with name and count' do
+        facet = @serializer.xml_facets.first
+        expect(facet[:values]).to eq [{ name: 'Nick Miller', count: 123 }, { name: 'Winston Bishop', count: 10 }]
+      end
+    end
+    
+    describe '#to_json' do
+      # it 'wraps everything in a jsonp function' do
+      #   allow(@search).to receive(:jsonp) { 'SupplejackApi.function' }
+      #   expect(@serializer.to_json).to match(/^SupplejackApi.function\(.*\)$/)
+      # end
+    end
+  end
+
+end

data/spec/serializers/supplejack_api/user_serializer_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 UserSerializer do
+    let(:user) { User.new(name: 'Fed', email: 'fed@boost.com', username: 'fede', authentication_token: '12345') }
+    let(:serializer) { UserSerializer.new(user) }
+  
+    it 'includes the basic user information' do
+      allow(user).to receive(:id) { 'abc1234567' }
+      expect(serializer.as_json).to eq({user: {id: 'abc1234567', name: 'Fed', email: 'fed@boost.com', username: 'fede', api_key: '12345'}})
+    end
+  
+  end
+
+end

data/spec/serializers/supplejack_api/user_set_serializer_spec.rb

@@ -0,0 +1,96 @@
+# 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
+  class FakeSet
+    ATTRIBUTES = [:id, :name, :description, :tags, :count, :privacy]
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+
+    def read_attribute_for_serialization(method)
+      @attributes[method]
+    end
+
+    def method_missing(method, *args, &block)
+      @attributes[method]
+    end
+  end
+
+  describe UserSetSerializer do
+    before :each do
+      @user_set = FactoryGirl.create(:user_set, name: "Dogs and cats", priority: 5)
+      @user_set.set_items.build(record_id: 1)
+      @user_set.save
+    end
+
+    context "with user's name" do
+      before :each do
+        allow(@user_set).to receive(:user) { double(:user, name: "John", api_key: "12345").as_null_object }
+      end
+
+      it "should include the user's name" do
+        serializer = UserSetSerializer.new(@user_set, user: true, items: false)
+        expect(serializer.as_json[:set]).to include({user: {name: "John"}})
+      end
+
+      it "includes the user api key when the user option is an admin" do
+        allow(RecordSchema).to receive(:roles) { { admin: double(:admin, admin: true) } }
+        admin = User.new(role: "admin")
+        serializer = UserSetSerializer.new(@user_set, user: admin, items: false)
+        expect(serializer.as_json[:set]).to include({user: {name: "John", api_key: "12345"}})
+      end
+    end
+
+    context "requesting a single item" do
+      it "should only fetch 1 record" do
+        serializer = UserSetSerializer.new(@user_set, featured: true, items: false)
+        expect(@user_set).to receive(:items_with_records).with(1) { [] }
+        serializer.as_json
+      end
+    end
+
+    context "not requesting set items" do
+      it "only returns the name, id, count and priority" do
+        serializer = UserSetSerializer.new(@user_set, items: false)
+        expect(serializer.as_json[:set]).to include({id: @user_set.id, name: "Dogs and cats", count: 0, priority: 5})
+      end
+
+      it "includes the set items without extra info" do
+        serializer = UserSetSerializer.new(@user_set, items: false)
+        expect(serializer.as_json[:set]).to include({records: [{record_id: 1, position: 1}]})
+      end
+    end
+
+    context "requesting set items" do
+      before(:each) do
+        @user_set = FakeSet.new(id: "1", name: "Dogs and cats", description: "Ugly dogs and cats", tags: ["dog"], count:1, privacy:"hidden", featured: true, approved: true)
+        allow(@user_set).to receive(:items_with_records){[double(:item, record_id: 5, position: 1, name: "John Smith", address: "Wellington").as_null_object]}
+        allow(@user_set).to receive(:user) { double(:user, name: "Tony").as_null_object }
+      end
+
+      let(:serializer) { UserSetSerializer.new(@user_set) }
+
+      it "returns the full set information" do
+        expect(serializer.as_json[:set]).to include({id: "1", name: "Dogs and cats", description: "Ugly dogs and cats", tags: ["dog"], count: 1, privacy: "hidden", featured: true, approved: true })
+      end
+
+      it "returns the set items with the records information" do
+        expect(serializer.as_json[:set][:records]).to eq [{record_id: 5, position: 1, name: "John Smith", address: "Wellington"}]
+      end
+
+      it "returns the user information" do
+        serializer = UserSetSerializer.new(@user_set, user: true)
+        expect(serializer.as_json[:set][:user]).to eq({name: "Tony"})
+      end
+    end
+
+  end
+
+end

data/spec/services/metrics_api/v3/api_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module MetricsApi
+  module V3
+    describe Api do
+      let!(:daily_item_metric){create(:daily_item_metric)}
+      let(:api) do
+        Api.new({
+          start_date: @start_date, 
+          end_date: @end_date, 
+          metrics: "usage,display_collection"
+        })
+      end
+
+      before do
+        @start_date = Date.current
+        @end_date = Date.current
+
+        5.times.map{create(:usage_metrics)}
+      end
+    end
+  end
+end

data/spec/services/metrics_api/v3/endpoints/facets_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module MetricsApi
+  module V3
+    module Endpoints
+      describe Facets, search: true, slow: true do
+        let(:facet) {Facets.new(nil)}
+
+        before do
+          Sunspot.session = Sunspot.session.original_session
+        end
+
+        describe "#call" do
+          it 'returns a list of all facets' do
+            create(:record_with_fragment, display_collection: 'dc1')
+            create(:record_with_fragment, display_collection: 'dc2')
+            Sunspot.commit
+
+            expect(facet.call).to eq(['dc1', 'dc2'])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/services/metrics_api/v3/endpoints/global_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module MetricsApi
+  module V3
+    module Endpoints
+      describe Global do
+        let(:global) {Global.new({})}
+
+        describe "#call" do
+          it "returns an array of hashes representing the DailyMetrics for the supplied date range" do
+            create(:daily_metrics, date: Date.today, total_public_sets: 10)
+
+            expect(global.call).to eq([{
+              day: Date.today,
+              total_public_sets: 10
+            }])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/services/metrics_api/v3/endpoints/root_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module MetricsApi
+  module V3
+    module Endpoints
+      describe Root do
+        let(:extended) do
+          Root.new({
+            facets: @facets,
+            start_date: @start_date,
+            end_date: @end_date,
+            metrics: @metrics
+          })
+        end
+
+        before do
+          @facets = 'dc1,dc2'
+          @start_date = Date.current.strftime
+          @end_date = Date.current.strftime
+          @metrics = 'view,record'
+
+          create(:faceted_metrics, name: 'dc1')
+          create(:faceted_metrics, name: 'dc2')
+          create(:usage_metrics, record_field_value: 'dc1', created_at: Date.current.midday)
+          create(:usage_metrics, record_field_value: 'dc2', created_at: Date.current.midday)
+        end
+
+        describe "#call" do
+          it 'retrieves a range of metrics' do
+            result = extended.call
+
+            expect(result.first[:date]).to eq(Date.current)
+            expect(result.first["record"].length).to eq(2)
+            expect(result.first["view"].length).to eq(2)
+          end
+
+          it 'filters metrics based on the facets argument' do
+            @facets = 'dc1'
+            result = extended.call
+
+            expect(result.first[:date]).to eq(Date.current)
+            expect(result.first["record"].length).to eq(1)
+            expect(result.first["view"].length).to eq(1)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/services/metrics_api/v3/presenters/extended_metadata_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module MetricsApi
+  module V3
+    module Presenters
+      describe ExtendedMetadata do
+        let(:presenter){ExtendedMetadata.new(@models, Date.yesterday, Date.current)}
+
+        before do
+          @models = [
+            {
+              metric: 'view',
+              models: {
+                Date.current => [
+                  create(:usage_metrics),
+                  create(:usage_metrics)
+                ],
+                Date.yesterday => [
+                  create(:usage_metrics, created_at: Date.yesterday.midday)
+                ]
+              }
+            },
+            {
+              metric: 'record',
+              models: {
+                Date.current => [
+                  create(:faceted_metrics),
+                ],
+                Date.yesterday => [
+                  create(:faceted_metrics, date: Date.yesterday)
+                ]
+              }
+            }
+          ]
+        end
+
+        it 'presents them' do
+          json = presenter.to_json
+
+          expect(json.length).to eq(2)
+          expect(json.first[:date]).to eq(Date.yesterday)
+          expect(json.last[:date]).to eq(Date.current)
+          expect(json.first['record'].length).to eq(1)
+          expect(json.first['view'].length).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+# 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
+
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+require 'rails/application'
+require 'rails/mongoid'
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'timecop'
+require 'sunspot_matchers'
+require 'mongoid-rspec'
+require 'simplecov'
+require 'rspec/active_model/mocks'
+require 'sunspot_test/rspec'
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+# SimpleCov.start
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.infer_spec_type_from_file_location!
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+  # Ignore focus on CI
+  config.filter_run focus: true unless ENV['CI']
+  config.run_all_when_everything_filtered = true
+
+  require 'database_cleaner'
+  config.before(:suite) do
+    DatabaseCleaner[:mongoid].strategy = :truncation
+  end
+
+  config.before(:each) do
+    # We have added this as database cleaner appears to not be working for mongo
+    SupplejackApi::Record.destroy_all
+    SupplejackApi::Concept.destroy_all
+    DatabaseCleaner.clean
+    Sunspot.session = Sunspot::Rails::StubSessionProxy.new(Sunspot.session)
+    Timecop.return
+
+    %w(record concept).each do |model|
+      klass = "#{model.capitalize}Schema".constantize
+
+      allow(klass).to receive(:default_role) { double(:role, name: :developer) }
+      allow(klass).to receive_message_chain(:roles, :keys) { [:developer] }
+    end
+  end
+
+  config.include SunspotMatchers
+  config.include Mongoid::Matchers
+  config.include FactoryGirl::Syntax::Methods
+end