github_api 0.8.11 → 0.9.0

data/lib/github_api/paged_request.rb

@@ -1,27 +1,30 @@
+# encoding: utf-8
+
 module Github
+
+  # A module that adds http get request to response pagination
   module PagedRequest
     include Github::Constants
 
-    extend self
-
     FIRST_PAGE = 1 # Default request page if none provided
 
     PER_PAGE   = 30 # Default number of items as specified by API
 
     NOT_FOUND  = -1 # Either page or per_page parameter not present
 
-    class << self
-      attr_accessor :page, :per_page
-    end
-
+    # Check if current api instance has default per_page param set,
+    # otherwise use global default.
+    #
     def default_page_size
-      Github.api_client.per_page ? Github.api_client.per_page : PER_PAGE
+      current_api.per_page ? current_api.per_page : PER_PAGE
     end
 
     def default_page
-      Github.api_client.page ? Github.api_client.page : FIRST_PAGE
+      current_api.page ? current_api.page : FIRST_PAGE
     end
 
+    # Perform http get request with paginatoin parameters
+    #
     def page_request(path, params={})
       if params[PARAM_PER_PAGE] == NOT_FOUND
         params[PARAM_PER_PAGE] = default_page_size
@@ -30,10 +33,7 @@ module Github
         params[PARAM_PAGE] = default_page
       end
 
-      Github::PagedRequest.page = params[PARAM_PAGE]
-      Github::PagedRequest.per_page = params[PARAM_PER_PAGE]
-
-      Github.api_client.get_request path, params
+      current_api.get_request(path, params)
     end
 
   end # PagedRequest

data/lib/github_api/{result.rb → pagination.rb}

@@ -1,87 +1,25 @@
 # encoding: utf-8
 
 module Github
-  module Result
-    include Github::Constants
-
-    # TODO Add result counts method to check total items looking at result links
-
-    # All request headers
-    def headers
-      loaded? ? @env[:response_headers] : nil
-    end
-
-    def oauth_scopes
-      loaded? ? @env[:response_headers][OAUTH_SCOPES] : nil
-    end
-
-    def accepted_oauth_scopes
-      loaded? ? @env[:response_headers][ACCEPTED_OAUTH_SCOPES] : nil
-    end
-
-    # Requests are limited to API v3 to 5000 per hour.
-    def ratelimit_limit
-      loaded? ? @env[:response_headers][RATELIMIT_LIMIT] : nil
-    end
-
-    def ratelimit_remaining
-      loaded? ? @env[:response_headers][RATELIMIT_REMAINING] : nil
-    end
-
-    def cache_control
-      loaded? ? @env[:response_headers][CACHE_CONTROL] : nil
-    end
-
-    def content_type
-      loaded? ? @env[:response_headers][CONTENT_TYPE] : nil
-    end
-
-    def content_length
-      loaded? ? @env[:response_headers][CONTENT_LENGTH] : nil
-    end
-
-    def etag
-      loaded? ? @env[:response_headers][ETAG] : nil
-    end
-
-    def date
-      loaded? ? @env[:response_headers][DATE] : nil
-    end
-
-    def location
-      loaded? ? @env[:response_headers][LOCATION] : nil
-    end
 
-    def server
-      loaded? ? @env[:response_headers][SERVER] : nil
-    end
-
-    def status
-      loaded? ? @env[:status] : nil
-    end
-
-    def success?
-      (200..299).include? status
-    end
-
-    # Returns raw body
-    def body
-      loaded? ? @env[:body] : nil
-    end
-
-    def loaded?
-      !!@env
-    end
+  # A module that decorates response with pagination helpers
+  module Pagination
+    include Github::Constants
 
     # Return page links
     def links
-      @@links = Github::PageLinks.new(@env[:response_headers])
+      @links = Github::PageLinks.new(env[:response_headers])
+    end
+
+    # Retrive number of total pages base on current :per_page parameter
+    def count_pages
+      page_iterator.count.to_i
     end
 
     # Iterator like each for response pages. If there are no pages to
