robopigeon 0.1.0

data/lib/robopigeon/slack/client.rb

@@ -0,0 +1,46 @@
+require 'slack-ruby-client'
+
+module RoboPigeon::Slack
+  class Client
+    @name = 'RoboPigeon'
+    @emoji = ':robot_face:'
+    @enabled = true
+
+    class << self
+      attr_accessor :name, :emoji, :enabled
+
+      def client
+        raise 'client requires API key be set' unless @client
+
+        @client
+      end
+
+      attr_writer :client
+
+      def api_key
+        raise 'api_key requires API key be set' unless client.token
+
+        client.token
+      end
+
+      def api_key=(api_key)
+        @client = Slack::Web::Client.new(token: api_key)
+      end
+
+      def get_user(search)
+        begin
+          users = client.users_search(user: search.downcase).try(:members)
+        rescue ::Faraday::Error => e
+          puts "Giving up on slack user lookup because the slack client raised a #{e.class}:\n#{e.message}"
+          users = nil
+        end
+
+        if users.nil? || users.empty? || users.length != 1
+          nil
+        else
+          users.try(:first)
+        end
+      end
+    end
+  end
+end

data/lib/robopigeon/slack/dsl.rb

@@ -0,0 +1,74 @@
+module RoboPigeon::Dsl
+  class SlackRoot
+    def self.run(&block)
+      slack = RoboPigeon::Dsl::SlackRoot.new
+      slack.instance_eval(&block)
+    end
+
+    RoboPigeon::Documentarian.add_command(
+      'enabled',
+      block: ['slack'],
+      params: [
+        { name: 'enabled', type: 'boolean', desc: 'should it run slack commands', example: 'false', default: 'true' }
+      ],
+      desc: 'Set whether or not to run slack commands, defaults to true'
+    )
+    def enabled(bool)
+      RoboPigeon::Slack::Client.enabled = bool
+    end
+
+    RoboPigeon::Documentarian.add_command('api_key', block: ['slack'], params: [{ name: 'api_key', type: 'String', desc: 'the api key for your slackbot', example: "xoxb-don't-actually-store-this-here", default: "ENV['SLACK_API_KEY']" }], desc: 'set your slack api key globally')
+    def api_key(key)
+      RoboPigeon::Slack::Client.api_key = key
+    end
+
+    RoboPigeon::Documentarian.add_command('name', block: ['slack'], params: [{ name: 'name', type: 'String', desc: 'the name your slackbot displays', example: 'RoboPigeon 9000', default: 'RoboPigeon' }], desc: 'set your slack bot name globally')
+    def name(name)
+      RoboPigeon::Slack::Client.name = name
+    end
+
+    RoboPigeon::Documentarian.add_command('emoji', block: ['slack'], params: [{ name: 'emoji', type: 'String', desc: 'the emoji icon your slackbot displays', example: 'RoboPigeon 9000', default: 'RoboPigeon' }], desc: 'set your slack bot emoji icon globally')
+    def emoji(emoji)
+      RoboPigeon::Slack::Client.emoji = emoji
+    end
+  end
+
+  class Slack < SlackRoot
+    include RoboPigeon::Dsl::Helpers
+    attr_accessor :message
+
+    def self.run(&block)
+      if RoboPigeon::Slack::Client.enabled
+        slack = RoboPigeon::Dsl::Slack.new
+        slack.instance_eval(&block)
+        slack.message.send!
+      else
+        puts 'Slack is disabled, please remove `enabled false` from your global slack config'
+      end
+    end
+
+    def initialize
+      self.message = RoboPigeon::Slack::Message.new
+    end
+
+    RoboPigeon::Documentarian.add_command('user', block: %w[job slack], params: [{ name: 'search', type: 'String', desc: 'the name, email, or slack handle of a user to search for', example: 'robopigeon@ives.dev' }], desc: 'add a single user recipient to your message, can be used multiple times')
+    def user(user)
+      message.users.push(RoboPigeon::Slack::Client.get_user(user).try(:id))
+    end
+
+    RoboPigeon::Documentarian.add_command('channel', block: %w[job slack], params: [{ name: 'channel', type: 'String', desc: 'the name of a channel to send the message to', example: '#team-pigeon' }], desc: 'add a single channel recipient to your message, can be used multiple times')
+    def channel(channel)
+      message.channels.push(channel)
+    end
+
+    RoboPigeon::Documentarian.add_command('text', block: %w[job slack], singular: true, params: [{ name: 'text', type: 'Text', desc: 'the text of the message you want to send', example: 'RoboPigeon failed a job! Oh no!' }], desc: 'Add a text message to the message you plan to send')
+    def text(text)
+      message.text = text
+    end
+
+    RoboPigeon::Documentarian.add_block('attachment', helpers: true, block: %w[job slack], desc: 'add an attachment to your slack message, can have multiple attachemnts')
+    def attachment(&block)
+      message.attachments.push(RoboPigeon::Dsl::SlackAttachment.run(&block))
+    end
+  end
+end

