github_api 0.8.11 → 0.9.0

data/lib/github_api/configuration.rb

@@ -74,7 +74,13 @@ module Github
     end
 
     def self.extended(base)
-      base.set_defaults
+      base.reset!
+    end
+
+    class << self
+      def keys
+        VALID_OPTIONS_KEYS
+      end
     end
 
     def options
@@ -83,7 +89,9 @@ module Github
       options
     end
 
-    def set_defaults
+    # Reset configuration options to their defaults
+    #
+    def reset!
       self.adapter            = DEFAULT_ADAPTER
       self.client_id          = DEFAULT_CLIENT_ID
       self.client_secret      = DEFAULT_CLIENT_SECRET

data/lib/github_api/connection.rb

@@ -4,8 +4,8 @@ require 'faraday'
 require 'github_api/response'
 require 'github_api/response/mashify'
 require 'github_api/response/jsonize'
-require 'github_api/response/helpers'
 require 'github_api/response/raise_error'
+require 'github_api/response/header'
 require 'github_api/request/oauth2'
 require 'github_api/request/basic_auth'
 require 'github_api/request/jsonize'
@@ -51,7 +51,6 @@ module Github
         builder.use Github::Request::BasicAuth, authentication if basic_authed?
 
         builder.use Faraday::Response::Logger if ENV['DEBUG']
-        builder.use Github::Response::Helpers
         unless options[:raw]
           builder.use Github::Response::Mashify
           builder.use Github::Response::Jsonize
@@ -88,7 +87,7 @@ module Github
 
     # Returns a Fraday::Connection object
     #
-    def connection(options = {})
+    def connection(options={})
       conn_options = default_options(options)
       clear_cache unless options.empty?
       puts "OPTIONS:#{conn_options.inspect}" if ENV['DEBUG']

data/lib/github_api/constants.rb

@@ -54,9 +54,6 @@ module Github
 
     PARAM_START_PAGE = "start_page".freeze
 
-    # URI parsing
-    QUERY_STR_SEP = '?'.freeze
-
 
   end # Constants
 end # Github

data/lib/github_api/gists.rb

@@ -14,14 +14,9 @@ module Github
       content
     ].freeze
 
-    # Creates new Gists API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Access to Gists::Comments API
-    def comments
-      @comments ||= ApiFactory.new 'Gists::Comments'
+    def comments(options={}, &block)
+      @comments ||= ApiFactory.new('Gists::Comments', current_options.merge(options), &block)
     end
 
     # List a user's gists.

data/lib/github_api/git_data.rb

@@ -11,34 +11,29 @@ module Github
       :Tags       => 'tags',
       :Trees      => 'trees'
 
-    # Creates new GitData API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Access to GitData::Blobs API
-    def blobs
-      @blobs ||= ApiFactory.new 'GitData::Blobs'
+    def blobs(options={}, &block)
+      @blobs ||= ApiFactory.new('GitData::Blobs', current_options.merge(options), &block)
     end
 
     # Access to GitData::Commits API
-    def commits
-      @commits ||= ApiFactory.new 'GitData::Commits'
+    def commits(options={}, &block)
+      @commits ||= ApiFactory.new('GitData::Commits', current_options.merge(options), &block)
     end
 
     # Access to GitData::References API
-    def references
-      @references ||= ApiFactory.new 'GitData::References'
+    def references(options={}, &block)
+      @references ||= ApiFactory.new('GitData::References', current_options.merge(options), &block)
     end
 
     # Access to GitData::Tags API
-    def tags
-      @tags ||= ApiFactory.new 'GitData::Tags'
+    def tags(options={}, &block)
+      @tags ||= ApiFactory.new('GitData::Tags', current_options.merge(options), &block)
     end
 
     # Access to GitData::Tags API
-    def trees
-      @trees ||= ApiFactory.new 'GitData::Trees'
+    def trees(options={}, &block)
+      @trees ||= ApiFactory.new('GitData::Trees', current_options.merge(options), &block)
     end
 
   end # GitData

data/lib/github_api/git_data/blobs.rb

@@ -8,11 +8,6 @@ module Github
 
     VALID_BLOB_PARAM_NAMES = %w[ content encoding ].freeze
 
-    # Creates new GitData::Blobs API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Get a blob
     #
     # = Examples

data/lib/github_api/git_data/commits.rb

@@ -20,11 +20,6 @@ module Github
       parents
     ].freeze
 
-    # Creates new GitData::Commits API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Get a commit
     #
     # = Examples

data/lib/github_api/git_data/references.rb

@@ -9,11 +9,6 @@ module Github
       'ref' => %r{^refs\/\w+(\/\w+)*} # test fully qualified reference
     }
 
-    # Creates new GitData::References API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Get all references
     #
     # This will return an array of all the references on the system,
