story_branch 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c0e160a81842521457a2ef968e48f3960b2681d
-  data.tar.gz: a1a816524e43ce91699ca78b0f772c6e89a2795a
+  metadata.gz: dfb03c2e2971ef4d7821325027d126506ec4d02c
+  data.tar.gz: de96f85c513ad4ec77f7bd058e7954edd0658446
 SHA512:
-  metadata.gz: 8328b3529fb52fd129fe8a936b1c07e940c094c6aa3d03d297ff1a9da0b0471e5d228f180ee1accfa2f0a8ff1c858136179cf111f9384e0b655bb6f1c917745d
-  data.tar.gz: 99e3f567048af4d348d0b510d09f3aca8e1147cb9afd00708614d4f079b5295517ff9c47a62dc594cbb0735edf345a76105087dd69db671660ee5cf9800d1bc6
+  metadata.gz: 9a326ba3d7ff1913aa8ba33af7519548b512d111a74c64899170190d533b5608726ee4800343210a22076cb908974e57cb7377cb9c3e82be88507bbebba58281
+  data.tar.gz: 2d8d4811aa52d7eb47bed0fa185f7424a54137f905b9d0e70b602586dc82856f489895acf7d3b5839e213e2bf587fb924f38d961d8af13f6f9cdebce58f93a52

data/README.md

@@ -19,10 +19,10 @@ e.g. `my-story-name-1234567`
 
 `git finish`: Creates a git commit message for the staged changes.
 
-e.g: `[Finishes #1234567] My Story Title`
+e.g: `[Finishes #1234567] My story name`
 
 You must stage all changes (or stash them) first. Note the commit will not
-be pushed.  Note: You'll be able to bail out before.
+be pushed.  Note: You'll be able to bail out of the commit.
 
 `git start`: Start a story in Pivotal Tracker from the terminal.
 It'll get all unstarted stories in your current project.  You can

data/lib/story_branch.rb

@@ -6,7 +6,7 @@
 #          Ranhiru Cooray <ranhiru@gmail.com>
 #          Gabe Hollombe <gabe@neo.com>
 #
-# Version: 0.2.7
+# Version: 0.2.8
 #
 # ## Description
 # A small collection of tools for working with git branches and Pivotal
@@ -26,10 +26,10 @@
 #
 # `git finish`: Creates a git commit message for the staged changes.
 #
-# e.g: `[Finishes #1234567] My Story Title`
+# e.g: `[Finishes #1234567] My story name`
 #
 # You must stage all changes (or stash them) first. Note the commit will not
-# be pushed.  Note: You'll be able to bail out before.
+# be pushed.  Note: You'll be able to bail out of the commit.
 #
 # `git start`: Start a story in Pivotal Tracker from the terminal.
 # It'll get all unstarted stories in your current project.  You can
@@ -81,85 +81,83 @@
 #
 # Code:
 
+require 'byebug'
 require 'yaml'
-require 'pivotal-tracker'
+require 'blanket'
 require 'rb-readline'
 require 'readline'
 require 'git'
 require 'levenshtein'
 
-trap('INT') {exit}
+trap('INT') { exit }
 
 module StoryBranch
-
   class Main
-
     ERRORS = {
-      "Stories in the started state must be estimated." =>
+      'Stories in the started state must be estimated.' =>
       "Error: Pivotal won't allow you to start an unestimated story"
     }
 
-    PIVOTAL_CONFIG_FILES = ['.story_branch',"#{ENV['HOME']}/.story_branch"]
+    PIVOTAL_CONFIG_FILES = ['.story_branch', "#{ENV['HOME']}/.story_branch"]
 
     attr_accessor :p
 
     def initialize
-      if config_file
-        @pivotal_info = YAML.load_file config_file
-      end
-      @p            = PivotalUtils.new
-      @p.api_key    = config_value "api", 'PIVOTAL_API_KEY'
-      @p.project_id = config_value "project", 'PIVOTAL_PROJECT_ID'
+      @pivotal_info = YAML.load_file config_file if config_file
+      @p = PivotalUtils.new
+      @p.api_key = config_value 'api', 'PIVOTAL_API_KEY'
+      @p.project_id = config_value 'project', 'PIVOTAL_PROJECT_ID'
       exit unless @p.valid?
     end
 
+    def unauthorised_message
+      $stderr.puts 'Pivotal API key or Project ID invalid'
+    end
+
     def create_story_branch
       begin
-        puts "Connecting with Pivotal Tracker"
+        puts 'Connecting with Pivotal Tracker'
         @p.get_project
-        puts "Getting stories..."
+        puts 'Getting stories...'
         stories = @p.display_stories :started, false
         if stories.length < 1
-          puts "No stories started, exiting"
+          puts 'No stories started, exiting'
           exit
         end
         story = @p.select_story stories
         if story
           @p.create_feature_branch story
         end
