github_api 0.9.0 → 0.9.1

data/lib/github_api/repos/collaborators.rb

@@ -3,6 +3,23 @@
 module Github
   class Repos::Collaborators < API
 
+    # List collaborators
+    #
+    # Examples:
+    #  github = Github.new
+    #  github.repos.collaborators.list 'user-name', 'repo-name'
+    #  github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }
+    #
+    def list(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
+
+      response = get_request("/repos/#{user}/#{repo}/collaborators", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
     # Add collaborator
     #
     # Examples:
@@ -12,10 +29,9 @@ module Github
     #  collaborators = Github::Repos::Collaborators.new
     #  collaborators.add 'user', 'repo', 'collaborator'
     #
-    def add(user_name, repo_name, collaborator, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, collaborator
-      normalize! params
+    def add(*args)
+      arguments(args, :required => [:user, :repo, :collaborator])
+      params = arguments.params
 
       put_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
     end
@@ -27,10 +43,12 @@ module Github
     #  github = Github.new
     #  github.repos.collaborators.collaborator?('user', 'repo', 'collaborator')
     #
-    def collaborator?(user_name, repo_name, collaborator, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, collaborator
-      normalize! params
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.collaborators.collaborator? collaborator: 'collaborator'
+    #
+    def collaborator?(*args)
+      arguments(args, :required => [:user, :repo, :collaborator])
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
       true
@@ -38,34 +56,15 @@ module Github
       false
     end
 
-    # List collaborators
-    #
-    # Examples:
-    #  github = Github.new
-    #  github.repos.collaborators.list 'user-name', 'repo-name'
-    #  github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }
-    #
-    def list(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
-
-      response = get_request("/repos/#{user}/#{repo}/collaborators", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
     # Removes collaborator
     #
     # Examples:
     #  github = Github.new
     #  github.repos.collaborators.remove 'user', 'repo', 'collaborator'
     #
-    def remove(user_name, repo_name, collaborator, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of collaborator
-      normalize! params
+    def remove(*args)
+      arguments(args, :required => [:user, :repo, :collaborator])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
     end

data/lib/github_api/repos/comments.rb

@@ -25,10 +25,9 @@ module Github
     #  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
+    def list(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
       response = if (sha = params.delete('sha'))
         get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
@@ -46,10 +45,9 @@ module Github
     #  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
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :comment_id])
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
     end
@@ -73,14 +71,12 @@ module Github
     #    "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! VALID_COMMENT_OPTIONS, params
-
-      assert_required_keys(REQUIRED_COMMENT_OPTIONS, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo, :sha]) do
+        sift VALID_COMMENT_OPTIONS
+        assert_required REQUIRED_COMMENT_OPTIONS
+      end
+      params = arguments.params
 
       post_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
     end
@@ -95,11 +91,11 @@ module Github
     #  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(REQUIRED_COMMENT_OPTIONS, params)
+    def update(*args)
+      arguments(args, :required => [:user, :repo, :comment_id]) do
+        assert_required REQUIRED_COMMENT_OPTIONS
+      end
+      params = arguments.params
 
       patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
     end
@@ -110,10 +106,9 @@ module Github
     #  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
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :comment_id])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
     end

data/lib/github_api/repos/commits.rb

@@ -23,11 +23,11 @@ module Github
     #  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! VALID_COMMITS_OPTIONS, params
+    def list(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_COMMITS_OPTIONS
+      end
+      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/commits", params)
       return response unless block_given?
@@ -41,10 +41,9 @@ module Github
     #  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
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :sha])
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/commits/#{sha}", params)
     end
@@ -60,12 +59,11 @@ module Github
     #    '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
+    def compare(*args)
+      arguments(args, :required => [:user, :repo, :base, :head])
+      params = arguments.params
 
-      get_request("/repos/#{user_name}/#{repo_name}/compare/#{base}...#{head}", params)
+      get_request("/repos/#{user}/#{repo}/compare/#{base}...#{head}", params)
     end
 
   end # Repos::Commits

data/lib/github_api/repos/contents.rb

@@ -1,8 +1,10 @@
 # encoding: utf-8
 
 module Github
+
+  # These API methods let you retrieve the contents of files within a repository
+  # as Base64 encoded content.
   class Repos::Contents < API
-    # These API methods let you retrieve the contents of files within a repository as Base64 encoded content
 
     # Get the README
     #
@@ -12,11 +14,14 @@ module Github
     #  github = Github.new
     #  github.repos.contents.readme 'user-name', 'repo-name'
     #
-    def readme(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      normalize! params
+    #  content = Github::Repos;:Contents.new user: 'user-name', 'repo-name'
+    #  content.readme
+    #
+    def readme(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
-      get_request("/repos/#{user_name}/#{repo_name}/readme", params)
+      get_request("/repos/#{user}/#{repo}/readme", params)
     end
 
     # Get contents
@@ -30,11 +35,14 @@ module Github
     #  github = Github.new
     #  github.repos.contents.get 'user-name', 'repo-name', 'path'
     #
-    def get(user_name, repo_name, path, params={})
-      set :user => user_name, :repo => repo_name
-      normalize! params
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.repos.contents.get path: 'README.md'
+    #
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :path])
+      params = arguments.params
 
-      get_request("/repos/#{user_name}/#{repo_name}/contents/#{path}", params)
+      get_request("/repos/#{user}/#{repo}/contents/#{path}", params)
     end
     alias :find :get
 
@@ -57,13 +65,13 @@ module Github
     #    "archive_format" =>  "tarball",
     #    "ref" => "master"
     #
-    def archive(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      normalize! params
+    def archive(*args)
+      arguments(args, :required => [:user, :repo])
+      params         = arguments.params
       archive_format = params.delete('archive_format') || 'zipball'
-      ref = params.delete('ref') || 'master'
+      ref            = params.delete('ref') || 'master'
 
-      get_request("/repos/#{user_name}/#{repo_name}/#{archive_format}/#{ref}", params)
+      get_request("/repos/#{user}/#{repo}/#{archive_format}/#{ref}", params)
     end
 
   end # Repos::Contents

data/lib/github_api/repos/downloads.rb

@@ -5,7 +5,7 @@ require 'github_api/s3_uploader'
 module Github
   class Repos::Downloads < API
 
-    REQUIRED_PARAMS = %w[ name size ]
+    REQUIRED_PARAMS = %w[ name size ].freeze
 
     VALID_DOWNLOAD_PARAM_NAMES = %w[
       name
@@ -21,12 +21,10 @@ module Github
     #  github.repos.downloads.list 'user-name', 'repo-name'
     #  github.repos.downloads.list 'user-name', 'repo-name' { |downl| ... }
     #
-    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])
 
-      response = get_request("/repos/#{user}/#{repo}/downloads", params)
+      response = get_request("/repos/#{user}/#{repo}/downloads", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -38,10 +36,9 @@ module Github
     #  github = Github.new
     #  github.repos.downloads.get 'user-name', 'repo-name', 'download-id'
     #
-    def get(user_name, repo_name, download_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, download_id
-      normalize! params
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :download_id])
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
     end
@@ -53,13 +50,13 @@ module Github
     #  github = Github.new
     #  github.repos.downloads.delete 'user-name', 'repo-name', 'download-id'
     #
-    def delete(user_name, repo_name, download_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, download_id
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :download_id])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}/downloads/#{download_id}", params)
     end
