tracker_deliveries 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f635ded874b022e199939d96831f90f396a4b885
-  data.tar.gz: c2f355173ce76fdb9196d46e814d7f042c152efb
+  metadata.gz: 4971fefd1275558af1f0fc609fc641ac5102c5fa
+  data.tar.gz: 8eab891ba1e6894bd8c1209a99b9ca5a1cbca2c1
 SHA512:
-  metadata.gz: d97c098c6e053c3b6c3e9157dee3f8153ab6ec0e8a98d519086c4502a3d3438876fd10765843797bc3aa5de3f5d0176bfd3f1ee0b25483e2cabee9d1d0ed16a1
-  data.tar.gz: f8a91a9fbeffed17b0397e4519e2b7522a2384587468def649e0065560d0247216a784a7ad90d02ef192656cd5620ddb3fe76c3a9f57f2dc5d1ba34d972769d1
+  metadata.gz: 433cf7f8aaf755e8f8dbb9933183742c0dac9eec1f74507f36fe022be5b5f9e9f45159912def85250254e6ebfe4ac9aae8e2ea9f033063b51be4ae8dc3bf3ef3
+  data.tar.gz: 48c87f501af5039dbe07f3e4d82fd6e2b202a67632af2f67417f462a5bf10944aa8a16f5b682c7f5d778b9fd751f98024da5902ba2ab35d8fbf169dae4e28ed8

data/.circleci/config.yml

@@ -23,10 +23,9 @@ jobs:
           command: |
             mkdir /tmp/test-results
             TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
-            bundle exec rspec --format progress \
+            bundle exec rspec --format documentation \
                               --format RspecJunitFormatter \
                               --out /tmp/test-results/rspec.xml \
-                              --format progress \
                               "${TEST_FILES}"
       - store_test_results:
           path: /tmp/test-results

data/README.md

@@ -19,31 +19,64 @@ gem install tracker_deliveries
 
 ## Usage
 
-Define these environment variables
+Define these environment variables:
 
-`TRACKER_DELIVERIES_API_TOKEN` - tracker API token.
+- `TRACKER_DELIVERIES_API_TOKEN` - tracker API token
+- `TRACKER_DELIVERIES_PROJECT_ID` - tracker project ID
 
-`TRACKER_DELIVERIES_PROJECT_ID` - tracker project ID
-
-Then run the command:
+Run:
 
 ```
 tracker_deliveries
 ```
 
-This fetches the currently delivered tracker stories from your project
-and display the id and story title.
+Output current delivered stories ids & story titles as plaintext e.g.:
+
+```
+132412351 - Add widget service request to order form
+123412144 - Display widget detail view UI
+131412414 - Update widget quantity in shopping cart
+132412155 - Localize cart in Pirate speak, arr.
+```
+
+### Formatting output
 
-e.g.
+Generate the list with alternative formatting as Markdown or HTML (with built in links to the tracker stories):
 
 ```
-#342351 - Add widget service request to order form
-#213144 - Display widget detail view UI
-#341414 - Update widget quantity in shopping cart
-#342155 - Localize cart in Pirate speak, arr.
+tracker_deliveries --markdown
 ```
 
