inquisitio 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 0153850b7330c032d7d3bdde601026aa999e4572
-  data.tar.gz: 7911234db6c6b7bf878a3b81b124cf07838a042c
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjQ3YThiYjYzNzQ5YTc0OGRjZjcxMTc5NjcwMDJmYjlmYzgwMjQ0Yw==
+  data.tar.gz: !binary |-
+    NTE2NmJiOTgxODVlMWZiN2U2MjYwOWFjNGJiMmNkMWQwNTJiMjNlZA==
 SHA512:
-  metadata.gz: 41b9e466ee1921dee60271bcacad62a9ca0f9456c21e94569d1700daeede197bedeeaf236662f1ed9c614e72a9e0ae038253352ffb87d178fadcee9349259a57
-  data.tar.gz: 984fc2e46cd3c754ab4846b1e8af8bd2190dcb5cad0c560bed257d786476585615ce376bb6029592379ffa8c478882e306716d5255d9f56df07f531ef809c9cb
+  metadata.gz: !binary |-
+    NDI3MWRhNzhkMTk2ZGUxNWE4MWRkYTQxNWE4YjIzNmE5OGU3MjYyMjJhZmQw
+    ZjI2NzBhYzU2NDNmMDY1NjhjN2FmZWViYTVjNWMxZGE3ZGVhNmQ1NWJhMWI5
+    OGFiN2E5NDBlMGIzNTkyMGVmOTc1N2U2ZDBmODQ2ZWUyMzFiZjc=
+  data.tar.gz: !binary |-
+    NjhhZmJmOTVkY2ZjY2JjY2M3MDFlODVhN2ZiZDU0ZGNkMzdlMmNhMjYxYTQz
+    ZWEyMzU5NmY1MDMzMDNhMWM2OWU1N2M0ZmI0ZTI0NGU0NjY4YmY5Y2I2MmRh
+    Njk1NzBiZGU2ODZiNjIwYWJjNmU1MWJkMzIwMzQ2NTUyYmU5NTY=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.1.1 / 2013-10-29 
+
+[FEATURE] Add pagination methods to match Kaminari
+
 0.1.0 / 2013-10-28
 
 [BUGFIX] Parse ids properly.

data/lib/inquisitio/results.rb

@@ -0,0 +1,27 @@
+module Inquisitio
+  class Results < Array
+    def initialize(items, current_page, results_per_page, total_count)
+      super(items)
+      @current_page     = current_page
+      @results_per_page = results_per_page
+      @total_count      = total_count
+    end
+
+    attr_reader :total_count, :results_per_page, :current_page
+    alias_method :total_entries, :total_count
+    alias_method :limit_value, :results_per_page
+
+    def total_pages
+      (total_count / results_per_page.to_f).ceil
+    end
+    alias_method :num_pages, :total_pages
+
+    def last_page?
+      current_page == total_pages
+    end
+
+    def to_a
+      self
+    end
+  end
+end

data/lib/inquisitio/searcher.rb

@@ -104,7 +104,11 @@ module Inquisitio
       if @results.nil?
         response = Excon.get(search_url)
         raise InquisitioError.new("Search failed with status code: #{response.status} Message #{response.body}") unless response.status == 200
-        @results = JSON.parse(response.body)["hits"]["hit"]
+        body = JSON.parse(response.body)
+        @results = Results.new(body["hits"]["hit"],
+                               params[:page],
+                               params[:per],
+                               body["hits"]["found"])
       end
       @results
     end

data/lib/inquisitio/version.rb

@@ -1,3 +1,3 @@
 module Inquisitio
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/inquisitio.rb

@@ -7,6 +7,7 @@ require "inquisitio/configuration"
 require "inquisitio/document"
 require "inquisitio/search_url_builder"
 require "inquisitio/searcher"
+require "inquisitio/results"
 require "inquisitio/indexer"
 
 module Inquisitio

data/test/results_test.rb

