github_api 0.9.0 → 0.9.1

data/lib/github_api/pull_requests.rb

@@ -35,19 +35,16 @@ module Github
     #  github.pull_requests.list
     #  github.pull_requests.list { |req| ... }
     #
-    #  pull_reqs = Github::PullRequests.new
-    #  pull_reqs.pull_requests.list 'user-name', 'repo-name'
+    #  pulls = Github::PullRequests.new
+    #  pulls.pull_requests.list 'user-name', 'repo-name'
     #
-    def list(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
+    def list(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_REQUEST_PARAM_NAMES
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
 
-      normalize! params
-      filter! VALID_REQUEST_PARAM_NAMES, params
-      # _merge_mime_type(:pull_request, params)
-      assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
-
-      response = get_request("/repos/#{user}/#{repo}/pulls", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -59,15 +56,13 @@ module Github
     #  github = Github.new
     #  github.pull_requests.get 'user-name', 'repo-name', 'number'
     #
-    #  pull_reqs = Github::PullRequests.new
-    #  pull_reqs.get 'user-name', 'repo-name', 'number'
+    #  pulls = Github::PullRequests.new
+    #  pulls.get 'user-name', 'repo-name', 'number'
     #
-    def get(user_name, repo_name, number, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, number
-      normalize! params
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :number])
 
-      get_request("/repos/#{user}/#{repo}/pulls/#{number}", params)
+      get_request("/repos/#{user}/#{repo}/pulls/#{number}", arguments.params)
     end
     alias :find :get
 
@@ -100,14 +95,12 @@ module Github
     #    "head" => "octocat:new-feature",
     #    "base" => "master"
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-
-      normalize! params
-      filter! VALID_REQUEST_PARAM_NAMES, params
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_REQUEST_PARAM_NAMES
+      end
 
-      post_request("/repos/#{user}/#{repo}/pulls", params)
+      post_request("/repos/#{user}/#{repo}/pulls", arguments.params)
     end
 
     # Update a pull request
@@ -124,14 +117,13 @@ module Github
     #    "body" => "Update body",
     #    "state" => "open",
     #
-    def update(user_name, repo_name, number, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, number
-      normalize! params
-      filter! VALID_REQUEST_PARAM_NAMES, params
-      assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
+    def update(*args)
+      arguments(args, :required => [:user, :repo, :number]) do
+        sift VALID_REQUEST_PARAM_NAMES
+        assert_values VALID_REQUEST_PARAM_VALUES
+      end
 
-      patch_request("/repos/#{user}/#{repo}/pulls/#{number}", params)
+      patch_request("/repos/#{user}/#{repo}/pulls/#{number}", arguments.params)
     end
 
     # List commits on a pull request
@@ -140,12 +132,11 @@ module Github
     #  github = Github.new
     #  github.pull_requests.commits 'user-name', 'repo-name', 'number'
     #
-    def commits(user_name, repo_name, number, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, number
-      normalize! params
+    def commits(*args)
+      arguments(args, :required => [:user, :repo, :number])
 
-      response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/commits", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/commits",
+        arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -156,12 +147,11 @@ module Github
     #  github = Github.new
     #  github.pull_requests.files 'user-name', 'repo-name', 'number'
     #
-    def files(user_name, repo_name, number, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, number
-      normalize! params
+    def files(*args)
+      arguments(args, :required => [:user, :repo, :number])
 
-      response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/files", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/files",
+        arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -172,12 +162,10 @@ module Github
     #  github = Github.new
     #  github.pull_requests.merged? 'user-name', 'repo-name', 'number'
     #
-    def merged?(user_name, repo_name, number, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, number
-      normalize! params
+    def merged?(*args)
+      arguments(args, :required => [:user, :repo, :number])
 
-      get_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", params)
+      get_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", arguments.params)
       true
     rescue Github::Error::NotFound
       false
@@ -193,14 +181,12 @@ module Github
     #  github = Github.new
     #  github.pull_requests.merge 'user-name', 'repo-name', 'number'
     #
-    def merge(user_name, repo_name, number, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, number
-
-      normalize! params
-      filter! VALID_REQUEST_PARAM_NAMES, params
+    def merge(*args)
+      arguments(args, :required => [:user, :repo, :number]) do
+        sift VALID_REQUEST_PARAM_NAMES
+      end
 
-      put_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", params)
+      put_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", arguments.params)
     end
 
   end # PullRequests

data/lib/github_api/pull_requests/comments.rb

@@ -35,10 +35,9 @@ module Github
     #  github.pull_requests.comments.list 'user-name', 'repo-name'
     #  github.pull_requests.comments.list 'user-name', 'repo-name' { |comm| ... }
     #
-    def list(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    def list(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
       response = if (request_id = params.delete('request_id'))
         get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
@@ -55,12 +54,10 @@ module Github
     #  github = Github.new
     #  github.pull_requests.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
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :comment_id])
 
-      get_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+      get_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
     end
     alias :find :get
 
@@ -92,14 +89,13 @@ module Github
     #    "body" => "Nice change",
     #    "in_reply_to" => 4
     #
-    def create(user_name, repo_name, request_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
-      normalize! params
-      filter! VALID_REQUEST_COM_PARAM_NAMES, params
+    def create(*args)
+      arguments(args, :required => [:user, :repo, :request_id]) do
+        sift VALID_REQUEST_COM_PARAM_NAMES
+      end
       # _validate_reply_to(params)
 
-      post_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+      post_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", arguments.params)
     end
 
     # Edit a pull request comment
@@ -112,13 +108,12 @@ module Github
     #  github.pull_requests.comments.edit 'user-name', 'repo-name','comment-id',
     #    "body" => "Nice change"
     #
-    def edit(user_name, repo_name, comment_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, comment_id
-      normalize! params
-      filter! VALID_REQUEST_COM_PARAM_NAMES, params
+    def edit(*args)
+      arguments(args, :required => [:user, :repo, :comment_id]) do
+        sift VALID_REQUEST_COM_PARAM_NAMES
+      end
 
-      patch_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+      patch_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
     end
 
     # Delete a pull request comment
@@ -127,12 +122,10 @@ module Github
     #  github = Github.new
     #  github.pull_requests.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
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :comment_id])
 
-      delete_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+      delete_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
     end
 
   private

data/lib/github_api/repos.rb

@@ -26,6 +26,8 @@ module Github
       "has_downloads" => true
     }.freeze
 
+    REQUIRED_REPO_OPTIONS = %w[ name ]
+
     VALID_REPO_OPTIONS = %w[
       name
       description
@@ -86,7 +88,7 @@ module Github
       @mergin ||= ApiFactory.new('Repos::Merging', current_options.merge(options), &block)
     end
 
-    # Access to Repos::Watchin API
+    # Access to Repos::PubSubHubbub API
     def pubsubhubbub(options={}, &block)
       @pubsubhubbub ||= ApiFactory.new('Repos::PubSubHubbub', current_options.merge(options), &block)
     end
@@ -96,41 +98,74 @@ module Github
       @statuses ||= ApiFactory.new('Repos::Statuses', current_options.merge(options), &block)
     end
 
-    # List branches
+    # List repositories for the authenticated user
     #
     # = Examples
+    #   github = Github.new :oauth_token => '...'
+    #   github.repos.list
+    #   github.repos.list { |repo| ... }
+    #
+    # List all repositories
+    #
+    # This provides a dump of every repository, in the order that they were created.
+    # = Parameters
+    # * <tt>:since</tt> - the integer ID of the last Repository that you've seen.
     #
+    # = Examples
     #   github = Github.new
-    #   github.repos.branches 'user-name', 'repo-name'
+    #   github.repos.list
+    #   github.repos.list { |repo| ... }
     #
-    #   repos = Github::Repos.new
-    #   repos.branches 'user-name', 'repo-name'
+    # List public repositories for the specified user.
     #
-    def branches(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    # = Examples
+    #   github = Github.new
+    #   github.repos.list :user => 'user-name'
+    #   github.repos.list :user => 'user-name', { |repo| ... }
+    #
+    # List repositories for the specified organisation.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.list :org => 'org-name'
+    #  github.repos.list :org => 'org-name', { |repo| ... }
+    #
+    def list(*args)
+      arguments(args) do
+        sift %w[ user org type sort direction ]
+      end
+      params = arguments.params
 
-      response = get_request("/repos/#{user}/#{repo}/branches", params)
+      response = if (user_name = (params.delete("user")))
+        get_request("/users/#{user_name}/repos", params)
+      elsif (org_name = (params.delete("org")))
+        get_request("/orgs/#{org_name}/repos", params)
+      elsif authenticated?
+        # For authenticated user
+        get_request("/user/repos", params)
+      else
+        get_request("/repositories", params)
+      end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :list_branches :branches
+    alias :all :list
 
-    # Get branch
+    # Get a repository
     #
     # = Examples
+    #  github = Github.new
+    #  github.repos.get 'user-name', 'repo-name'
+    #  github.repos.get user: 'user-name', repo: 'repo-name'
+    #  github.repos(user: 'user-name', repo: 'repo-name').get
     #
-    #   github = Github.new
-    #   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
+    def get(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
-      get_request("/repos/#{user_name}/#{repo_name}/branches/#{branch}", params)
+      get_request("/repos/#{user}/#{repo}", params)
     end
+    alias :find :get
 
     # Create a new repository for the autheticated user.
     #
@@ -163,10 +198,11 @@ module Github
     #   github.repos.create :name => 'repo-name', :org => 'organisation-name'
     #
     def create(*args)
-      params = args.extract_options!
-      normalize! params
-      filter! VALID_REPO_OPTIONS + %w[ org ], params
-      assert_required_keys(%w[ name ], params)
+      arguments(args) do
+        sift VALID_REPO_OPTIONS + %w[ org ]
+        assert_required %w[ name ]
+      end
+      params = arguments.params
 
       # Requires authenticated user
       if (org = params.delete("org"))
@@ -185,10 +221,9 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.repos.delete 'user-name', 'repo-name'
     #
-    def delete(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}", params)
     end
@@ -205,11 +240,11 @@ module Github
     #  github.repos.contributors 'user-name','repo-name'
     #  github.repos.contributors 'user-name','repo-name' { |cont| ... }
     #
-    def contributors(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
-      filter! ['anon'], params
+    def contributors(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift %w[ anon ]
+      end
+      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/contributors", params)
       return response unless block_given?
@@ -238,101 +273,111 @@ module Github
     #    :homepage => "https://github.com",
     #    :public => true, :has_issues => true
     #
-    def edit(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-
-      normalize! params
-      filter! VALID_REPO_OPTIONS, params
-      assert_required_keys(%w[ name ], params)
+    def edit(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_REPO_OPTIONS
+        assert_required %w[ name ]
+      end
+      params = arguments.params
 
       patch_request("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
     end
 
-    # Get a repository
+    # Delete a repository
+    #
+    # Deleting a repository requires admin access.
+    # If OAuth is used, the delete_repo scope is required.
     #
     # = Examples
-    #  github = Github.new
-    #  github.repos.get 'user-name', 'repo-name'
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.delete 'user-name', 'repo-name'
     #
-    def get(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
-      get_request("/repos/#{user}/#{repo}", params)
+      delete_request("/repos/#{user}/#{repo}", params)
     end
-    alias :find :get
+    alias :remove :delete
 
-    # List languages
+    # List branches
     #
     # = Examples
-    #  github = Github.new
-    #  github.repos.languages 'user-name', 'repo-name'
-    #  github.repos.languages 'user-name', 'repo-name' { |lang| ... }
     #
-    def languages(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    #   github = Github.new
+    #   github.repos.branches 'user-name', 'repo-name'
+    #   github.repos(user: 'user-name', repo: 'repo-name').branches
+    #
+    #   repos = Github::Repos.new
+    #   repos.branches 'user-name', 'repo-name'
+    #
+    # def branches(user_name, repo_name, params={})
+    def branches(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
-      response = get_request("/repos/#{user}/#{repo}/languages", params)
+      response = get_request("/repos/#{user}/#{repo}/branches", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :list_languages :languages
+    alias :list_branches :branches
 
-    # List repositories for the authenticated user
+    # Get branch
     #
     # = Examples
-    #   github = Github.new :oauth_token => '...'
-    #   github.repos.list
-    #   github.repos.list { |repo| ... }
     #
-    # List all repositories
+    #   github = Github.new
+    #   github.repos.branch 'user-name', 'repo-name', 'branch-name'
+    #   github.repos.branch user: 'user-name', repo: 'repo-name', branch: 'branch-name'
+    #   github.repos(user: 'user-name', repo: 'repo-name', branch: 'branch-name').branch
+    #
+    def branch(*args)
+      arguments(args, :required => [:user, :repo, :branch])
+      params = arguments.params
+
+      get_request("/repos/#{user}/#{repo}/branches/#{branch}", params)
+    end
+
+    # List contributors
     #
-    # This provides a dump of every repository, in the order that they were created.
     # = Parameters
-    # * <tt>:since</tt> - the integer ID of the last Repository that you've seen.
+    #  <tt>:anon</tt> - Optional flag. Set to 1 or true to include anonymous contributors.
     #
     # = Examples
-    #   github = Github.new
-    #   github.repos.list
-    #   github.repos.list { |repo| ... }
-    #
-    # List public repositories for the specified user.
     #
-    # = Examples
-    #   github = Github.new
-    #   github.repos.list :user => 'user-name'
-    #   github.repos.list :user => 'user-name', { |repo| ... }
+    #  github = Github.new
+    #  github.repos.contributors 'user-name','repo-name'
+    #  github.repos.contributors 'user-name','repo-name' { |cont| ... }
     #
-    # List repositories for the specified organisation.
+    def contributors(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift ['anon']
+      end
+      params = arguments.params
+
+      response = get_request("/repos/#{user}/#{repo}/contributors", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :list_contributors :contributors
+    alias :contribs :contributors
+
+    # List languages
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.list :org => 'org-name'
-    #  github.repos.list :org => 'org-name', { |repo| ... }
+    #  github.repos.languages 'user-name', 'repo-name'
+    #  github.repos.languages 'user-name', 'repo-name' { |lang| ... }
     #
-    def list(*args)
-      params = args.extract_options!
-      normalize! params
-      filter! %w[ user org type sort direction ], params
+    def languages(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
-      response = if (user_name = params.delete("user"))
-        get_request("/users/#{user_name}/repos", params)
-      elsif (org_name = params.delete("org"))
-        get_request("/orgs/#{org_name}/repos", params)
-      elsif authenticated?
-        # For authenticated user
-        get_request("/user/repos", params)
-      else
-        get_request("/repositories", params)
-      end
+      response = get_request("/repos/#{user}/#{repo}/languages", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias :list_languages :languages
 
     # List tags
     #
@@ -341,10 +386,9 @@ module Github
     #   github.repos.tags 'user-name', 'repo-name'
     #   github.repos.tags 'user-name', 'repo-name' { |tag| ... }
     #
-    def tags(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    def tags(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/tags", params)
       return response unless block_given?
@@ -361,10 +405,11 @@ module Github
     #   github.repos.teams 'user-name', 'repo-name'
     #   github.repos.teams 'user-name', 'repo-name' { |team| ... }
     #
-    def teams(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    #   github.repos(user: 'user-name, repo: 'repo-name').teams
+    #
+    def teams(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/teams", params)
       return response unless block_given?