github_api 0.4.1 → 0.4.2

data/lib/github_api/page_uri_processor.rb

@@ -0,0 +1,21 @@
+module Github
+  class PageUriProcessor
+    include Github::Constants
+    include Github::Utils::Url
+
+    attr_reader :link, :query_string
+
+    def initialize(uri)
+      @link = uri.split(QUERY_STR_SEP).first
+      @query_string = uri.split(QUERY_STR_SEP).last
+    end
+
+    def resource_link
+      query_string
+    end
+
+    def query_hash
+      
+    end
+  end
+end

data/lib/github_api/paged_request.rb

@@ -26,7 +26,7 @@ module Github
       if params[PARAM_PER_PAGE] == NOT_FOUND
         params[PARAM_PER_PAGE] = default_page_size
       end
-      if !params[PARAM_PAGE] || params[PARAM_PAGE] == NOT_FOUND
+      if params[PARAM_PAGE] && params[PARAM_PAGE] == NOT_FOUND
         params[PARAM_PAGE] = default_page
       end
 

data/lib/github_api/repos/watching.rb

@@ -11,7 +11,7 @@ module Github
       #  @github.repos.watchers
       #  @github.repos.watchers { |watcher| ... }
       #
-      def watchers(user_name=nil, repo_name=nil, params={})
+      def watchers(user_name, repo_name, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _normalize_params_keys(params)
@@ -24,8 +24,8 @@ module Github
       # List repos being watched by a user
       #
       # = Examples
-      #  @github = Github.new :user => 'user-name'
-      #  @github.repos.watched
+      #  @github = Github.new
+      #  @github.repos.watched :user => 'user-name'
       #
       # List repos being watched by the authenticated user
       #
@@ -33,12 +33,13 @@ module Github
       #  @github = Github.new :oauth_token => '...'
       #  @github.repos.watched
       #
-      def watched(user_name=nil, params={})
-        _update_user_repo_params(user_name)
+      def watched(*args)
+        params = args.last.is_a?(Hash) ? args.pop : {}
         _normalize_params_keys(params)
+        _merge_user_into_params!(params) unless params.has_key?('user')
 
-        response = if user
-          get("/users/#{user}/watched", params)
+        response = if (user_name = params.delete('user'))
+          get("/users/#{user_name}/watched", params)
         else
           get("/user/watched", params)
         end

data/lib/github_api/request.rb

@@ -63,8 +63,8 @@ module Github
     end
 
     def _extract_mime_type(params, options) # :nodoc:
-      options['resource']  = params.delete('resource') || ''
-      options['mime_type'] = params.delete('mime_type')
+      options['resource']  = params['resource'] ? params.delete('resource') : ''
+      options['mime_type'] = params['resource'] ? params.delete('mime_type') : ''
     end
 
     # no need for this smizzle

data/lib/github_api/result.rb

@@ -23,6 +23,14 @@ module Github
       loaded? ? @env[:response_headers][CONTENT_LENGTH] : nil
     end
 
+    def etag
+      loaded? ? @env[:response_headers][ETAG] : nil
+    end
+
+    def server
+      loaded? ? @env[:response_headers][SERVER] : nil
+    end
+
     def status
       loaded? ? @env[:status] : nil
     end
@@ -59,7 +67,7 @@ module Github
     def first_page
       first_request = page_iterator.first
       self.instance_eval { @env = first_request.env } if first_request
-      first_request
+      self.body
     end
 
     # Retrives the result of the next page. Returns <tt>nil</tt> if there is
@@ -67,7 +75,7 @@ module Github
     def next_page
       next_request = page_iterator.next
       self.instance_eval { @env = next_request.env } if next_request
-      next_request
+      self.body
     end
 
     # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
@@ -75,7 +83,7 @@ module Github
     def prev_page
       prev_request = page_iterator.prev
       self.instance_eval { @env = prev_request.env } if prev_request
-      prev_request
+      self.body
     end
     alias :previous_page :prev_page
 
@@ -85,7 +93,7 @@ module Github
     def last_page
       last_request = page_iterator.last
       self.instance_eval { @env = last_request.env } if last_request
-      last_request
+      self.body
     end
 
     # Retrives a specific result for a page given page number.
@@ -95,7 +103,7 @@ module Github
     def page(page_number)
       request = page_iterator.get_page(page_number)
       self.instance_eval { @env = request.env } if request
-      request
+      self.body
     end
 
     # Returns <tt>true</tt> if there is another page in the result set,

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 4
-    PATCH = 1
+    PATCH = 2
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/github/page_iterator_spec.rb

@@ -5,14 +5,23 @@ describe Github::PageIterator do
   let(:link) {
     "<https://api.github.com/users/wycats/repos?page=4&per_page=20>; rel=\"next\", <https://api.github.com/users/wycats/repos?page=6&per_page=20>; rel=\"last\", <https://api.github.com/users/wycats/repos?page=1&per_page=20>; rel=\"first\", <https://api.github.com/users/wycats/repos?page=2&per_page=20>; rel=\"prev\""
   }
-  let(:env)  { { :response_headers => {'Link' => link } } }
-  let(:first) { "https://api.github.com/users/wycats/repos?page=1&per_page=20" }
+  let(:sha_link) {
+    "<https://api.github.com/repos/peter-murach/github/commits?last_sha=d1e503c02fa770859895dd0d12aedefa28b95723&per_page=30&sha=801d80dfd59bf1d2cb30a243799953ab683a3abd&top=801d80dfd59bf1d2cb30a243799953ab683a3abd>; rel=\"next\", <https://api.github.com/repos/peter-murach/github/commits?per_page=30&sha=801d80dfd59bf1d2cb30a243799953ab683a3abd>; rel=\"first\""
+  }
+  let(:env)      { { :response_headers => {'Link' => link } } }
+  let(:sha_env)  { { :response_headers => {'Link' => sha_link } } }
+  let(:first)  { "https://api.github.com/users/wycats/repos?page=1&per_page=20" }
   let(:nexxt)  { "https://api.github.com/users/wycats/repos?page=4&per_page=20" }
-  let(:prev)  { "https://api.github.com/users/wycats/repos?page=2&per_page=20" }
-  let(:last)  { "https://api.github.com/users/wycats/repos?page=6&per_page=20" }
-  let(:user) { 'wycats' }
+  let(:prev)   { "https://api.github.com/users/wycats/repos?page=2&per_page=20" }
+  let(:last)   { "https://api.github.com/users/wycats/repos?page=6&per_page=20" }
+  let(:user)   { 'wycats' }
+  let(:last_sha) { "d1e503c02fa770859895dd0d12aedefa28b95723"}
 
   let(:instance) { Github::PageIterator.new(env) }
+  let(:sha_instance) { Github::PageIterator.new(sha_env) }
+  let(:sha_links) { Github::PageLinks.new(sha_env)}
+  let(:sha_first) { "https://api.github.com/repos/peter-murach/github/commits?per_page=30&sha=801d80dfd59bf1d2cb30a243799953ab683a3abd" }
+  let(:sha_next) { "https://api.github.com/repos/peter-murach/github/commits?last_sha=d1e503c02fa770859895dd0d12aedefa28b95723&per_page=30&sha=801d80dfd59bf1d2cb30a243799953ab683a3abd&top=801d80dfd59bf1d2cb30a243799953ab683a3abd"}
 
   it { described_class::ATTRIBUTES.should_not be_nil }
 
@@ -27,6 +36,15 @@ describe Github::PageIterator do
     it { instance.last_page.should eql 6 }
     it { instance.last_page_uri.should eq last }
 
+    it { sha_instance.first_page.should eq -1 }
+    it { sha_instance.first_page_uri.should eq sha_first }
+    it { sha_instance.next_page.should  eq -1 }
+    it { sha_instance.next_page_uri.should  eq sha_next }
+    it { sha_instance.prev_page.should eq -1 }
+    it { sha_instance.prev_page_uri.should be_nil }
+    it { sha_instance.last_page.should eql -1 }
+    it { sha_instance.last_page_uri.should be_nil }
+
   end
 
   context 'has_next?' do
@@ -67,6 +85,31 @@ describe Github::PageIterator do
           and_return link
       instance.first
     end
+
+    context 'no pagination params' do
+      before do
+        Github.new
+        sha_instance.stub(:has_next?).and_return true
+        sha_instance.stub(:next_page).and_return -1
+
+        stub_get("/repos/peter-murach/github/commits").
+          to_return(:body => '', :status => 200,
+            :headers => {
+              :content_type => "application/json; charset=utf-8",
+              'Link' => sha_link
+              }
+          )
+      end
+
+      it 'receives sha params' do
+        sha_link.stub(:links).and_return sha_links
+        sha_instance.stub(:udpate_page_links)
+        sha_instance.should_receive(:page_request).
+          with("https://api.github.com/repos/peter-murach/github/commits",
+            'sha' => 'master', 'per_page' => 30).and_return sha_link
+        sha_instance.first
+      end
+    end
   end # first
 
   context 'next' do
@@ -96,6 +139,31 @@ describe Github::PageIterator do
           'page' => 4,'per_page' => 20).and_return link
       instance.next
     end
