octopolo 0.0.1

data/lib/octopolo/github.rb

@@ -0,0 +1,95 @@
+require "octokit"
+# TODO this needs to get moved out of scripts and into its own new module
+require_relative "scripts/github_auth"
+
+module Octopolo
+  module GitHub
+    extend UserConfigWrapper
+
+    # Used as the name of a user if we can't find it on GitHub's API
+    UNKNOWN_USER = "Unknown User"
+
+    # Public: Perform the given block if the user has valid GitHub credentials
+    #
+    # When performing anything that connects to GitHub, wrap with
+    # GitHub.connect to ensure that the user's credentials are all set up
+    # before running anything.
+    #
+    # Example:
+    #
+    #   GitHub.connect do
+    #     # PullRequest.create or whatever
+    #   end
+    def self.connect &block
+      GitHub.check_connection
+
+      yield
+    rescue GitHub::BadCredentials, GitHub::TryAgain => error
+      CLI.say error.message
+    end
+
+    # Public: A GitHub client object
+    def self.client(options = {})
+      Octokit::Client.new(options.merge(login: user_config.github_user, access_token: user_config.github_token))
+    rescue UserConfig::MissingGitHubAuth
+      raise TryAgain, "No GitHub API token stored. Please run `bundle exec github-auth` to generate your token."
+    end
+
+    # Public: A GitHub client configured to crawl through pages
+    def self.crawling_client
+      client(auto_traversal: true)
+    end
+
+    # Public: Check that GitHub credentials have been properly set up
+    def self.check_connection
+      # we don't care about the output, just try to hit the API
+      client.user && nil
+    rescue Octokit::Unauthorized
+      raise BadCredentials, "Your stored credentials were rejected by GitHub. Run `bundle exec github-auth` to generate a new token."
+    end
+
+    def self.pull_request *args
+      client.pull_request *args
+    end
+
+    def self.pull_request_commits *args
+      client.pull_request_commits *args
+    end
+
+    def self.issue_comments *args
+      client.issue_comments *args
+    end
+
+    def self.pull_requests *args
+      crawling_client.pull_requests *args
+    end
+
+    def self.create_pull_request *args
+      client.create_pull_request *args
+    end
+
+    def self.add_comment *args
+      client.add_comment *args
+    end
+
+    def self.user username
+      client.user(username)
+    rescue
+      Hashie::Mash.new(name: UNKNOWN_USER)
+    end
+
+    def self.org_repos org_name="sportngin"
+      crawling_client.organization_repositories org_name
+    end
+
+    def self.excluded_users
+      ["tst-octopolo"]
+    end
+
+    # now that you've set up your credentials, try again
+    TryAgain = Class.new(StandardError)
+    # the credentials you've entered are bad
+    BadCredentials = Class.new(StandardError)
+  end
+end
+

data/lib/octopolo/github/commit.rb

@@ -0,0 +1,45 @@
+require_relative "../github"
+require_relative "user"
+
+module Octopolo
+  module GitHub
+    class Commit
+      attr_accessor :commit_data
+
+      # Public: Instantiate a new Commit wrapper object
+      #
+      # commit_data - The GitHub API data about the commit
+      def initialize commit_data
+        self.commit_data = commit_data
+      end
+
+      # Public: Find commits for a given pull request
+      #
+      # pull_request - A PullRequest or other object responding to #repo_name
+      #   and #number
+      #
+      # Returns an Array of Commit objects
+      def self.for_pull_request pull_request
+        GitHub.pull_request_commits(pull_request.repo_name, pull_request.number).map do |c|
+          Commit.new c
+        end
+      end
+
+      # Public: GitHub User that is the author of the commit
+      #
+      # Returns a Hashie::Mash object of the GitHub User
+      def author
+        GitHub::User.new(commit_data.author.login)
+      rescue NoMethodError
+        GitHub::User.new(GitHub::UNKNOWN_USER)
+      end
+
+      # Public: The name of the author of the commit
+      #
+      # Returns a String containing the author's name
+      def author_name
+        author.author_name
+      end
+    end
+  end
+end

data/lib/octopolo/github/pull_request.rb

