github_api 0.3.9 → 0.4.0

data/features/cassettes/repos/teams.yml

@@ -0,0 +1,38 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.github.com:443/repos/peter-murach/github/teams
+    body: 
+    headers: 
+      accept-encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 404
+      message: Not Found
+    headers: 
+      server: 
+      - nginx/1.0.4
+      date: 
+      - Tue, 03 Jan 2012 16:15:19 GMT
+      content-type: 
+      - application/json; charset=utf-8
+      transfer-encoding: 
+      - chunked
+      connection: 
+      - keep-alive
+      status: 
+      - 404 Not Found
+      x-ratelimit-limit: 
+      - "5000"
+      etag: 
+      - "\"e66a7a6c91e2c26803f3f49feb7a883f\""
+      x-ratelimit-remaining: 
+      - "4997"
+      content-encoding: 
+      - gzip
+    body: !binary |
+      H4sIAAAAAAAAA6tWyk0tLk5MT1WyUvLLL1Fwyy/NS1GqBQB8+Ys1FwAAAA==
+
+    http_version: "1.1"

data/features/repos.feature

@@ -0,0 +1,28 @@
+Feature: Accessing Repos Main API
+  In order to interact with github repositories
+  GithubAPI gem
+  Should return the expected results depending on passed parameters
+
+  Scenario: Returning all repository branches
+    Given I have "Github::Repos" instance
+    And I am looking for "branches" with the following params:
+      | user          | repo   |
+      | peter-murach  | github |
+    And I make request within a cassette named "repos/branches"
+    Then the response should be "200"
+
+  Scenario: Returning all repository tags
+    Given I have "Github::Repos" instance
+    And I am looking for "tags" with the following params:
+      | user          | repo   |
+      | peter-murach  | github |
+    And I make request within a cassette named "repos/tags"
+    Then the response should be "200"
+
+  Scenario: Returning all repositories for the user
+    Given I have "Github::Repos" instance
+    And I am looking for "list_repos" with the following params:
+      | user          |
+      | peter-murach  |
+    And I make request with hash params within a cassette named "repos/tags"
+    Then the response should be "200"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,11 @@
+Before do
+  step "I have github instance"
+end
+
+When /^(.*) within a cassette named "([^"]*)"$/ do |step_to_call, cassette_name|
+  VCR.use_cassette(cassette_name) { step step_to_call }
+end
+
+Then /^the response should be "([^"]*)"$/ do |expected_response|
+  @response.status.should eql expected_response.to_i
+end

data/features/step_definitions/github_api_steps.rb

@@ -2,6 +2,14 @@ Given /^I have github instance$/ do
   @github = Github.new
 end
 
+Given /^I have "([^"]*)" instance$/ do |api_classes|
+  constant = Object
+  api_classes.split('::').each do |api_class|
+    constant = constant.const_get api_class
+  end
+  @instance = constant.new
+end
+
 When /^I fetch "([^"]*)"$/ do |method|
   @response = @github.send(method.to_sym)
 end
@@ -9,3 +17,18 @@ end
 When /^I will have access to "([^"]*)" API$/ do |api|
   @response.class.to_s.should match api
 end
+
+When /^I am looking for "([^"]*)" with the following params:$/ do |method, table|
+  table.hashes.each do |attributes|
+    @method = method.to_sym
+    @attributes = attributes
+  end
+end
+
+When /^I make request$/ do
+  @response = @instance.send @method, *@attributes.values
+end
+
+When /^I make request with hash params$/ do
+  @response = @instance.send @method, @attributes
+end

data/features/support/vcr.rb

@@ -1,6 +1,12 @@
+require 'vcr'
+
 VCR.config do |conf|
   conf.stub_with :webmock
   conf.cassette_library_dir = 'features/cassettes'
   conf.default_cassette_options = { :record => :new_episodes }
   conf.filter_sensitive_data('<***>') { ''}
 end
+
+VCR.cucumber_tags do |t|
+  t.tag '@live', :record => :all
+end

data/lib/github_api.rb

@@ -2,6 +2,8 @@
 
 require 'github_api/version'
 require 'github_api/configuration'
+require 'github_api/constants'
+require 'github_api/utils/url'
 require 'github_api/connection'
 
 module Github
@@ -12,7 +14,12 @@ module Github
     #
     # @return [Github::Client]
     def new(options = {}, &block)
-      Github::Client.new(options, &block)
+      @@api_client = Github::Client.new(options, &block)
+    end
+
+    # Returns handle for the client instance
+    def api_client
+      @@api_client
     end
 
     # Delegate to Github::Client