+
+    context 'no pagination params' do
+      before do
+        Github.new
+        sha_instance.stub(:has_next?).and_return true
+        sha_instance.stub(:next_page).and_return -1
+
+        stub_get("/repos/peter-murach/github/commits").
+          to_return(:body => '', :status => 200,
+            :headers => {
+              :content_type => "application/json; charset=utf-8",
+              'Link' => sha_link
+              }
+          )
+      end
+
+      it 'receives sha params' do
+        sha_link.stub(:links).and_return sha_links
+        sha_instance.stub(:udpate_page_links)
+        sha_instance.should_receive(:page_request).
+          with("https://api.github.com/repos/peter-murach/github/commits",
+            'sha' => last_sha, 'per_page' => 30).and_return sha_link
+        sha_instance.next
+      end
+    end
   end # next
 
   context 'prev' do

data/spec/github/repos/watching_spec.rb

@@ -56,7 +56,7 @@ describe Github::Repos::Watching, :type => :base do
 
   end
 
-  describe "watched" do
+  describe ":watched:" do
 
     context "if user unauthenticated" do
       before do
@@ -76,7 +76,7 @@ describe Github::Repos::Watching, :type => :base do
       it "should get the resource with username" do
         stub_get("/users/#{user}/watched").
           to_return(:body => fixture("repos/watched.json"), :status => 200, :headers => {})
