octokit 1.25.0 → 2.0.0.pre

data/lib/octokit/client/authorizations.rb

@@ -1,5 +1,9 @@
 module Octokit
   class Client
+
+    # Methods for the Authorizations API
+    #
+    # @see http://developer.github.com/v3/oauth/#oauth-authorizations-api
     module Authorizations
 
       # List a users authorizations
@@ -51,8 +55,7 @@ module Octokit
       def create_authorization(options={})
         # Techincally we can omit scopes as GitHub has a default, however the
         # API will reject us if we send a POST request with an empty body.
-        options = {:scopes => ""}.merge(options)
-        post('authorizations', options)
+        post 'authorizations', options
       end
 
       # Update an authorization for the authenticated user.
@@ -74,10 +77,7 @@ module Octokit
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.update_authorization(999999, {:add_scopes => ["gist", "repo"], :note => "Why not Zoidberg possibly?"})
       def update_authorization(number, options={})
-        # Techincally we can omit scopes as GitHub has a default, however the
-        # API will reject us if we send a POST request with an empty body.
-        options = {:scopes => ""}.merge(options)
-        patch("authorizations/#{number}", options)
+        patch "authorizations/#{number}", options
       end
 
       # Delete an authorization for the authenticated user.
@@ -93,7 +93,7 @@ module Octokit
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.delete_authorization(999999)
       def delete_authorization(number, option={})
-        boolean_from_response(:delete, "authorizations/#{number}")
+        boolean_from_response :delete, "authorizations/#{number}"
       end
 
       # Check scopes for a token
@@ -101,14 +101,40 @@ module Octokit
       # @param token [String] GitHub OAuth token
       # @return [Array<String>] OAuth scopes
       # @see http://developer.github.com/v3/oauth/#scopes
-      def scopes(token=nil)
-        request(:get, "user", :access_token => token).
-          headers[:x_oauth_scopes].
+      def scopes(token = @access_token)
+        raise ArgumentError.new("Access token required") if token.nil?
+
+        agent.call(:get, "user", :headers => {"Authorization" => "token #{token}" }).
+          headers['X-OAuth-Scopes'].
+          to_s.
           split(',').
           map(&:strip).
           sort
       end
 
     end
+
+    # Get the URL to authorize a user for an application via the web flow
+    #
+    # @param app_id [String] Client Id we received when our application was registered with GitHub.
+    # @param app_secret [String] Client Secret we received when our application was registered with GitHub.
+    # @option options [String] :redirect_uri The url to redirect to after authorizing.
+    # @option options [String] :scope The scopes to request from the user.
+    # @option options [String] :state A random string to protect against CSRF.
+    # @return [String] The url to redirect the user to authorize.
+    # @see Octokit::Client
+    # @see http://developer.github.com/v3/oauth/#web-application-flow
+    # @example
+    #   @client.authorize_url('xxxx', 'yyyy')
+    def authorize_url(app_id, app_secret, options = {})
+      authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
+      authorize_url += "login/oauth/authorize?client_id=" + app_id + "&client_secret=" + app_secret
+
+      options.each do |key, value|
+        authorize_url += "&" + key.to_s + "=" + value
+      end
+
+      authorize_url
+    end
   end
 end

data/lib/octokit/client/commit_comments.rb

@@ -0,0 +1,96 @@
+module Octokit
+  class Client
+
+    # Methods for the Commit Comments API
+    #
+    # @see http://developer.github.com/v3/repos/comments/
+    module CommitComments
+
+      # List all commit comments
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Array] List of commit comments
+      # @see http://developer.github.com/v3/repos/comments/
+      def list_commit_comments(repo, options={})
+        get "repos/#{Repository.new(repo)}/comments", options
+      end
+
+      # List comments for a single commit
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit whose comments will be fetched
+      # @return [Array]  List of commit comments
+      # @see http://developer.github.com/v3/repos/comments/
+      def commit_comments(repo, sha, options={})
+        get "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options
+      end
+
+      # Get a single commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to fetch
+      # @return [Sawyer::Resource] Commit comment
+      # @see http://developer.github.com/v3/repos/comments/
+      def commit_comment(repo, id, options={})
+        get "repos/#{Repository.new(repo)}/comments/#{id}", options
+      end
+
+      # Create a commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param sha [String] Sha of the commit to comment on
+      # @param body [String] Message
+      # @param path [String] Relative path of file to comment on
+      # @param line [Integer] Line number in the file to comment on
+      # @param position [Integer] Line index in the diff to comment on
+      # @return [Sawyer::Resource] Commit comment
+      # @see http://developer.github.com/v3/repos/comments/
+      # @example Create a commit comment
+      #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
+      #   commit.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
+      #   commit.body # => "My comment message"
+      #   commit.path # => "README.md"
+      #   commit.line # => 10
+      #   commit.position # => 1
+      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options={})
+        params = {
+          :body => body,
+          :commit_id => sha,
+          :path => path,
+          :line => line,
+          :position => position
+        }
+        post "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params)
+      end
+
+      # Update a commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to update
+      # @param body [String] Message
+      # @return [Sawyer::Resource] Updated commit comment
+      # @see http://developer.github.com/v3/repos/comments/
+      # @example Update a commit comment
+      #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
+      #   commit.id # => 860296
+      #   commit.body # => "Updated commit comment"
+      def update_commit_comment(repo, id, body, options={})
+        params = {
+          :body => body
+        }
+        patch "repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params)
+      end
+
+      # Delete a commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to delete
+      # @return [Boolean] Success
+      # @see http://developer.github.com/v3/repos/comments/
+      def delete_commit_comment(repo, id, options={})
+        boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
+      end
+
+    end
+  end
+end