data/lib/robopigeon/slack/helper_dsl.rb

@@ -0,0 +1,26 @@
+module RoboPigeon::Dsl
+  module Helpers
+    module Slack
+      RoboPigeon::Documentarian.add_command('slack_user_for', block: ['helpers'], params: [{ name: 'search', type: 'String', desc: 'the name, email, or slack handle of a user to search for', example: 'robopigeon@ives.dev' }], desc: 'Searches for a given user and returns a formatted slack message mention')
+      def slack_user_for(search)
+        uid = RoboPigeon::Slack::Client.get_user(search).try(:id)
+        return '' if uid.nil?
+
+        "<@#{uid}>"
+      end
+
+      RoboPigeon::Documentarian.add_command('slack_name_for', block: ['helpers'], params: [{ name: 'search', type: 'String', desc: 'the name, email, or slack handle of a user to search for', example: 'robopigeon@ives.dev' }], desc: 'Searches for a given user and returns their slack handle with an @')
+      def slack_name_for(search)
+        name = RoboPigeon::Slack::Client.get_user(search).try(:name)
+        return '' if uid.nil?
+
+        "@#{name}"
+      end
+
+      RoboPigeon::Documentarian.add_command('slack_user_group', block: ['helpers'], params: [{ name: 'id', type: 'String', desc: 'the usergroup id to mention', example: 'robopigeon@ives.dev' }], desc: 'a message formatted mention of the given slack group id')
+      def slack_user_group(id)
+        "<!subteam^#{id}>"
+      end
+    end
+  end
+end

data/lib/robopigeon/slack/message.rb

@@ -0,0 +1,35 @@
+module RoboPigeon::Slack
+  class Message
+    attr_accessor :users, :channels, :text, :attachments
+    def initialize
+      self.attachments = []
+      self.users = []
+      self.channels = []
+    end
+
+    def client
+      RoboPigeon::Slack::Client
+    end
+
+    def send_message(recipient)
+      raise 'No text or attachments set' if (text.nil? || text.empty?) && attachments.empty?
+
+      client.client.chat_postMessage(
+        channel: recipient,
+        text: text,
+        icon_emoji: client.emoji,
+        username: client.name,
+        attachments: attachments
+      )
+    end
+
+    def send!
+      users.each do |user|
+        send_message(user)
+      end
+      channels.each do |channel|
+        send_message(channel)
+      end
+    end
+  end
+end

data/lib/robopigeon/slack.rb

@@ -0,0 +1,30 @@
+RoboPigeon::Documentarian.add_block('slack', helpers: true, block: [], desc: 'a configuration block for slack')
+RoboPigeon::Documentarian.add_block('slack', helpers: true, block: ['job'], desc: 'configure a slack notification, sends on end, can have multiple')
+
+require 'robopigeon/slack/client'
+require 'robopigeon/slack/message'
+require 'robopigeon/slack/dsl'
+require 'robopigeon/slack/helper_dsl'
+require 'robopigeon/slack/attachments_dsl'
+
+module RoboPigeon::Dsl
+  module Helpers
+    include RoboPigeon::Dsl::Helpers::Slack
+  end
+end
+
+module RoboPigeon::Dsl
+  class Root
+    def slack(&block)
+      RoboPigeon::Dsl::SlackRoot.run(&block)
+    end
+  end
+end
+
+module RoboPigeon::Dsl
+  class Job
+    def slack(&block)
+      RoboPigeon::Dsl::Slack.run(&block)
+    end
+  end
+end

data/lib/robopigeon/version.rb

@@ -0,0 +1,3 @@
+module RoboPigeon
+  VERSION = File.read(File.join(__dir__, '../../.version')).freeze
+end