-        github.repos.watched(user)
+        github.repos.watched(:user => user)
         a_get("/users/#{user}/watched").should have_been_made
       end
     end

data/spec/github/result_spec.rb

@@ -4,7 +4,7 @@ describe Github::Result do
 
   let(:github) { Github.new }
   let(:user)   { 'wycats' }
-  let(:res)    { github.events.public }
+  let(:res)    { github.events.public :per_page => 20 }
   let(:pages)  { ['1', '5', '6'] }
   let(:link) {
     "<https://api.github.com/users/wycats/repos?page=6&per_page=20>; rel=\"last\", <https://api.github.com/users/wycats/repos?page=1&per_page=20>; rel=\"first\""
@@ -12,6 +12,7 @@ describe Github::Result do
 
   before do
     stub_get("/events").
+      with(:query => { 'per_page' => '20' }).
       to_return(:body => fixture('events/events.json'),
         :status => 200,
         :headers => {
@@ -19,12 +20,15 @@ describe Github::Result do
           'X-RateLimit-Remaining' => '4999',
           'X-RateLimit-Limit' => '5000',
           'content-length' => '344',
+          'etag' => "\"d9a88f20567726e29d35c6fae87cef2f\"",
+          'server' => "nginx/1.0.4",
           'Link' => link
         })
 
-    ['1', '5', '6'].each do |page|
+    ['', '1', '5', '6'].each do |page|
+    params = page.empty? ? {'per_page'=>'20'} : {'per_page'=>'20', 'page'=>page}
     stub_get("/users/#{user}/repos").
-      with(:query => {'per_page' => '20', 'page' => page}).
+      with(:query => params).
       to_return(:body => fixture('events/events.json'),
         :status => 200,
         :headers => {
@@ -57,6 +61,14 @@ describe Github::Result do
     res.status.should be 200
   end
 
+  it 'should read response etag' do
+    res.etag.should eql "\"d9a88f20567726e29d35c6fae87cef2f\""
+  end
+
+  it 'should read response server' do
+    res.server.should eql "nginx/1.0.4"
+  end
+
   it "should assess successful" do
     res.success?.should be_true
   end
@@ -80,14 +92,26 @@ describe Github::Result do
     end
 
     %w[ next prev ].each do |link|
-      it "should return #{link} page if exists" do
-        res.send(:"#{link}_page").should eq @items
+      context "#{link}_page" do
+        it "should return collection of resources" do
+          res.send(:"#{link}_page").should be_an Array
+        end
+
+        it 'should have no link information' do
+          res.links.send(:"#{link}").should be_nil
+        end
       end
     end
 
     %w[ first last].each do |link|
-      it "should return #{link} page if exists" do
-        res.send(:"#{link}_page").should_not be_empty
+      context "#{link}_page" do
+        it "should return resource if exists" do
+          res.send(:"#{link}_page").should_not be_empty
+        end
+
+        it "should have link information" do
+          res.send(:"#{link}_page").should_not be_nil
+        end
       end
     end
 

metadata

@@ -2,7 +2,7 @@
 name: github_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-18 00:00:00 +00:00
+date: 2012-01-21 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -177,6 +177,14 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
+- features/cassettes/pagination/repos/commits/next.yml
+- features/cassettes/pagination/repos/commits/sha/next.yml
+- features/cassettes/pagination/repos/commits/sha.yml
+- features/cassettes/pagination/repos/commits.yml
+- features/cassettes/pagination/repos/diff/next.yml
+- features/cassettes/pagination/repos/diff.yml
+- features/cassettes/pagination/repos/next.yml
+- features/cassettes/pagination/repos.yml
 - features/cassettes/repos/branches.yml
 - features/cassettes/repos/tags.yml
 - features/cassettes/repos/teams.yml
@@ -222,6 +230,7 @@ files:
 - lib/github_api/orgs.rb
 - lib/github_api/page_iterator.rb
 - lib/github_api/page_links.rb
+- lib/github_api/page_uri_processor.rb
 - lib/github_api/paged_request.rb
 - lib/github_api/pull_requests/comments.rb
 - lib/github_api/pull_requests.rb