pivotoolz 1.2.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dce9f049813a75033d4a499da7caf119aadf0a369ad851882833e5e90ef28ffa
-  data.tar.gz: 325b2049fd6e74137ccd18554935bdf78c69a50a6b2b853b4a00e8370cd43b79
+  metadata.gz: 94e90398170d1e718943d5deed60a7d79d8a61b9b5a365a56497a3c69058eb2a
+  data.tar.gz: d9eba00b2fca976d49f35cfc20dad9ad96c8b59dbc75edf6a682e0826be92839
 SHA512:
-  metadata.gz: 2f0f4588c7b334c13b5bf8c43889cf572ca6eb5f9c02898c3fa58cf58799fdd2bab483a1e392f6599bf10b85e3cbf701fb4a1a6a8cadedb84af14b34fb8bd4ed
-  data.tar.gz: ba1d55f64f7cb29f01056ccb28762652e8b282f362d9370441acb2b3b61e81f812421d6fba7c9a8c5999ca277cbdc2fe33f8e9c58a061fce3c83862d734fbb5e
+  metadata.gz: 95c19644a4959d37793779391d3340bb5fa7cae45447b8022e0b7a7cf0582229f327a355c8f4c32c0714751903e3ab17c98c326d10b85ee1212c882d711dc6ef
+  data.tar.gz: 78215c1d296e66a10702b9cbf81bd590cd0b9a46f7648f3506a88fe8930fde15559a45d7ab41adb7c0cea3cced68ee5a9c8dbbf7987d9a6b4e7e37e38f6af2a3

data/Gemfile.lock

@@ -1,51 +1,53 @@
 PATH
   remote: .
   specs:
-    pivotoolz (0.1.3)
-      rest-client (~> 2.0.2)
+    pivotoolz (2.2.0)
+      rest-client (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    domain_name (0.5.20170404)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.3)
+    http-accept (1.7.0)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
-    mime-types (3.1)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
+    mime-types-data (3.2021.0901)
     netrc (0.11.0)
-    rake (10.4.2)
-    rest-client (2.0.2)
+    rake (13.0.6)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.4)
+    unf_ext (0.0.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2)
   pivotoolz!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake (~> 13.0)
+  rspec (~> 3.10)
 
 BUNDLED WITH
-   1.16.1
+   2.2.27

data/README.md

@@ -189,11 +189,19 @@ Be sure to set your `PIVOTAL_TRACKER_API_TOKEN` env variable in your `.bashrc` f
 set your git config user initials like this: `git config --add user.initials af`. Otherwise it
 will take your `git config user.name` or `whoami` information.
 
-Example:
+Example 1:
 ```bash
 pv-git-branch "#111222333"
 ```
-This would create and checkout a new branch: `af/features/building-someting-great-111222333`.
+This would create and checkout a new branch:
+`af/features/building-someting-great-111222333`.
+
+Example 2 (appending values):
+```bash
+pv-git-branch 12345678 version2 backend only
+```
+This would create and checkout a new branch:
+`af/features/building-something-awesome-12345678-version2-backend-only`
 
 If the branch had already been created, the command will automatically check out existing branch.
 

data/exe/get-story-info-from-jira-id

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'open-uri'
+require 'json'
+
+BASE_URL = ENV['JIRA_API_BASE_URL']
+
+def get_story_info(story_id, flags = [], subdomain)
+  return nil if story_id.empty?
+
+  begin
+    include_owner_names = flags.any? { |f| f == '--owners' || f == '-O' }
+    url = BASE_URL + "#{story_id}" + "/#{include_owner_names ? '?fields=:default,owners' : ''}"
+    open(
+      url,
+      'Authorization' => "Basic #{ENV['JIRA_API_BASIC_AUTH_BASE64_ENCODED']}"
+    ).read
+  rescue StandardError => e
+    story_link = "https://#{subdomain}.atlassian.net/browse/#{story_id}"
+
+    JSON.generate({
+      error: "Could not get story info for story #{story_id}: #{e.message}\n\nStory info may be available at #{story_link}",
+      story_link: story_link
+    })
+  end
+end
+
+if BASE_URL.nil? || BASE_URL.empty?
+  puts "Please set JIRA_API_BASE_URL. It looks something like 'https://YOUR-COMPANY.atlassian.net/rest/api/2/issue/'"
+  exit 1
+end
+
+begin
+  subdomain = URI.parse(BASE_URL).host.split('.atlassian.net').first
+rescue => e
+  puts "Error determining your Jira subdomain. Please check your JIRA_API_BASE_URL environment variable"
+  exit 1
+end
+
+flags = ARGV.reduce([]) do |reduced, a|
+  reduced << a if a.include?('--') || a.include?('-')
+  reduced
+end
+
+flags.each { |f| ARGV.delete f }
+
+stream = ARGV.any? ? ARGV : ARGF
+
+if stream == ARGF && $stdin.tty?
+  puts "Usage:\nget-story-info-from-jira-id STORY_ID\n"
+  puts " OR\n"
+  puts "echo STORY_ID | get-story-info-from-id"
+  puts " OR\n"
+  exit 1
+end
+
+infos = stream.reduce([]) do |reduced, story_id|
+  next reduced unless story_id && story_id =~ /\d+/
+  reduced << get_story_info(story_id.strip, flags, subdomain)
+end
+
+puts infos.join("\n")

