github_api 0.9.0 → 0.9.1

data/lib/github_api/error/validations.rb

@@ -8,8 +8,8 @@ module Github #:nodoc
         super(
           generate_message(
             :problem => "Attempted to send request with nil arguments for #{errors.keys.join(', ')}.",
-            :summary => 'Each request expects certain number of arguments.',
-            :resolution => 'Double check that the provided arguments are set to some value.'
+            :summary => 'Each request expects certain number of required arguments.',
+            :resolution => 'Double check that the provided arguments are set to some value that is neither nil nor empty string.'
           )
         )
       end

data/lib/github_api/gists.rb

@@ -32,12 +32,10 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.gists.list
     #
-    def list(params={})
-      normalize! params
+    def list(*args)
+      params = arguments(args).params
 
-      user = params.delete('user')
-
-      response = if user
+      response = if (user = params.delete('user'))
         get_request("/users/#{user}/gists", params)
       elsif oauth_token
         get_request("/gists", params)
@@ -55,10 +53,9 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.gists.starred
     #
-    def starred(params={})
-      normalize! params
-
-      response = get_request("/gists/starred", params)
+    def starred(*args)
+      arguments(args)
+      response = get_request("/gists/starred", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -69,11 +66,10 @@ module Github
     #  github = Github.new
     #  github.gists.get 'gist-id'
     #
-    def get(gist_id, params={})
-      normalize! params
-      assert_presence_of gist_id
+    def get(*args)
+      arguments(args, :required => [:gist_id])
 
-      get_request("/gists/#{gist_id}", params)
+      get_request("/gists/#{gist_id}", arguments.params)
     end
     alias :find :get
 
@@ -98,11 +94,12 @@ module Github
     #       }
     #    }
     #
-    def create(params={})
-      normalize! params
-      assert_required_keys(REQUIRED_GIST_INPUTS, params)
+    def create(*args)
+      arguments(args) do
+        assert_required REQUIRED_GIST_INPUTS
+      end
 
-      post_request("/gists", params)
+      post_request("/gists", arguments.params)
     end
 
     # Edit a gist
@@ -133,11 +130,10 @@ module Github
     #       'delete_the_file.txt' => nil
     #    }
     #
-    def edit(gist_id, params={})
-      assert_presence_of gist_id
-      normalize! params
+    def edit(*args)
+      arguments(args, :required => [:gist_id])
 
-      patch_request("/gists/#{gist_id}", params)
+      patch_request("/gists/#{gist_id}", arguments.params)
     end
 
     # Star a gist
@@ -146,11 +142,10 @@ module Github
     #  github = Github.new
     #  github.gists.star 'gist-id'
     #
-    def star(gist_id, params={})
-      assert_presence_of gist_id
-      normalize! params
+    def star(*args)
+      arguments(args, :required => [:gist_id])
 
-      put_request("/gists/#{gist_id}/star", params)
+      put_request("/gists/#{gist_id}/star", arguments.params)
     end
 
     # Unstar a gist
@@ -159,11 +154,10 @@ module Github
     #  github = Github.new
     #  github.gists.unstar 'gist-id'
     #
-    def unstar(gist_id, params={})
-      assert_presence_of gist_id
-      normalize! params
+    def unstar(*args)
+      arguments(args, :required => [:gist_id])
 
-      delete_request("/gists/#{gist_id}/star", params)
+      delete_request("/gists/#{gist_id}/star", arguments.params)
     end
 
     # Check if a gist is starred
@@ -172,11 +166,9 @@ module Github
     #  github = Github.new
     #  github.gists.starred? 'gist-id'
     #
-    def starred?(gist_id, params={})
-      assert_presence_of gist_id
-      normalize! params
-
-      get_request("/gists/#{gist_id}/star", params)
+    def starred?(*args)
+      arguments(args, :required => [:gist_id])
+      get_request("/gists/#{gist_id}/star", arguments.params)
       true
     rescue Github::Error::NotFound
       false
@@ -188,11 +180,10 @@ module Github
     #  github = Github.new
     #  github.gists.fork 'gist-id'
     #
-    def fork(gist_id, params={})
-      assert_presence_of gist_id
-      normalize! params
+    def fork(*args)
+      arguments(args, :required => [:gist_id])
 
-      post_request("/gists/#{gist_id}/fork", params)
+      post_request("/gists/#{gist_id}/fork", arguments.params)
     end
 
     # Delete a gist
@@ -201,11 +192,10 @@ module Github
     #  github = Github.new
     #  github.gists.delete 'gist-id'
     #
-    def delete(gist_id, params={})
-      assert_presence_of gist_id
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:gist_id])
 