@@ -68,6 +75,9 @@ module Github
     :CoreExt      => 'core_ext',
     :MimeType     => 'mime_type',
     :Authorization => 'authorization',
-    :Authorizations => 'authorizations'
+    :Authorizations => 'authorizations',
+    :PageLinks    => 'page_links',
+    :PageIterator => 'page_iterator',
+    :PagedRequest => 'paged_request'
 
 end # Github

data/lib/github_api/api.rb

@@ -18,8 +18,9 @@ module Github
     include Request
 
     VALID_API_KEYS = [
-      :per_page,
-      :pagination
+      'page',
+      'per_page',
+      'jsonp_callback'
     ]
 
     attr_reader *Configuration::VALID_OPTIONS_KEYS
@@ -61,10 +62,13 @@ module Github
       end
     end
 
-    # Responds to attribute query
+    # Responds to attribute query or attribute clear
     def method_missing(method, *args, &block) # :nodoc:
-      if method.to_s =~ /^(.*)\?$/
+      case method.to_s
+      when /^(.*)\?$/
         return !self.send($1.to_s).nil?
+      when /^clear_(.*)$/
+        self.send("#{$1.to_s}=", nil)
       else
         super
       end
@@ -123,7 +127,7 @@ module Github
       case params
       when Hash
         params.keys.each do |k, v|
-          unless keys.include? k
+          unless (keys.include?(k) or VALID_API_KEYS.include?(k))
             params.delete(k)
           else
             _filter_params_keys(keys, params[k])

data/lib/github_api/connection.rb