@@ -130,8 +125,9 @@ module Github
 
   private
 
-    def validate_reference ref
-      refs = ref.start_with?('ref/') ? ref : "refs/#{ref}"
+    def validate_reference(ref)
+      refs = (ref =~ (/^(\/)?refs.*/) ? ref : "refs/#{ref}").gsub(/(\/)+/, '/')
+      refs.gsub!(/^\//, '')
       unless VALID_REF_PARAM_VALUES['ref'] =~ refs
         raise ArgumentError, "Provided 'reference' is invalid"
       end

data/lib/github_api/git_data/tags.rb

@@ -22,11 +22,6 @@ module Github
       'type' => %w[ blob tree commit ]
     }
 
-    # Creates new GitData::Tags API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Get a tag
     #
     # = Examples

data/lib/github_api/git_data/trees.rb

@@ -19,11 +19,6 @@ module Github
       'type' => %w[ blob tree commit ]
     }
 
-    # Creates new GitData::Trees API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Get a tree
     #
     # = Examples

data/lib/github_api/gitignore.rb

@@ -6,11 +6,6 @@ module Github
   # .gitignore template to apply to the repository upon creation.
   class Gitignore < API
 
-    # Creates new Gitignore API
-    def initialize(options = {})
-      super(options)
-    end
-
     # List all templates available to pass as an option when creating a repository.
     #
     # = Examples

data/lib/github_api/issues.rb

@@ -36,34 +36,29 @@ module Github
       'since'     => %r{\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z}
     }
 
-    # Creates new Issues API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Access to Issues::Assignees API
-    def assignees
-      @assignees ||= ApiFactory.new 'Issues::Assignees'
+    def assignees(options={}, &block)
+      @assignees ||= ApiFactory.new('Issues::Assignees', current_options.merge(options), &block)
     end
 
     # Access to Issues::Comments API
-    def comments
-      @comments ||= ApiFactory.new 'Issues::Comments'
+    def comments(options={}, &block)
+      @comments ||= ApiFactory.new('Issues::Comments', current_options.merge(options), &block)
     end
 
     # Access to Issues::Events API
-    def events
-      @events ||= ApiFactory.new 'Issues::Events'
+    def events(options={}, &block)
+      @events ||= ApiFactory.new('Issues::Events', current_options.merge(options), &block)
     end
 
     # Access to Issues::Comments API
-    def labels
-      @labels ||= ApiFactory.new 'Issues::Labels'
+    def labels(options={}, &block)
+      @labels ||= ApiFactory.new('Issues::Labels', current_options.merge(options), &block)
     end
 
     # Access to Issues::Comments API
-    def milestones
-      @milestones ||= ApiFactory.new 'Issues::Milestones'
+    def milestones(options={}, &block)
+      @milestones ||= ApiFactory.new('Issues::Milestones', current_options.merge(options), &block)
     end
 
     # List your issues

data/lib/github_api/issues/comments.rb

@@ -9,11 +9,6 @@ module Github
       mime_type
     ].freeze
 
-    # Creates new Issues::Comments API
-    def initialize(options = {})
-      super(options)
-    end
-
     # List comments on an issue
     #
     # = Examples

data/lib/github_api/issues/events.rb

@@ -3,11 +3,6 @@
 module Github
   class Issues::Events < API
 
-    # Creates new Issues::Events API
-    def initialize(options = {})
-      super(options)
-    end
-
     # List events for an issue
     #
     # = Examples

data/lib/github_api/issues/labels.rb

@@ -5,11 +5,6 @@ module Github
 
     VALID_LABEL_INPUTS = %w[ name color ].freeze
 
-    # Creates new Issues::Labels API
-    def initialize(options = {})
-      super(options)
-    end
-
     # List all labels for a repository
     #
     # = Examples

data/lib/github_api/issues/milestones.rb

@@ -16,11 +16,6 @@ module Github
       due_on
     ].freeze # :nodoc:
 
-    # Creates new Issues::Milestones API
-    def initialize(options = {})
-      super(options)
-    end
-
     # List milestones for a repository
     #
     # = Parameters

data/lib/github_api/markdown.rb

@@ -3,11 +3,6 @@
 module Github
   class Markdown < API
 
-    # Creates new Markdown API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Render an arbritrary Markdown document
     #
     # = Parameters

data/lib/github_api/meta.rb

@@ -3,11 +3,6 @@
 module Github
   class Meta < API
 
-    # Creates new Search API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Get meta information about GitHub.com, the service.
     #
     # = Examples

data/lib/github_api/orgs.rb

@@ -16,19 +16,14 @@ module Github
       name
     ].freeze
 
-    # Creates new Orgs API
-    def initialize(options = {})
-      super(options)
-    end
-
     # Access to Orgs::Members API
