github_api 0.3.9 → 0.4.0

data/lib/github_api/paged_request.rb

@@ -0,0 +1,34 @@
+module Github
+  module PagedRequest
+    include Github::Constants
+
+    extend self
+
+    FIRST_PAGE = 1
+
+    PER_PAGE = 25
+
+    class << self
+      attr_accessor :page, :per_page
+    end
+
+    def default_page_size
+      Github.api_client.per_page ? Github.api_client.per_page : PER_PAGE
+    end
+
+    def default_page
+      Github.api_client.page ? Github.api_client.page : FIRST_PAGE
+    end
+
+    def page_request(path, params={})
+      params[PARAM_PER_PAGE] = default_page_size unless params[PARAM_PER_PAGE]
+      params[PARAM_PAGE] = default_page unless params[PARAM_PAGE]
+
+      Github::PagedRequest.page = params[PARAM_PAGE]
+      Github::PagedRequest.per_page = params[PARAM_PER_PAGE]
+
+      Github.api_client.get path, params
+    end
+
+  end # PagedRequest
+end # Github

data/lib/github_api/repos.rb

@@ -225,11 +225,11 @@ module Github
     def repos(*args)
       params = args.last.is_a?(Hash) ? args.pop : {}
       _normalize_params_keys(params)
-      # _merge_user_into_params!(params) unless params.has_key?('user')
+      _merge_user_into_params!(params) unless params.has_key?('user')
       _filter_params_keys(%w[ org user type ], params)
 
       response = if (user_name = params.delete("user"))
-        get("/users/#{user_name}/repos")
+        get("/users/#{user_name}/repos", params)
       elsif (org_name = params.delete("org"))
         get("/orgs/#{org_name}/repos", params)
       else

data/lib/github_api/response/helpers.rb

@@ -6,7 +6,14 @@ module Github
   class Response::Helpers < Response
 
     def on_complete(env)
-      env[:body].extend(Github::Result)
+      env[:body].class.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        include Github::Result
+
+        def env
+          @env
+        end
+
+      RUBY_EVAL
       env[:body].instance_eval { @env = env }
     end
 

data/lib/github_api/response/raise_error.rb

@@ -16,6 +16,9 @@ module Github
         raise Github::Forbidden.new(response_message(env), env[:response_headers])
       when 404
         raise Github::ResourceNotFound.new(response_message(env), env[:response_headers])
+
+      when 422
+        raise Github::UnprocessableEntitty.new(response_message(env), env[:response_headers])
       when 500
         raise Github::InternalServerError.new(response_message(env), env[:response_headers])
       when 503

data/lib/github_api/result.rb

@@ -2,16 +2,17 @@
 
 module Github
   module Result
+    include Github::Constants
 
-    RATELIMIT = 'X-RateLimit-Remaining'.freeze
-    CONTENT_TYPE = 'Content-Type'.freeze
-    CONTENT_LENGTH = 'content-length'.freeze
-
-    attr_reader :env
+    # TODO Add result counts method to check total items looking at result links
 
     # Requests are limited to API v3 to 5000 per hour.
-    def ratelimit
-      loaded? ? @env[:response_headers][RATELIMIT] : nil
+    def ratelimit_limit
+      loaded? ? @env[:response_headers][RATELIMIT_LIMIT] : nil
+    end
+
+    def ratelimit_remaining
+      loaded? ? @env[:response_headers][RATELIMIT_REMAINING] : nil
     end
 
     def content_type
@@ -30,12 +31,89 @@ module Github
       (200..299).include? status
     end
 
+    # Returns raw body
     def body
       loaded? ? @env[:body] : nil
     end
 
     def loaded?
