inquisitio 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5979b3509dd914841f1fc553f33e2b2e3ae2e2ef
-  data.tar.gz: d36201990c6be855dea556acfd81a1b22393440f
+  metadata.gz: 35812975d269869fb5fb249d158726a592ef548b
+  data.tar.gz: bb8169aaec4ec7c056c7acc8ec490ecd2babd242
 SHA512:
-  metadata.gz: 2ecf3137719704252be5de8ef79cba9575eaca75a4b29c4a627dd6f208d2176a195d9152cbddc3e341ad9cf56345cc1c3570a8a256115f343591fb875fba724e
-  data.tar.gz: 9d9e8c5c91afe5ce9aaa2f306efd98aa8cc4637b9b679e465a3b8c045e60da9bd5a53fa86905529639a20ca12ba54c955e82a015736ac2d3809c24659c849e1f
+  metadata.gz: f5cc4b3fd919ef34495ca4abc3fcfcc4c71b7da1caf36df2604ccec85e21150437c8edc4b93c8464bd84dceceb1e8f1afed2ae5eb998aab2fd40690d0ecd2d75
+  data.tar.gz: 99cb031e9cd75f5fa20f76b86477e09918d51fe394c4c5278756215e0d6cd8f76383ecac2ace084c5e9c8a9e9712817560ef42fd9a40eda6e615ed419924c7fb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+1.3.0 / 2014-11-22
+[FEATURE] Added sorting option to searcher
+
 1.2.4 / 2014-06-12
 [FEATURE] Remove deep clone to allow inquisitio on jRuby
 

data/lib/inquisitio/search_url_builder.rb

@@ -12,6 +12,7 @@ module Inquisitio
       @return_fields = options[:return_fields]
       @size = options[:size] || Inquisitio.config.default_search_size
       @start = options[:start] || 0
+      @sort = options[:sort] || {}
     end
 
     def build
@@ -22,6 +23,7 @@ module Inquisitio
       components << arguments
       components << "&size=#{@size}" unless @arguments[:size]
       components << "&start=#{@start}" unless @arguments[:start] || @start == 0 || @start == '0'
+      components << '&sort=' + @sort.map {|k,v| "#{k}%20#{v}"}.join(',') unless @sort.empty?
       components.join("")
     end
 

data/lib/inquisitio/searcher.rb

@@ -16,7 +16,8 @@ module Inquisitio
         per: 10,
         page: 1,
         returns: [],
-        with: {}
+        with: {},
+        sort: {}
       }
       @failed_attempts = 0
 
@@ -109,6 +110,12 @@ module Inquisitio
       end
     end
 
+    def sort(value)
+      clone do |s|
+        s.params[:sort].merge!(value)
+      end
+    end
+
     # Proxy everything to the results so that this this class
     # transparently acts as an Array.
     def method_missing(name, *args, &block)
@@ -157,6 +164,7 @@ module Inquisitio
           arguments: params[:with],
           size: params[:per],
           start: params[:per] * (params[:page] - 1),
+          sort: params[:sort],
           return_fields: return_fields
         )
       end

data/lib/inquisitio/version.rb

@@ -1,3 +1,3 @@
 module Inquisitio
-  VERSION = "1.2.4"
+  VERSION = "1.3.0"
 end

data/test/test_searcher.rb

@@ -4,6 +4,7 @@ module Inquisitio
 
   class Elephant
     attr_accessor :id, :name
+
     def initialize(_id, _name)
       @id, @name = _id, _name
     end
@@ -11,6 +12,7 @@ module Inquisitio
 
   class Giraffe
     attr_accessor :id, :name
+
     def initialize(_id, _name)
       @id, @name = _id, _name
     end
@@ -227,12 +229,12 @@ module Inquisitio
 
     def test_with_saves_variable
       searcher = Searcher.with(foo: 'bar')
