slurper 1.1.8 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f431cd179fd7aebd44ae9faca7dba74728a68d1
+  data.tar.gz: e3c062a31514b3a39c73da68b9618ecb1f0388d7
+SHA512:
+  metadata.gz: 7248112fd89f8d81bdcae4da1364c2da793e5f0e935e09b1fc57a9a1992e50c5a635b237386e8691e41abfefc90cb8be043e85f13d177f7ab904e85b95892fb9
+  data.tar.gz: fb5295fcc2e9033157e871d946d175345b1e6cf0a29e354854ab07d83cfccba4f1fb2deab5a1ed900959b3fe19aa3c5c711ece40d4115453ca1e9d1312a38314

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hashrocket
+
+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

@@ -1,20 +1,10 @@
-= slurper
+= slurper gem
 
 Slurper allows you to quickly compose your stories in a text file and import them into Pivotal Tracker.
 
-Works great with slurper.vim! (http://github.com/alowe/vim-slurper)
+Works great with slurper.vim! (http://github.com/adamlowe/vim-slurper)
 
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request.
-
-== Setup
+== Install
 
   $gem install slurper
 
@@ -27,7 +17,6 @@ Slurper requires a slurper_config.yml file in your working directory. This file
   project_id: 1234
   token: 123abc123abc123abc
   requested_by: Jane Stakeholder
-  ssl: true
 
 The project_id tells tracker which project to add your stories to. It can be found on the project settings or the url for the project.
 
@@ -35,9 +24,6 @@ The token can be found on your personal profile page in Pivotal Tracker.
 
 The requested_by field should be the name of your project stakeholder exactly as it appears in tracker.
 
-The ssl field should be set to true if you've enabled "Use HTTPS" in Pivotal Tracker.
-SSL is being verified by peer using the cacert.pem from (http://curl.haxx.se/ca)
-
 == Usage
 
 Create a stories.slurper file and compose your stories in the slurper story format. In your working directory use the slurp command to import your stories from the stories.slurper file into Pivotal Tracker. Slurper looks for a stories.slurper file in your current directory by default, however, you can provide an alternate story source file if necessary.
@@ -45,11 +31,11 @@ Create a stories.slurper file and compose your stories in the slurper story form
 Default
 
   $slurp ~/stories.slurper
-  
+
 Also valid
 
   $slurp ~/special_stories.slurper
-  
+
 Or even
 
   $slurp ~/mystories.txt
@@ -65,7 +51,7 @@ Or even
     Set up and configure staging environment for approval of stories
 
   labels:
-    
+    staging
   ==
   story_type:
     feature
@@ -89,7 +75,7 @@ Or even
     This release marks a lot of awesome functionality
 
   labels:
-    
+    campaign managers
   ==
   story_type:
     bug
@@ -99,10 +85,40 @@ Or even
     When I do something, another thing is supposed to happen but I see an error screen instead.
 
   labels:
-    
+    campaign managers
 
 Note: the story source file is whitespace-sensitive. Be sure the value for each key phrase is indented with two spaces beneath each key phrase. Also, start each story with a double-equals on its own line.
 
 Your best bet is to leverage slurper.vim and benefit from its auto-indenting goodness.
 
+=== Example advanced_stories.slurper
+
+There are some advanced techniques for formatting your stories beyond the simple type, name, description and label fields. See below for some examples.
+
+  ==
+  story_type:
+    feature
+  name:
+    Make the cart accept coupons on checkout
+  description:
+    When I get to the checkout phase, I want the ability to add an optional coupon code. Use TESTCOUPON to test with.
+  labels:
+    cart,coupon system,checkout
+  estimate:
+    3
+  requested_by:
+    Joe Developer
+
+Note: Any field that is supported by the Pivotal Tracker API should work within reason (i.e file uploads won't work). To get an idea of the fields available see this page (https://www.pivotaltracker.com/help/faq#canstoriesbeimportedfromcsv)
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
 Credit - Wes Gibbs (http://wgibbs.github.com) thought of and wrote slurper as a ruby script. It was later packaged and released as a gem by his fellow Rocketeers after using it and finding it extremely handy.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/slurper.rb

@@ -1,60 +1,18 @@
+require 'active_support'
+require 'active_support/core_ext/object'
 require 'yaml'
-require 'story'
-YAML::ENGINE.yamler='syck'
 
+module Slurper
 
-class Slurper
-
-  attr_accessor :story_file, :stories
+  autoload :Client, 'slurper/client'
+  autoload :Config, 'slurper/config'
+  autoload :Engine, 'slurper/engine'
+  autoload :Story,  'slurper/story'
+  autoload :User,   'slurper/user'
 
   def self.slurp(story_file, reverse)
-    slurper = new(story_file)
-    slurper.load_stories
-    slurper.prepare_stories
+    slurper = Engine.new(story_file)
     slurper.stories.reverse! unless reverse
-    slurper.create_stories
-  end
-
-  def initialize(story_file)
-    self.story_file = story_file
-  end
-
-  def load_stories
-    self.stories = YAML.load(yamlize_story_file)
-  end
-
-  def prepare_stories
-    stories.each { |story| story.prepare }
+    slurper.process
   end
-
-  def create_stories
-    puts "Preparing to slurp #{stories.size} stories into Tracker..."
-    stories.each_with_index do |story, index|
-      begin
-        if story.save
-          puts "#{index+1}. #{story.name}"
-        else
-          puts "Slurp failed. #{story.errors.full_messages}"
-        end
-      rescue ActiveResource::ConnectionError => e
-        msg = "Slurp failed on story "
-        if story.attributes["name"]
-          msg << story.attributes["name"]
-        else
-          msg << "##{options[:reverse] ? index + 1 : stories.size - index }"
-        end
-        puts msg + ".  Error: #{e}"
-      end
-    end
-  end
-
-  protected
-
-  def yamlize_story_file
-    IO.read(story_file).
-      gsub(/^/, "    ").
-      gsub(/    ==.*/, "- !ruby/object:Story\n  attributes:").
-      gsub(/    description:$/, "    description: |")
-  end
-
 end

data/lib/slurper/client.rb

@@ -0,0 +1,24 @@
+require 'typhoeus'
+
+module Slurper
+  class Client
+    CREATE_STORY_URL = "https://www.pivotaltracker.com/services/v5/projects/#{Slurper::Config.project_id}/stories"
+    USERS_URL        = "https://www.pivotaltracker.com/services/v5/projects/#{Slurper::Config.project_id}/memberships"
+
+    def self.create(story)
+      Typhoeus.post CREATE_STORY_URL,
+        body: story.to_json,
+        headers: {
+          "Content-Type" => "application/json",
+          "X-TrackerToken" => Slurper::Config.token
+        }
+    end
+
+    def self.users
+      JSON.parse(Typhoeus.get(
+        USERS_URL,
+        headers: { "X-TrackerToken" => Slurper::Config.token }
+      ).try(:body) || '[]')
+    end
+  end
+end

data/lib/slurper/config.rb

@@ -0,0 +1,17 @@
+module Slurper
+
+  class Config
+
+    def self.project_id; @project_id ||= yaml['project_id'] end
+    def self.requested_by; @requested_by ||= yaml['requested_by'] end
+    def self.token; @token ||= yaml['token'] end
+
+    private
+
+    def self.yaml
+      YAML.load_file('slurper_config.yml')
+    end
+
+  end
+
+end

data/lib/slurper/engine.rb

@@ -0,0 +1,32 @@
+module Slurper
+  class Engine < Struct.new(:story_file)
+
+    def stories
+      @stories ||= YAML.load(yamlize_story_file).map { |attrs| Slurper::Story.new(attrs) }
+    end
+
+    def process
+      puts "Validating story content"
+      stories.each(&:valid?)
+
+      puts "Preparing to slurp #{stories.size} stories into Tracker..."
+      stories.each_with_index do |story, index|
+        if story.save
+          puts "#{index+1}. #{story.name}"
+        else
+          puts "Slurp failed. #{story.error_message}"
+        end
+      end
+    end
+
+    protected
+
+    def yamlize_story_file
+      IO.read(story_file).
+        gsub(/^/, "    ").
+        gsub(/    ==.*/, "-").# !ruby/object:Slurper::Story\n  attributes:").
+        gsub(/    description:$/, "    description: |")
+    end
+
+  end
+end

data/lib/slurper/story.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module Slurper
+  class Story
+
+    attr_accessor :attributes
+    def initialize(attrs={})
+      self.attributes = (attrs || {}).symbolize_keys
+
+      if attributes[:owned_by].present?
+        puts "DEPRECATION WARNING: `owned_by` is no longer a supported attribute. Please change to `requested_by`."
+        attributes[:requested_by] = attributes[:owned_by]
+      end
+    end
+
+    def to_json
+      {
+        name: name,
+        description: description,
+        story_type: story_type,
+        labels: labels,
+        estimate: estimate,
+        requested_by_id: requested_by_id
+      }.reject { |k,v| v.blank? }.to_json
+    end
+
+    def save
+      (@response = Slurper::Client.create(self)).success?
+    end
+
+    def error_message; @response.body end
+
+    def name;       attributes[:name]       end
+    def estimate;   attributes[:estimate]   end
+    def story_type; attributes[:story_type] end
+
+    def description
+      return nil unless attributes[:description].present?
+      attributes[:description].split("\n").map(&:strip).join("\n")
+    end
+
+    def labels
+      return [] unless attributes[:labels].present?
+      attributes[:labels].split(',').map do |tag|
+        {name: tag}
+      end
+    end
+
+    def requested_by
+      attributes[:requested_by].presence || Slurper::Config.requested_by
+    end
+
+    def requested_by_id
+      Slurper::User.find_by_name(requested_by).try(:id) if requested_by.present?
+    end
+
+    def valid?
+      if name.blank?
+        raise "Name is blank for story:\n#{to_json}"
+      elsif !requested_by_id
+        raise "Could not find requester \"#{requested_by}\" in project"
+      end
+    end
+
+  end
+end

data/lib/slurper/user.rb

@@ -0,0 +1,21 @@
+module Slurper
+  class User
+    attr_accessor :attributes
+    def initialize(attrs={})
+      self.attributes = (attrs || {}).symbolize_keys
+    end
+
+    def self.collection
+      @collection ||= Slurper::Client.users.map do |attrs|
+        Slurper::User.new(attrs['person'])
+      end
+    end
+
+    def self.find_by_name(name)
+      collection.detect { |user| user.name == name }
+    end
+
+    def name; attributes[:name] end
+    def id;   attributes[:id]   end
+  end
+end

metadata

@@ -1,67 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: slurper
 version: !ruby/object:Gem::Version
-  version: 1.1.8
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
-- Wes Gibbs
 - Adam Lowe
-- Stephen Caudill
-- Tim Pope
+- Paul Elliott
+- Taylor Mock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-04 00:00:00.000000000Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activeresource
-  requirement: &70272048833000 !ruby/object:Gem::Requirement
-    none: false
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.9
+        version: '4.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70272048833000
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70272048832060 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: *70272048832060
+        version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &70272048831080 !ruby/object:Gem::Requirement
-    none: false
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.6
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
-  version_requirements: *70272048831080
-- !ruby/object:Gem::Dependency
-  name: configuration
-  requirement: &70272048830160 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: *70272048830160
-description: ! "\n      Slurps stories from the given file (stories.slurper by default)
-  and creates Pivotal Tracker stories from them. Useful during story carding sessions
-  when you want to capture a number of stories quickly without clicking your way through
-  the Tracker UI.\n    "
+        version: '0.6'
+description: Slurps stories from the given file (stories.slurper by default) and creates
+  Pivotal Tracker stories from them. Useful during story carding sessions when you
+  want to capture a number of stories quickly without clicking your way through the
+  Tracker UI.
 email: dev@hashrocket.com
 executables:
 - slurp
@@ -69,38 +51,39 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- MIT_LICENSE
+- README.rdoc
+- Rakefile
 - bin/slurp
 - lib/slurper.rb
-- lib/story.rb
-- lib/cacert.pem
-- README.rdoc
-- spec/slurper_spec.rb
-- spec/story_spec.rb
+- lib/slurper/client.rb
+- lib/slurper/config.rb
+- lib/slurper/engine.rb
+- lib/slurper/story.rb
+- lib/slurper/user.rb
 homepage: http://github.com/hashrocket/slurper
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: takes a formatted story file and puts it on Pivotal Tracker
-test_files:
-- spec/slurper_spec.rb
-- spec/story_spec.rb
+test_files: []