-      !!env
+      !!@env
+    end
+
+    # Return page links
+    def links
+      @@links = Github::PageLinks.new(@env[:response_headers])
+    end
+
+    # Iterator like each for response pages. If there are no pages to
+    # iterate over this method will return nothing.
+    def each_page
+      while page_iterator.has_next?
+        yield next_page #page_iterator.next
+      end
+    end
+
+    # Retrives the result of the first page. Returns <tt>nil</tt> if there is
+    # no first page - either because you are already on the first page
+    # or there are no pages at all in the result.
+    def first_page
+      first_request = page_iterator.first
+      self.instance_eval { @env = first_request.env } if first_request
+      first_request
+    end
+
+    # Retrives the result of the next page. Returns <tt>nil</tt> if there is
+    # no next page or no pages at all.
+    def next_page
+      next_request = page_iterator.next
+      self.instance_eval { @env = next_request.env } if next_request
+      next_request
+    end
+
+    # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
+    # no previous page or no pages at all.
+    def prev_page
+      prev_request = page_iterator.prev
+      self.instance_eval { @env = prev_request.env } if prev_request
+      prev_request
+    end
+    alias :previous_page :prev_page
+
+    # Retrives the result of the last page. Returns <tt>nil</tt> if there is
+    # no last page - either because you are already on the last page,
+    # there is only one page or there are no pages at all in the result.
+    def last_page
+      last_request = page_iterator.last
+      self.instance_eval { @env = last_request.env } if last_request
+      last_request
+    end
+
+    # Retrives a specific result for a page given page number.
+    # The <tt>page_number</tt> parameter is not validate, hitting a page
+    # that does not exist will return Github API error. Consequently, if
+    # there is only one page, this method returns nil
+    def page(page_number)
+      request = page_iterator.get_page(page_number)
+      self.instance_eval { @env = request.env } if request
+      request
+    end
+
+    # Returns <tt>true</tt> if there is another page in the result set,
+    # otherwise <tt>false</tt>
+    def has_next_page?
+      page_iterator.has_next?
+    end
+
+    # Repopulates objects for new values
+    def reset
+      nil
+    end
+
+  private
+
+    # Internally used page iterator
+    def page_iterator # :nodoc:
+      @@page_iterator = Github::PageIterator.new(@env)
     end
 
   end # Result

data/lib/github_api/utils/url.rb

@@ -0,0 +1,46 @@
+require 'cgi'
+
+module Github
+  module Utils
+    module Url
+      extend self
+
+      DEFAULT_QUERY_SEP = /[&;] */n
+
+      KEY_VALUE_SEP = '='.freeze
+
+      def escape(s) CGI.escape s.to_s end
+
+      def unescape(s) CGI.unescape s.to_s end
+
+      def parse_query(query_string)
+        return '' if query_string.nil? || query_string.empty?
+        params = {}
+
+        query_string.split(DEFAULT_QUERY_SEP).each do |part|
+          k, v = part.split(KEY_VALUE_SEP, 2).map { |el| unescape(el) }
+
+          if cur = params[k]
+            if cur.class == Array
+              params[k] << v
+            else
+              params[k] = [cur, v]
+            end
+          else
+            params[k] = v
+          end
+        end
+        params
+      end
+
+      def parse_query_for_param(query_string, name)
+        parse_query(query_string).each do |key, val|
+          return val.first if (name == key) && val.is_a?(Array)
+          return val if (name == key)
+        end
+        return nil
+      end
+
+    end # Url
+  end # Utils
+end # Github

data/lib/github_api/version.rb

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

data/spec/README.rdoc

@@ -9,6 +9,10 @@ To run the specs first run the +bundle+ command to install the necessary gems an
 
 The specs currently require Ruby 1.9.x.
 
+In order to run only features
+
+  rake features
+
 == Coverage
 
 GithubAPI will run coverage only on demand and to run it do

