pillboxr 0.7.6 → 0.8.0

data/README.md

@@ -33,14 +33,14 @@ result.pages.current.pills # An array with the retrieved pill objects.
 ```ruby
 require 'pillboxr'
 
-result = Pillboxr.color(:blue).image(true).all # Get result of object with one page of blue pills with images associated.
+result = Pillboxr.color(:blue).image(true).get # Get result of object with one page of blue pills with images associated.
 
 result.pages.current.pills # an array with the retrieved pill objects.
 ```
 
 ***
 
-**Important:** *When chaining query methods you must add the `all` method on the end of the query chain, similar to working with `ActiveRelation` in Rails, so the request can be lazily evaluated.*
+**Important:** *When chaining query methods you must add the `get` method on the end of the query chain, similar to working with `ActiveRelation` in Rails (where the `all` method indicates completion of the query), so the request can be lazily evaluated.*
 
 ***
 
@@ -66,7 +66,7 @@ all_blue_pills.flatten! # all_blue_pills is now an array of all 2059 blue pills.
 ```ruby
 require 'pillboxr'
 
-result = Pillboxr.color(:blue).all do |r|
+result = Pillboxr.color(:blue).get do |r|
   r.pages.each do |page|
     page.get # won't retrieve a page that is already retrieved.
   end
@@ -77,6 +77,15 @@ result.pages.each { |page| all_blue_pills << page.pills }
 
 all_blue_pills.flatten! # all_blue_pills is now an array of all 2059 blue pills.
 ```
+You can also pass an additional options hash to the `get` method to explicitly specify the page of results you want.
+
+```ruby
+require 'pillboxr'
+
+result = Pillboxr.color(:blue).get(page: 3) # pages are zero indexed.
+
+result.pages.current.pills # an array of the fourth page of blue pill results.
+```
 
 You can run the tests by typing `rake` in the library directory.  You may have to install some development gems prior to running the tests by running `bundle install` in the library directory.
 

data/lib/pillboxr.rb

@@ -51,7 +51,11 @@ module Pillboxr
   end
 
   def complete(params = @params, &block) # :nodoc:
-    return Result.new(Request.new(params).perform, &block)
+    begin
+      return Result.new(Request.new(params).perform, &block)
+    ensure
+      @params = Params.new(self)
+    end
   end
 
   private

data/lib/pillboxr/params.rb

@@ -11,7 +11,12 @@ module Pillboxr
       self.collect(&:to_param).join
     end
 
-    def all(&block)
+    # finalize the query and request the results
+    # @param [Hash] options for which page to fetch
+    def get(options = {}, &block)
+      if options[:page]
+        self << Pillboxr::Attributes::Lowerlimit.new(options.fetch(:page) * RECORDS_PER_PAGE)
+      end
       @module_name.send(:complete, self, &block)
     end
 

data/lib/pillboxr/request.rb

@@ -28,15 +28,15 @@ module Pillboxr
 
     attr_reader :full_path, :params, :api_response
 
-    def initialize(default_path = default_path, api_params)
-      @full_path = default_path + api_params.concatenate
+    def initialize(path = default_path, api_params)
+      @full_path = path + api_params.concatenate
       @params = api_params
       @api_response = Pillboxr::Response.new
       @api_response.query = self
     end
 
     def perform
-      puts "path = #{default_path + params.concatenate}"
+      puts "path = #{full_path}"
       @api_response.body = self.class.get(full_path)
       return self.api_response
     end

data/lib/pillboxr/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 module Pillboxr
- VERSION = "0.7.6"
+ VERSION = "0.8.0"
 end

data/test/pillboxr/params_test.rb

@@ -23,12 +23,12 @@ class TestParams < MiniTest::Unit::TestCase
     assert_equal(300, @params.limit)
   end
 
-  def test_all_method
+  def test_get_method
     pillboxr = MiniTest::Mock.new
     result = MiniTest::Mock.new
     p = Pillboxr::Params.new(pillboxr)
     pillboxr.expect(:send,  result, [:complete, @params])
-    p.all
+    p.get
     pillboxr.verify
   end
 

data/test/pillboxr/pill_test.rb

@@ -3,8 +3,8 @@ require_relative 'test_helper'
 
 class TestPill < MiniTest::Unit::TestCase
   def setup
