octodoggy 4.6.2

data/lib/octokit/client/commit_comments.rb

@@ -0,0 +1,95 @@
+module Octokit
+  class Client
+
+    # Methods for the Commit Comments API
+    #
+    # @see https://developer.github.com/v3/repos/comments/
+    module CommitComments
+
+      # List all commit comments
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Array] List of commit comments
+      # @see https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
+      def list_commit_comments(repo, options = {})
+        paginate "#{Repository.path repo}/comments", options
+      end
+
+      # List comments for a single commit
+      #
+      # @param repo [Integer, 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 https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
+      def commit_comments(repo, sha, options = {})
+        paginate "#{Repository.path repo}/commits/#{sha}/comments", options
+      end
+
+      # Get a single commit comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to fetch
+      # @return [Sawyer::Resource] Commit comment
+      # @see https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
+      def commit_comment(repo, id, options = {})
+        get "#{Repository.path repo}/comments/#{id}", options
+      end
+
+      # Create a commit comment
+      #
+      # @param repo [Integer, 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 https://developer.github.com/v3/repos/comments/#create-a-commit-comment
+      # @example Create a commit comment
+      #   comment = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
+      #   comment.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
+      #   comment.id # => 54321
+      #   comment.body # => "My comment message"
+      #   comment.path # => "README.md"
+      #   comment.line # => 10
+      #   comment.position # => 1
+      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
+        params = {
+          :body => body,
+          :path => path,
+          :line => line,
+          :position => position
+        }
+        post "#{Repository.path repo}/commits/#{sha}/comments", options.merge(params)
+      end
+
+      # Update a commit comment
+      #
+      # @param repo [Integer, 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 https://developer.github.com/v3/repos/comments/#update-a-commit-comment
+      # @example Update a commit comment
+      #   comment = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
+      #   comment.id # => 860296
+      #   comment.body # => "Updated commit comment"
+      def update_commit_comment(repo, id, body, options = {})
+        params = {
+          :body => body
+        }
+        patch "#{Repository.path repo}/comments/#{id}", options.merge(params)
+      end
+
+      # Delete a commit comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to delete
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/repos/comments/#delete-a-commit-comment
+      def delete_commit_comment(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/comments/#{id}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/commits.rb

@@ -0,0 +1,239 @@
+require 'date'
+
+module Octokit
+  class Client
+
+    # Methods for the Commits API
+    #
+    # @see https://developer.github.com/v3/repos/commits/
+    module Commits
+
+      # List commits
+      #
+      # @overload commits(repo, sha_or_branch, options = {})
+      #   @deprecated
+      #   @param repo [Integer, 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 [Integer, 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 https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      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 "#{Repository.new(arguments.repo).path}/commits", arguments.options
+      end
+      alias :list_commits :commits
+
+      # Get commits after a specified date
+      #
+      # @overload commits_since(repo, date, options = {})
+      #   @param repo [Integer, 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 [Integer, 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 https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @example
+      #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
+      def commits_since(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        date   = parse_date(arguments.shift)
+        params = arguments.options
+        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 [Integer, 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 [Integer, 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 https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @example
+      #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
+      def commits_before(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        date   = parse_date(arguments.shift)
+        params = arguments.options
+        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 [Integer, 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 [Integer, 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 https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @example
+      #   Octokit.commits_on('octokit/octokit.rb', '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 [Integer, 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 [Integer, 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 https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
+      # @example
+      #   Octokit.commits_between('octokit/octokit.rb', '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 [Integer, String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit to fetch
+      # @return [Sawyer::Resource] A hash representing the commit
+      # @see https://developer.github.com/v3/repos/commits/#get-a-single-commit
+      def commit(repo, sha, options = {})
+        get "#{Repository.path repo}/commits/#{sha}", options
+      end
+
+      # Get a detailed git commit
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit to fetch
+      # @return [Sawyer::Resource] A hash representing the commit
+      # @see https://developer.github.com/v3/git/commits/#get-a-commit
+      def git_commit(repo, sha, options = {})
+        get "#{Repository.path repo}/git/commits/#{sha}", options
+      end
+
+      # Create a commit
+      #
+      # Optionally pass <tt>author</tt> and <tt>committer</tt> hashes in <tt>options</tt>
+      # if you'd like manual control over those parameters. If absent, details will be
+      # inferred from the authenticated user. See <a href="http://developer.github.com/v3/git/commits/">GitHub's documentation</a>
+      # for details about how to format committer identities.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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 [Sawyer::Resource] A hash representing the new commit
+      # @see https://developer.github.com/v3/git/commits/#create-a-commit
+      # @example Create a commit
+      #   commit = Octokit.create_commit("octocat/Hello-World", "My commit message", "827efc6d56897b048c772eb4087f854f46256132", "7d1b31e74ee336d15cbd21741bc88a537ed063a0")
+      #   commit.sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
+      #   commit.tree.sha # => "827efc6d56897b048c772eb4087f854f46256132"
+      #   commit.message # => "My commit message"
+      #   commit.committer # => { "name" => "Wynn Netherland", "email" => "wynn@github.com", ... }
+      def create_commit(repo, message, tree, parents=nil, options = {})
+        params = { :message => message, :tree => tree }
+        params[:parents] = [parents].flatten if parents
+        post "#{Repository.path repo}/git/commits", options.merge(params)
+      end
+
+      # Compare two commits
+      #
+      # @param repo [Integer, 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 [Sawyer::Resource] A hash representing the comparison
+      # @see https://developer.github.com/v3/repos/commits/#compare-two-commits
+      def compare(repo, start, endd, options = {})
+        get "#{Repository.path repo}/compare/#{start}...#{endd}", options
+      end
+
+      # Merge a branch or sha
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @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 [Sawyer::Resource] A hash representing the comparison
+      # @see https://developer.github.com/v3/repos/merging/#perform-a-merge
+      def merge(repo, base, head, options = {})
+        params = {
+          :base => base,
+          :head => head
+        }.merge(options)
+        post "#{Repository.path repo}/merges", params
+      end
+
+      protected
+
+      def iso8601(date)
+        if date.respond_to?(:iso8601)
+          date.iso8601
+        else
+          date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+        end
+      end
+
+      # Parses the given string representation of a date, throwing a meaningful exception
+      # (containing the date that failed to parse) in case of failure.
+      #
+      # @param date [String] String representation of a date
+      # @return [DateTime]
+      def parse_date(date)
+        date = DateTime.parse(date.to_s)
+      rescue ArgumentError
+        raise ArgumentError, "#{date} is not a valid date"
+      end
+    end
+  end
+end

data/lib/octokit/client/contents.rb

@@ -0,0 +1,162 @@
+require 'base64'
+
+module Octokit
+  class Client
+
+    # Methods for the Repo Contents API
+    #
+    # @see https://developer.github.com/v3/repos/contents/
+    module Contents
+
+      # Receive the default Readme for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
+      # @return [Sawyer::Resource] The detail of the readme
+      # @see https://developer.github.com/v3/repos/contents/#get-the-readme
+      # @example Get the readme file for a repo
+      #   Octokit.readme("octokit/octokit.rb")
+      def readme(repo, options={})
+        get "#{Repository.path repo}/readme", options
+      end
+
+      # Receive a listing of a repository folder or the contents of a file
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [String] :path A folder or file path
+      # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
+      # @return [Sawyer::Resource] The contents of a file or list of the files in the folder
+      # @see https://developer.github.com/v3/repos/contents/#get-contents
+      # @example List the contents of lib/octokit.rb
+      #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
+      def contents(repo, options={})
+        repo_path = options.delete :path
+        url = "#{Repository.path repo}/contents/#{repo_path}"
+        get url, options
+      end
+      alias :content :contents
+
+      # Add content to a repository
+      #
+      # @overload create_contents(repo, path, message, content = nil, options = {})
+      #   @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #   @param path [String] A path for the new content
+      #   @param message [String] A commit message for adding the content
+      #   @param optional content [String] The content for the file
+      #   @option options [String] :branch The branch on which to add the content
+      #   @option options [String] :file Path or Ruby File object for content
+      # @return [Sawyer::Resource] The contents and commit info for the addition
+      # @see https://developer.github.com/v3/repos/contents/#create-a-file
+      # @example Add content at lib/octokit.rb
+      #   Octokit.create_contents("octokit/octokit.rb",
+      #                    "lib/octokit.rb",
+      #                    "Adding content",
+      #                    "File content",
+      #                    :branch => "my-new-feature")
+      def create_contents(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        repo    = args.shift
+        path    = args.shift
+        message = args.shift
+        content = args.shift
+        if content.nil? && file = options.delete(:file)
+          case file
+          when String
+            if File.exist?(file)
+              file = File.open(file, "r")
+              content = file.read
+              file.close
+            end
+          when File, Tempfile
+            content = file.read
+            file.close
+          end
+        end
+        raise ArgumentError.new("content or :file option required") if content.nil?
+        options[:content] = Base64.respond_to?(:strict_encode64) ?
+          Base64.strict_encode64(content) :
+          Base64.encode64(content).delete("\n") # Ruby 1.9.2
+        options[:message] = message
+        url = "#{Repository.path repo}/contents/#{path}"
+        put url, options
+      end
+      alias :create_content :create_contents
+      alias :add_content :create_contents
+      alias :add_contents :create_contents
+
+      # Update content in a repository
+      #
+      # @overload update_contents(repo, path, message, sha, content = nil, options = {})
+      #   @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #   @param path [String] A path for the content to update
+      #   @param message [String] A commit message for updating the content
+      #   @param sha [String] The _blob sha_ of the content to update
+      #   @param content [String] The content for the file
+      #   @option options [String] :branch The branch on which to update the content
+      #   @option options [String] :file Path or Ruby File object for content
+      # @return [Sawyer::Resource] The contents and commit info for the update
+      # @see https://developer.github.com/v3/repos/contents/#update-a-file
+      # @example Update content at lib/octokit.rb
+      #   Octokit.update_contents("octokit/octokit.rb",
+      #                    "lib/octokit.rb",
+      #                    "Updating content",
+      #                    "7eb95f97e1a0636015df3837478d3f15184a5f49",
+      #                    "File content",
+      #                    :branch => "my-new-feature")
+      def update_contents(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        repo    = args.shift
+        path    = args.shift
+        message = args.shift
+        sha     = args.shift
+        content = args.shift
+        options.merge!(:sha => sha)
+        create_contents(repo, path, message, content, options)
+      end
+      alias :update_content :update_contents
+
+      # Delete content in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param path [String] A path for the content to delete
+      # @param message [String] A commit message for deleting the content
+      # @param sha [String] The _blob sha_ of the content to delete
+      # @option options [String] :branch The branch on which to delete the content
+      # @return [Sawyer::Resource] The commit info for the delete
+      # @see https://developer.github.com/v3/repos/contents/#delete-a-file
+      # @example Delete content at lib/octokit.rb
+      #   Octokit.delete_contents("octokit/octokit.rb",
+      #                    "lib/octokit.rb",
+      #                    "Deleting content",
+      #                    "7eb95f97e1a0636015df3837478d3f15184a5f49",
+      #                    :branch => "my-new-feature")
+      def delete_contents(repo, path, message, sha, options = {})
+        options[:message] = message
+        options[:sha] = sha
+        url = "#{Repository.path repo}/contents/#{path}"
+        delete url, options
+      end
+      alias :delete_content :delete_contents
+      alias :remove_content :delete_contents
+      alias :remove_contents :delete_contents
+
+      # This method will provide a URL to download a tarball or zipball archive for a repository.
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository.
+      # @option options format [String] Either tarball (default) or zipball.
+      # @option options [String] :ref Optional valid Git reference, defaults to master.
+      # @return [String] Location of the download
+      # @see https://developer.github.com/v3/repos/contents/#get-archive-link
+      # @example Get archive link for octokit/octokit.rb
+      #   Octokit.archive_link("octokit/octokit.rb")
+      def archive_link(repo, options={})
+        repo_ref = options.delete :ref
+        format = (options.delete :format) || 'tarball'
+        url = "#{Repository.path repo}/#{format}/#{repo_ref}"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+    end
+  end
+end