tpope-pickler 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Tim Pope
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,43 @@
+= Pickler
+
+Synchronize user stories in Pivotal Tracker with Cucumber features.
+
+== Getting started
+
+  echo "api_token: ..."  > ~/.tracker.yml
+  echo "project_id: ..." > ~/my/app/features/tracker.yml
+
+For details about the Pivotal Tracker API, including where to find your API
+token and project id, see http://www.pivotaltracker.com/help/api .
+
+The pull and push commands map the story's name into the "Feature: ..." line
+and the story's description with an additional two space indent into the
+feature's body.  Keep this in mind when entering stories into Pivotal Tracker.
+
+== Usage
+
+  pickler pull
+
+Download all well formed stories to the features/ directory.  Previously
+unseen stories will be given a numeric filename that you are encouraged to
+change.
+
+  pickler push
+
+Upload all features with a tracker url in a comment on the first line.
+
+  pickler search <query>
+
+List all stories matching the given query.
+
+  pickler show <id>
+
+Show details for the story referenced by the id.
+
+== Disclaimer
+
+No warranties, expressed or implied.
+
+Notably, the push and pull commands are quite happy to blindly clobber
+features if so instructed.  Pivotal Tracker has a history to recover things
+server side.

data/bin/pickler

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(File.dirname(__FILE__)),'lib'))
+begin; require 'rubygems'; rescue LoadError; end
+require 'pickler'
+
+Pickler.run(ARGV)

data/lib/pickler/tracker/project.rb

@@ -0,0 +1,46 @@
+class Pickler
+  class Tracker
+    class Project < Abstract
+
+      attr_reader :tracker
+      reader :point_scale, :week_start_day, :name, :iteration_length
+
+      def initialize(tracker, attributes = {})
+        @tracker = tracker
+        super(attributes)
+      end
+
+      def story(story_id)
+        Story.new(self,tracker.get_xml("/projects/#{id}/stories/#{story_id}")["story"])
+      end
+
+      def stories(*args)
+        filter = encode_term(args) if args.any?
+        path = "/projects/#{id}/stories"
+        path << "?filter=#{CGI.escape(filter)}" if filter
+        response = tracker.get_xml(path)
+        [response["stories"]["story"]].flatten.compact.map {|s| Story.new(self,s)}
+      end
+
+      def new_story(attributes = {}, &block)
+        Story.new(self, attributes, &block)
+      end
+
+      def deliver_all_finished_stories
+        request_xml(:put,"/projects/#{id}/stories_deliver_all_finished")
+      end
+
+      private
+      def encode_term(term)
+        case term
+        when Array   then term.map {|v| encode_term(v)}.join(" ")
+        when Hash    then term.map {|k,v| encode_term("#{k}:#{v}")}.join(" ")
+        when /^\S+$/, Symbol then term
+        when /^(\S+?):(.*)$/ then %{#$1:"#$2"}
+        else %{"#{term}"}
+        end
+      end
+
+    end
+  end
+end

data/lib/pickler/tracker/story.rb

@@ -0,0 +1,90 @@
+class Pickler
+  class Tracker
+    class Story < Abstract
+
+      TYPES = %w(bug feature chore release)
+      STATES = %w(unstarted started finished delivered rejected accepted)
+
+      attr_reader :project
+      reader :created_at, :iteration, :url, :labels
+      accessor :current_state, :name, :description, :estimate, :owned_by, :requested_by, :story_type
+
+      def initialize(project, attributes = {})
+        @project = project
+        super(attributes)
+      end
+
+      def tracker
+        project.tracker
+      end
+
+      def to_s
+        to_s = "# #{url}\n#{story_type.capitalize}: #{name}\n"
+        description_lines.each do |line|
+          to_s << "  #{line}".rstrip << "\n"
+        end
+        to_s
+      end
+
+      def to_s=(body)
+        body = body.sub(/\A# .*\n/,'')
+        if body =~ /\A(\w+): (.*)/
+          self.story_type = $1.downcase
+          self.name = $2
+          description = $'
+        else
+          self.story_type = "feature"
+          self.name = body[/.*/]
+          description = $'
+        end
+        self.description = description.gsub(/\A\n+|\n+\Z/,'') + "\n"
+        if description_lines.all? {|l| l.empty? || l =~ /^  /}
+          self.description.gsub!(/^  /,'')
+        end
+        self
+      end
+
+      def description_lines
+        array = []
+        description.to_s.each_line do |line|
+          array << line.chomp
+        end
+        array
+      end
+
+      def notes
+        [@attributes["notes"]].flatten.compact
+      end
+
+      def to_xml
+        hash = @attributes.except("id","url","iteration","notes","labels")
+        hash["labels"] = Array(@attributes["labels"]).join(", ")
+        hash.to_xml(:root => "story")
+      end
+
+      def destroy
+        if id
+          request = tracker.request_xml(:delete, "/projects/#{project.id}/stories/#{id}", to_xml)
+          raise Error, request["message"], caller if request["success"] != "true"
+          @attributes["id"] = nil
+          self
+        end
+      end
+
+      def save
+        if id
+          request = tracker.request_xml(:put, "/projects/#{project.id}/stories/#{id}", to_xml)
+        else
+          request = tracker.request_xml(:post, "/projects/#{project.id}/stories", to_xml)
+        end
+        if request["success"] == "true"
+          initialize(project, request["story"])
+          true
+        else
+          Array(request["errors"]["error"])
+        end
+      end
+
+    end
+  end
+end

data/lib/pickler/tracker.rb

@@ -0,0 +1,77 @@
+class Pickler
+  class Tracker
+
+    ADDRESS = 'www.pivotaltracker.com'
+    BASE_PATH = '/services/v1'
+    SEARCH_KEYS = %w(label type state requester owner mywork id includedone)
+
+    class Error < Pickler::Error; end
+
+    attr_reader :token
+
+    def initialize(token)
+      require 'active_support'
+      @token = token
+    end
+
+    def request(method, path, *args)
+      require 'net/http'
+      Net::HTTP.start(ADDRESS) do |http|
+        headers = {
+          "Token"        => @token,
+          "Accept"       => "application/xml",
+          "Content-type" => "application/xml"
+        }
+        klass = Net::HTTP.const_get(method.to_s.capitalize)
+        http.request(klass.new("#{BASE_PATH}#{path}", headers), *args)
+      end
+    end
+
+    def request_xml(method, path, *args)
+      response = request(method,path,*args)
+      raise response.inspect if response["Content-type"].split(/; */).first != "application/xml"
+      Hash.from_xml(response.body)["response"]
+    end
+
+    def get_xml(path)
+      response = request_xml(:get, path)
+      unless response["success"] == "true"
+        if response["message"]
+          raise Error, response["message"], caller
+        else
+          raise "#{path}: #{response.inspect}"
+        end
+      end
+      response
+    end
+
+    def project(id)
+      Project.new(self,get_xml("/projects/#{id}")["project"].merge("id" => id.to_i))
+    end
+
+    class Abstract
+      def initialize(attributes)
+        @attributes = (attributes || {}).stringify_keys
+        yield self if block_given?
+      end
+
+      def self.reader(*methods)
+        methods.each do |method|
+          define_method(method) { @attributes[method.to_s] }
+        end
+      end
+
+      def self.accessor(*methods)
+        reader(*methods)
+        methods.each do |method|
+          define_method("#{method}=") { |v| @attributes[method.to_s] = v }
+        end
+      end
+      reader :id
+    end
+
+  end
+end
+
+require 'pickler/tracker/project'
+require 'pickler/tracker/story'

data/lib/pickler.rb

@@ -0,0 +1,194 @@
+require 'yaml'
+
+class Pickler
+
+  class Error < RuntimeError
+  end
+
+  def self.config
+    @config ||= {'api_token' => ENV["TRACKER_API_TOKEN"]}.merge(
+      if File.exist?(path = File.expand_path('~/.tracker.yml'))
+        YAML.load_file(path)
+      end || {}
+    )
+  end
+
+  def self.run(argv)
+    pickler = new(Dir.getwd)
+
+    case first = argv.shift
+    when 'show', /^\d+$/
+      story = pickler.project.story(first == 'show' ? argv.shift : first)
+      puts story
+    when 'search'
+      stories = pickler.project.stories(*argv).group_by {|s| s.current_state}
+      first = true
+      states = Tracker::Story::STATES
+      states -= %w(unstarted accepted) if argv.empty?
+      states.each do |state|
+        next unless stories[state]
+        puts unless first
+        first = false
+        puts state.upcase
+        puts '-' * state.length
+        stories[state].each do |story|
+          puts "[#{story.id}] #{story.story_type.capitalize}: #{story.name}"
+        end
+      end
+    when 'push'
+      pickler.push(*argv)
+    when 'pull'
+      pickler.pull(*argv)
+    when 'help', '--help', '-h', '', nil
+      puts 'pickler commands: show <id>, search <query>, push, pull'
+    else
+      $stderr.puts "pickler: unknown command #{first}"
+      exit 1
+    end
+  rescue Pickler::Error
+    $stderr.puts "#$!"
+    exit 1
+  rescue Interrupt
+    $stderr.puts "Interrupted!"
+    exit 130
+  end
+
+  attr_reader :directory
+
+  def initialize(path = '.')
+    @lang = 'en'
+    @directory = File.expand_path(path)
+    until File.directory?(File.join(@directory,'features'))
+      if @directory == File.dirname(@directory)
+        raise Error, 'Project not found.  Make sure you have a features/ directory.', caller
+      end
+      @directory = File.dirname(@directory)
+    end
+  end
+
+  def features_path(*subdirs)
+    File.join(@directory,'features',*subdirs)
+  end
+
+  def config_file
+    features_path('tracker.yml')
+  end
+
+  def config
+    @config ||= File.exist?(config_file) && YAML.load_file(config_file) || {}
+    self.class.config.merge(@config)
+  end
+
+  def parser
+    require 'cucumber'
+    require "cucumber/treetop_parser/feature_#@lang"
+    Cucumber.load_language(@lang)
+    @parser ||= Cucumber::TreetopParser::FeatureParser.new
+  end
+
+  def project_id
+    config["project_id"] || (self.class.config["projects"]||{})[File.basename(@directory)]
+  end
+
+  def project
+    @project ||= Dir.chdir(@directory) do
+      unless token = config['api_token']
+        raise Error, 'echo api_token: ... > ~/.tracker.yml'
+      end
+      unless id = project_id
+        raise Error, 'echo project_id: ... > features/tracker.yml'
+      end
+      Tracker.new(token).project(id)
+    end
+  end
+
+  def scenario_word
+    parser
+    Cucumber.language['scenario']
+  end
+
+  def remote_features
+    project.stories(scenario_word, :includedone => true).select do |s|
+      s.to_s =~ /^\s*#{Regexp.escape(scenario_word)}:/ && parser.parse(s.to_s)
+    end
+  end
+
+  def local_features
+    Dir[features_path('**','*.feature')].map {|f| LocalFeature.new(self,f)}
+  end
+
+  def pull
+    l = local_features
+    remote_features.each do |remote|
+      body = "# http://www.pivotaltracker.com/story/show/#{remote.id}\n" <<
+      normalize_feature(remote.to_s)
+      if local = l.detect {|f| f.id == remote.id}
+        filename = local.filename
+      else
+        next if remote.current_state == 'unstarted'
+        filename = features_path("#{remote.id}.feature")
+      end
+      File.open(filename,'w') {|f| f.puts body}
+    end
+    nil
+  end
+
+  def push
+    local_features.select do |local|
+      next unless local.id
+      remote = local.story
+      next if remote.to_s == local.to_s
+      remote.to_s = local.to_s
+      remote.save
+    end
+  end
+
+  protected
+
+  def normalize_feature(body)
+    return body unless ast = parser.parse(body)
+    feature = ast.compile
+    new = ''
+    (feature.header.chomp << "\n").each_line do |l|
+      new << '  ' unless new.empty?
+      new << l.strip << "\n"
+    end
+    feature.scenarios.each do |scenario|
+      new << "\n  Scenario: #{scenario.name}\n"
+      scenario.steps.each do |step|
+        new << "    #{step.keyword} #{step.name}\n"
+      end
+    end
+    new
+  end
+
+  class LocalFeature
+    attr_reader :pickler, :filename
+
+    def initialize(pickler, filename)
+      @pickler = pickler
+      @filename = filename
+    end
+
+    def to_s
+      File.read(@filename)
+    end
+
+    def id
+      unless defined?(@id)
+        @id = if id = to_s[%r{#\s*http://www\.pivotaltracker\.com/\S*?/(\d+)},1]
+                id.to_i
+              end
+      end
+      @id
+    end
+
+    def story
+      @pickler.project.story(id) if id
+    end
+
+  end
+
+end
+
+require 'pickler/tracker'

data/pickler.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name                = "pickler"
+  s.version             = "0.0.0"
+
+  s.summary             = "PIvotal traCKer Liaison to cucumbER"
+  s.description         = "Synchronize between Cucumber and Pivotal Tracker"
+  s.authors             = ["Tim Pope"]
+  s.email               = "ruby@tpope.i"+'nfo'
+  s.homepage            = "http://github.com/tpope/pickler"
+  s.default_executable  = "pickler"
+  s.executables         = ["pickler"]
+  s.files               = [
+    "README.rdoc",
+    "MIT-LICENSE",
+    "pickler.gemspec",
+    "bin/pickler",
+    "lib/pickler.rb",
+    "lib/pickler/tracker.rb",
+    "lib/pickler/tracker/project.rb",
+    "lib/pickler/tracker/story.rb"
+  ]
+  s.add_dependency("activesupport", [">= 2.0.0"])
+  s.add_dependency("cucumber", [">= 0.1.9"])
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: tpope-pickler
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Tim Pope
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-27 00:00:00 -07:00
+default_executable: pickler
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.9
+    version: 
+description: Synchronize between Cucumber and Pivotal Tracker
+email: ruby@tpope.info
+executables: 
+- pickler
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- MIT-LICENSE
+- pickler.gemspec
+- bin/pickler
+- lib/pickler.rb
+- lib/pickler/tracker.rb
+- lib/pickler/tracker/project.rb
+- lib/pickler/tracker/story.rb
+has_rdoc: false
+homepage: http://github.com/tpope/pickler
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: PIvotal traCKer Liaison to cucumbER
+test_files: []
+