-    def members
-      @members ||= ApiFactory.new 'Orgs::Members'
+    def members(options={}, &block)
+      @members ||= ApiFactory.new('Orgs::Members', current_options.merge(options), &block)
     end
 
     # Access to Orgs::Teams API
-    def teams
-      @teams ||= ApiFactory.new 'Orgs::Teams'
+    def teams(options={}, &block)
+      @teams ||= ApiFactory.new('Orgs::Teams', current_options.merge(options), &block)
     end
 
     # List all public organizations for a user.

data/lib/github_api/page_iterator.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'github_api/utils/url'
+require 'uri'
 
 module Github
   class PageIterator
@@ -15,8 +16,11 @@ module Github
       attr_accessor :"#{attr}_page_uri", :"#{attr}_page"
     end
 
-    def initialize(env)
-      @links = Github::PageLinks.new(env[:response_headers])
+    attr_reader :current_api
+
+    def initialize(links, current_api)
+      @links       = links
+      @current_api = current_api
       update_page_links @links
     end
 
@@ -24,78 +28,89 @@ module Github
       next_page == 0 || !next_page_uri.nil?
     end
 
+    def count
+      return nil unless last_page_uri
+      parse_query(URI(last_page_uri).query)['page']
+    end
+
+    # Perform http get request for the first resource
+    #
     def first
       return nil unless first_page_uri
-
-      response = if next_page < 1
-        parsed_query = parse_query(first_page_uri.split(QUERY_STR_SEP).last)
-        params = {}
-        if parsed_query.keys.include?('sha')
-          params['sha'] = 'master'
-        end
+      page_uri = URI(first_page_uri)
+      params = parse_query(page_uri.query)
+      if next_page < 1
+        params['sha'] = 'master' if params.keys.include?('sha')
         params['per_page'] = parse_per_page_number(first_page_uri)
-
-        page_request first_page_uri.split(QUERY_STR_SEP).first, params
       else
-        page_request first_page_uri.split(QUERY_STR_SEP).first,
-                           'per_page' => parse_per_page_number(first_page_uri)
+        params['page']     = parse_page_number(first_page_uri)
+        params['per_page'] = parse_per_page_number(first_page_uri)
       end
 
+      response = page_request(page_uri.path, params)
       update_page_links response.links
       response
     end
 
+    # Perform http get request for the next resource
+    #
     def next
       return nil unless has_next?
-
-      response = if next_page < 1
-        params = parse_query next_page_uri.split(QUERY_STR_SEP).last
+      page_uri = URI(next_page_uri)
+      params   = parse_query(page_uri.query)
+      if next_page < 1
         params['sha'] = params['last_sha'] if params.keys.include?('last_sha')
         params['per_page'] = parse_per_page_number(next_page_uri)
-        page_request next_page_uri.split(QUERY_STR_SEP).first, params
       else
-        params = parse_query next_page_uri.split(QUERY_STR_SEP).last
-        params['page'] = parse_page_number(next_page_uri)
+        params['page']     = parse_page_number(next_page_uri)
         params['per_page'] = parse_per_page_number(next_page_uri)
-        page_request next_page_uri.split(QUERY_STR_SEP).first, params
       end
+
+      response = page_request(page_uri.path, params)
       update_page_links response.links
       response
     end
 
+    # Perform http get request for the previous resource
+    #
     def prev
       return nil unless prev_page_uri
-      params   = parse_query prev_page_uri.split(QUERY_STR_SEP).last
-      params['page'] = parse_page_number(prev_page_uri)
+      page_uri = URI(prev_page_uri)
+      params = parse_query(page_uri.query)
+      params['page']     = parse_page_number(prev_page_uri)
       params['per_page'] = parse_per_page_number(prev_page_uri)
-      response = page_request prev_page_uri.split(QUERY_STR_SEP).first, params
 
+      response = page_request(page_uri.path, params)
       update_page_links response.links
       response
     end
 
+    # Perform http get request for the last resource
+    #
     def last
       return nil unless last_page_uri
-      params   = parse_query last_page_uri.split(QUERY_STR_SEP).last
-      params['page'] = parse_page_number(last_page_uri)
+      page_uri = URI(last_page_uri)
+      params = parse_query(page_uri.query)
+      params['page']     = parse_page_number(last_page_uri)
       params['per_page'] = parse_per_page_number(last_page_uri)
-      response = page_request last_page_uri.split(QUERY_STR_SEP).first, params
 
+      response = page_request(page_uri.path, params)
       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
-      params   = parse_query page_uri.split(QUERY_STR_SEP).last
-      params['page'] = page_number
+      params = parse_query URI(page_uri).query
+      params['page']     = page_number
       params['per_page'] = parse_per_page_number(page_uri)
-      response = page_request page_uri.split(QUERY_STR_SEP).first, params
 
+      response = page_request URI(page_uri).path, params
       update_page_links response.links
       response
     end