supplejack_client 1.0.1

data/spec/supplejack/facet_spec.rb

@@ -0,0 +1,44 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client 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 Supplejack
+  describe Facet do
+    
+    it 'initializes the facet with a name' do
+      facet = Supplejack::Facet.new('description', {})
+      facet.name.should eq('description')
+    end
+    
+    it 'initializes the facet with values' do
+      facet = Supplejack::Facet.new('location', {'Wellington' => 100, 'Auckland' => 10})
+      facet.values.should eq({'Wellington' => 100, 'Auckland' => 10})
+    end
+
+    context 'sorting' do
+      let(:facet) { Supplejack::Facet.new('location', {'Wellington' => 100, 'Auckland' => 10, 'Dunedin' => 5, 'Queenstown' => 30}) }
+
+      it 'sorts by alphabetical order set in config' do
+        Supplejack.stub(:facets_sort) { :index }
+        facet.values.keys.should eq ['Auckland', 'Dunedin', 'Queenstown', 'Wellington']
+        facet.values.values.should eq [10, 5, 30, 100]
+      end
+
+      it 'sorts by count set in the config' do
+        Supplejack.stub(:facets_sort) { :count }
+        facet.values.keys.should eq ['Wellington', 'Queenstown', 'Auckland', 'Dunedin']
+        facet.values.values.should eq [100, 30, 10, 5]
+      end
+
+      it 'overrides the global facets sort' do
+        Supplejack.stub(:facets_sort) { :count }
+        facet.values(:index).keys.should eq ['Auckland', 'Dunedin', 'Queenstown', 'Wellington']
+      end
+    end
+  end
+end

data/spec/supplejack/item_relation_spec.rb

@@ -0,0 +1,111 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client 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 Supplejack
+  describe ItemRelation do
+    let(:supplejack_set) { Supplejack::UserSet.new(id: '1234567890', records: [{record_id: 1, position: 1}]) }
+    let(:relation) { Supplejack::ItemRelation.new(supplejack_set) }
+  
+    describe '#initialize' do
+      it 'assigns the user_set object as @user_set' do
+        Supplejack::ItemRelation.new(supplejack_set).user_set.should eq supplejack_set
+      end
+
+      it 'initializes an array of Supplejack::Items' do
+        Supplejack::ItemRelation.new(supplejack_set).items.should be_a Array
+      end
+
+      it 'returns an empty array of items when the user_set attributes records are nil' do
+        supplejack_set.stub(:attributes) { {} }
+        Supplejack::ItemRelation.new(supplejack_set).items.should be_empty
+      end
+
+      it 'adds the user_set_id to the Supplejack::Item object' do
+        Supplejack::ItemRelation.new(supplejack_set).items.first.user_set_id.should eq '1234567890'
+      end
+
+      it 'adds the api_key in the user_set to the Supplejack::Item' do
+        supplejack_set.api_key = 'abc123'
+        Supplejack::ItemRelation.new(supplejack_set).items.first.api_key.should eq 'abc123'
+      end
+    end
+
+    describe '#all' do
+      it 'returns the array of @items' do
+        supplejack_set.items.all.should be_a Array
+      end
+    end
+
+    describe '#find' do
+      it 'returns finds the item by record_id' do
+        item = relation.find(1)
+        item.should be_a Supplejack::Item
+        item.record_id.should eq 1
+      end
+
+      it 'finds the item by a string record_id' do
+        item = relation.find('1')
+        item.should be_a Supplejack::Item
+        item.record_id.should eq 1
+      end
+    end
+
+    describe '#build' do
+      it 'initializes a new item object with the user_set_id' do
+        item = relation.build
+        item.user_set_id.should eq '1234567890'
+      end
+
+      it 'accepts a hash of attributes' do
+        item = relation.build(record_id: 2, position: 9)
+        item.record_id.should eq 2
+        item.position.should eq 9
+      end
+
+      it 'adds the user_set api_key' do
+        relation.stub(:user_set) { double(:user_set, api_key: '1234').as_null_object }
+        item = relation.build
+        item.api_key.should eq '1234'
+      end
+    end
+
+    describe '#create' do
+      let(:item) { double(:item).as_null_object }
+
+      it 'builds and saves the item' do
+        relation.should_receive(:build) { item }
+        item.should_receive(:save)
+        relation.create
+      end
+
+      it 'passes the parameters along to the build method' do
+        relation.should_receive(:build).with(record_id: 8, position: 3) { item }
+        relation.create(record_id: 8, position: 3)
+      end
+    end
+
+    context 'items array behaviour' do
+      it 'executes array methods on the @items array' do
+        relation = Supplejack::ItemRelation.new(supplejack_set)
+        items = relation.instance_variable_get('@items')
+        items.should_receive(:size)
+        relation.size
+      end
+
+      it 'should be able to iterate through the items relation' do
+        relation = Supplejack::ItemRelation.new(supplejack_set)
+        relation.each do |item|
+          item.should be_a Supplejack::Item
+        end
+        relation.size.should eq 1
+      end
+    end
+  end
+end
+