data/lib/robopigeon.rb

@@ -0,0 +1,13 @@
+require 'robopigeon/documentarian'
+require 'robopigeon/dsl'
+require 'robopigeon/git'
+require 'robopigeon/gitlab'
+require 'robopigeon/jira'
+require 'robopigeon/markdown'
+require 'robopigeon/slack'
+require 'robopigeon/version'
+
+module RoboPigeon
+  DEFAULT_FILE = "#{FileUtils.pwd}/robopigeon.rb".freeze
+  class SkippedJob < StandardError; end
+end

data/robopigeon.gemspec

@@ -0,0 +1,47 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robopigeon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'robopigeon'
+  spec.version       = RoboPigeon::VERSION
+  spec.authors       = ['Alex Ives']
+  spec.email         = ['alex.ives@granicus.com']
+
+  spec.summary       = 'A set of tools for gitlab and other ci piplines'
+  spec.description   = 'Gitlab ci, jenkins, bamboo, circleci all leave something to be desired - a tigher integration with notifications and git actions. Pigeon bot is a new tool to help you craft pipelines that give you notifications and get you the functionality of a full time bot, without having to run one.'
+  spec.homepage      = 'https://gitlab.com/robopigeon/robopigeon'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://gitlab.com/robopigeon/robopigeon'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gitlab'
+  spec.add_dependency 'markdown2confluence'
+  spec.add_dependency 'picky'
+  spec.add_dependency 'slack-ruby-client'
+  spec.add_dependency 'slackdown', '~> 0.2'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/robopigeon.rb