-      rescue RestClient::Unauthorized
-        $stderr.puts "Pivotal API key or Project ID invalid"
+      rescue Blanket::Unauthorized
+        unauthorised_message
         return nil
       end
     end
 
     def pick_and_update filter, hash, msg, is_estimated
       begin
-        puts "Connecting with Pivotal Tracker"
+        puts 'Connecting with Pivotal Tracker'
         @p.get_project
-        puts "Getting stories..."
+        puts 'Getting stories...'
         stories = @p.filtered_stories_list filter, is_estimated
         story = @p.select_story stories
         if story
-          result = story.update hash
-          if result.errors.count > 0
-            puts result.errors.to_a.uniq.map{|e| ERRORS[e] }
-            return nil
-          end
+          result = @p.story_update story, hash
+          fail result.error if result.error
           puts "#{story.id} #{msg}"
         end
-      rescue RestClient::Unauthorized
-        $stderr.puts "Pivotal API key or Project ID invalid"
+      rescue Blanket::Unauthorized
+        unauthorised_message
         return nil
       end
     end
 
     def story_start
-      pick_and_update(:unstarted, {:current_state => "started"}, "started", true)
+      pick_and_update(:unstarted, { current_state: 'started' }, 'started', true)
     end
 
     def story_unstart
-      pick_and_update(:started, {:current_state => "unstarted"}, "unstarted", false)
+      pick_and_update(:started, { current_state: 'unstarted' }, 'unstarted', false)
     end
 
     def story_estimate
@@ -168,7 +166,7 @@ module StoryBranch
 
     def story_finish
       begin
-        puts "Connecting with Pivotal Tracker"
+        puts 'Connecting with Pivotal Tracker'
         @p.get_project
 
         unless @p.is_current_branch_a_story?
@@ -177,29 +175,29 @@ module StoryBranch
         end
 
         if GitUtils.has_status? :untracked or GitUtils.has_status? :modified
-          puts "There are unstaged changes"
-          puts "Use git add to stage changes before running git finish"
-          puts "Use git stash if you want to hide changes for this commit"
+          puts 'There are unstaged changes'
+          puts 'Use git add to stage changes before running git finish'
+          puts 'Use git stash if you want to hide changes for this commit'
           return nil
         end
 
         unless GitUtils.has_status? :added or GitUtils.has_status? :staged
-          puts "There are no staged changes."
-          puts "Nothing to do"
+          puts 'There are no staged changes.'
+          puts 'Nothing to do'
           return nil
         end
 
-        puts "Use standard finishing commit message: [y/N]?"
+        puts 'Use standard finishing commit message: [y/N]?'
         commit_message = "[Finishes ##{GitUtils.current_branch_story_parts[:id]}] #{StringUtils.undashed GitUtils.current_branch_story_parts[:title]}"
         puts commit_message
 
-        if gets.chomp!.downcase == "y"
+        if gets.chomp!.downcase == 'y'
           GitUtils.commit commit_message
         else
-          puts "Aborted"
+          puts 'Aborted'
         end
-      rescue RestClient::Unauthorized
-        $stderr.puts "Pivotal API key or Project ID invalid"
+      rescue Blanket::Unauthorized
+        unauthorised_message
         return nil
       end
     end
@@ -235,23 +233,22 @@ module StoryBranch
     end
 
     def self.normalised_branch_name s
-      simple_sanitize((dashed s).downcase).squeeze("-")
+      simple_sanitize((dashed s).downcase).squeeze('-')
     end
 
     def self.strip_newlines s
-      s.tr "\n", "-"
+      s.tr '\n', '-'
     end
 
     def self.undashed s
-      s.gsub(/-/, " ").capitalize
+      s.gsub(/-/, ' ').capitalize
     end
 
   end
 
   class GitUtils
-
     def self.g
-      Git.open "."
+      Git.open '.'
     end
 
     def self.is_existing_branch? name
@@ -321,7 +318,7 @@ module StoryBranch
       untracked_rx = /^\?\? (.*)/
       staged_rx    = /^M  (.*)/
       added_rx     = /^A  (.*)/