-    # iterate over this method will return nothing.
+    # iterate over this method will return current page.
     def each_page
-      yield self.body
+      yield self
       while page_iterator.has_next?
         yield next_page
       end
@@ -93,7 +31,7 @@ module Github
     def first_page
       first_request = page_iterator.first
       self.instance_eval { @env = first_request.env } if first_request
-      self.body
+      first_request
     end
 
     # Retrives the result of the next page. Returns <tt>nil</tt> if there is
@@ -101,7 +39,7 @@ module Github
     def next_page
       next_request = page_iterator.next
       self.instance_eval { @env = next_request.env } if next_request
-      self.body
+      next_request
     end
 
     # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
@@ -109,7 +47,7 @@ module Github
     def prev_page
       prev_request = page_iterator.prev
       self.instance_eval { @env = prev_request.env } if prev_request
-      self.body
+      prev_request
     end
     alias :previous_page :prev_page
 
@@ -119,7 +57,7 @@ module Github
     def last_page
       last_request = page_iterator.last
       self.instance_eval { @env = last_request.env } if last_request
-      self.body
+      last_request
     end
 
     # Retrives a specific result for a page given page number.
@@ -129,7 +67,7 @@ module Github
     def page(page_number)
       request = page_iterator.get_page(page_number)
       self.instance_eval { @env = request.env } if request
-      self.body
+      request
     end
 
     # Returns <tt>true</tt> if there is another page in the result set,
@@ -138,17 +76,12 @@ module Github
       page_iterator.has_next?
     end
 
-    # Repopulates objects for new values
-    def reset
-      nil
-    end
-
-  private
+    private
 
     # Internally used page iterator
     def page_iterator # :nodoc:
-      @@page_iterator = Github::PageIterator.new(@env)
+      @page_iterator = Github::PageIterator.new(links, current_api)
     end
 
-  end # Result
+  end # Pagination
 end # Github

data/lib/github_api/params_hash.rb

@@ -3,7 +3,7 @@ module Github
 
     def initialize(*args, &block)
       hash = args.extract_options!
-      debugger
+      # debugger
       # debugger
       # normalize_keys!(hash)
       # debugger

data/lib/github_api/pull_requests.rb

@@ -23,14 +23,9 @@ module Github
       'state' => %w[ open closed ]
     }
 
-    # Creates new Gists API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Access to PullRequests::Comments API
-    def comments
-      @comments ||= ApiFactory.new 'PullRequests::Comments'
+    def comments(options={}, &block)
+      @comments ||= ApiFactory.new('PullRequests::Comments', current_options.merge(options), &block)
     end
 
     # List pull requests

data/lib/github_api/repos.rb

@@ -41,64 +41,59 @@ module Github
 
     VALID_REPO_TYPES = %w[ all public private member ].freeze
 
-    # Creates new Repositories API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Access to Repos::Collaborators API
-    def collaborators
-      @collaborators ||= ApiFactory.new 'Repos::Collaborators'
+    def collaborators(options={}, &block)
+      @collaborators ||= ApiFactory.new('Repos::Collaborators', current_options.merge(options), &block)
     end
 
     # Access to Repos::Comments API
-    def comments
-      @commits ||= ApiFactory.new 'Repos::Comments'
+    def comments(options={}, &block)
+      @commits ||= ApiFactory.new('Repos::Comments', current_options.merge(options), &block)
     end
 
     # Access to Repos::Commits API
-    def commits
-      @commits ||= ApiFactory.new 'Repos::Commits'
+    def commits(options={}, &block)
+      @commits ||= ApiFactory.new('Repos::Commits', current_options.merge(options), &block)
     end
 
     # Access to Repos::Contents API