@@ -0,0 +1,126 @@
+require_relative "../github"
+require_relative "commit"
+require_relative "pull_request_creator"
+require_relative "user"
+require_relative "../week"
+require "octokit"
+
+module Octopolo
+  module GitHub
+    class PullRequest
+      attr_accessor :pull_request_data
+      attr_accessor :repo_name
+      attr_accessor :number
+
+      def initialize repo_name, number, pull_request_data = nil
+        raise MissingParameter if repo_name.nil? or number.nil?
+
+        self.repo_name = repo_name
+        self.number = number
+        self.pull_request_data = pull_request_data
+      end
+
+      # Public: All closed pull requests for a given repo
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      #
+      # Returns an Array of PullRequest objects
+      def self.closed repo_name
+        GitHub.pull_requests(repo_name, "closed").map do |data|
+          new repo_name, data.number, data
+        end
+      end
+
+      # Public: Create a pull request for the given repo
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      # options - Hash of pull request information
+      #   title: Title of the pull request
+      #   description: Brief description of the pull request
+      #   release: Boolean indicating if the pull request is for Release
+      #   destination_branch: Which branch to merge into
+      #   source_branch: Which branch to be merged
+      #
+      # Returns a PullRequest instance
+      def self.create repo_name, options
+        # create via the API
+        creator = PullRequestCreator.perform(repo_name, options)
+        # wrap in our class
+        new repo_name, creator.number, creator.pull_request_data
+      end
+
+      def pull_request_data
+        @pull_request_data ||= GitHub.pull_request(repo_name, number)
+      rescue Octokit::NotFound
+        raise NotFound
+      end
+
+      def title
+        pull_request_data.title
+      end
+
+      def url
+        pull_request_data.html_url
+      end
+
+      def branch
+        pull_request_data.head.ref
+      end
+
+      def mergeable?
+        pull_request_data.mergeable
+      end
+
+      def week
+        Week.parse pull_request_data.closed_at
+      end
+
+      def commenter_names
+        exlude_octopolo_user (comments.map{ |comment| GitHub::User.new(comment.user.login).author_name }.uniq - author_names)
+      end
+
+      def author_names
+        exlude_octopolo_user commits.map(&:author_name).uniq
+      end
+
+      def exlude_octopolo_user(user_list)
+        user_list.reject{|u| GitHub.excluded_users.include?(u) }
+      end
+
+      def body
+        pull_request_data.body || ""
+      end
+
+      def external_urls
+        # extract http and https URLs from the body
+        URI.extract body, %w(http https)
+      end
+
+      def human_app_name
+        repo = repo_name.split("/").last
+        repo.split("_").map(&:capitalize).join(" ")
+      end
+
+      def commits
+        @commits ||= Commit.for_pull_request self
+      end
+
+      def comments
+        @comments ||= GitHub.issue_comments(repo_name, number)
+      end
+
+      # Public: Add a comment to the pull request
+      #
+      # message - A String containing the desired comment body
+      def write_comment(message)
+        GitHub.add_comment repo_name, number, ":octocat: #{message}"
+      rescue Octokit::UnprocessableEntity => error
+        raise CommentFailed, "Unable to write the comment: '#{error.message}'"
+      end
+
+      MissingParameter = Class.new StandardError
+      NotFound = Class.new StandardError
+      CommentFailed = Class.new StandardError
+    end
+  end
+end

data/lib/octopolo/github/pull_request_creator.rb