-      status = g.lib.send(:command, "status", "-s").lines
+      status = g.lib.send(:command, 'status', '-s').lines
       return nil if status.length == 0
       {
         modified:  status_collect(status, modified_rx),
@@ -343,16 +340,25 @@ module StoryBranch
   end
 
   class PivotalUtils
-
-    attr_accessor :api_key, :project_id, :project
+    API_URL = 'https://www.pivotaltracker.com/services/v5/'
+    attr_accessor :api_key, :project_id
 
     def valid?
-      return (not @api_key.nil? and not @project_id.nil?)
+      !@api_key.nil? && !@project_id.nil?
+    end
+
+    def api
+      fail 'API key must be specified' unless @api_key
+      Blanket.wrap API_URL, headers: { 'X-TrackerToken' => @api_key }
     end
 
     def get_project
-      PivotalTracker::Client.token = @api_key
-      @project = PivotalTracker::Project.find @project_id.to_i
+      fail 'Project ID must be set' unless @project_id
+      api.projects(@project_id.to_i)
+    end
+
+    def story_accessor
+      get_project.stories
     end
 
     def is_current_branch_a_story?
@@ -364,21 +370,22 @@ module StoryBranch
     end
 
     def story_from_current_branch
-      get_project.stories.find(GitUtils.current_story[2].to_i) if GitUtils.current_story.length == 3
+      story_accessor.get(GitUtils.current_story[2].to_i) if GitUtils.current_story.length == 3
     end
 
-    # TODO: Add some other predicates as we need them...
-    # Filtering on where a story lives (Backlog, IceBox)
-    # Filtering on tags/labels
-
+    # TODO: Maybe add some other predicates
+    # - Filtering on where a story lives (Backlog, IceBox)
+    # - Filtering on labels
+    # as the need arises...
+    #
     def filtered_stories_list state, estimated
-      project = get_project
-      stories = project.stories.all({current_state: state})
+      options = { with_state: state.to_s }
+      stories = [* story_accessor.get(params: options).payload]
       if estimated
-        stories.select{|s|
-          s.story_type == "bug" or
-          s.story_type == "chore" or
-          (s.story_type == "feature" and s.estimate and s.estimate >= 0)}
+        stories.select do |s|
+          s.story_type == 'bug' || s.story_type == 'chore' ||
+            (s.story_type == 'feature' && s.estimate && s.estimate >= 0)
+        end
       else
         stories
       end
@@ -394,11 +401,9 @@ module StoryBranch
 
     def select_story stories
       story_texts = stories.map{|s| one_line_story s }
-      puts "Leave blank to exit, use <up>/<down> to scroll through stories, TAB to list all and auto-complete"
-      story_selection = readline("Select a story: ", story_texts)
-      if story_selection == "" or story_selection.nil?
-        return nil
-      end
+      puts 'Leave blank to exit, use <up>/<down> to scroll through stories, TAB to list all and auto-complete'
+      story_selection = readline('Select a story: ', story_texts)
+      return nil if story_selection == '' or story_selection.nil?
       story = stories.select{|s| story_matcher s, story_selection }.first
       if story.nil?
         puts "Not found: #{story_selection}"
@@ -409,6 +414,10 @@ module StoryBranch
       end
     end
 
+    def story_update story, hash
+      get_project.stories(story.id).put(body: hash).payload
+    end
+
     def story_matcher story, selection
       m = selection.match(/^(\d*) /)
       return false unless m
@@ -420,9 +429,9 @@ module StoryBranch
       dashed_story_name = StringUtils.normalised_branch_name story.name
       feature_branch_name = nil
       puts "You are checked out at: #{GitUtils.current_branch}"
-      while feature_branch_name == nil or feature_branch_name == ""
-        puts "Provide a new branch name... (TAB for suggested name)" if [nil, ""].include? feature_branch_name
-        feature_branch_name = readline("Name of feature branch: ", [dashed_story_name])
+      while feature_branch_name == nil or feature_branch_name == ''
+        puts 'Provide a new branch name... (TAB for suggested name)' if [nil, ''].include? feature_branch_name
+        feature_branch_name = readline('Name of feature branch: ', [dashed_story_name])
       end
       feature_branch_name.chomp!
       if validate_branch_name feature_branch_name, story.id
@@ -439,7 +448,7 @@ module StoryBranch
         return false
       end
       if GitUtils.is_existing_branch? name
-        puts "Error: This name is very similar to an existing branch. Avoid confusion and use a more unique name."
+        puts 'Error: This name is very similar to an existing branch. Avoid confusion and use a more unique name.'
         return false
       end
       unless valid_branch_name? name
@@ -461,9 +470,9 @@ module StoryBranch
       RbReadline.clear_history
       if completions.length > 0
         completions.each {|i| Readline::HISTORY.push i}
-        RbReadline.rl_completer_word_break_characters = ""
-        Readline.completion_proc = proc {|s| completions.grep(/#{Regexp.escape(s)}/) }
-        Readline.completion_append_character = ""
+        RbReadline.rl_completer_word_break_characters = ''
+        Readline.completion_proc = proc { |s| completions.grep(/#{Regexp.escape(s)}/) }
+        Readline.completion_append_character = ''
       end
       Readline.readline(prompt, false)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Jason Milkins
@@ -12,22 +12,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pivotal-tracker
+  name: blanket_wrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: Simple gem that fetches the available stories in your pivotaltracker
   project and allows you to create a git branch with the name based on the selected
   story