data/spec/supplejack/item_spec.rb

@@ -0,0 +1,115 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client 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 Supplejack
+	describe Item do
+
+    describe '#initialize' do
+      it 'accepts a hash of attributes' do
+        Supplejack::Item.new({record_id: '123', name: 'Dog'})
+      end
+
+      it 'accepts a hash with string keys' do
+        Supplejack::Item.new({'record_id' => '123'}).record_id.should eq '123'
+      end
+
+      it 'handles nil attributes' do
+        Supplejack::Item.new(nil).record_id.should be_nil
+      end
+
+      [:record_id].each do |attribute|
+        it 'should initialize the attribute #{attribute}' do
+          Supplejack::Item.new({attribute => 'value'}).send(attribute).should eq 'value'
+        end
+      end
+    end
+
+    describe '#attributes' do
+      it 'should not include the api_key' do
+        Supplejack::Item.new({api_key: '1234'}).attributes.should_not have_key(:api_key)
+      end
+
+      it 'should not include the user_set_id' do
+        Supplejack::Item.new({user_set_id: '1234'}).attributes.should_not have_key(:user_set_id)
+      end
+    end
+
+    describe '#save' do
+      let(:item) { Supplejack::Item.new(record_id: 1, title: 'Dogs', user_set_id: '1234', api_key: 'abc') }
+
+      it 'triggers a post request to create a set_item with the set api_key' do
+        item.should_receive(:post).with('/sets/1234/records', {api_key: 'abc'}, {record: {record_id: 1}})
+        item.save.should be_true
+      end
+
+      it 'sends the position when set' do
+        item.should_receive(:post).with('/sets/1234/records', {api_key: 'abc'}, {record: {record_id: 1, position: 3}})
+        item.position = 3
+        item.save.should be_true
+      end
+
+      context 'HTTP error is raised' do
+        before :each do
+          item.stub(:post).and_raise(RestClient::Forbidden.new)
+        end
+
+        it 'returns false when a HTTP error is raised' do
+          item.save.should be_false
+        end
+
+        it 'stores the error when a error is raised' do
+          item.save
+          item.errors.should eq 'Forbidden: '
+        end
+      end
+    end
+
+    describe '#destroy' do
+      let(:item) { Supplejack::Item.new(user_set_id: '1234', api_key: 'abc', record_id: 5) }
+
+      it 'triggers a delete request with the user_set api_key' do
+        item.should_receive(:delete).with('/sets/1234/records/5', {api_key: 'abc'})
+        item.destroy
+      end
+
+      context 'HTTP error is raised' do
+        before :each do
+          item.stub(:delete).and_raise(RestClient::Forbidden.new)
+        end
+
+        it 'returns false when a HTTP error is raised' do
+          item.destroy.should be_false
+        end
+
+        it 'stores the error when a error is raised' do
+          item.destroy
+          item.errors.should eq 'Forbidden: '
+        end
+      end
+    end
+
+    describe '#date' do
+      it 'returns a Time object' do
+        item = Supplejack::Item.new(date: ['1977-01-01T00:00:00.000Z'])
+        item.date.should eq Time.parse('1977-01-01T00:00:00.000Z')
+      end
+
+      it 'returns nil when the date is not in the correct format' do
+        item = Supplejack::Item.new(date: ['afsdfgsdfg'])
+        item.date.should be_nil
+      end
+    end
+
+    describe '#method_missing' do
+      it 'returns nil for any unknown attribute' do
+        Supplejack::Item.new.non_existent_method.should be_nil
+      end
+    end
+  end
+end