-      assert_equal({foo:'bar'}, searcher.params[:with])
+      assert_equal({foo: 'bar'}, searcher.params[:with])
     end
 
     def test_with_appends_to_variable
       searcher = Searcher.with(foo: 'bar').with(cat: 'dog')
-      assert_equal({foo:'bar', cat:'dog'}, searcher.params[:with])
+      assert_equal({foo: 'bar', cat: 'dog'}, searcher.params[:with])
     end
 
     def test_with_gets_correct_url
@@ -258,7 +260,7 @@ module Inquisitio
     end
 
     def test_search_raises_exception_when_excon_exception_thrown
-      Excon.stub({}, lambda { |_| raise Excon::Errors::Timeout})
+      Excon.stub({}, lambda { |_| raise Excon::Errors::Timeout })
 
       searcher = Searcher.where('Star Wars')
       searcher.instance_variable_set(:@failed_attempts, 3)
@@ -280,21 +282,21 @@ module Inquisitio
     def test_that_iterating_calls_results
       searcher = Searcher.where("star_wars")
       searcher.expects(results: [])
-      searcher.each { }
+      searcher.each {}
     end
 
     def test_that_iterating_calls_each
       searcher = Searcher.where("star_wars")
       searcher.search
       searcher.send(:results).expects(:each)
-      searcher.each { }
+      searcher.each {}
     end
 
     def test_that_select_calls_each
       searcher = Searcher.where("star_wars")
       searcher.search
       searcher.send(:results).expects(:select)
-      searcher.select { }
+      searcher.select {}
     end
 
     def test_search_should_set_results
@@ -331,7 +333,7 @@ module Inquisitio
 
     def test_should_return_ids
       searcher = Searcher.where('Star Wars')
-      assert_equal [1,2,20], searcher.ids
+      assert_equal [1, 2, 20], searcher.ids
     end
 
     def test_should_return_records_in_results_order
@@ -339,19 +341,38 @@ module Inquisitio
       expected_2 = Giraffe.new(20, 'Wolf')
       expected_3 = Elephant.new(1, 'Gobbolino')
 
-      Elephant.expects(:where).with(id: ['2','1']).returns([expected_3, expected_1])
+      Elephant.expects(:where).with(id: ['2', '1']).returns([expected_3, expected_1])
       Giraffe.expects(:where).with(id: ['20']).returns([expected_2])
 
       searcher = Searcher.new
       result = [
-          {'data' => {'id' => ['2'],  'type' => ['Inquisitio_Elephant']}},
+          {'data' => {'id' => ['2'], 'type' => ['Inquisitio_Elephant']}},
           {'data' => {'id' => ['20'], 'type' => ['Inquisitio_Giraffe']}},
-          {'data' => {'id' => ['1'],  'type' => ['Inquisitio_Elephant']}}
+          {'data' => {'id' => ['1'], 'type' => ['Inquisitio_Elephant']}}
       ]
       searcher.instance_variable_set("@results", result)
       expected_records = [expected_1, expected_2, expected_3]
       actual_records = searcher.records
       assert_equal expected_records, actual_records
     end
+
+    def test_should_sort_field_ascending
+      searcher = Searcher.where('Star Wars').sort(year: :asc)
+      search_url = searcher.send(:search_url)
+      assert search_url.include?('sort=year%20asc'), "search url should include sort parameter:\n#{search_url}"
+    end
+
+    def test_should_sort_field_descending
+      searcher = Searcher.where('Star Wars').sort(year: :desc)
+      search_url = searcher.send(:search_url)
+      assert search_url.include?('sort=year%20desc'), "search url should include sort parameter:\n#{search_url}"
+    end
+
+    def test_should_sort_multiple_fields
+      searcher = Searcher.where('Star Wars').sort(year: :desc, foo: :asc)
+      search_url = searcher.send(:search_url)
+      assert search_url.include?('sort=year%20desc,foo%20asc'), "search url should include sort parameter:\n#{search_url}"
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Jeremy Walker
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This wraps AWS CloudSearch in a Ruby Gem