@@ -25,9 +25,9 @@ module Github
     def default_options(options={}) # :nodoc:
       {
         :headers => {
-          'Accept'       => '*/*', #accepts,
-          'User-Agent'   => user_agent,
-          'Content-Type' => 'application/x-www-form-urlencoded'
+          :accept       => '*/*', #accepts,
+          :user_agent   => user_agent,
+          :content_type => 'application/x-www-form-urlencoded'
         },
         :ssl => { :verify => false },
         :url => endpoint
@@ -49,7 +49,7 @@ module Github
 
       @connection ||= begin
         Faraday.new(merged_options.merge(connection_options)) do |builder|
-          puts options.inspect
+          puts options.inspect if ENV['DEBUG']
 
           builder.use Faraday::Request::JSON
           builder.use Faraday::Request::Multipart

data/lib/github_api/constants.rb

@@ -0,0 +1,38 @@
+module Github
+  module Constants
+    extend self
+
+    # Response headers
+    RATELIMIT_REMAINING = 'X-RateLimit-Remaining'.freeze
+
+    RATELIMIT_LIMIT = 'X-RateLimit-Limit'.freeze
+
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    CONTENT_LENGTH = 'content-length'.freeze
+
+    # Link headers
+    HEADER_LINK = "Link".freeze
+
+    HEADER_NEXT = "X-Next".freeze
+
+    HEADER_LAST = "X-Last".freeze
+
+    META_REL = "rel".freeze
+
+    META_LAST = "last".freeze
+
+    META_NEXT = "next".freeze
+
+    META_FIRST = "first".freeze
+
+    META_PREV = "prev".freeze
+
+    PARAM_PAGE = "page".freeze
+
+    PARAM_PER_PAGE = "per_page".freeze
+
+    PARAM_START_PAGE = "start_page".freeze
+
+  end # Constants
+end # Github

data/lib/github_api/error.rb

@@ -5,7 +5,7 @@ module Github
     attr_reader :response_message, :response_headers
 
     def initialize(message, headers)
-      @response_message = message 
+      @response_message = message
       super message
     end
 
@@ -21,11 +21,14 @@ module Github
   class Unauthorised < Error; end
 
   # Raised when Github returns the HTTP status code 403
-  class Forbidden < Error; end 
+  class Forbidden < Error; end
 
   # Raised when Github returns the HTTP status code 404
   class ResourceNotFound < Error; end
 
+  # Raised when Github returns the HTTP status code 422
+  class UnprocessableEntity < Error; end
+
   # Raised when Github returns the HTTP status code 500
   class InternalServerError < Error; end
 

data/lib/github_api/page_iterator.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+require 'github_api/utils/url'
+
+module Github
+  class PageIterator
+    include Github::Constants
+    include Github::Utils::Url
+    include Github::PagedRequest
+
+    # Query string separator
+    QUERY_STR_SEP = '?'.freeze
+
+    # Setup attribute accesor for all the link types
+    ATTRIBUTES = [ META_FIRST, META_NEXT, META_PREV, META_LAST ]
+
+    ATTRIBUTES.each do |attr|
+      attr_accessor :"#{attr}_page_uri", :"#{attr}_page"
+    end
+
+    def initialize(env)
+      @links = Github::PageLinks.new(env[:response_headers])
+      update_page_links @links
+    end
+
+    def has_next?
+      next_page == 0 || !next_page_uri.nil?
+    end
+
+    def first
+      return nil unless first_page_uri
+      response = page_request first_page_uri.split(QUERY_STR_SEP)[0],
+                              'per_page' => parse_per_page_number(first_page_uri)
+      update_page_links response.links
+      response
+    end
+
+    def next
+      return nil unless has_next?
+
+      response = page_request next_page_uri.split(QUERY_STR_SEP)[0],
+                                'page' => next_page,
+                                'per_page'=> parse_per_page_number(next_page_uri)
+      update_page_links response.links
+      response
+    end
+
+    def prev
+      return nil unless prev_page_uri
+      response = page_request prev_page_uri.split(QUERY_STR_SEP)[0],
+                              'page' => prev_page,
+                              'per_page'=> parse_per_page_number(prev_page_uri)
+      update_page_links response.links
+      response
+    end
+
+    def last
+      return nil unless last_page_uri
+      response = page_request last_page_uri.split(QUERY_STR_SEP)[0],
+                              'page' => last_page,
+                              'per_page' => parse_per_page_number(last_page_uri)
+      update_page_links response.links
+      response
+    end
+
+    # Returns the result for a specific page.
+    def get_page(page_number)
+      # Find URI that we can work with, if we cannot get the first or the
+      # last page URI then there is only one page.
+      page_uri = first_page_uri || last_page_uri
+      return nil unless page_uri
+
+      response = page_request page_uri.split(QUERY_STR_SEP)[0],
+                              'page' => page_number,
+                              'per_page' => parse_per_page_number(page_uri)
+      update_page_links response.links
+      response
+    end
+
+
+  private
+
+    def parse_per_page_number(uri) # :nodoc:
+      parse_page_params(uri, PARAM_PER_PAGE)
+    end
+
+    def parse_page_number(uri) # :nodoc:
+      parse_page_params(uri, PARAM_PAGE)
+    end
+
+    # Extracts query string parameter for given name
+    def parse_page_params(uri, attr) # :nodoc:
+      return -1 if uri.nil? || uri.empty?
+      parsed = nil
+      begin
+        parsed = URI.parse(uri)
+      rescue URI::Error => e
+        return -1
+      end
+      param = parse_query_for_param(parsed.query, attr)
+      return -1 if param.nil? || param.empty?
+      begin
+        return param.to_i
+      rescue ArgumentError => err
+        return -1
+      end
+    end
+
+    # Wholesale update of all link attributes
+    def update_page_links(links) # :nodoc:
+      ATTRIBUTES.each do |attr|
+        self.send(:"#{attr}_page_uri=", links.send(:"#{attr}"))
+        self.send(:"#{attr}_page=", parse_page_number(links.send(:"#{attr}")))
+      end
+    end
+
+  end # PageIterator
+end # Github

data/lib/github_api/page_links.rb

@@ -0,0 +1,45 @@
+module Github
+  # Determines the links in the current response link header to be used
+  # to find the links to other pages of request responses. These will
+  # only be present if the result set size exceeds the per page limit.
+  class PageLinks
+    include Github::Constants
+
+    DELIM_LINKS = ",".freeze # :nodoc:
+
+    # Hold the extracted values for URI from the Link header
+    # for the first, last, next and previous page.
+    attr_accessor :first, :last, :next, :prev
+
+    # Parses links from executed request
+    #
+    def initialize(response_headers)
+      link_header = response_headers[HEADER_LINK]
+      if link_header
+        return unless link_header =~ /(next|first|last|prev)/
+
+        link_header.split(DELIM_LINKS).each do |link|
+          if link.strip =~ /<([^>]+)>; rel=\"([^\"]+)\"/
+            url_part, meta_part = $1, $2
+            next if !url_part || !meta_part
+            case meta_part
+            when META_FIRST
+              self.first = url_part
+            when META_LAST
+              self.last = url_part
+            when META_NEXT
+              self.next = url_part
+            when META_PREV
+              self.prev = url_part
+            end
+          end
+        end
+      else
+        # When on the first page
+        self.next = response_headers[HEADER_NEXT]
+        self.last = response_headers[HEADER_LAST]
+      end
+    end
+
+  end # PageLinks
+end # Github