data/spec/supplejack/log_subscriber_spec.rb

@@ -0,0 +1,40 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client 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 Supplejack
+  describe LogSubscriber do
+    
+    it 'returns nil when logging not enabled' do
+      Supplejack.stub(:enable_logging) { false }
+      Supplejack::LogSubscriber.new.log_request(1, {}).should be_nil
+    end
+    
+    describe '#api_environment' do
+      it 'returns Prod' do
+        Supplejack.stub(:api_url) { 'http://api.digitalnz.org' }
+        Supplejack::LogSubscriber.new.api_environment.should eq 'Prod'
+      end
+      
+      it 'returns Staging' do
+        Supplejack.stub(:api_url) { 'http://hippo.uat.digitalnz.org:8001' }
+        Supplejack::LogSubscriber.new.api_environment.should eq 'Staging'
+      end
+      
+      it 'returns Staging' do
+        Supplejack.stub(:api_url) { 'http://api.uat.digitalnz.org' }
+        Supplejack::LogSubscriber.new.api_environment.should eq 'Staging'
+      end
+      
+      it 'returns Dev' do
+        Supplejack.stub(:api_url) { 'http://localhost:3000' }
+        Supplejack::LogSubscriber.new.api_environment.should eq 'Dev'
+      end
+    end
+  end
+end

data/spec/supplejack/paginated_collection_spec.rb

@@ -0,0 +1,43 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client 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'
+
+describe 'PaginatedCollection' do
+  subject { Supplejack::PaginatedCollection.new [], 1, 10, 20 }
+
+  it { subject.should be_an(Array) }
+
+  context 'behaves like a WillPaginate::Collection' do
+    it { subject.total_entries.should eql(20) }
+    it { subject.total_pages.should eql(2) }
+    it { subject.current_page.should eql(1) }
+    it { subject.per_page.should eql(10) }
+    it { subject.previous_page.should be_nil }
+    it { subject.next_page.should eql(2) }
+    it { subject.out_of_bounds?.should_not be_true }
+    it { subject.offset.should eql(0) }
+
+    it 'should allow setting total_count' do
+      subject.total_count = 1
+      subject.total_count.should eql(1)
+    end
+
+    it 'should allow setting total_entries' do
+      subject.total_entries = 1
+      subject.total_entries.should eql(1)
+    end
+  end
+
+  context 'behaves like Kaminari' do
+    it { subject.total_count.should eql(20) }
+    it { subject.num_pages.should eql(2) }
+    it { subject.limit_value.should eql(10) }
+    it { subject.first_page?.should be_true }
+    it { subject.last_page?.should_not be_true }
+  end
+end

data/spec/supplejack/record_spec.rb