@@ -0,0 +1,127 @@
+require_relative "../renderer"
+
+module Octopolo
+  module GitHub
+    class PullRequestCreator
+      include ConfigWrapper
+      # for instantiating the pull request creator
+      attr_accessor :repo_name
+      attr_accessor :options
+      # for caputuring the created pull request information
+      attr_accessor :number
+      attr_accessor :pull_request_data
+
+      # Public: Create a pull request for the given repo with the given options
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      # options - Hash of pull request information
+      #   title: Title of the pull request
+      #   destination_branch: Which branch to merge into
+      #   source_branch: Which branch to be merged
+      def initialize repo_name, options
+        self.repo_name = repo_name
+        self.options = options
+      end
+
+      # Public: Create a pull request for the given repo with the given options
+      #
+      # repo_name - Full name ("account/repo") of the repo in question
+      # options - Hash of pull request information
+      #   title: Title of the pull request
+      #   destination_branch: Which branch to merge into
+      #   source_branch: Which branch to be merged
+      #
+      # Returns the PullRequestCreator instance
+      def self.perform repo_name, options
+        new(repo_name, options).tap do |creator|
+          creator.perform
+        end
+      end
+
+      # Public: Create the pull request
+      #
+      # Returns an array with the first element being the pull request's
+      # number, the second being a Mash of the response from GitHub's API
+      def perform
+        result = GitHub.create_pull_request(repo_name, destination_branch, source_branch, title, body)
+        # capture the information
+        self.number = result.number
+        self.pull_request_data = result
+      rescue => e
+        raise CannotCreate, e.message
+      end
+
+      # Public: The created pull request's details
+      def pull_request_data
+        @pull_request_data || raise(NotYetCreated)
+      end
+
+      # Public: The created pull request's number
+      def number
+        @number || raise(NotYetCreated)
+      end
+
+      # Public: Branch to merge the pull request into
+      #
+      # Returns a String with the branch name
+      def destination_branch
+        options[:destination_branch] || raise(MissingAttribute)
+      end
+
+      # Public: Branch to merge into the destination branch
+      #
+      # Returns a String with the branch name
+      def source_branch
+        options[:source_branch] || raise(MissingAttribute)
+      end
+
+      # Public: Title of the pull request
+      #
+      # Returns a String with the title
+      def title
+        options[:title] || raise(MissingAttribute)
+      end
+
+      # Public: The Pivotal Tracker story IDs associated with the pull request
+      #
+      # Returns an Array of Strings
+      def pivotal_ids
+        options[:pivotal_ids] || []
+      end
+
+      # Public: Jira Issue IDs associated with the pull request
+      #
+      # Returns an Array of Strings
+      def jira_ids
+        options[:jira_ids] || []
+      end
+
+      # Public: Jira Url associated with the pull request
+      #
+      # Returns Jira Url
+      def jira_url
+        config.jira_url
+      end
+
+      # Public: The body (primary copy) of the pull request
+      #
+      # Returns a String
+      def body
+        Renderer.render Renderer::PULL_REQUEST_BODY, body_locals
+      end
+
+      # Public: The local variables to pass into the template
+      def body_locals
+        {
+          pivotal_ids: pivotal_ids,
+          jira_ids: jira_ids,
+          jira_url: jira_url,
+        }
+      end
+
+      MissingAttribute = Class.new(StandardError)
+      NotYetCreated = Class.new(StandardError)
+      CannotCreate = Class.new(StandardError)
+    end
+  end
+end

data/lib/octopolo/github/user.rb

@@ -0,0 +1,40 @@
+module Octopolo
+  module GitHub
+    class User
+      @cache ||= {}
+
+      attr_accessor :login
+
+      # Public: Instantiate a new User
+      #
+      # login - The login (username) of the given user
+      def initialize login
+        self.login = login
+      end
+
+      # Public: The real name of the author
+      #
+      # If the user has a name in GitHub, #author_name returns this. Otherwise
+      # returns the given login.
+      #
+      # Returns a String containing the name
+      def author_name
+        user_data.name || login
+      end
+
+      # Private: The raw GitHub API data for the user
+      #
+      # Returns a Hashie::Mash containing the data
+      def user_data
+        User.user_data login
+      end
+
+      # Private: The raw GitHub API data for the given login
+      #
+      # Returns a Hashie::Mash containing the data
+      def self.user_data login
+        @cache[login] ||= GitHub.user login
+      end
+    end
+  end
+end

data/lib/octopolo/jira/story_commenter.rb

@@ -0,0 +1,26 @@
+require 'jiralicious'
+
+module Octopolo
+  module Jira
+    class StoryCommenter
+      include ConfigWrapper
+
+      attr_accessor :issue
+      attr_accessor :comment
+
+      def initialize(issue_id, comment)
+        Jiralicious.configure do |jira_config|
+          jira_config.username = config.jira_user
+          jira_config.password = config.jira_password
+          jira_config.uri = config.jira_url
+        end
+        self.issue =  Jiralicious::Issue.find issue_id
+        self.comment = comment
+      end
+
+      def perform
+        issue.comments.add(comment)
+      end
+    end
+  end
+end