-      delete_request("/gists/#{gist_id}", params)
+      delete_request("/gists/#{gist_id}", arguments.params)
     end
 
   end # Gists

data/lib/github_api/gists/comments.rb

@@ -19,11 +19,10 @@ module Github
     #  github = Github.new
     #  github.gists.comments.list 'gist-id'
     #
-    def list(gist_id, params={})
-      normalize! params
-      assert_presence_of gist_id
+    def list(*args)
+      arguments(args, :required => [:gist_id])
 
-      response = get_request("/gists/#{gist_id}/comments", params)
+      response = get_request("/gists/#{gist_id}/comments", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -35,11 +34,10 @@ module Github
     #  github = Github.new
     #  github.gists.comments.get 'gist-id', 'comment-id'
     #
-    def get(gist_id, comment_id, params={})
-      normalize! params
-      assert_presence_of comment_id
+    def get(*args)
+      arguments(args, :required => [:gist_id, :comment_id])
 
-      get_request("/gists/#{gist_id}/comments/#{comment_id}", params)
+      get_request("/gists/#{gist_id}/comments/#{comment_id}", arguments.params)
     end
     alias :find :get
 
@@ -49,12 +47,13 @@ module Github
     #  github = Github.new
     #  github.gists.comments.create 'gist-id'
     #
-    def create(gist_id, params={})
-      normalize! params
-      filter! VALID_GIST_COMMENT_OPTIONS, params
-      assert_required_keys(REQUIRED_GIST_COMMENT_OPTIONS, params)
+    def create(*args)
+      arguments(args, :required => [:gist_id]) do
+        sift VALID_GIST_COMMENT_OPTIONS
+        assert_required REQUIRED_GIST_COMMENT_OPTIONS
+      end
 
-      post_request("/gists/#{gist_id}/comments", params)
+      post_request("/gists/#{gist_id}/comments", arguments.params)
     end
 
     # Edit a comment
@@ -63,13 +62,13 @@ module Github
     #  github = Github.new
     #  github.gists.comments.edit 'gist-id', 'comment-id'
     #
-    def edit(gist_id, comment_id, params={})
-      normalize! params
-      assert_presence_of comment_id
-      filter! VALID_GIST_COMMENT_OPTIONS, params
-      assert_required_keys(REQUIRED_GIST_COMMENT_OPTIONS, params)
+    def edit(*args)
+      arguments(args, :required => [:gist_id, :comment_id]) do
+        sift VALID_GIST_COMMENT_OPTIONS
+        assert_required REQUIRED_GIST_COMMENT_OPTIONS
+      end
 
-      patch_request("/gists/#{gist_id}/comments/#{comment_id}", params)
+      patch_request("/gists/#{gist_id}/comments/#{comment_id}", arguments.params)
     end
 
     # Delete a comment
@@ -78,11 +77,10 @@ module Github
     #  github = Github.new
     #  github.gists.comments.delete 'gist-id', 'comment-id'
     #
-    def delete(gist_id, comment_id, params={})
-      normalize! params
-      assert_presence_of comment_id
+    def delete(*args)
+      arguments(args, :required => [:gist_id, :comment_id])
 
-      delete_request("/gists/#{gist_id}/comments/#{comment_id}", params)
+      delete_request("/gists/#{gist_id}/comments/#{comment_id}", arguments.params)
     end
 
   end # Gists::Comments

data/lib/github_api/git_data/blobs.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
 
 module Github
+
+  # Since blobs can be any arbitrary binary data, the input and responses for
+  # the blob api takes an encoding parameter that can be either utf-8 or base64.
+  # If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.
   class GitData::Blobs < API
-    # Since blobs can be any arbitrary binary data, the input and responses for
-    # the blob api takes an encoding parameter that can be either utf-8 or base64.
-    # If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it.
 
     VALID_BLOB_PARAM_NAMES = %w[ content encoding ].freeze
 
@@ -14,12 +15,10 @@ module Github
     #  github = Github.new
     #  github.git_data.blobs.get 'user-name', 'repo-name', 'sha'
     #
-    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])
 
-      get_request("/repos/#{user}/#{repo}/git/blobs/#{sha}", params)
+      get_request("/repos/#{user}/#{repo}/git/blobs/#{sha}", arguments.params)
     end
     alias :find :get
 