+    alias :remove :delete
 
     # Creating a new download is a two step process.
     # You must first create a new download resource using this method.
@@ -79,13 +76,12 @@ module Github
     #    "description" => "Latest release",
     #    "content_type" => "text/plain"
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-
-      normalize! params
-      filter! VALID_DOWNLOAD_PARAM_NAMES, params
-      assert_required_keys(REQUIRED_PARAMS, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_DOWNLOAD_PARAM_NAMES
+        assert_required REQUIRED_PARAMS
+      end
+      params = arguments.params
 
       post_request("/repos/#{user}/#{repo}/downloads", params)
     end
@@ -103,8 +99,8 @@ module Github
     #
     #  github.repos.downloads.upload resource, '/users/octokit/image.jpg'
     #
-    def upload(resource, filename)
-      assert_presence_of resource, filename
+    def upload(*args)
+      arguments(args, :required => [:resource, :filename])
 
       response = Github::S3Uploader.new(resource, filename).send
       response.body

data/lib/github_api/repos/forks.rb

@@ -13,12 +13,10 @@ module Github
     #  github.repos.forks.list 'user-name', 'repo-name'
     #  github.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
     #
-    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])
 
-      response = get_request("/repos/#{user}/#{repo}/forks", params)
+      response = get_request("/repos/#{user}/#{repo}/forks", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -34,13 +32,10 @@ module Github
     #  github.repos.forks.create 'user-name', 'repo-name',
     #    "org" =>  "github"
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
-      filter! %w[ org ], params
+    def create(*args)
+      arguments(args, :required => [:user, :repo])
 
-      post_request("/repos/#{user}/#{repo}/forks", params)
+      post_request("/repos/#{user}/#{repo}/forks", arguments.params)
     end
 
   end # Repos::Forks

data/lib/github_api/repos/hooks.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Github
+
   # The Repository Hooks API manages the post-receive web and
   # service hooks for a repository.
   class Repos::Hooks < API
@@ -42,12 +43,10 @@ module Github
     #  github.repos.hooks.list 'user-name', 'repo-name'
     #  github.repos.hooks.list 'user-name', 'repo-name' { |hook| ... }
     #
-    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])
 
