github_api 0.9.0 → 0.9.1

data/lib/github_api/repos/keys.rb

@@ -12,10 +12,12 @@ module Github
     #  github.repos.keys.list 'user-name', 'repo-name'
     #  github.repos.keys.list 'user-name', 'repo-name' { |key| ... }
     #
-    def list(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    #  keys = Github::Repos::Keys.new user: 'user-name', repo: 'repo-name'
+    #  keys.list
+    #
+    def list(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/keys", params)
       return response unless block_given?
@@ -29,10 +31,9 @@ module Github
     #  github = Github.new
     #  github.repos.keys.get 'user-name', 'repo-name', 'key-id'
     #
-    def get(user_name, repo_name, key_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, key_id
-      normalize! params
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :key_id])
+      params = arguments.params
 
       get_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end
@@ -50,14 +51,13 @@ module Github
     #    "title" => "octocat@octomac",
     #    "key" =>  "ssh-rsa AAA..."
     #
-    def create(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
-      filter! VALID_KEY_OPTIONS, params
-      assert_required_keys(VALID_KEY_OPTIONS, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_KEY_OPTIONS
+        assert_required VALID_KEY_OPTIONS
+      end
 
-      post_request("/repos/#{user}/#{repo}/keys", params)
+      post_request("/repos/#{user}/#{repo}/keys", arguments.params)
     end
 
     # Edit a key
@@ -72,12 +72,11 @@ module Github
     #    "title" => "octocat@octomac",
     #    "key" =>  "ssh-rsa AAA..."
     #
-    def edit(user_name, repo_name, key_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, key_id
-
-      normalize! params
-      filter! VALID_KEY_OPTIONS, params
+    def edit(*args)
+      arguments(args, :required => [:user, :repo, :key_id]) do
+        sift VALID_KEY_OPTIONS
+      end
+      params = arguments.params
 
       patch_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end
@@ -85,13 +84,12 @@ module Github
     # Delete key
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.repos.keys.delete 'user-name', 'repo-name', 'key-id'
+    #  github = Github.new
+    #  github.repos.keys.delete 'user-name', 'repo-name', 'key-id'
     #
-    def delete(user_name, repo_name, key_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, key_id
-      normalize! params
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :key_id])
+      params = arguments.params
 
       delete_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end

data/lib/github_api/repos/merging.rb

@@ -28,13 +28,14 @@ module Github
     #    "head": "cool_feature",
     #    "commit_message": "Shipped cool_feature!"
     #
-    def merge(user_name, repo_name, params={})
-      set :user => user_name, :repo => repo_name
-      normalize! params
-      filter! VALID_MERGE_PARAM_NAMES, params
-      assert_required_keys REQUIRED_MERGE_PARAMS, params
+    def merge(*args)
+      arguments(args, :required => [:user, :repo]) do
+        sift VALID_MERGE_PARAM_NAMES
+        assert_required REQUIRED_MERGE_PARAMS
+      end
+      params = arguments.params
 
-      post_request("/repos/#{user_name}/#{repo_name}/merges", params)
+      post_request("/repos/#{user}/#{repo}/merges", params)
     end
 
   end # Repos::Merging

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -22,9 +22,8 @@ module Github
     #    :verify => 'sync',
     #    :secret => '...'
     #
-    def subscribe(topic, callback, params={})
-      assert_presence_of topic, callback
-      normalize! params
+    def subscribe(*args)
+      params = arguments(args, :required => [:topic, :callback]).params
       _merge_action!("subscribe", topic, callback, params)
 
       post_request("/hub", params, OPTIONS)
@@ -44,9 +43,8 @@ module Github
     #    :verify => 'sync',
     #    :secret => '...'
     #
-    def unsubscribe(topic, callback, params={})
-      assert_presence_of topic, callback
-      normalize! params
+    def unsubscribe(*args)
+      params = arguments(args, :required => [:topic, :callback]).params
       _merge_action!("unsubscribe", topic, callback, params)
 
       post_request("/hub", params, OPTIONS)
@@ -67,12 +65,11 @@ module Github
     #    :token => 'abc123',
     #    :event => 'watch'
     #
-    def subscribe_service(user_name, repo_name, service_name, params={})
-      assert_presence_of user_name, repo_name, service_name
-      normalize! params
-      event = params.delete('event') || 'push'
-      topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
-      callback = "github://#{service_name}?#{params.serialize}"
+    def subscribe_service(*args)
+      params   = arguments(args, :required => [:user, :repo, :service]).params
+      event    = params.delete('event') || 'push'
+      topic    = "#{site}/#{user}/#{repo}/events/#{event}"
+      callback = "github://#{service}?#{params.serialize}"
 
       subscribe(topic, callback)
     end
@@ -90,12 +87,11 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.repos.pubsubhubbub.unsubscribe_service 'user-name', 'repo-name', 'campfire'
     #
-    def unsubscribe_service(user_name, repo_name, service_name, params={})
-      assert_presence_of user_name, repo_name, service_name
-      normalize! params
-      event = params.delete('event') || 'push'
-      topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
-      callback = "github://#{service_name}"
+    def unsubscribe_service(*args)
+      params   = arguments(args, :required => [:user, :repo, :service]).params
+      event    = params.delete('event') || 'push'
+      topic    = "#{site}/#{user}/#{repo}/events/#{event}"
+      callback = "github://#{service}"
 
       unsubscribe(topic, callback)
     end

data/lib/github_api/repos/statuses.rb

@@ -1,10 +1,11 @@
 # encoding: utf-8
 
 module Github
+
+  # The Status API allows external services to mark commits with a success,
+  # failure, error, or pending state, which is then reflected in pull requests
+  # involving those commits.
   class Repos::Statuses < API
-    # The Status API allows external services to mark commits with a success,
-    # failure, error, or pending state, which is then reflected in pull requests
-    # involving those commits.
 
     VALID_STATUS_PARAM_NAMES = %w[
       state
@@ -21,10 +22,9 @@ module Github
     #  github.repos.statuses.list 'user-name', 'repo-name', 'sha'
     #  github.repos.statuses.list 'user-name', 'repo-name', 'sha' { |status| ... }
     #
-    def list(user_name, repo_name, sha, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-      normalize! params
+    def list(*args)
+      arguments(args, :required => [:user, :repo, :sha])
+      params = arguments.params
 
       response = get_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
       return response unless block_given?
@@ -49,13 +49,12 @@ module Github
     #    "target_url" => "http://ci.example.com/johndoe/my-repo/builds/sha",
     #    "description" => "Successful build #3 from origin/master"
     #
-    def create(user_name, repo_name, sha, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo
-
-      normalize! params
-      filter! VALID_STATUS_PARAM_NAMES, params, :recursive => false
-      assert_required_keys(REQUIRED_PARAMS, params)
+    def create(*args)
+      arguments(args, :required => [:user, :repo, :sha]) do
+        sift VALID_STATUS_PARAM_NAMES, :recursive => false
+        assert_required REQUIRED_PARAMS
+      end
+      params = arguments.params
 
       post_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
     end

data/lib/github_api/say.rb

@@ -12,9 +12,7 @@ module Github
     #  github.octocat.say "My custom string..."
     #
     def say(*args)
-      params = args.extract_options!
-      normalize! params
-
+      params = arguments(*args).params
       params[:s] = args.shift unless args.empty?
 
       get_request('/octocat', params, :raw => true)

data/lib/github_api/search.rb

@@ -14,21 +14,14 @@ module Github
     #
     # = Examples
     #  github = Github.new
+    #  github.search.issues 'owner', 'repo-name', 'open','api'
     #  github.search.issues owner: 'owner', repo: 'repo-name', state: 'open', keyword: 'api'
     #
     def issues(*args)
-      params = args.extract_options!
-      normalize! params
-
       required = ['owner', 'repo', 'state', 'keyword']
-      assert_required_keys required, params
-
-      options = required.inject({}) do |hash, key|
-        hash[key] = params.delete(key)
-        hash
-      end
+      arguments(args, :required => required)
 
-      get_request("/legacy/issues/search/#{options['owner']}/#{options['repo']}/#{options['state']}/#{escape(options['keyword'])}", params)
+      get_request("/legacy/issues/search/#{owner}/#{repo}/#{state}/#{escape(keyword)}", arguments.params)
     end
 
     # Search repositories
@@ -40,14 +33,13 @@ module Github
     #
     # = Examples
     #  github = Github.new
+    #  github.search.repos 'api'
     #  github.search.repos keyword: 'api'
     #
     def repos(*args)
-      params = args.extract_options!
-      normalize! params
-      assert_required_keys %w[ keyword ], params
+      arguments(args, :required => [:keyword])
 
-      get_request("/legacy/repos/search/#{escape(params.delete('keyword'))}", params)
+      get_request("/legacy/repos/search/#{escape(keyword)}", arguments.params)
     end
     alias :repositories :repos
 
@@ -63,11 +55,9 @@ module Github
     #  github.search.users keyword: 'wycats'
     #
     def users(*args)
-      params = args.extract_options!
-      normalize! params
-      assert_required_keys %w[ keyword ], params
+      arguments(args, :required => [:keyword])
 
-      get_request("/legacy/user/search/#{escape(params.delete('keyword'))}", params)
+      get_request("/legacy/user/search/#{escape(keyword)}", arguments.params)
     end
 
     # Search email
@@ -83,9 +73,10 @@ module Github
     #  github.search.email email: 'wycats'
     #
     def email(*args)
-      params = args.extract_options!
-      normalize! params
-      assert_required_keys %w[ email ], params
+      arguments(args) do
+        assert_required %w[ email ]
+      end
+      params = arguments.params
 
       get_request("/legacy/user/email/#{params.delete('email')}", params)
     end

data/lib/github_api/users.rb

@@ -47,10 +47,10 @@ module Github
     #  users = Github::Users.new
     #  users.list
     #
-    def list(params={})
-      normalize! params
+    def list(*args)
+      arguments(args)
 
-      response = get_request("/users", params)
+      response = get_request("/users", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -69,8 +69,8 @@ module Github
     #  github.users.get
     #
     def get(*args)
-      params = args.extract_options!
-      normalize! params
+      params = arguments(args).params
+
       if user_name = params.delete('user')
         get_request("/users/#{user_name}", params)
       else
@@ -102,10 +102,11 @@ module Github
     #    "bio" => "There once..."
     #
     def update(*args)
-      params = args.extract_options!
-      normalize! params
-      filter! VALID_USER_PARAMS_NAMES, params
-      patch_request("/user", params)
+      arguments(args) do
+        sift VALID_USER_PARAMS_NAMES
+      end
+
+      patch_request("/user", arguments.params)
     end
 
   end # Users

data/lib/github_api/users/emails.rb

@@ -11,9 +11,9 @@ module Github
     #  github.users.emails.list
     #  github.users.emails.list { |email| ... }
     #
-    def list(params={})
-      normalize! params
-      response = get_request("/user/emails", params)
+    def list(*args)
+      arguments(args)
+      response = get_request("/user/emails", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -29,9 +29,10 @@ module Github
     #  github.users.emails.add "octocat@github.com", "support@github.com"
     #
     def add(*args)
-      params = args.extract_options!
-      normalize! params
-      params['data'] = args if args
+      arguments(args)
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
       post_request("/user/emails", params)
     end
     alias :<< :add
@@ -46,9 +47,10 @@ module Github
     #  github.users.emails.delete "octocat@github.com", "support@github.com"
     #
     def delete(*args)
-      params = args.extract_options!
-      normalize! params
-      params['data'] = args if args
+      arguments(args)
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
       delete_request("/user/emails", params)
     end
 

data/lib/github_api/users/followers.rb

@@ -13,13 +13,14 @@ module Github
     # List the authenticated user's followers
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.followers
     #  github.users.followers { |user| ... }
     #
-    def list(user_name=nil, params={})
-      normalize! params
-      response = if user_name
+    def list(*args)
+      params = arguments(args).params
+
+      response = if user_name = arguments.remaining.first
         get_request("/users/#{user_name}/followers", params)
       else
         get_request("/user/followers", params)
@@ -40,12 +41,13 @@ module Github
     #
     # = Examples
     #
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.followers.following
     #
-    def following(user_name=nil, params={})
-      normalize! params
-      response = if user_name
+    def following(*args)
+      params = arguments(args).params
+
+      response = if user_name = arguments.remaining.first
         get_request("/users/#{user_name}/following", params)
       else
         get_request("/user/following", params)
@@ -57,13 +59,13 @@ module Github
     # Check if you are following a user
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.followers.following? 'user-name'
+    #  github.users.followers.following? user: 'user-name'
     #
-    def following?(user_name, params={})
-      assert_presence_of user_name
-      normalize! params
-      get_request("/user/following/#{user_name}", params)
+    def following?(*args)
+      arguments(args, :required => [:user])
+      get_request("/user/following/#{user}", arguments.params)
       true
     rescue Github::Error::NotFound
       false
@@ -72,25 +74,25 @@ module Github
     # Follow a user
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.followers.follow 'user-name'
+    #  github.users.followers.follow user: 'user-name'
     #
-    def follow(user_name, params={})
-      assert_presence_of user_name
-      normalize! params
-      put_request("/user/following/#{user_name}", params)
+    def follow(*args)
+      arguments(args, :required => [:user])
+      put_request("/user/following/#{user}", arguments.params)
     end
 
     # Unfollow a user
     #
     # = Examples
-    #  github = Github.new :oauth_token => '...'
+    #  github = Github.new oauth_token: '...'
     #  github.users.followers.unfollow 'user-name'
+    #  github.users.followers.unfollow user: 'user-name'
     #
-    def unfollow(user_name, params={})
-      assert_presence_of user_name
-      normalize! params
-      delete_request("/user/following/#{user_name}", params)
+    def unfollow(*args)
+      arguments(args, :required => [:user])
+      delete_request("/user/following/#{user}", arguments.params)
     end
 
   end # Users::Followers