@@ -0,0 +1,156 @@
+slack do
+  # Slack is currently disabled, make sure you have a valid bot token, then remove
+  # the following line
+  enabled false
+  # This is where you configure your global slack preferences, like bot name and api key
+  # You should always keep the api key either encrypted with something like `encryptatron`
+  # or in a ci environment variable (which is probably better)
+  api_key ENV['SLACK_API_KEY']
+  name 'RoboPigeon'
+end
+
+gitlab do
+  # GitLab is currently disabled, make sure you have a valid api token with acces to
+  # to your repo, then remove the following line
+  enabled false
+  # This is where you configure your global gitlab settings, like api url and api key
+  # always keep your api key either in an environment variable or encrypted with something
+  # something like `encryptatron` or rails secrets.
+  api_url ENV['CI_API_V4_URL']
+  api_key ENV['GITLAB_API_KEY'] # Always use an envrionment variable, don't check in secrets.
+end
+
+jira do
+  # Jira is currently disabled, make sure you have a valid api token with acces to
+  # to your repo, then remove the following line
+  enabled false
+  # This is where you configure your global jira settings, like api url and api token
+  # always keep your api key either in an environment variable or encrypted with
+  # something like `encryptatron` or rails secrets.
+  api_url ENV['JIRA_API_URL']
+  api_key ENV['JIRA_API_TOKEN'] # Always use an envrionment variable, don't check in secrets.
+end
+
+job 'deploy_complete', 'Notify slack and comment in gitlab that a deploy is complete' do
+  # This configures a slack notification, at the end of the block it sends to
+  # the users and channels in the body. Un-comment the channels and fill in the
+  # appropriate ones to have them sent there.
+  slack do
+    # channel '#your-team-channel'
+    # channel '#your-release-notifications-channel'
+    user ENV['GITLAB_USER_EMAIL']
+    # `git_committer_email` looks at the commit log and returns the email address
+    # for the last person to make a non-merge commit
+    user git_committer_email
+    # `git_merger_email` looks at the commit log and returns the email address
+    # for the last person to make a merge commit
+    user git_merger_email
+    # This configures the overall message to send, it comes first, before attachments.
+    # If you want to send multiple messages, you can use attachments with pretext in them
+    # It's not actually required to that you set a message in order to send attachments
+    message "#{slack_user_for(ENV['GITLAB_USER_EMAIL'])} deployed #{ENV['CI_PROJECT_NAME']} #{ENV['CI_COMMIT_TAG']} to #{ENV['CI_ENVIRONMENT_NAME']}"
+    attachment do
+      # You have to set a fallback text for the actions
+      fallback "<#{ENV['CI_PIPELINE_URL']}|Pipeline>"
+      # Actions show up as little buttons under the message, this one will be
+      # a green button that links to the pipeline.
+      action 'button', 'Pipeline', ENV['CI_PIPELINE_URL'], 'primary'
+      action 'button', 'Rollback', "#{ENV['CI_PROJECT_URL']}/environments", 'danger'
+      color 'good'
+    end
+  end
+
+  # This configures an action taken in gitlab. In this case, we're saying to use
+  # the last branch merged into this one as the branch name, and then comment on
+  # each merge request with that branch that someone has started deploying
+  gitlab do
+    merge_request_comment "#{ENV['GITLAB_USER_EMAIL']} deployed branch", git_branch_merged_source
+  end
+
+  # This configures an action taken in jira, In this case, we're looping over all
+  # of the tickets since the last deployment, and then adding a comment to them
+  # with what version it was released in.
+  jira do
+    # This helper gets all of the tickets referenced in the git log since the last
+    # deployment to the referenced environment, that contain the provided key
+    tickets_in_log_since_deployment_to('production', 'TIC').each do |ticket_id|
+      # Then it comments on them with the project that was deployed and the version
+      ticket ticket_id do
+        # Then it comments on them with the project that was deployed and the version
+        comment "#{ENV['CI_PROJECT_NAME']} had changes related to this deployed to production in version #{ENV['CI_COMMIT_TAG']}"
+        # Runs a transition called 'Release'
+        transition 'Release'
+        # and sets the fix version to the tag of the deployment
+        field 'Fix Version', ENV['CI_COMMIT_TAG']
+      end
+    end
+  end
+end
+
+# This example job creates a ticket, assignes it to whoever runs the pipeline, and
+# then sends them a slack message with the id of the ticket
+job 'create ticket' do
+  jira do
+    ticket do
+      # Set the project key
+      project 'PIG'
+      # Set the issue type
+      issuetype 'Bug'
+      # Set the summary of the ticket
+      summary 'Detecetd a defect! Fix it!'
+      # Assign the ticket to the user who is running the pipeline
+      assign ENV['GITLAB_USER_EMAIL']
+      # Set a description from a file template, that template can
+      # use any of the other dsl helpers like the git or deployment
+      # operations
+      description jira_from_md('path/to/file.erb.md')
+      # Create the ticket and store the id in a global variable
+      create!
+      # Print out the ticket number for logging/deubgging
+      puts 'Created ticket:'
+      print_id
+    end
+  end
+
+  slack do
+    user ENV['GITLAB_USER_EMAIL']
+    message "Created #{jira_last_created_ticket_slack_link}"
+  end
+end
+
+# Below are a number of pre-configured jobs that some people find useful!
+job 'deploy_started', 'Notfiy slack and comment in gitlab that a deploy is starting' do
+  slack do
+    user ENV['GITLAB_USER_EMAIL']
+    user git_committer_email
+    user git_merger_email
+    message "#{slack_user_for(ENV['GITLAB_USER_EMAIL'])} deployed #{ENV['CI_PROJECT_NAME']} #{ENV['CI_COMMIT_TAG']} to #{ENV['CI_ENVIRONMENT_NAME']}"
+    attachment do
+      fallback "<#{ENV['CI_PIPELINE_URL']}|Pipeline>"
+      action 'button', 'Pipeline', ENV['CI_PIPELINE_URL'], 'primary'
+      color 'good'
+    end
+  end
+
+  gitlab do
+    merge_request_comment "#{ENV['GITLAB_USER_EMAIL']} has started deyploying this branch", git_branch_merged_source
+  end
+end
+
+job 'notify_failure', 'Notify slack and gitlab that a job has failed' do
+  slack do
+    # channel '#your-team-channel'
+    user ENV['GITLAB_USER_EMAIL']
+    user git_committer_email
+    attachment do
+      fallback "#{ENV['CI_PROJECT_NAME']} - #{ENV['CI_COMMIT_REF_NAME']} has a failure - <#{ENV['CI_PIPELINE_URL']}|Pipeline>"
+      title "#{ENV['CI_PROJECT_NAME']} - #{ENV['CI_COMMIT_REF_NAME']} has a failure"
+      action 'button', 'Pipeline', ENV['CI_PIPELINE_URL'], 'primary'
+      color 'danger'
+    end
+  end
+
+  gitlab do
+    merge_request_comment "The branch from this merge request has a failure - ENV['CI_PIPELINE_URL']", git_branch_merged_source
+  end
+end