@@ -34,15 +33,13 @@ module Github
     #    "content" => "Content of the blob",
     #    "encoding" => "utf-8"
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-
-      normalize! params
-      filter! VALID_BLOB_PARAM_NAMES, params
-      assert_required_keys(VALID_BLOB_PARAM_NAMES, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_BLOB_PARAM_NAMES
+        assert_required VALID_BLOB_PARAM_NAMES
+      end
 
-      post_request("/repos/#{user}/#{repo}/git/blobs", params)
+      post_request("/repos/#{user}/#{repo}/git/blobs", arguments.params)
     end
 
   end # GitData::Blobs

data/lib/github_api/git_data/commits.rb

@@ -26,10 +26,12 @@ module Github
     #  github = Github.new
     #  github.git_data.commits.get 'user-name', 'repo-name', 'sha'
     #
-    def get(user_name, repo_name, sha, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, sha
-      normalize! params
+    #  commits = Github::Commits.new user: 'user-name', repo: 'repo-name'
+    #  commits.get sha: '...'
+    #
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :sha])
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/git/commits/#{sha}", params)
     end
@@ -67,12 +69,12 @@ module Github
     #    ],
     #    "tree": "827efc6d56897b048c772eb4087f854f46256132"]
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
-      filter! VALID_COMMIT_PARAM_NAMES, params
-      assert_required_keys(REQUIRED_COMMIT_PARAMS, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_COMMIT_PARAM_NAMES
+        assert_required REQUIRED_COMMIT_PARAMS
+      end
+      params = arguments.params
 
       post_request("/repos/#{user}/#{repo}/git/commits", params)
     end

data/lib/github_api/git_data/references.rb

@@ -5,6 +5,8 @@ module Github
 
     VALID_REF_PARAM_NAMES = %w[ ref sha force ].freeze
 
+    REQUIRED_REF_PARAMS = %w[ ref sha ].freeze
+
     VALID_REF_PARAM_VALUES = {
       'ref' => %r{^refs\/\w+(\/\w+)*} # test fully qualified reference
     }
@@ -22,13 +24,11 @@ module Github
     #
     #  github.git_data.references.list 'user-name', 'repo-name', ref:'tags'
     #
-    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 params['ref']
-        ref = params.delete('ref')
+      response = if (ref = params.delete('ref'))
         validate_reference ref
         get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
       else
@@ -50,17 +50,15 @@ module Github
     #  github = Github.new
     #  github.git_data.references.get 'user-name', 'repo-name', 'heads/branch'
     #
-    def get(user_name, repo_name, ref, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, ref
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :ref])
       validate_reference ref
-      normalize! params
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
     end
     alias :find :get
 
-
     # Create a reference
     #
     # = Inputs
@@ -73,13 +71,13 @@ module Github
     #    "ref" => "refs/heads/master",
     #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132"
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      normalize! params
-      filter! VALID_REF_PARAM_NAMES, params
-      assert_presence_of user, repo, params['ref']
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_REF_PARAM_NAMES
+        assert_required REQUIRED_REF_PARAMS
+      end
+      params = arguments.params
       validate_reference params['ref']
-      assert_required_keys(%w[ ref sha ], params)
 
       post_request("/repos/#{user}/#{repo}/git/refs", params)
     end
@@ -96,13 +94,12 @@ module Github
     #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132",
     #    "force" => true
     #
-    def update(user_name, repo_name, ref, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, ref
-      validate_reference ref
-      normalize! params
-      filter! VALID_REF_PARAM_NAMES, params
-      assert_required_keys(%w[ sha ], params)
+    def update(*args)
+      arguments(args, :required => [:user, :repo, :ref]) do
+        sift VALID_REF_PARAM_NAMES
+        assert_required %w[ sha ]
+      end
+      params = arguments.params
 
       patch_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
     end
@@ -114,10 +111,9 @@ module Github
     #  github.git_data.references.delete 'user-name', 'repo-name',
     #    "ref" => "refs/heads/master",
     #
-    def delete(user_name, repo_name, ref, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, ref
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :ref])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
     end

data/lib/github_api/git_data/tags.rb

@@ -28,10 +28,9 @@ module Github
     #  github = Github.new
     #  github.git_data.tags.get 'user-name', 'repo-name', 'sha'
     #
-    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}/git/tags/#{sha}", params)
     end
@@ -65,13 +64,12 @@ module Github
     #      "date" => "2011-06-17T14:53:3"
     #    }
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
-
-      filter! VALID_TAG_PARAM_NAMES, params
-      assert_valid_values(VALID_TAG_PARAM_VALUES, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_TAG_PARAM_NAMES
+        assert_values VALID_TAG_PARAM_VALUES
+      end
+      params = arguments.params
 
       post_request("/repos/#{user}/#{repo}/git/tags", params)
     end