@@ -0,0 +1,255 @@
+# The Supplejack Client code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# See https://github.com/DigitalNZ/supplejack_client 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'
+
+class SupplejackRecord
+  include Supplejack::Record
+end
+
+class Search < Supplejack::Search
+  def initialize(params={})
+    super
+    self.or = {:type => ['Person']}
+  end
+end
+
+class SpecialSearch < Supplejack::Search
+  def initialize(params={})
+    super(params)
+    if self.api_params && self.api_params[:and]
+      self.api_params[:and].delete(:format)
+    end
+  end
+end
+
+module Supplejack
+  describe Record do
+    it 'initializes its attributes from a JSON string' do
+      record = SupplejackRecord.new(%{{"type": "Person", "location": "NZ"}})
+      record.attributes.should eq({:type => 'Person', :location => 'NZ'})
+    end
+
+    it 'handles nil params' do
+      record = SupplejackRecord.new(nil)
+      record.attributes.should eq({})
+    end
+    
+    it 'handles a string as params' do
+      record = SupplejackRecord.new('')
+      record.attributes.should eq({})
+    end
+    
+    it 'handles a array as params' do
+      record = SupplejackRecord.new([])
+      record.attributes.should eq({})
+    end
+
+    it 'raises a NoMethodError for every method call that doesn\'t have a key in the attributes' do
+      record = SupplejackRecord.new
+      expect { record.something }.to raise_error(NoMethodError)
+    end
+
+    it 'should return the value when is present in the attributes' do
+      record = SupplejackRecord.new(:weird_method => 'Something')
+      record.weird_method.should eq 'Something'
+    end
+
+    describe 'id' do
+      it 'returns the record_id' do
+        record = SupplejackRecord.new({'record_id' => '95'})
+        record.id.should eq 95
+      end
+
+      it 'returns the id' do
+        record = SupplejackRecord.new({'id' => '96'})
+        record.id.should eq 96
+      end
+    end
+
+    describe '#title' do
+      it 'returns the title attribute value' do
+        SupplejackRecord.new(title: 'Dogs').title.should eq 'Dogs'
+      end
+
+      it 'returns "Untitled" for records without a title' do
+        SupplejackRecord.new(title: nil).title.should eq 'Untitled'
+      end
+    end
+
+    describe '#metadata' do
+      it 'returns an array of hashes with supplejack fields their values and schemas' do
+        Supplejack.stub(:supplejack_fields) { [:location] }
+        record = SupplejackRecord.new({:location => 'Wellington'})
+        record.metadata.should include({:name => 'location', :schema => 'supplejack', :value => 'Wellington'})
+      end
+
+      it 'should not return metadata for inexistent attribtues' do
+        Supplejack.stub(:supplejack_fields) { [:description] }
+        record = SupplejackRecord.new({:location => 'Wellington'})
+        record.metadata.should be_empty
+      end
+
+      it 'returns multiple elements for a multi value field' do
+        Supplejack.stub(:supplejack_fields) { [:location] }
+        record = SupplejackRecord.new({:location => ['Wellington', 'Auckland']})
+        record.metadata.should include({:name => 'location', :schema => 'supplejack', :value => 'Wellington'}, {:name => 'location', :schema => 'supplejack', :value => 'Auckland'})
+      end
+
+      it 'returns a empty array for a empty field' do
+        Supplejack.stub(:supplejack_fields) { [:location] }
+        record = SupplejackRecord.new({:location => nil})
+        record.metadata.should be_empty
+      end
+
+      it 'works for boolean fields too' do
+        Supplejack.stub(:supplejack_fields) { [:is_human] }
+        record = SupplejackRecord.new({:is_human => true})
+        record.metadata.should include({:name => 'is_human', :schema => 'supplejack', :value => true})
+      end
+
+      it 'works for boolean fields when they are true' do
+        Supplejack.stub(:admin_fields) { [:is_animal] }
+        record = SupplejackRecord.new({:is_animal => true})
+        record.metadata.should include({:name => 'is_animal', :schema => 'admin', :value => true})
+      end
+
+      it 'works for boolean fields when they are false' do
+        Supplejack.stub(:admin_fields) { [:is_animal] }
+        record = SupplejackRecord.new({:is_animal => false})
+        record.metadata.should include({:name => 'is_animal', :schema => 'admin', :value => false})
+      end
+
+      it 'returns names with the schema removed' do
+        Supplejack.stub(:supplejack_fields) { [:identifier] }
+        record = SupplejackRecord.new({:identifier => 'sj:IE1174615'})
+        record.metadata.should include({:name => 'identifier', :schema => 'supplejack', :value => 'sj:IE1174615'})
+      end
+    end
+
+    describe '#single_value_methods' do
+      before(:each) do
+        Supplejack.single_value_methods = [:description]
+      end
+
+      it 'converts values defined in the single_value_methods to a string' do
+        record = SupplejackRecord.new({'description' => ['One', 'Two']})
+        record.description.should eq 'One'
+      end
+
+      it 'returns the string if is already a string' do
+        record = SupplejackRecord.new({'description' => 'One'})
+        record.description.should eq 'One'
+      end
+    end
+
+    [:next_record, :previous_record, :next_page, :previous_page].each do |attr|
+      describe "#{attr}" do
+        it "returns the #{attr}" do
+          record = SupplejackRecord.new({attr => 1})
+          record.send(attr).should eq 1
+        end
+
+        it "returns the nil" do
+          record = SupplejackRecord.new({})
+          record.send(attr).should be_nil
+        end
+      end
+    end
+
+    describe '#find' do
+      context 'single record' do
+        it 'raises a Supplejack::RecordNotFound' do
+          SupplejackRecord.stub(:get).and_raise(RestClient::ResourceNotFound)
+          expect { SupplejackRecord.find(1) }.to raise_error(Supplejack::RecordNotFound)
+        end
+
+        it 'raises a Supplejack::MalformedRequest' do 
+          expect { SupplejackRecord.find('replace_this') }.to raise_error(Supplejack::MalformedRequest)
+        end
+
+        it 'requests the record from the API' do
+          SupplejackRecord.should_receive(:get).with('/records/1', {:fields => 'default'}).and_return({'record' => {}})
+          SupplejackRecord.find(1)
+        end
+
+        it 'initializes a new SupplejackRecord object' do
+          SupplejackRecord.stub(:get).and_return({'record' => {'record_id' => '1', 'title' => 'Wellington'}})
+          record = SupplejackRecord.find(1)
+          record.class.should eq SupplejackRecord
+          record.id.should eq 1
+          record.title.should eq 'Wellington'
+        end
+
+        it 'send the fields defined in the configuration' do
+          Supplejack.stub(:fields) { [:verbose,:default] }
+          SupplejackRecord.should_receive(:get).with('/records/1', {:fields => 'verbose,default'}).and_return({'record' => {}})
+          SupplejackRecord.find(1)
+        end
+
+        it 'sets the correct search options' do
+          SupplejackRecord.should_receive(:get).with('/records/1', hash_including(:search => hash_including({:text=>'dog'}))).and_return({'record' => {}})
+          SupplejackRecord.find(1, {:text => 'dog'})
+        end
+
+        context '#using a special search klass' do
+          before(:each) do
+            @search = ::Search.new
+          end
+
+          it 'uses the specified search klass' do
+            SupplejackRecord.stub(:get) { {'record' => {}} }
+            Supplejack.stub(:search_klass) { 'Search' }
+            ::Search.should_receive(:new).with({:i => {:location => 'Wellington'}}).and_return(@search)
+            SupplejackRecord.find(1, {:i => {:location => 'Wellington'}})
+          end
+
+          it 'uses the default search klass' do
+            SupplejackRecord.stub(:get) { {'record' => {}} }
+            Supplejack.stub(:search_klass) { nil }
+            Supplejack::Search.should_receive(:new).with({:i => {:location => 'Wellington'}}).and_return(@search)
+            SupplejackRecord.find(1, {:i => {:location => 'Wellington'}})
+          end
+
+          it 'sends the params from the subclassed search to the API' do
+            Supplejack.stub(:search_klass) { 'Search' }
+            SupplejackRecord.should_receive(:get).with("/records/1", hash_including(:search => hash_including(:and=>{:name=>'John'}, :or=>{:type=>['Person']}))).and_return({'record' => {}})
+            SupplejackRecord.find(1, {:i => {:name => 'John'}})
+          end
+
+          it 'sends any changes to the api_params made on the subclassed search object' do
+            Supplejack.stub(:search_klass) { 'SpecialSearch' }
+            SupplejackRecord.should_receive(:get).with('/records/1', hash_including(:search => hash_including(:and=>{}))).and_return({'record' => {}})
+            SupplejackRecord.find(1, {:i => {:format => 'Images'}})
+          end
+        end
+      end
+
+      context 'multiple records' do
+        it 'sends a request to /records/multiple endpoint with an array of record ids' do
+          SupplejackRecord.should_receive(:get).with('/records/multiple', {:record_ids => [1,2], :fields => 'default'}).and_return({'records' => []})
+          SupplejackRecord.find([1,2])
+        end
+
+        it 'initializes multiple SupplejackRecord objects' do
+          SupplejackRecord.stub(:get).and_return({'records' => [{'id' => '1'}, {'id' => '2'}]})
+          records = SupplejackRecord.find([1,2])
+          records.size.should eq 2
+          records.first.class.should eq SupplejackRecord
+          records.first.id.should eq 1
+        end
+
+        it 'requests the fields in Supplejack.fields' do
+          Supplejack.stub(:fields) { [:verbose,:description] }
+          SupplejackRecord.should_receive(:get).with('/records/multiple', {:record_ids => [1,2], :fields => 'verbose,description'}).and_return({'records' => []})
+          SupplejackRecord.find([1,2])
+        end
+      end
+    end
+
+  end
+end