github_api 0.7.0 → 0.7.1

data/lib/github_api/pull_requests/comments.rb

@@ -21,8 +21,7 @@ module Github
     #
     def list(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of request_id
+      assert_presence_of user, repo, request_id
 
       normalize! params
       # _merge_mime_type(:pull_comment, params)
@@ -40,8 +39,7 @@ module Github
     #
     def get(user_name, repo_name, comment_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of comment_id
+      assert_presence_of user, repo, comment_id
 
       normalize! params
       # _merge_mime_type(:pull_comment, params)
@@ -80,8 +78,7 @@ module Github
     #
     def create(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of request_id
+      assert_presence_of user, repo, request_id
 
       normalize! params
       # _merge_mime_type(:pull_comment, params)
@@ -103,8 +100,7 @@ module Github
     #
     def edit(user_name, repo_name, comment_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of comment_id
+      assert_presence_of user, repo, comment_id
 
       normalize! params
       # _merge_mime_type(:pull_comment, params)
@@ -121,8 +117,7 @@ module Github
     #
     def delete(user_name, repo_name, comment_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of comment_id
+      assert_presence_of user, repo, comment_id
 
       normalize! params
       # _merge_mime_type(:pull_comment, params)

data/lib/github_api/repos.rb

@@ -117,7 +117,7 @@ module Github
     #
     def branches(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless (user? && repo?)
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/branches", params)
@@ -134,6 +134,7 @@ module Github
     #   github.repos.branch 'user-name', 'repo-name', 'branch-name'
     #
     def branch(user_name, repo_name, branch, params={})
+      assert_presence_of user_name, repo_name, branch
       normalize! params
 
       get_request("repos/#{user_name}/#{repo_name}/branches/#{branch}", params)
@@ -183,6 +184,24 @@ module Github
       end
     end
 
+    # Delete a repository
+    #
+    # Deleting a repository requires admin access.
+    # If OAuth is used, the delete_repo scope is required.
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.delete 'user-name', 'repo-name'
+    #
+    def delete(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      assert_presence_of user, repo
+      normalize! params
+
+      delete_request("/repos/#{user}/#{repo}")
+    end
+    alias :remove :delete
+
     # List contributors
     #
     # = Parameters
@@ -196,7 +215,7 @@ module Github
     #
     def contributors(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
       filter! ['anon'], params
 
@@ -229,7 +248,7 @@ module Github
     #
     def edit(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       filter! VALID_REPO_OPTIONS, params
@@ -246,7 +265,7 @@ module Github
     #
     def get(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       get_request("/repos/#{user}/#{repo}", params)
@@ -262,7 +281,7 @@ module Github
     #
     def languages(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/languages", params)
@@ -295,7 +314,7 @@ module Github
     def list(*args)
       params = args.extract_options!
       normalize! params
-      filter! %w[ org user type ], params
+      filter! %w[ user org type sort direction ], params
 
       response = if (user_name = params.delete("user"))
         get_request("/users/#{user_name}/repos", params)
@@ -319,7 +338,7 @@ module Github
     #
     def tags(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/tags", params)
@@ -339,7 +358,7 @@ module Github
     #
     def teams(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/teams", params)

data/lib/github_api/repos/collaborators.rb

@@ -14,8 +14,7 @@ module Github
     #
     def add(user_name, repo_name, collaborator, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of collaborator
+      assert_presence_of user, repo, collaborator
       normalize! params
 
       put_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
@@ -30,8 +29,7 @@ module Github
     #
     def collaborator?(user_name, repo_name, collaborator, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of collaborator
+      assert_presence_of user, repo, collaborator
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
@@ -49,7 +47,7 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless (user? && repo?)
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/collaborators", params)
@@ -66,8 +64,7 @@ module Github
     #
     def remove(user_name, repo_name, collaborator, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of collaborator
+      assert_presence_of collaborator
       normalize! params
 
       delete_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)

data/lib/github_api/repos/commits.rb

@@ -22,7 +22,7 @@ module Github
       #    'master'
       #
       def compare(user_name, repo_name, base, head, params={})
-        _validate_presence_of base, head
+        assert_presence_of base, head
         normalize! params
 
         get_request("/repos/#{user_name}/#{repo_name}/compare/#{base}...#{head}", params)
@@ -48,8 +48,7 @@ module Github
       #
       def create_comment(user_name, repo_name, sha, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of sha
+        assert_presence_of user, repo, sha
 
         normalize! params
         filter! REQUIRED_COMMENT_PARAMS, params
@@ -67,8 +66,7 @@ module Github
       #
       def delete_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of comment_id
+        assert_presence_of user, repo, comment_id
         normalize! params
 
         delete_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
@@ -88,7 +86,7 @@ module Github
       #
       def list(user_name, repo_name, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
+        assert_presence_of user, repo
         normalize! params
         filter! %w[sha path author], params
 
@@ -107,7 +105,7 @@ module Github
       #
       def repo_comments(user_name, repo_name, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
+        assert_presence_of user, repo
         normalize! params
 
         response = get_request("/repos/#{user}/#{repo}/comments", params)
@@ -125,8 +123,7 @@ module Github
       #
       def commit_comments(user_name, repo_name, sha, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of sha
+        assert_presence_of user, repo, sha
         normalize! params
 
         response = get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
@@ -143,8 +140,7 @@ module Github
       #
       def get(user_name, repo_name, sha, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of sha
+        assert_presence_of user, repo, sha
         normalize! params
 
         get_request("/repos/#{user}/#{repo}/commits/#{sha}", params)
@@ -159,8 +155,7 @@ module Github
       #
       def commit_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of comment_id
+        assert_presence_of user, repo, comment_id
         normalize! params
 
         get_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
@@ -179,9 +174,7 @@ module Github
       #
       def update_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of comment_id
-
+        assert_presence_of user, repo, comment_id
         normalize! params
         assert_required_keys(%w[ body ], params)
 

data/lib/github_api/repos/downloads.rb

@@ -23,7 +23,7 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/downloads", params)
@@ -40,8 +40,7 @@ module Github
     #
     def get(user_name, repo_name, download_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of download_id
+      assert_presence_of user, repo, download_id
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
@@ -56,8 +55,7 @@ module Github
     #
     def delete(user_name, repo_name, download_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of download_id
+      assert_presence_of user, repo, download_id
       normalize! params
 
       delete_request("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
@@ -83,7 +81,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       filter! VALID_DOWNLOAD_PARAM_NAMES, params
@@ -106,7 +104,7 @@ module Github
     #  github.repos.downloads.upload resource, '/users/octokit/image.jpg'
     #
     def upload(resource, filename)
-      _validate_presence_of resource, filename
+      assert_presence_of resource, filename
 
       response = Github::S3Uploader.new(resource, filename).send
       response.body

data/lib/github_api/repos/forks.rb

@@ -11,11 +11,11 @@ module Github
     # = Examples
     #  github = Github.new
     #  github.repos.forks.list 'user-name', 'repo-name'
-    #  github.repos.forks.list 'user-name', 'repo-name' { |hook| ... }
+    #  github.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
     #
     def list(user_name, repo_name, params = {})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/forks", params)
@@ -36,7 +36,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
       filter! %w[ org ], params
 

data/lib/github_api/repos/hooks.rb

@@ -1,8 +1,9 @@
 # encoding: utf-8
 
 module Github
+  # The Repository Hooks API manages the post-receive web and
+  # service hooks for a repository.
   class Repos::Hooks < API
-    # The Repository Hooks API manages the post-receive web and service hooks for a repository.
 
     VALID_HOOK_PARAM_NAMES = %w[
       name
@@ -13,8 +14,8 @@ module Github
       remove_events
     ].freeze # :nodoc:
 
-    # Active hooks can be configured to trigger for one or more events. The default event is push.
-    # The available events are:
+    # Active hooks can be configured to trigger for one or more events.
+    # The default event is push. The available events are:
     VALID_HOOK_PARAM_VALUES = {
       'events' => %w[
         push
@@ -43,7 +44,7 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/hooks", params)
@@ -60,8 +61,7 @@ module Github
     #
     def get(user_name, repo_name, hook_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of hook_id
+      assert_presence_of user, repo, hook_id
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
@@ -88,7 +88,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       filter! VALID_HOOK_PARAM_NAMES, params, :recursive => false
@@ -120,8 +120,7 @@ module Github
     #
     def edit(user_name, repo_name, hook_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of hook_id
+      assert_presence_of user, repo, hook_id
 
       normalize! params
       filter! VALID_HOOK_PARAM_NAMES, params, :recursive => false
@@ -140,8 +139,7 @@ module Github
     #
     def test(user_name, repo_name, hook_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of hook_id
+      assert_presence_of user, repo, hook_id
       normalize! params
 
       post_request("/repos/#{user}/#{repo}/hooks/#{hook_id}/test", params)
@@ -155,8 +153,7 @@ module Github
     #
     def delete(user_name, repo_name, hook_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of hook_id
+      assert_presence_of user, repo, hook_id
       normalize! params
 
       delete_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)

data/lib/github_api/repos/keys.rb

@@ -14,7 +14,7 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/keys", params)
@@ -31,8 +31,7 @@ module Github
     #
     def get(user_name, repo_name, key_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of key_id
+      assert_presence_of user, repo, key_id
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
@@ -53,7 +52,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
       filter! VALID_KEY_PARAM_NAMES, params
       assert_required_keys(VALID_KEY_PARAM_NAMES, params)
@@ -75,8 +74,7 @@ module Github
     #
     def edit(user_name, repo_name, key_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of key_id
+      assert_presence_of user, repo, key_id
 
       normalize! params
       filter! VALID_KEY_PARAM_NAMES, params
@@ -92,8 +90,7 @@ module Github
     #
     def delete(user_name, repo_name, key_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of key_id
+      assert_presence_of user, repo, key_id
       normalize! params
 
       delete_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)