-      response = get_request("/repos/#{user}/#{repo}/hooks", params)
+      response = get_request("/repos/#{user}/#{repo}/hooks", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -59,12 +58,10 @@ module Github
     #  github = Github.new
     #  github.repos.hooks.get 'user-name', 'repo-name'
     #
-    def get(user_name, repo_name, hook_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, hook_id
-      normalize! params
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :hook_id])
 
-      get_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
+      get_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", arguments.params)
     end
     alias :find :get
 
@@ -86,15 +83,13 @@ module Github
     #      }
     #    }
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-
-      normalize! params
-      filter! VALID_HOOK_PARAM_NAMES, params, :recursive => false
-      assert_required_keys(REQUIRED_PARAMS, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_HOOK_PARAM_NAMES, :recursive => false
+        assert_required REQUIRED_PARAMS
+      end
 
-      post_request("/repos/#{user}/#{repo}/hooks", params)
+      post_request("/repos/#{user}/#{repo}/hooks", arguments.params)
     end
 
     # Edit a hook
@@ -118,15 +113,13 @@ module Github
     #      "token" => "abc123"
     #    }
     #
-    def edit(user_name, repo_name, hook_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, hook_id
-
-      normalize! params
-      filter! VALID_HOOK_PARAM_NAMES, params, :recursive => false
-      assert_required_keys(REQUIRED_PARAMS, params)
+    def edit(*args)
+      arguments(args, :required => [:user, :repo, :hook_id]) do
+        sift VALID_HOOK_PARAM_NAMES, :recursive => false
+        assert_required REQUIRED_PARAMS
+      end
 
-      patch_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
+      patch_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", arguments.params)
     end
 
     # Test a hook
@@ -137,10 +130,9 @@ module Github
     #  github = Github.new
     #  github.repos.hooks.test 'user-name', 'repo-name', 'hook-id'
     #
-    def test(user_name, repo_name, hook_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, hook_id
-      normalize! params
+    def test(*args)
+      arguments(args, :required => [:user, :repo, :hook_id])
+      params = arguments.params
 
       post_request("/repos/#{user}/#{repo}/hooks/#{hook_id}/test", params)
     end
@@ -151,10 +143,9 @@ module Github
     #  github = Github.new
     #  github.repos.hooks.delete 'user-name', 'repo-name', 'hook-id'
     #
-    def delete(user_name, repo_name, hook_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, hook_id
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :hook_id])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
     end