@@ -0,0 +1,102 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Inquisitio
+  class ResultsTest < Minitest::Test
+    def setup
+      super
+      @search_endpoint = 'http://my.search-endpoint.com'
+      Inquisitio.config.search_endpoint = @search_endpoint
+      @result_1 = {'data' => {'med_id' => ['1'], 'title' => ["Foobar"], 'med_type' => ["Cat"]}}
+      @result_2 = {'data' => {'med_id' => ['2'], 'title' => ["Foobar"], 'med_type' => ["Cat"]}}
+      @result_3 = {'data' => {'med_id' => ['20'], 'title' => ["Foobar2"], 'med_type' => ["Module_Dog"]}}
+      @expected_results = [@result_1, @result_2, @result_3]
+      @start = 5
+      @found = 8
+
+      @body = <<-EOS
+      {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":#{@found},"start":#{@start},"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
+      EOS
+
+      Excon.defaults[:mock] = true
+      Excon.stub({}, {body: @body, status: 200})
+    end
+
+    def teardown
+      super
+      Excon.stubs.clear
+    end
+
+    def test_should_return_total_count
+      searcher = Searcher.where("star_wars")
+      searcher.search
+      assert_equal @found, searcher.total_entries
+    end
+
+    def test_total_entries_should_proxy
+      searcher = Searcher.where("star_wars")
+      searcher.search
+      assert_equal @found, searcher.total_count
+    end
+
+    def test_should_return_results_per_page
+      per = 9
+      searcher = Searcher.per(per)
+      searcher.search
+      assert_equal per, searcher.results_per_page
+    end
+
+    def test_should_return_limit_value
+      per = 9
+      searcher = Searcher.per(per)
+      searcher.search
+      assert_equal per, searcher.limit_value
+    end
+
+    def test_should_return_current_page
+      page = 7
+      searcher = Searcher.page(7)
+      searcher.search
+      assert_equal page, searcher.current_page
+    end
+
+    def test_should_return_total_pages_with_less
+      per = 10
+      searcher = Searcher.per(per)
+      searcher.search
+      assert_equal 1, searcher.total_pages
+    end
+
+    def test_should_return_total_pages_with_equal
+      per = 8
+      searcher = Searcher.per(per)
+      searcher.search
+      assert_equal 1, searcher.total_pages
+    end
+
+    def test_should_return_total_pages_with_more
+      per = 3
+      searcher = Searcher.per(per)
+      searcher.search
+      assert_equal 3, searcher.total_pages
+    end
+
+    def test_nums_pages_should_proxy
+      per = 3
+      searcher = Searcher.per(per)
+      searcher.search
+      assert_equal 3, searcher.num_pages
+    end
+
+    def test_last_page_before
+      results = Inquisitio::Results.new([], 1, nil, nil)
+      results.expects(total_pages: 2)
+      refute results.last_page?
+    end
+
+    def test_last_page_equal
+      results = Inquisitio::Results.new([], 2, nil, nil)
+      results.expects(total_pages: 2)
+      assert results.last_page?
+    end
+  end
+end

data/test/searcher_test.rb

@@ -10,9 +10,11 @@ module Inquisitio
       @result_2 = {'data' => {'med_id' => ['2'], 'title' => ["Foobar"], 'med_type' => ["Cat"]}}
       @result_3 = {'data' => {'med_id' => ['20'], 'title' => ["Foobar2"], 'med_type' => ["Module_Dog"]}}
       @expected_results = [@result_1, @result_2, @result_3]
+      @start = 5
+      @found = 8
 
       @body = <<-EOS
-      {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":2,"start":0,"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
+      {"rank":"-text_relevance","match-expr":"(label 'star wars')","hits":{"found":#{@found},"start":#{@start},"hit":#{@expected_results.to_json}},"info":{"rid":"9d3b24b0e3399866dd8d376a7b1e0f6e930d55830b33a474bfac11146e9ca1b3b8adf0141a93ecee","time-ms":3,"cpu-time-ms":0}}
       EOS
 
       Excon.defaults[:mock] = true
@@ -235,12 +237,18 @@ module Inquisitio
       searcher.select { }
     end
 
-    def test_search_should_results
+    def test_search_should_set_results
       searcher = Searcher.where("star_wars")
       searcher.search
       assert_equal @expected_results, searcher.instance_variable_get("@results")
     end
 
+    def test_search_should_create_a_results_object
+      searcher = Searcher.where("star_wars")
+      searcher.search
+      assert Results, searcher.instance_variable_get("@results").class
+    end
+
     def test_search_only_runs_once
       searcher = Searcher.where("star_wars")
       Excon.expects(:get).returns(mock(status: 200, body: @body)).once

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Walker
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -30,14 +30,14 @@ dependencies:
   name: ruby_deep_clone
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -58,42 +58,42 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -143,6 +143,7 @@ files:
 - lib/inquisitio/indexer.rb
 - lib/inquisitio/inquisitio_error.rb
 - lib/inquisitio/logger.rb
+- lib/inquisitio/results.rb
 - lib/inquisitio/search_url_builder.rb
 - lib/inquisitio/searcher.rb
 - lib/inquisitio/version.rb
@@ -150,6 +151,7 @@ files:
 - test/document_test.rb
 - test/indexer_test.rb
 - test/logger_test.rb
+- test/results_test.rb
 - test/search_url_builder_test.rb
 - test/searcher_test.rb
 - test/test_helper.rb
@@ -163,12 +165,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -182,6 +184,7 @@ test_files:
 - test/document_test.rb
 - test/indexer_test.rb
 - test/logger_test.rb
+- test/results_test.rb
 - test/search_url_builder_test.rb
 - test/searcher_test.rb
 - test/test_helper.rb