data/exe/jira-stories-deployed

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'ostruct'
+
+BASE_URL = ENV['JIRA_API_BASE_URL']
+
+if BASE_URL.nil? || BASE_URL.empty?
+  puts "Please set JIRA_API_BASE_URL. It looks something like 'https://YOUR-COMPANY.atlassian.net/rest/api/2/issue/'"
+  exit 1
+end
+
+begin
+  subdomain = URI.parse(BASE_URL).host.split('.atlassian.net').first
+rescue => e
+  puts "Error determining your Jira subdomain. Please check your JIRA_API_BASE_URL environment variable"
+  exit 1
+end
+
+environment_tag = ARGV[0]&.strip
+if environment_tag.nil? || environment_tag.empty?
+  puts "Usage: stories-deployed ENVIRONMENT"
+  exit 1
+end
+
+flags = ARGV.select { |a| a.include?('--') || a.include?('-') }
+
+include_owners = flags
+  .any? { |f| f == '--owners' || f == '-O' }
+
+format_as_json = flags
+  .any? { |f| f == '--json' || f == '-j' }
+
+deployed_story_infos = `jira-story-ids-deployed #{environment_tag} | get-story-info-from-jira-id #{flags.join(' ')}`
+
+def as_json(story, include_owners, flags, subdomain)
+  if story.error
+    return {
+      title: story.error,
+      title_link: story.story_link
+    }.to_json
+  end
+
+  json = {
+    title: story.fields['summary']&.strip,
+    title_link: "https://#{subdomain}.atlassian.net/browse/#{story.key}",
+    mrkdwn_in: ["text", "pretext", "footer"]
+  }
+
+  if include_owners
+    if flags.include? '--owners-footer'
+      json.merge!(
+        footer: "\n\nBrought to you by: #{story_owner_names(story, flags)}"
+      )
+    else
+      json.merge!(
+        text: "\n\nBrought to you by: #{story_owner_names(story, flags)}"
+      )
+    end
+  end
+
+  json.to_json
+end
+
+def story_owner_names(story, flags)
+  owners = story
+    .owners
+    .compact
+    .map { |o| OpenStruct.new(o).name }
+
+  if flags.include? '--bold-owners'
+    return to_sentence(owners.map { |o| "*#{o}*" })
+  end
+
+  to_sentence(owners)
+end
+
+def to_sentence(array)
+  array.size > 2 ?
+    "#{array[0..-2].join(', ')} and #{array.last}" :
+    array.join(' and ')
+end
+
+stories_deployed = deployed_story_infos
+  .split("\n")
+  .compact
+  .reduce([]) do |reduced, story_info|
+    story = OpenStruct.new(JSON.parse(story_info))
+
+    if format_as_json
+      reduced << as_json(story, include_owners, flags, subdomain)
+      next reduced
+    end
+
+    reduced << "#{story.error}"
+    next reduced if story.error
+
+    reduced << "#{story.name&.strip}:\n#{story.url}"
+
+    if include_owners
+      reduced << "\nBrought to you by: #{story_owner_names(story, flags)}"
+    end
+
+    reduced
+  end
+
+puts stories_deployed

data/exe/jira-story-ids-deployed

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+environment_tag = ARGV[0]&.strip
+
+if environment_tag.nil? || environment_tag.empty?
+  puts "Usage: story-ids-deployed ENVIRONMENT"
+  exit 1
+end
+
+commit_range = `git tag -l #{environment_tag}* | tail -n 2 | tr '\n' ' ' | sed -e 's/ /../'`.strip
+
+if commit_range.nil? || commit_range.empty?
+  puts "Empty commit range! Are there any commits tagged with #{environment_tag}?"
+  exit 1
+end
+
+commit_message_bodies = `git log --pretty="%h %s" #{commit_range}`.strip
+story_ids = commit_message_bodies.
+  # TODO: Make this configurable
+  scan(/(DI-\d+|ST-\d+)/).
+  flatten.
+  compact.
+  uniq
+
+puts story_ids.join("\n")

data/exe/post-slack-message

@@ -2,47 +2,32 @@
 
 require 'rest-client'
 require 'json'
+require_relative '../lib/pivotoolz/post_slack_message'
 
-URL = ENV['SLACK_WEBHOOK_URL']
+URL = ENV.fetch('SLACK_WEBHOOK_URL') { '' }
+CHANNEL_URL_MAP = ENV.fetch('SLACK_WEBHOOK_CHANNEL_URLS') { {} }
+
+if URL.empty? && CHANNEL_URL_MAP.empty?
+  puts "Need either SLACK_WEBHOOK_URL or SLACK_WEBHOOK_CHANNEL_URLS to be defined!"
+  exit 0
+end
 
 channel = ARGV.shift
+if channel.to_s.empty?
+  puts "Channel to post to is required!!"
+  exit 0
+end
+
 content = ARGV.empty? ? ARGF.read : StringIO.new(ARGV.join("\n")).read
 exit 0 if content.strip.empty?
 
-begin
-  if attachments = JSON.parse(
-    "[#{content.split("\n").slice(1..-1).join(",")}]"
-  )
-    begin
-      RestClient.post(
-        URL,
-        payload: {
-          username: ENV['SLACKBOT_USERNAME'] || 'slackbot',
-          channel: channel,
-          text: content.split("\n")&.first || '',
-          attachments: attachments,
-          icon_emoji: ":ghost:"
-        }.to_json
-      )
-    rescue RestClient::Exceptions => e
-      puts "Error posting to slack #{e.message}:\n#{e.backtrace}"
-    end
-
-    exit 0
-  end
-rescue JSON::ParserError => e
-end
+psm = PostSlackMessage.new
+webhook_url = psm.select_webhook_url(URL, CHANNEL_URL_MAP, channel)
 
-begin
-  RestClient.post(
-    URL,
-    payload: {
-      username: ENV['SLACKBOT_USERNAME'] || 'slackbot',
-      channel: channel,
-      text: content,
-      icon_emoji: ":ghost:"
-    }.to_json
-  )
-rescue RestClient::Exceptions => e
-  puts "Error posting to slack #{e.message}:\n#{e.backtrace}"
+if webhook_url.nil?
+  puts "Channel '#{channel}' webhook url not found! Please define it in SLACK_WEBHOOK_CHANNEL_URLS environment variable"
+  exit 0
 end
+
+result = psm.post_message(webhook_url, channel, content)
+puts result if !result.empty?

data/exe/pv-git-branch

@@ -2,8 +2,9 @@
 
 require_relative '../lib/pivotoolz/git_branch'
 
-if ARGV.length != 1
+if ARGV.length < 1
   puts "#{GitBranch.usage_message}"
   exit
 end
-puts GitBranch.new.generate(ARGV.first)
+first_arg, *the_rest = ARGV
+puts GitBranch.new.generate(first_arg, the_rest)

data/lib/pivotoolz/git_branch.rb

@@ -1,7 +1,7 @@
 require 'json'
 
 class GitBranch
-  def generate(story_id)
+  def generate(story_id, *append)
     if !story_id
       puts "#{GitBranch.usage_message}"
       exit
@@ -13,8 +13,9 @@ class GitBranch
     category    = set_category(story['story_type'])
     description = set_description(story['name'])
     pivotal_id  = story['id']
+    append      = set_append_values(append)
 
-    create_branch("#{author}/#{category}/#{description}-#{pivotal_id}")
+    create_branch("#{author}/#{category}/#{description}-#{pivotal_id}#{append}")
   end
 
   private
@@ -38,9 +39,7 @@ class GitBranch
 
   def set_author
     author_name = get_author_initials || get_author_name || get_whoami || 'unknown'
-    author_name.downcase!
-    author_name.tr!('.@!#$%^\&*()', '')
-    author_name.tr(' ', '+')
+    clean_text(author_name)
   end
 
   def get_author_initials
@@ -63,14 +62,24 @@ class GitBranch
   end
 
   def set_description(description)
-    description.tr!(':_,/.&!@#$%^*()[]\'`<>"', '') # remove unwanted punctuation
-    description.tr!('-', ' ') # replace dashes with space
-    description.downcase! # convert to lowercase
-    description.gsub!(/ +/,'-') # collapse spacing and replace spaces with dashes
-    description[0 .. 45].gsub(/-$/, '')
+    clean_text(description)
+  end
+
+  def set_append_values(appendings)
+    return '' if appendings.empty?
+    clean_appendings = appendings.map{|appending| clean_text(appending) }
+    "-#{clean_appendings.join('-')}"
+  end
+
+  def clean_text(string_value)
+    string_value.tr!(':_,/.&!@#$%^*()[]\'`<>"', '') # remove unwanted punctuation
+    string_value.tr!('-', ' ') # replace dashes with space
+    string_value.downcase! # convert to lowercase
+    string_value.gsub!(/ +/,'-') # collapse spacing and replace spaces with dashes
+    string_value[0 .. 35].gsub(/-$/, '') # limit to 45 chars
   end
 
   def self.usage_message
-    "Usage : pv-git-branch '[pivotal_story_id]'"
+    "Usage : pv-git-branch '<pivotal_story_id>' '[<appended_branchname_values>...]'"
   end
 end

data/lib/pivotoolz/post_slack_message.rb

@@ -0,0 +1,51 @@
+class PostSlackMessage
+  def select_webhook_url(url, channel_map, channel)
+    return url if channel_map.empty?
+
+    channel_webhook_map = channel_map.split(',').reduce({}) do |reduced, channel_map_string|
+      c, url = channel_map_string.split('->')
+      reduced[c] = url
+      reduced["@#{c}"] = url if !c.start_with?('@')
+      reduced["##{c}"] = url if !c.start_with?('#')
+      reduced
+    end
+
+    channel_webhook_map[channel]
+  end
+
+  def post_message(url, channel, content)
+    begin
+      text, *json = content.split("\n")
+      return post_basic_message(url, channel, content) if json.empty?
+
+      post_data = json.any? { |s| s.include? 'blocks' } ? JSON.parse(json.first) : {attachments: json.map { |j| JSON.parse(j) }}
+      begin
+        RestClient.post(
+          url,
+          post_data.merge({text: text || ''}).to_json,
+          {content_type: :json, accept: :json}
+        )
+      rescue RestClient::Exceptions => e
+        return "Error posting to slack #{e.message}:\n#{e.backtrace}"
+      end
+    rescue JSON::ParserError => e
+      "Error parsing json: #{e}"
+    end
+  end
+
+  def post_basic_message(url, channel, content)
+    begin
+      RestClient.post(
+        url,
+        payload: {
+          username: ENV['SLACKBOT_USERNAME'] || 'slackbot',
+          channel: channel,
+          text: content,
+          icon_emoji: ":ghost:"
+        }.to_json
+      )
+    rescue RestClient::Exceptions => e
+      puts "Error posting to slack #{e.message}:\n#{e.backtrace}"
+    end
+  end
+end

data/lib/pivotoolz/version.rb

@@ -1,3 +1,3 @@
 module Pivotoolz
-  VERSION = "1.2.2"
+  VERSION = "2.2.0"
 end

data/pivotoolz.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rest-client', "~> 2.0.2"
+  spec.add_dependency 'rest-client', "~> 2.1"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pivotoolz
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Sufyan Adam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-11-22 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 description: Auto-deliver your finished stories upon successful deployment, find out
   which stories went out in the last deployment, get a list of pivotal tracker story
   ids that went out in the last deployment.
@@ -75,6 +75,9 @@ executables:
 - deliver-deployed-stories
 - deliver-story
 - get-story-info-from-id
+- get-story-info-from-jira-id
+- jira-stories-deployed
+- jira-story-ids-deployed
 - merge
 - post-slack-message
 - pv-git-branch
@@ -104,6 +107,9 @@ files:
 - exe/deliver-deployed-stories
 - exe/deliver-story
 - exe/get-story-info-from-id
+- exe/get-story-info-from-jira-id
+- exe/jira-stories-deployed
+- exe/jira-story-ids-deployed
 - exe/merge
 - exe/post-slack-message
 - exe/pv-git-branch
@@ -112,6 +118,7 @@ files:
 - exe/tag-it
 - lib/pivotoolz.rb
 - lib/pivotoolz/git_branch.rb
+- lib/pivotoolz/post_slack_message.rb
 - lib/pivotoolz/version.rb
 - pivotoolz.gemspec
 homepage: https://github.com/sufyanadam/pivotoolz
@@ -119,7 +126,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,9 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Tools to save you time when working with Pivotal Tracker stories
 test_files: []