data/lib/octokit/client/commits.rb

@@ -2,31 +2,156 @@ require 'date'
 
 module Octokit
   class Client
+
+    # Methods for the Commits API
+    #
+    # @see http://developer.github.com/v3/repos/commits/
     module Commits
 
       # List commits
       #
-      # Optionally pass <tt>path => "path/to/file.rb"</tt> in <tt>options</tt> to
-      # only return commits containing the given file path.
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
-      # @return [Array] An array of hashes representing commits
+      # @overload commits(repo, sha_or_branch, options = {})
+      #   @deprecated
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param sha_or_branch [String] A commit SHA or branch name
+      #   @param options [String] :sha Commit SHA or branch name from which to start the list
+      # @overload commits(repo, options = {})
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param options [String] :sha Commit SHA or branch name from which to start the list
+      # @return [Array<Sawyer::Resource>] An array of hashes representing commits
       # @see http://developer.github.com/v3/repos/commits/
-      def commits(repo, sha_or_branch="master", options={})
-        params = { :sha => sha_or_branch, :per_page => 35 }
-        get("repos/#{Repository.new(repo)}/commits", params.merge(options))
+      def commits(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        sha_or_branch = arguments.pop
+        if sha_or_branch
+          arguments.options[:sha] = sha_or_branch
+        end
+        paginate "repos/#{Repository.new(arguments.repo)}/commits", arguments.options
       end
       alias :list_commits :commits
 
+      # Get commits after a specified date
+
+      # @overload commits_since(repo, date, options = {})
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param date [String] Date on which we want to compare
+      #   @param options [String] :sha Commit SHA or branch name from which to start the list
+      # @overload commits_since(repo, date, sha_or_branch, options = {})
+      #   @deprecated
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param date [String] Date on which we want to compare
+      #   @param sha_or_branch [String] A commit SHA or branch name
+      #   @param options [String] :sha Commit SHA or branch name from which to start the list
+      # @return [Array<Sawyer::Resource>] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @example
+      #   Octokit.commits_since('pengwynn/octokit', '2012-10-01')
+      def commits_since(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        date   = parse_date(arguments.shift)
+        params = arguments.options
+        end_date = date + 1
+        params.merge!(:since => iso8601(date))
+        sha_or_branch = arguments.pop
+        if sha_or_branch
+          params[:sha] = sha_or_branch
+        end
+        commits(arguments.repo, params)
+      end
+
+      # Get commits before a specified date
+      #
+      # @overload commits_before(repo, date, options = {})
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param date [String] Date on which we want to compare
+      # @overload commits_before(repo, date, sha_or_branch, options = {})
+      #   @deprecated
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param date [String] Date on which we want to compare
+      #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array<Sawyer::Resource>] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @example
+      #   Octokit.commits_before('pengwynn/octokit', '2012-10-01')
+      def commits_before(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        date   = parse_date(arguments.shift)
+        params = arguments.options
+        end_date = date + 1
+        params.merge!(:until => iso8601(date))
+        sha_or_branch = arguments.pop
+        if sha_or_branch
+          params[:sha] = sha_or_branch
+        end
+        commits(arguments.repo, params)
+      end
+
+      # Get commits on a specified date
+      #
+      # @overload commits_on(repo, date, options = {})
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param date [String] Date on which we want to compare
+      # @overload commits_on(repo, date, sha_or_branch, options = {})
+      #   @deprecated
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param date [String] Date on which we want to compare
+      #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array<Sawyer::Resource>] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @example
+      #   Octokit.commits_on('pengwynn/octokit', '2012-10-01')
+      def commits_on(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        date   = parse_date(arguments.shift)
+        params = arguments.options
+        end_date = date + 1
+        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        sha_or_branch = arguments.pop
+        if sha_or_branch
+          params[:sha] = sha_or_branch
+        end
+        commits(arguments.repo, params)
+      end
+
+      # Get commits made between two nominated dates
+      #
+      # @overload commits_between(repo, start_date, end_date, options = {})
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param start_date [String] Start Date on which we want to compare
+      #   @param end_date [String] End Date on which we want to compare
+      # @overload commits_between(repo, start_date, end_date, sha_or_branch, options = {})
+      #   @deprecated
+      #   @param repo [String, Hash, Repository] A GitHub repository
+      #   @param start_date [String] Start Date on which we want to compare
+      #   @param end_date [String] End Date on which we want to compare
+      #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array<Sawyer::Resource>] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @example
+      #   Octokit.commits_on('pengwynn/octokit', '2012-10-01', '2012-11-01')
+      def commits_between(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        date       = parse_date(arguments.shift)
+        end_date   = parse_date(arguments.shift)
+        raise ArgumentError, "Start date #{date} does not precede #{end_date}" if date > end_date
+
+        params = arguments.options
+        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        sha_or_branch = arguments.pop
+        if sha_or_branch
+          params[:sha] = sha_or_branch
+        end
+        commits(arguments.repo, params)
+      end
+
       # Get a single commit
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit to fetch
-      # @return [Hashie::Mash] A hash representing the commit
+      # @return [Sawyer::Resource] A hash representing the commit
       # @see http://developer.github.com/v3/repos/commits/
       def commit(repo, sha, options={})
-        get("repos/#{Repository.new(repo)}/commits/#{sha}", options)
+        get "repos/#{Repository.new(repo)}/commits/#{sha}", options
       end
 
       # Create a commit
@@ -40,7 +165,7 @@ module Octokit
       # @param message [String] The commit message
       # @param tree [String] The SHA of the tree object the new commit will point to
       # @param parents [String, Array] One SHA (for a normal commit) or an array of SHAs (for a merge) of the new commit's parent commits. If ommitted or empty, a root commit will be created
-      # @return [Hashie::Mash] A hash representing the new commit
+      # @return [Sawyer::Resource] A hash representing the new commit
       # @see http://developer.github.com/v3/git/commits/
       # @example Create a commit
       #   commit = Octokit.create_commit("octocat/Hello-World", "My commit message", "827efc6d56897b048c772eb4087f854f46256132", "7d1b31e74ee336d15cbd21741bc88a537ed063a0")
@@ -51,7 +176,7 @@ module Octokit
       def create_commit(repo, message, tree, parents=nil, options={})
         params = { :message => message, :tree => tree }
         params[:parents] = [parents].flatten if parents
-        post("repos/#{Repository.new(repo)}/git/commits", options.merge(params))
+        post "repos/#{Repository.new(repo)}/git/commits", options.merge(params)
       end
 
       # List all commit comments
@@ -60,7 +185,7 @@ module Octokit
       # @return [Array] An array of hashes representing comments
       # @see http://developer.github.com/v3/repos/comments/
       def list_commit_comments(repo, options={})
-        get("repos/#{Repository.new(repo)}/comments", options)
+        get "repos/#{Repository.new(repo)}/comments", options
       end
 
       # List comments for a single commit
@@ -70,17 +195,17 @@ module Octokit
       # @return [Array] An array of hashes representing comments
       # @see http://developer.github.com/v3/repos/comments/
       def commit_comments(repo, sha, options={})
-        get("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options)
+        get "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options
       end
 
       # Get a single commit comment
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to fetch
-      # @return [Hashie::Mash] A hash representing the comment
+      # @return [Sawyer::Resource] A hash representing the comment
       # @see http://developer.github.com/v3/repos/comments/
       def commit_comment(repo, id, options={})
-        get("repos/#{Repository.new(repo)}/comments/#{id}", options)
+        get "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
 
       # Create a commit comment
@@ -91,7 +216,7 @@ module Octokit
       # @param path [String] Relative path of file to comment on
       # @param line [Integer] Line number in the file to comment on
       # @param position [Integer] Line index in the diff to comment on
-      # @return [Hashie::Mash] A hash representing the new commit comment
+      # @return [Sawyer::Resource] A hash representing the new commit comment
       # @see http://developer.github.com/v3/repos/comments/
       # @example Create a commit comment
       #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
@@ -108,7 +233,7 @@ module Octokit
           :line => line,
           :position => position
         }
-        post("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params))
+        post "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params)
       end
 
       # Update a commit comment
@@ -116,7 +241,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to update
       # @param body [String] Message
-      # @return [Hashie::Mash] A hash representing the updated commit comment
+      # @return [Sawyer::Resource] A hash representing the updated commit comment
       # @see http://developer.github.com/v3/repos/comments/
       # @example Update a commit comment
       #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
@@ -126,7 +251,7 @@ module Octokit
         params = {
           :body => body
         }
-        patch("repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params))
+        patch "repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params)
       end
 
       # Delete a commit comment
@@ -136,7 +261,7 @@ module Octokit
       # @return [nil] nil
       # @see http://developer.github.com/v3/repos/comments/
       def delete_commit_comment(repo, id, options={})
-        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/comments/#{id}", options)
+        boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
 
       # Compare two commits
@@ -144,10 +269,10 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param start [String] The sha of the starting commit
       # @param endd [String] The sha of the ending commit
-      # @return [Hashie::Mash] A hash representing the comparison
+      # @return [Sawyer::Resource] A hash representing the comparison
       # @see http://developer.github.com/v3/repos/commits/
       def compare(repo, start, endd, options={})
-        get("repos/#{Repository.new(repo)}/compare/#{start}...#{endd}", options)
+        get "repos/#{Repository.new(repo)}/compare/#{start}...#{endd}", options
       end
 
       # Merge a branch or sha
@@ -156,81 +281,14 @@ module Octokit
       # @param base [String] The name of the base branch to merge into
       # @param head [String] The branch or SHA1 to merge
       # @option options [String] :commit_message The commit message for the merge
-      # @return [Hashie::Mash] A hash representing the comparison
+      # @return [Sawyer::Resource] A hash representing the comparison
       # @see http://developer.github.com/v3/repos/merging/
       def merge(repo, base, head, options={})
         params = {
           :base => base,
           :head => head
         }.merge(options)
-        post("repos/#{Repository.new(repo)}/merges", params)
-      end
-
-      # Get commits based on time windows
-
-      # Get commits after a specified date
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param date [String] Date on which we want to compare
-      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
-      # @return [Array] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
-      # @example
-      #   Octokit.commits_since('pengwynn/octokit', '2012-10-01')
-      def commits_since(repo, date, sha_or_branch="master", options={})
-        params = {:since => iso8601(parse_date(date))}
-        commits(repo, sha_or_branch, params.merge(options))
-      end
-
-      # Get commits before a specified date
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param date [String] Date on which we want to compare
-      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
-      # @return [Array] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
-      # @example
-      #   Octokit.commits_before('pengwynn/octokit', '2012-10-01')
-      def commits_before(repo, date, sha_or_branch="master", options={})
-        params = {:until => iso8601(parse_date(date))}
-        commits(repo, sha_or_branch, params.merge(options))
-      end
-
-      # Get commits on a specified date
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param date [String] Date on which we want to compare
-      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
-      # @return [Array] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
-      # @example
-      #   Octokit.commits_on('pengwynn/octokit', '2012-10-01')
-      def commits_on(repo, date, sha_or_branch="master", options={})
-        start_date = parse_date(date)
-        end_date = start_date + 1
-        params = { :since => iso8601(start_date), :until => iso8601(end_date) }
-        commits(repo, sha_or_branch, params.merge(options))
-      end
-
-      # Get commits made between two nominated dates
-      #
-      # @param repo [String, Hash, Repository] A GitHub repository
-      # @param start_date [String] Start Date on which we want to compare
-      # @param end_date [String] End Date on which we want to compare
-      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
-      # @return [Array] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
-      # @example
-      #   Octokit.commits_on('pengwynn/octokit', '2012-10-01', '2012-11-01')
-      def commits_between(repo, start_date, end_date, sha_or_branch="master", options={})
-        _start_date = parse_date(start_date)
-        _end_date = parse_date(end_date)
-        if _end_date < _start_date
-          raise ArgumentError, "Start date #{start_date} does not precede #{end_date}"
-        end
-        params = {:since => iso8601(_start_date),
-          :until => iso8601(_end_date) }
-        commits(repo, sha_or_branch, params.merge(options))
+        post "repos/#{Repository.new(repo)}/merges", params
       end
 
       protected
@@ -249,7 +307,7 @@ module Octokit
       # @param date [String] String representation of a date
       # @return [DateTime]
       def parse_date(date)
-        date = DateTime.parse(date)
+        date = DateTime.parse(date.to_s)
       rescue ArgumentError
         raise ArgumentError, "#{date} is not a valid date"
       end