octokit 1.0.6 → 1.0.7

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # CHANGELOG
 
+* [1.0.7 - May 11, 2012](https://github.com/pengwynn/octokit/compare/v1.0.6...v1.0.7)
 * [1.0.6 - May 11, 2012](https://github.com/pengwynn/octokit/compare/v1.0.5...v1.0.6)
 * [1.0.5 - May 2, 2012](https://github.com/pengwynn/octokit/compare/v1.0.4...v1.0.5)
 * [1.0.4 - April 24, 2012](https://github.com/pengwynn/octokit/compare/v1.0.3...v1.0.4)

data/lib/octokit/configuration.rb

@@ -11,7 +11,8 @@ module Octokit
       :proxy,
       :oauth_token,
       :user_agent,
-      :auto_traversal].freeze
+      :auto_traversal,
+      :per_page].freeze
 
     DEFAULT_ADAPTER        = Faraday.default_adapter
     DEFAULT_API_VERSION    = 3

data/lib/octokit/request.rb

@@ -28,6 +28,10 @@ module Octokit
       response = connection(authenticate, raw, version, force_urlencoded).send(method) do |request|
         case method
         when :delete, :get
+          if auto_traversal && per_page.nil?
+            self.per_page = 100
+          end
+          options.merge!(:per_page => per_page) if per_page
           request.url(path, options)
         when :patch, :post, :put
           request.path = path

data/lib/octokit/version.rb

@@ -1,3 +1,3 @@
 module Octokit
-  VERSION = "1.0.6".freeze unless defined?(Octokit::VERSION)
+  VERSION = "1.0.7".freeze unless defined?(Octokit::VERSION)
 end

data/spec/octokit/client_spec.rb

@@ -10,19 +10,37 @@ describe Octokit::Client do
     }.should_not raise_exception
   end
 
-  it "should traverse a paginated response if auto_traversal is on" do
-    stub_get("https://api.github.com/foo/bar").
-      to_return(:status => 200, :body => %q{["stuff"]}, :headers => 
-        { 'Link' => %q{<https://api.github.com/foo/bar?page=2>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last"} })
 
-    stub_get("https://api.github.com/foo/bar?page=2").
-      to_return(:status => 200, :body => %q{["even more stuff"]}, :headers => 
-        { 'Link' => %q{<https://api.github.com/foo/bar?page=3>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last", <https://api.github.com/foo/bar?page=1>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"} })
+  describe "auto_traversal" do
 
-    stub_get("https://api.github.com/foo/bar?page=3").
-      to_return(:status => 200, :body => %q{["stuffapalooza"]}, :headers => 
-        { 'Link' => %q{<https://api.github.com/foo/bar?page=2>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"} })
+    it "should traverse a paginated response using the maximum allowed number of items per page" do
+      stub_get("https://api.github.com/foo/bar?per_page=100").
+        to_return(:status => 200, :body => %q{["stuff"]}, :headers =>
+          { 'Link' => %q{<https://api.github.com/foo/bar?page=2>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last"} })
+
+      stub_get("https://api.github.com/foo/bar?page=2&per_page=100").
+        to_return(:status => 200, :body => %q{["even more stuff"]}, :headers =>
+          { 'Link' => %q{<https://api.github.com/foo/bar?page=3>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last", <https://api.github.com/foo/bar?page=1>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"} })
+
+      stub_get("https://api.github.com/foo/bar?page=3&per_page=100").
+        to_return(:status => 200, :body => %q{["stuffapalooza"]}, :headers =>
+          { 'Link' => %q{<https://api.github.com/foo/bar?page=2>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"} })
+
+      Octokit::Client.new(:auto_traversal => true).get("https://api.github.com/foo/bar", {}, 3).should == ['stuff', 'even more stuff', 'stuffapalooza']
+    end
+
+    it "should use the number set in the per_page configuration option when present" do
+      stub_get("https://api.github.com/foo/bar?per_page=50").
+        to_return(:status => 200, :body => %q{["stuff"]}, :headers =>
+          { 'Link' => %q{<https://api.github.com/foo/bar?page=2>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last"} })
+
+      stub_get("https://api.github.com/foo/bar?page=2&per_page=50").
+        to_return(:status => 200, :body => %q{["even more stuff"]}, :headers =>
+          { 'Link' => %q{<https://api.github.com/foo/bar?page=3>; rel="last", <https://api.github.com/foo/bar?page=1>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"} })
+
+      Octokit::Client.new(:auto_traversal => true, :per_page => 50).get("https://api.github.com/foo/bar", {}, 3).should
+    end
 
-    Octokit::Client.new(:auto_traversal => true).get("https://api.github.com/foo/bar", {}, 3).should == ['stuff', 'even more stuff', 'stuffapalooza']
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: &70196526523460 !ruby/object:Gem::Requirement
+  requirement: &70146290234980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70196526523460
+  version_requirements: *70146290234980
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70196526522860 !ruby/object:Gem::Requirement
+  requirement: &70146290234400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70196526522860
+  version_requirements: *70146290234400
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70196526522400 !ruby/object:Gem::Requirement
+  requirement: &70146290233920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70196526522400
+  version_requirements: *70146290233920
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70196526521880 !ruby/object:Gem::Requirement
+  requirement: &70146290233380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70196526521880
+  version_requirements: *70146290233380
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70196526521340 !ruby/object:Gem::Requirement
+  requirement: &70146290232860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,10 +67,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70196526521340
+  version_requirements: *70146290232860
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70196526520940 !ruby/object:Gem::Requirement
+  requirement: &70146290232460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526520940
+  version_requirements: *70146290232460
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70196526520380 !ruby/object:Gem::Requirement
+  requirement: &70146290231880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526520380
+  version_requirements: *70146290231880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70196526519860 !ruby/object:Gem::Requirement
+  requirement: &70146290231360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,10 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526519860
+  version_requirements: *70146290231360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70196526519220 !ruby/object:Gem::Requirement
+  requirement: &70146290230680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -111,10 +111,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526519220
+  version_requirements: *70146290230680
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70196526511900 !ruby/object:Gem::Requirement
+  requirement: &70146290223020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -122,10 +122,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526511900
+  version_requirements: *70146290223020
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70196526510940 !ruby/object:Gem::Requirement
+  requirement: &70146290222300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -133,10 +133,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526510940
+  version_requirements: *70146290222300
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70196526509900 !ruby/object:Gem::Requirement
+  requirement: &70146290221400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -144,7 +144,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70196526509900
+  version_requirements: *70146290221400
 description: Simple wrapper for the GitHub API (v2 and v3)
 email:
 - wynn.netherland@gmail.com