-    def contents
-      @contents ||= ApiFactory.new 'Repos::Contents'
+    def contents(options={}, &block)
+      @contents ||= ApiFactory.new('Repos::Contents', current_options.merge(options), &block)
     end
 
     # Access to Repos::Downloads API
-    def downloads
-      @downloads ||= ApiFactory.new 'Repos::Downloads'
+    def downloads(options={}, &block)
+      @downloads ||= ApiFactory.new('Repos::Downloads', current_options.merge(options), &block)
     end
 
     # Access to Repos::Forks API
-    def forks
-      @forks ||= ApiFactory.new 'Repos::Forks'
+    def forks(options={}, &block)
+      @forks ||= ApiFactory.new('Repos::Forks', current_options.merge(options), &block)
     end
 
     # Access to Repos::Hooks API
-    def hooks
-      @hooks ||= ApiFactory.new 'Repos::Hooks'
+    def hooks(options={}, &block)
+      @hooks ||= ApiFactory.new('Repos::Hooks', current_options.merge(options), &block)
     end
 
     # Access to Repos::Keys API
-    def keys
-      @keys ||= ApiFactory.new 'Repos::Keys'
+    def keys(options={}, &block)
+      @keys ||= ApiFactory.new('Repos::Keys', current_options.merge(options), &block)
     end
 
     # Access to Repos::Merging API
-    def merging
-      @mergin ||= ApiFactory.new 'Repos::Merging'
+    def merging(options={}, &block)
+      @mergin ||= ApiFactory.new('Repos::Merging', current_options.merge(options), &block)
     end
 
     # Access to Repos::Watchin API
-    def pubsubhubbub
-      @pubsubhubbub ||= ApiFactory.new 'Repos::PubSubHubbub'
+    def pubsubhubbub(options={}, &block)
+      @pubsubhubbub ||= ApiFactory.new('Repos::PubSubHubbub', current_options.merge(options), &block)
     end
 
     # Access to Repos::Statuses API
-    def statuses
-      @statuses ||= ApiFactory.new 'Repos::Statuses'
+    def statuses(options={}, &block)
+      @statuses ||= ApiFactory.new('Repos::Statuses', current_options.merge(options), &block)
     end
 
     # List branches

data/lib/github_api/request.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Github
+
   # Defines HTTP verbs
   module Request
 
@@ -27,7 +28,7 @@ module Github
       request(:delete, path, params, options)
     end
 
-    def request(method, path, params, options)
+    def request(method, path, params, options) # :nodoc:
       if !METHODS.include?(method)
         raise ArgumentError, "unkown http method: #{method}"
       end
@@ -35,8 +36,10 @@ module Github
 
       puts "EXECUTED: #{method} - #{path} with #{params} and #{options}" if ENV['DEBUG']
 
