github_api 0.7.1 → 0.7.2

data/lib/github_api/page_iterator.rb

@@ -95,10 +95,11 @@ module Github
       # 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['per_page'] = parse_per_page_number(page_uri)
+      response = page_request page_uri.split(QUERY_STR_SEP).first, params
 
-      response = page_request page_uri.split(QUERY_STR_SEP).first,
-                              'page' => page_number,
-                              'per_page' => parse_per_page_number(page_uri)
       update_page_links response.links
       response
     end

data/lib/github_api/pull_requests.rb

@@ -44,7 +44,7 @@ module Github
     #  pull_reqs.pull_requests.list 'user-name', 'repo-name'
     #
     def list(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -68,7 +68,7 @@ module Github
     #  @pull_reqs.get 'user-name', 'repo-name', 'request-id'
     #
     def get(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
       normalize! params
       # _merge_mime_type(:pull_request, params)
@@ -107,7 +107,7 @@ module Github
     #    "base" => "master"
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -132,7 +132,7 @@ module Github
     #    "state" => "open",
     #
     def update(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
 
       normalize! params
@@ -150,7 +150,7 @@ module Github
     #  github.pull_requests.commits 'user-name', 'repo-name', 'request-id'
     #
     def commits(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
 
       normalize! params
@@ -168,7 +168,7 @@ module Github
     #  github.pull_requests.files 'user-name', 'repo-name', 'request-id'
     #
     def files(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
       normalize! params
       # _merge_mime_type(:pull_request, params)
@@ -185,7 +185,7 @@ module Github
     #  github.pull_requests.merged? 'user-name', 'repo-name', 'request-id'
     #
     def merged?(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
 
       normalize! params
@@ -207,7 +207,7 @@ module Github
     #  github.pull_requests.merge 'user-name', 'repo-name', 'request-id'
     #
     def merge(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
 
       normalize! params

data/lib/github_api/pull_requests/comments.rb

@@ -20,7 +20,7 @@ module Github
     #  github.pull_requests.comments.list 'user-name', 'repo-name', 'request-id'
     #
     def list(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
 
       normalize! params
@@ -38,7 +38,7 @@ module Github
     #  github.pull_requests.comments.get 'user-name', 'repo-name', 'comment-id'
     #
     def get(user_name, repo_name, comment_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
 
       normalize! params
@@ -77,7 +77,7 @@ module Github
     #    "in_reply_to" => 4
     #
     def create(user_name, repo_name, request_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, request_id
 
       normalize! params
@@ -99,7 +99,7 @@ module Github
     #    "body" => "Nice change"
     #
     def edit(user_name, repo_name, comment_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
 
       normalize! params
@@ -116,7 +116,7 @@ module Github
     #  github.pull_requests.comments.delete 'user-name', 'repo-name','comment-id'
     #
     def delete(user_name, repo_name, comment_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
 
       normalize! params

data/lib/github_api/repos.rb

@@ -7,6 +7,7 @@ module Github
     # Load all the modules after initializing Repos to avoid superclass mismatch
     autoload_all 'github_api/repos',
       :Collaborators => 'collaborators',
+      :Comments      => 'comments',
       :Commits       => 'commits',
       :Contents      => 'contents',
       :Downloads     => 'downloads',
@@ -50,6 +51,11 @@ module Github
       @collaborators ||= ApiFactory.new 'Repos::Collaborators'
     end
 
+    # Access to Repos::Comments API
+    def comments
+      @commits ||= ApiFactory.new 'Repos::Comments'
+    end
+
     # Access to Repos::Commits API
     def commits
       @commits ||= ApiFactory.new 'Repos::Commits'
@@ -116,7 +122,7 @@ module Github
     #   repos.branches 'user-name', 'repo-name'
     #
     def branches(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -134,6 +140,7 @@ module Github
     #   github.repos.branch 'user-name', 'repo-name', 'branch-name'
     #
     def branch(user_name, repo_name, branch, params={})
+      set :user => user_name, :repo => repo_name
       assert_presence_of user_name, repo_name, branch
       normalize! params
 
@@ -194,7 +201,7 @@ module Github
     #  github.repos.delete 'user-name', 'repo-name'
     #
     def delete(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -214,7 +221,7 @@ module Github
     #  github.repos.contributors 'user-name','repo-name' { |cont| ... }
     #
     def contributors(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
       filter! ['anon'], params
@@ -247,7 +254,7 @@ module Github
     #    :public => true, :has_issues => true
     #
     def edit(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -264,7 +271,7 @@ module Github
     #  github.repos.get 'user-name', 'repo-name'
     #
     def get(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -280,7 +287,7 @@ module Github
     #  github.repos.languages 'user-name', 'repo-name' { |lang| ... }
     #
     def languages(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -337,7 +344,7 @@ module Github
     #   github.repos.tags 'user-name', 'repo-name' { |tag| ... }
     #
     def tags(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -357,7 +364,7 @@ module Github
     #   github.repos.teams 'user-name', 'repo-name' { |team| ... }
     #
     def teams(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 

data/lib/github_api/repos/collaborators.rb

@@ -13,7 +13,7 @@ module Github
     #  collaborators.add 'user', 'repo', 'collaborator'
     #
     def add(user_name, repo_name, collaborator, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, collaborator
       normalize! params
 
@@ -28,7 +28,7 @@ module Github
     #  github.collaborators.collaborator?('user', 'repo', 'collaborator')
     #
     def collaborator?(user_name, repo_name, collaborator, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, collaborator
       normalize! params
 
@@ -46,7 +46,7 @@ module Github
     #  github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }
     #
     def list(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -63,7 +63,7 @@ module Github
     #  github.repos.collaborators.remove 'user', 'repo', 'collaborator'
     #
     def remove(user_name, repo_name, collaborator, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of collaborator
       normalize! params
 

data/lib/github_api/repos/comments.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+
+module Github
+  class Repos::Comments < API
+
+    REQUIRED_COMMENT_PARAMS = %w[
+      body
+      commit_id
+      line
+      path
+      position
+    ].freeze
+
+    # List commit comments for a repository
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.comments.list 'user-name', 'repo-name'
+    #  github.repos.comments.list 'user-name', 'repo-name' { |com| ... }
+    #
+    # List comments for a single commit
+    #
+    # = Examples
+    #  github.repos.comments.list 'user-name', 'repo-name',
+    #   :sha => '6dcb09b5b57875f334f61aebed695e2e4193db5e'
+    #
+    def list(user_name, repo_name, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo
+      normalize! params
+
+      response = if (sha = params.delete('sha'))
+        get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
+      else
+        get_request("/repos/#{user}/#{repo}/comments", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single commit comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.comments.get 'user-name', 'repo-name', 'comment-id'
+    #
+    def get(user_name, repo_name, comment_id, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo, comment_id
+      normalize! params
+
+      get_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
+    end
+    alias :find :get
+
+    # Creates a commit comment
+    #
+    # = Inputs
+    # * <tt>:body</tt> - Required string.
+    # * <tt>:comment_id</tt> - Required string - Sha of the commit to comment on.
+    # * <tt>:line</tt> - Required number - Line number in the file to comment on.
+    # * <tt>:path</tt> - Required string - Relative path of the file to comment on.
+    # * <tt>:position</tt> - Required number - Line index in the diff to comment on.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.comments.create 'user-name', 'repo-name', 'sha-key', 
+    #    "body" => "Nice change",
+    #    "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    #    "line" => 1,
+    #    "path" =>  "file1.txt",
+    #    "position" =>  4
+    #
+    def create(user_name, repo_name, sha, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo, sha
+
+      normalize! params
+      filter! REQUIRED_COMMENT_PARAMS, params
+
+      assert_required_keys(REQUIRED_COMMENT_PARAMS, params)
+
+      post_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
+    end
+
+    # Update a commit comment
+    #
+    # = Inputs
+    # * <tt>:body</tt> - Required string.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.comments.update 'user-name', 'repo-name',
+    #    'comment-id', "body" => "Nice change"
+    #
+    def update(user_name, repo_name, comment_id, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo, comment_id
+      normalize! params
+      assert_required_keys(%w[ body ], params)
+
+      patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
+    end
+
+    # Deletes a commit comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.comments.delete 'user-name', 'repo-name', 'comment-id'
+    #
+    def delete(user_name, repo_name, comment_id, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo, comment_id
+      normalize! params
+
+      delete_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
+    end
+
+  end # Repos::Comments
+end # Github

data/lib/github_api/repos/commits.rb

@@ -3,183 +3,62 @@
 module Github
   class Repos::Commits < API
 
-      REQUIRED_COMMENT_PARAMS = %w[
-        body
-        commit_id
-        line
-        path
-        position
-      ].freeze
-
-      # Compares two commits
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.compare
-      #    'user-name',
-      #    'repo-name',
-      #    'v0.4.8',
-      #    'master'
-      #
-      def compare(user_name, repo_name, base, head, params={})
-        assert_presence_of base, head
-        normalize! params
-
-        get_request("/repos/#{user_name}/#{repo_name}/compare/#{base}...#{head}", params)
-      end
-
-      # Creates a commit comment
-      #
-      # = Inputs
-      # * <tt>:body</tt> - Required string.
-      # * <tt>:comment_id</tt> - Required string - Sha of the commit to comment on.
-      # * <tt>:line</tt> - Required number - Line number in the file to comment on.
-      # * <tt>:path</tt> - Required string - Relative path of the file to comment on.
-      # * <tt>:position</tt> - Required number - Line index in the diff to comment on.
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.create_comment 'user-name', 'repo-name', 'sha-key', 
-      #    "body" => "Nice change",
-      #    "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
-      #    "line" => 1,
-      #    "path" =>  "file1.txt",
-      #    "position" =>  4
-      #
-      def create_comment(user_name, repo_name, sha, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo, sha
-
-        normalize! params
-        filter! REQUIRED_COMMENT_PARAMS, params
-
-        assert_required_keys(REQUIRED_COMMENT_PARAMS, params)
-
-        post_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
-      end
-
-      # Deletes a commit comment
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.delete_comment 'user-name', 'repo-name', 'comment-id'
-      #
-      def delete_comment(user_name, repo_name, comment_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo, comment_id
-        normalize! params
-
-        delete_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
-      end
-
-      # List commits on a repository
-      #
-      # = Parameters
-      # * <tt>:sha</tt>     Optional string. Sha or branch to start listing commits from.
-      # * <tt>:path</tt>    Optional string. Only commits containing this file path will be returned.
-      # * <tt>:author</tt>  GitHub login, name, or email by which to filter by commit author.
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.list 'user-name', 'repo-name', :sha => '...'
-      #  github.repos.commits.list 'user-name', 'repo-name', :sha => '...' { |commit| ... }
-      #
-      def list(user_name, repo_name, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo
-        normalize! params
-        filter! %w[sha path author], params
-
-        response = get_request("/repos/#{user}/#{repo}/commits", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :all :list
-
-      # List commit comments for a repository
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.repo_comments 'user-name', 'repo-name'
-      #  github.repos.commits.repo_comments 'user-name', 'repo-name' { |com| ... }
-      #
-      def repo_comments(user_name, repo_name, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo
-        normalize! params
-
-        response = get_request("/repos/#{user}/#{repo}/comments", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_repo_comments :repo_comments
-      alias :list_repository_comments :repo_comments
-
-      # List comments for a single commit
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.commit_comments 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed695e2e4193db5e'
-      #
-      def commit_comments(user_name, repo_name, sha, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo, sha
-        normalize! params
-
-        response = get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_commit_comments :commit_comments
-
-      # Gets a single commit
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
-      #
-      def get(user_name, repo_name, sha, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo, sha
-        normalize! params
-
-        get_request("/repos/#{user}/#{repo}/commits/#{sha}", params)
-      end
-      alias :find :get
-
-      # Gets a single commit comment
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.commit_comment 'user-name', 'repo-name', 'comment-id'
-      #
-      def commit_comment(user_name, repo_name, comment_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo, comment_id
-        normalize! params
-
-        get_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
-      end
-      alias :get_commit_comment :commit_comment
-
-      # Update a commit comment
-      #
-      # = Inputs
-      # * <tt>:body</tt> - Required string.
-      #
-      # = Examples
-      #  github = Github.new
-      #  github.repos.commits.update_comment 'user-name', 'repo-name',
-      #    'comment-id', "body" => "Nice change"
-      #
-      def update_comment(user_name, repo_name, comment_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        assert_presence_of user, repo, comment_id
-        normalize! params
-        assert_required_keys(%w[ body ], params)
-
-        patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
-      end
+    # List commits on a repository
+    #
+    # = Parameters
+    # * <tt>:sha</tt>     Optional string. Sha or branch to start listing commits from.
+    # * <tt>:path</tt>    Optional string. Only commits containing this file path will be returned.
+    # * <tt>:author</tt>  GitHub login, name, or email by which to filter by commit author.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.commits.list 'user-name', 'repo-name', :sha => '...'
+    #  github.repos.commits.list 'user-name', 'repo-name', :sha => '...' { |commit| ... }
+    #
+    def list(user_name, repo_name, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo
+      normalize! params
+      filter! %w[sha path author], params
+
+      response = get_request("/repos/#{user}/#{repo}/commits", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single commit
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
+    #
+    def get(user_name, repo_name, sha, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of user, repo, sha
+      normalize! params
+
+      get_request("/repos/#{user}/#{repo}/commits/#{sha}", params)
+    end
+    alias :find :get
+
+    # Compares two commits
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.commits.compare
+    #    'user-name',
+    #    'repo-name',
+    #    'v0.4.8',
+    #    'master'
+    #
+    def compare(user_name, repo_name, base, head, params={})
+      set :user => user_name, :repo => repo_name
+      assert_presence_of base, head
+      normalize! params
+
+      get_request("/repos/#{user_name}/#{repo_name}/compare/#{base}...#{head}", params)
+    end
 
   end # Repos::Commits
 end # Github