data/spec/github/page_iterator_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+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(: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(:instance) { Github::PageIterator.new(env) }
+
+  it { described_class::ATTRIBUTES.should_not be_nil }
+
+  context 'initialization' do
+
+    it { instance.first_page.should eq 1 }
+    it { instance.first_page_uri.should eq first }
+    it { instance.next_page.should eq 4 }
+    it { instance.next_page_uri.should eq nexxt }
+    it { instance.prev_page.should eq 2 }
+    it { instance.prev_page_uri.should eq prev }
+    it { instance.last_page.should eql 6 }
+    it { instance.last_page_uri.should eq last }
+
+  end
+
+  context 'has_next?' do
+    it "return true when next_page_uri is present" do
+      instance.has_next?.should be_true
+    end
+
+    it "returns false when next_page_uri is nil" do
+      instance.should_receive(:next_page_uri).and_return nil
+      instance.has_next?.should be_false
+    end
+  end
+
+  context 'first' do
+    before do
+      Github.new
+      instance.stub(:has_next?).and_return true
+      stub_get("/users/#{user}/repos").
+        with(:query => { 'per_page' => '20'}).
+        to_return(:body => '', :status => 200,
+          :headers => {
+            :content_type => "application/json; charset=utf-8",
+            'Link' => link
+            }
+        )
+    end
+
+    it 'returns nil if there are no more pages' do
+      instance.stub(:first_page_uri).and_return false
+      instance.first.should be_nil
+    end
+
+    it 'performs request' do
+      link.stub(:links).and_return link
+      instance.stub(:update_page_links)
+      instance.should_receive(:page_request).
+        with("https://api.github.com/users/#{user}/repos", 'per_page' => 20).
+          and_return link
+      instance.first
+    end
+  end # first
+
+  context 'next' do
+    before do
+      Github.new
+      instance.stub(:has_next?).and_return true
+      stub_get("/users/#{user}/repos").
+        with(:query => { 'page' => '4', 'per_page' => '20'}).
+        to_return(:body => '', :status => 200,
+          :headers => {
+            :content_type => "application/json; charset=utf-8",
+            'Link' => link
+            }
+        )
+    end
+
+    it 'returns nil if there are no more pages' do
+      instance.stub(:has_next?).and_return false
+      instance.next.should be_nil
+    end
+
+    it 'performs request' do
+      link.stub(:links).and_return link
+      instance.stub(:update_page_links)
+      instance.should_receive(:page_request).
+        with("https://api.github.com/users/#{user}/repos",
+          'page' => 4,'per_page' => 20).and_return link
+      instance.next
+    end
+  end # next
+
+  context 'prev' do
+    before do
+      Github.new
+      instance.stub(:has_next?).and_return true
+      stub_get("/users/#{user}/repos").
+        with(:query => { 'page' => '2', 'per_page' => '20'}).
+        to_return(:body => '', :status => 200,
+          :headers => {
+            :content_type => "application/json; charset=utf-8",
+            'Link' => link
+            }
+        )
+    end
+
+    it 'returns nil if there are no previous pages' do
+      instance.stub(:prev_page_uri).and_return false
+      instance.prev.should be_nil
+    end
+
+    it 'performs request' do
+      link.stub(:links).and_return link
+      instance.stub(:update_page_links)
+      instance.should_receive(:page_request).
+        with("https://api.github.com/users/#{user}/repos",
+          'page' => 2,'per_page' => 20).and_return link
+      instance.prev
+    end
+  end # prev
+
+  context 'last' do
+    before do
+      Github.new
+      instance.stub(:has_next?).and_return true
+      stub_get("/users/#{user}/repos").
+        with(:query => { 'page' => '6', 'per_page' => '20'}).
+        to_return(:body => '', :status => 200,
+          :headers => {
+            :content_type => "application/json; charset=utf-8",
+            'Link' => link
+            }
+        )
+    end
+
+    it 'returns nil if there is not last page' do
+      instance.stub(:last_page_uri).and_return false
+      instance.last.should be_nil
+    end
+
+    it 'performs request' do
+      link.stub(:links).and_return link
+      instance.stub(:update_page_links)
+      instance.should_receive(:page_request).
+        with("https://api.github.com/users/#{user}/repos",
+          'page' => 6,'per_page' => 20).and_return link
+      instance.last
+    end
+  end # last
+
+  context 'get_page' do
+    before do
+      Github.new
+      instance.stub(:has_next?).and_return true
+      stub_get("/users/#{user}/repos").
+        with(:query => { 'page' => '6', 'per_page' => '20'}).
+        to_return(:body => '', :status => 200,
+          :headers => {
+            :content_type => "application/json; charset=utf-8",
+            'Link' => link
+            }
+        )
+    end
+
+    it 'returns nil if there are no pages' do
+      instance.stub(:first_page_uri).and_return nil
+      instance.stub(:last_page_uri).and_return nil
+      instance.get_page(5).should be_nil
+    end
+
+    it 'finds a single page' do
+      instance.should_receive(:update_page_links)
+      instance.should_receive(:page_request).
+        with("https://api.github.com/users/#{user}/repos",
+          'page' => 2, 'per_page' => 20).and_return link
+      link.stub(:links).and_return link
+      instance.get_page(2)
+    end
+  end # get_page
+
+end # Github::PageIterator