-      conn = connection(options)
-      path = (conn.path_prefix + path).gsub(/\/\//,'/') if conn.path_prefix != '/'
+      conn = connection(options.merge(current_options))
+      if conn.path_prefix != '/' && path.index(conn.path_prefix) != 0
+        path = (conn.path_prefix + path).gsub(/\/(\/)*/, '/')
+      end
 
       response = conn.send(method) do |request|
         case method.to_sym
@@ -48,7 +51,7 @@ module Github
           request.body = extract_data_from_params(params) unless params.empty?
         end
       end
-      response.body
+      ResponseWrapper.new(response, self)
     end
 
     private

data/lib/github_api/response/header.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+module Github
+  class Response
+
+    # Represents http response header
+    class Header < Struct.new(:env)
+      include Github::Constants
+
+      SUCCESSFUL_STATUSES = 200..299
+
+      def loaded?
+        !!env
+      end
+
+      def oauth_scopes
+        loaded? ? env[:response_headers][OAUTH_SCOPES] : nil
+      end
+
+      def accepted_oauth_scopes
+        loaded? ? env[:response_headers][ACCEPTED_OAUTH_SCOPES] : nil
+      end
+
+      # Requests are limited to API v3 to 5000 per hour.
+      def ratelimit_limit
+        loaded? ? env[:response_headers][RATELIMIT_LIMIT] : nil
+      end
+
+      def ratelimit_remaining
+        loaded? ? env[:response_headers][RATELIMIT_REMAINING] : nil
+      end
+
+      def cache_control
+        loaded? ? env[:response_headers][CACHE_CONTROL] : nil
+      end
+
+      def content_type
+        loaded? ? env[:response_headers][CONTENT_TYPE] : nil
+      end
+
+      def content_length
+        loaded? ? env[:response_headers][CONTENT_LENGTH] : nil
+      end
+
+      def etag
+        loaded? ? env[:response_headers][ETAG] : nil
+      end
+
+      def date
+        loaded? ? env[:response_headers][DATE] : nil
+      end
+
+      def location
+        loaded? ? env[:response_headers][LOCATION] : nil
+      end
+
+      def server
+        loaded? ? env[:response_headers][SERVER] : nil
+      end
+
+      def status
+        loaded? ? env[:status] : nil
+      end
+
+      def success?
+        SUCCESSFUL_STATUSES.include? status
+      end
+
+      # Returns raw body
+      def body
+        loaded? ? env[:body] : nil
+      end
+
+    end # Header
+  end # Response
+end # Github

data/lib/github_api/response_wrapper.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+module Github
+
+  # A class responsible for proxing to faraday response
+  class ResponseWrapper
+    extend Forwardable
+    include Pagination
+    include Enumerable
+
+    attr_reader :response
+
+    attr_reader :current_api
+
+    attr_reader :env
+
+    def_delegators :body, :empty?, :size, :include?, :length, :to_a, :first, :flatten, :include?, :keys, :[]
+
+    def initialize(response, current_api)
+      @response    = response
+      @current_api = current_api
+      @env         = response.env
+    end
+
+    # Request url
+    #
+    def url
+      response.env[:url].to_s
+    end
+
+    # Response raw body
+    #
+    def body
+      response.body
+    end
+
+    # Response status
+    #
+    def status
+      response.status
+    end
+
+    def success?
+      response.success?
+    end
+
+    # Return response headers
+    #
+    def headers
+      Github::Response::Header.new(env)
+    end
+
+    # Lookup an attribute from the body.
+    # Convert any key to string before calling.
+    #
+    def [](key)
+      self.body.send(:"#{key}")
+    end
+
+    # Return response body as string
+    #
+    def to_s
+      body.to_s
+    end
+
+    # Convert the ResponseWrapper into a Hash
+    #
+    def to_hash
+      body.to_hash
+    end
+
+    # Convert the ResponseWrapper into an Array
+    #
+    def to_ary
+      body.to_ary
+    end
+
+    # Iterate over each resource inside the body
+    #
+    def each
+      body_parts = self.body.respond_to?(:each) ? self.body : [self.body]
+      return body_parts.to_enum unless block_given?
+      body_parts.each { |part| yield(part) }
+    end
+
+    # Check if body has an attribute
+    #
+    def has_key?(key)
+      !self.body.is_a?(Array) && self.body.has_key?(key)
+    end
+
+    # Coerce any method calls for body attributes
+    #
+    def method_missing(method_name, *args, &block)
+      if self.has_key?(method_name.to_s)
+        self.[](method_name, &block)
+      else
+        super
+      end
+    end
+
+    # Check if method is defined on the body
+    #
+    def respond_to?(method_name)
+      if self.has_key?(method_name.to_s)
+        true
+      else
+        super
+      end
+    end
+
+    # Print only response body
+    #
+    def inspect
+      "#<#{self.class.name} @body=\"#{self.body}\">"
+    end
+
+    # Compare the wrapper with other wrapper for equality
+    #
+    def ==(other)
+      self.env == other.env &&
+      self.body == other.body
+    end
+
+  end # ResponseWrapper
+end # Github