-    @blue_pills = Pillboxr.color(:blue).image(true).all.pages.current.pills
-    @scored_pills = Pillboxr.score(3).all.pages.current.pills
+    @blue_pills = Pillboxr.color(:blue).image(true).get.pages.current.pills
+    @scored_pills = Pillboxr.score(3).get.pages.current.pills
   end
 
   def test_accessor_methods

data/test/pillboxr/pillboxr_test.rb

@@ -96,13 +96,13 @@ class TestPillboxr < MiniTest::Unit::TestCase
 
   def test_method_missing_with_shape
     VCR.use_cassette(:method_missing_shape) do
-      assert_equal(@num_round_shape_records, Pillboxr.shape(:round).all.record_count)
+      assert_equal(@num_round_shape_records, Pillboxr.shape(:round).get.record_count)
     end
   end
 
   def test_method_missing_with_image
     VCR.use_cassette(:method_missing_has_image) do
-      @result = Pillboxr.image(true).all
+      @result = Pillboxr.image(true).get
     end
 
     @result.pages.first.pills.each do |pill|
@@ -113,32 +113,32 @@ class TestPillboxr < MiniTest::Unit::TestCase
 
   def test_method_missing_with_color
     VCR.use_cassette(:method_missing_color) do
-      assert_equal(@num_blue_color_records, Pillboxr.color(:blue).all.record_count)
+      assert_equal(@num_blue_color_records, Pillboxr.color(:blue).get.record_count)
     end
   end
 
   # def test_method_missing_with_imprint # Broken currently
   #   VCR.use_cassette(:method_missing_imprint) do
-  #     assert_equal(@num_imprint_23_records, Pillboxr.imprint(23).all.record_count)
+  #     assert_equal(@num_imprint_23_records, Pillboxr.imprint(23).get.record_count)
   #   end
   # end
 
   def test_method_missing_with_size
-    VCR.use_cassette(:method_missing_size, :allow_playback_repeats => true) do
-      assert_equal(@num_5_mm_records, Pillboxr.size(5).all.record_count)
-      assert_equal(@num_5_mm_records, Pillboxr.size("5").all.record_count)
+    VCR.use_cassette(:method_missing_size, :match_requests_on => [:body], :allow_playback_repeats => true) do
+      assert_equal(@num_5_mm_records, Pillboxr.size(5).get.record_count)
+      assert_equal(@num_5_mm_records, Pillboxr.size("5").get.record_count)
     end
   end
 
   def test_method_missing_with_author
     VCR.use_cassette(:method_missing_author) do
-      assert_equal(@num_mylan_records, Pillboxr.author("Mylan Pharmaceuticals Inc.").all.record_count)
+      assert_equal(@num_mylan_records, Pillboxr.author("Mylan Pharmaceuticals Inc.").get.record_count)
     end
   end
 
   def test_method_missing_with_lower_limit
     VCR.use_cassette(:method_missing_with_lower_limit, :allow_playback_repeats => true) do
-      assert_equal(201, Pillboxr.shape(:round).lower_limit(202).all.pages.current.pills.size)
+      assert_equal(201, Pillboxr.shape(:round).lower_limit(202).get.pages.current.pills.size)
     end
   end
 
@@ -153,13 +153,13 @@ class TestPillboxr < MiniTest::Unit::TestCase
 
   def test_method_chaining
     VCR.use_cassette(:method_chaining) do
-      assert_equal(@num_blue_records_with_image, Pillboxr.color(:blue).image(true).all.record_count)
+      assert_equal(@num_blue_records_with_image, Pillboxr.color(:blue).image(true).get.record_count)
     end
   end
 
   def test_method_missing_with_a_block
     VCR.use_cassette(:method_missing_with_a_block) do
-      @result = Pillboxr.image(true).all do |r|
+      @result = Pillboxr.image(true).get do |r|
         r.pages.each do |page|
           page.get unless page.retrieved?
         end
@@ -168,4 +168,11 @@ class TestPillboxr < MiniTest::Unit::TestCase
     @result.pages.each { |page| assert page.retrieved? }
     assert_equal(@num_image_records, @result.pages.inject(0) { |sum, page| sum + page.pills.size })
   end
+
+  def test_get_method_with_options
+    VCR.use_cassette(:get_method_with_options) do
+      @result = Pillboxr.image(true).get(page: 3)
+      assert_equal(3, @result.pages.current.number)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pillboxr
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty