pivotoolz 2.0.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bb165619a9f870e9bddf016cc7f848b0e4540469afa55815b73ecd72ec120b3
-  data.tar.gz: ac122af7c59ba532b2db9c1c10b962a95c8c4f8f5ca5f9553544aff1099ad3a5
+  metadata.gz: 4dd31c5a6721ed081086c98c0a069f4a38a4c1dde54b170e446780da2773bdd4
+  data.tar.gz: b099cfa80fdc349cead72eaded1c036467f793feb063fa8d54672a94f789d481
 SHA512:
-  metadata.gz: f62d291e64171cc4648046fd35fb5dbb45ed2a7959f2427adaceba71b92661b6890a81ae132fd9200ae73b21d434a1ad8ee36187d54ed78b8dfa30dd6095243c
-  data.tar.gz: 6b776e7f9be4954b3fbab03c2d74cd3e97bb0e9809268815d7c591750d4e24832a6f99f9a92251a24afb5aa6024f048f384fab83b53aace6d9994652a27bc791
+  metadata.gz: 929634a5713e90745ae1bc2cac413855af3dee6441092c3f010854bc4159461f08d38872d9a6faa25cb2bae23ae7fba7094d487d5edbdc9b6601319c9b602a6a
+  data.tar.gz: 6437d69d3b64ed6c9dd380e3fb0028b94a71af256e3142e3d92946fb73fd8bae5c580c98c2ec532d73b3a4b467d6e03f6048077875f1ebe254cbade96c33411d

data/Gemfile.lock

@@ -1,51 +1,53 @@
 PATH
   remote: .
   specs:
-    pivotoolz (1.3.0)
-      rest-client (~> 2.0.2)
+    pivotoolz (2.2.0)
+      rest-client (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
+    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.3)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
+    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.6)
+    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.17.2
+   2.2.27

data/README.md

@@ -156,6 +156,29 @@ https://www.pivotaltracker.com/story/show/456
 Use with `post-slack-message` to post a message in a slack deployment channel
 with the list of stories that just got deployed.
 
+For a slack-compatible formatted message, add the `--json` flag.
+
+There are additional formatting flags if you want to see the name of the person who completed a story in the slack formatted message:
+`--owners` - Show name of person who completed the story as part of the message
+
+`--owners-footer` - Show name of person who completed the story as a footer (requires `--owners` flag)
+
+`--bold-owners` - Show name of person who completed the story in bold text (requires `--owners` flag)
+
+### `jira-stories-deployed`
+
+Similar to `stories-deployed`, but for Jira! Now you can use your favourite development workflow accelerator, even if your
+current team uses Jira!
+
+Simply define the following environment variables, and you're ready to go!
+
+```
+export JIRA_API_BASIC_AUTH_BASE64_ENCODED=BASE_64_ENCODED_username:password   # See https://developer.atlassian.com/server/jira/platform/basic-authentication/
+export JIRA_API_BASE_URL=https://YOUR_ORG.atlassian.net/rest/api/3/issue/
+export STORY_ID_REGEX=YOUR_STORY_ID_PATTERN_REGEX  # Falls back to [[:alpha:]]+-\d+ if not set
+```
+Use `jira-stories-deployed` just as you would `stories-deployed`.
+
 ### `post-slack-message`
 
 Post a message to a slack channel. You will need to [setup

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

@@ -11,7 +11,7 @@ def get_story_info(story_id, flags = [])
   begin
     include_owner_names = flags.any? { |f| f == '--owners' || f == '-O' }
     url = BASE_URL + "#{story_id}" + "/#{include_owner_names ? '?fields=:default,owners' : ''}"
-    open(
+    URI.open(
       url,
       'X-TrackerToken' => ENV['PIVOTAL_TRACKER_API_TOKEN']
     ).read

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

@@ -0,0 +1,61 @@
+#!/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
+    url = BASE_URL + "#{story_id}"
+    URI.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,110 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'ostruct'
+require 'uri'
+
+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
+    .fields
+    .assignee
+    &.displayName
+  )
+
+  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 = JSON.parse(story_info, object_class: OpenStruct)
+
+    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(/#{ENV['STORY_ID_REGEX'] || '[[:alpha:]]+-\d+'}/).
+  flatten.
+  compact.
+  uniq
+
+puts story_ids.join("\n")

data/lib/pivotoolz/version.rb

@@ -1,3 +1,3 @@
 module Pivotoolz
-  VERSION = "2.0.0"
+  VERSION = "2.4.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: 2.0.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Sufyan Adam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2022-01-16 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
@@ -120,7 +126,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,8 +141,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Tools to save you time when working with Pivotal Tracker stories
 test_files: []