-## Pivotal Tracker API Token and Project ID
+```
+- [132412351](https://pivotaltracker.com/story/show/132412351) - Add widget service request to order form
+- [123412144](https://pivotaltracker.com/story/show/123412144) - Display widget detail view UI
+- [131412414](https://pivotaltracker.com/story/show/131412414) - Update widget quantity in shopping cart
+- [132412155](https://pivotaltracker.com/story/show/132412155) - Localize cart in Pirate speak, arr.
+```
+
+or
+
+```
+tracker_deliveries --html
+```
+
+```
+<ul>
+<li><a href="https://pivotaltracker.com/story/show/132412351">132412351</a> - Add widget service request to order form</li>
+<li><a href="https://pivotaltracker.com/story/show/123412144">123412144</a> - Display widget detail view UI</li>
+<li><a href="https://pivotaltracker.com/story/show/131412414">131412414</a> - Update widget quantity in shopping cart</li>
+<li><a href="https://pivotaltracker.com/story/show/132412155">132412155</a> - Localize cart in Pirate speak, arr.</li>
+</ul>
+```
+
+Rendering as:
+
+- [132412351](https://pivotaltracker.com/story/show/132412351) - Add widget service request to order form
+- [123412144](https://pivotaltracker.com/story/show/123412144) - Display widget detail view UI
+- [131412414](https://pivotaltracker.com/story/show/131412414) - Update widget quantity in shopping cart
+- [132412155](https://pivotaltracker.com/story/show/132412155) - Localize cart in Pirate speak, arr.
+
+## Get hold of the Pivotal Tracker API Token / Project ID
 
 On https://www.pivotaltracker.com/profile (while logged in) the API
 token is at the bottom of the page.

data/exe/tracker_deliveries

@@ -1,5 +1,12 @@
 #!/usr/bin/env ruby
+# -*- mode: ruby -*-
 
 require 'tracker_deliveries'
 
-puts TrackerDeliveries::Main.new().delivered_stories
+if ARGV[0] == '--markdown'
+   puts TrackerDeliveries::Main.new(format: :markdown).delivered_stories
+elsif ARGV[0] == '--html'
+   puts TrackerDeliveries::Main.new(format: :html).delivered_stories
+else
+   puts TrackerDeliveries::Main.new().delivered_stories
+end

data/lib/tracker_deliveries/version.rb

@@ -1,3 +1,3 @@
 module TrackerDeliveries
-  VERSION = "0.1.2"
+  VERSION = "0.1.6"
 end

data/lib/tracker_deliveries.rb

@@ -7,10 +7,10 @@ module TrackerDeliveries
                   :api_token,
                   :pivotal_tracker
 
-    def initialize
+    def initialize(options = {})
       @project_id = ENV['TRACKER_DELIVERIES_PROJECT_ID']
       @api_token = ENV['TRACKER_DELIVERIES_API_TOKEN']
-      @pivotal_tracker = PivotalTracker.new(@project_id, @api_token)
+      @pivotal_tracker = PivotalTracker.new(@project_id, @api_token, options)
     end
 
     def delivered_stories
@@ -22,21 +22,52 @@ module TrackerDeliveries
     PIVOTAL_API_URL = 'https://www.pivotaltracker.com/services/v5/'
     attr_accessor :api
 
-    def initialize project_id, api_key
+    def initialize project_id, api_key, options = {}
       @api_key = api_key
       @project_id = project_id
+      @format = options[:format] || :plaintext
       @api = Blanket.wrap PIVOTAL_API_URL,
                           headers: { 'X-TrackerToken' => @api_key }
     end
 
     def delivered_stories
       options = {with_state: "delivered"}
-      api
-        .projects(@project_id)
-        .stories
-        .get(params: options)
-        .payload
-        .map{|s| "#{s.id} - #{s.name}" }
+      wrap_output(api
+                    .projects(@project_id)
+                    .stories
+                    .get(params: options)
+                    .payload
+                    .map{|s| story_formatter s }
+                    .join("\n"))
+    end
+
+    private
+
+    def pivotal_tracker_link s
+      %Q{https://pivotaltracker.com/story/show/#{s.id}}
+    end
+
+    def story_formatter s
+      return send(@format, s)
+    end
+
+    def wrap_output output
+      return %Q{<ul>\n#{output}\n</ul>} if @format == :html
+      output
+    end
+
+    def plaintext s
+      %Q{#{s.id} - #{s.name}}
+    end
+
+    def markdown s
+      link = %Q{[#{s.id}](#{pivotal_tracker_link s})}
+      %Q{- #{link} - #{s.name}}
+    end
+
+    def html s
+      link = %Q{<a href="#{pivotal_tracker_link s}">#{s.id}</a>}
+      %Q{<li>#{link} - #{s.name}</li>}
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tracker_deliveries
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Jason Milkins