trackinator 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rvmrc

@@ -0,0 +1,6 @@
+if [[ -d "$rvm_path/environments" && -s "$rvm_path/environments/ruby-1.9.3-p194@trackinator" ]] ; then
+  \. "$rvm_path/environments/ruby-1.9.3-p194@trackinator"
+else
+  rvm --create use  "ruby-1.9.3-p194@trackinator"
+fi
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trackinator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Justin Beck
+
+MIT License
+
+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.md

@@ -0,0 +1,89 @@
+# Trackinator
+
+This gem, when used correctly, will import a Google spreadsheet
+into YouTrack as tickets.  The spreadsheet is a test plan which
+defines features (and how to use them).  There are numerous
+benefits to this approach:
+
+- Scope is defined up front which reduces scope creep
+- Creating the test plan forces developers to be appropriately familiar
+  with the project
+- A test plan is written up front (TDD at a macro level)
+
+The format of the spreadsheet is as follows (columns can be in any order):
+
+####project
+The abbreviation for the project in YouTrack.  The project must
+exist in YouTrack already, this gem will not create the project for you
+
+####id
+Similar to a version number.  Must be unique in this test plan.  Follows
+the format x.y.z (this example is 3 levels deep) and there is no limit
+to nesting depth.  Each level denotes sub-tickets that will be created
+and associated to the level above.
+
+####type
+"Story" for top level items, "Features" and "Tasks" for items one or more
+levels below "Story".  “Features” are user facing and "Tasks" are
+implementation details.  "Tasks" will not be acceptance tested.
+
+####summary
+A one-line summarizing of the feature.
+
+####description
+A description of the feature including steps to use the feature.
+
+####outcome
+The expected outcome if the feature is used per the steps in the description.
+
+####notes
+Any additional notes (which will show up as a comment) that might be useful
+for the developer or tester.
+
+####references
+A reference to the design document.  The format should be wf/c-<page>-<screen
+(or range)>.  E.g. wf-12-5 or c-9-2-3 (where "wf" refers to wireframe and "c"
+refers to composition)
+
+####platform
+This is usually one of iOS, iPhone, iPad, Android, Desktop Web, Mobile Web
+
+####priority
+One of Low, Normal, High, Show-stopper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trackinator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trackinator
+
+## Usage
+
+<pre>
+Options:
+     --youtrack-username, -y <s>:   Your YouTrack username
+     --youtrack-password, -p <s>:   Your YouTrack password
+       --google-username, -g <s>:   Your Google username
+       --google-password, -a <s>:   Your Google password
+         --youtrack-host, -o <s>:   YouTrack host
+         --youtrack-port, -r <i>:   YouTrack port (default: 80)
+  --youtrack-path-prefix, -e <s>:   YouTrack path prefix (e.g. '/youtrack/') (default: /)
+                      --help, -h:   Show this message
+                        filename:   File name in Google Docs
+</pre>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/trackinate

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby
+
+require 'trackinator/importer'
+require 'trollop'
+
+opts = Trollop::options do
+  opt :youtrack_username, "Your YouTrack username", :type => :string, :short => "y"
+  opt :youtrack_password, "Your YouTrack password", :type => :string, :short => "p"
+  opt :google_username, "Your Google username", :type => :string, :short => "g"
+  opt :google_password, "Your Google password", :type => :string, :short => "a"
+  opt :youtrack_host, "YouTrack host", :type => :string, :short => "o"
+  opt :youtrack_port, "YouTrack port", :type => :int, :default => 80, :short => "r"
+  opt :youtrack_path_prefix, "YouTrack path prefix (e.g. '/youtrack/')", :type => :string, :default => "/", :short =>"e"
+end
+
+p opts
+
+Trollop::die :youtrack_username, "is required" if opts[:youtrack_username].empty?
+Trollop::die :youtrack_password, "is required" if opts[:youtrack_password].empty?
+Trollop::die :google_username, "is required" if opts[:google_username].empty?
+Trollop::die :google_password, "is required" if opts[:google_password].empty?
+Trollop::die :youtrack_host, "is required" if opts[:youtrack_host].empty?
+
+importer = Trackinator::Importer.new opts
+importer.import ARGV[0]

data/lib/trackinator/importer.rb

@@ -0,0 +1,176 @@
+require 'net/http'
+require 'CSV'
+
+require 'gdata'
+
+module Trackinator
+  class Importer
+    @youtrack_cookie
+    @youtrack_connection
+
+    @google_headers
+    @stack
+
+    @col_count
+
+    @youtrack_host
+    @youtrack_port
+    @youtrack_path_prefix
+
+    def initialize opts
+      @stack = []
+      @google_connection = Net::HTTP
+      @google_client = GData::Client::Spreadsheets.new
+
+      google_login = opts[:google_username]
+      youtrack_login = opts[:youtrack_username]
+
+      @youtrack_host = opts[:youtrack_host]
+      @youtrack_port = opts[:youtrack_port]
+      @youtrack_path_prefix = opts[:youtrack_path_prefix]
+
+      google_password = params[:google_password]
+      youtrack_password = params[:youtrack_password]
+
+      login_youtrack youtrack_login, youtrack_password
+
+      @google_client.clientlogin(google_login, google_password)
+    end
+
+    def import file_name
+      spreadsheet_feed = @google_client.get("http://spreadsheets.google.com/feeds/worksheets/#{get_spreadsheet_key(file_name)}/private/full").to_xml
+      spreadsheet_list_data = @google_client.get(spreadsheet_feed.elements[1, 'entry'].elements[1, 'content'].attributes['src']).to_xml
+
+      spreadsheet_list_data.elements.each('entry') do |entry|
+        ticket_data = get_ticket_data entry
+        issue_id = is_issue_exists? ticket_data
+        false unless !issue_id.nil? ? update_ticket(issue_id, ticket_data) : create_ticket(ticket_data)
+      end
+    end
+
+    private
+
+    # Google API methods
+
+    def get_spreadsheet_key file_name
+      doc_feed = @google_client.get("http://spreadsheets.google.com/feeds/spreadsheets/private/full").to_xml
+
+      doc_feed.elements.each ('entry') do |entry|
+        if entry.elements['title'].text.eql? file_name
+          return entry.elements[1].text[/spreadsheets\/(.*)/, 1]
+        end
+      end
+    end
+
+    def get_ticket_data entry
+      data = {}
+
+      REXML::XPath.match(entry, 'gsx:*').each do |col|
+        data[col.name] = URI.escape(col.text) unless col.text.nil?
+      end
+
+      data
+    end
+
+    # YouTrack API methods
+
+    def login_youtrack user_name, password
+      @youtrack_connection = Net::HTTP.new @youtrack_host, @youtrack_port
+      response = @youtrack_connection.post "#{@youtrack_path_prefix}rest/user/login", "login=#{user_name}&password=#{password}"
+      @youtrack_cookie = response.response['Set-Cookie'].split('; ')[0]
+    end
+
+    def create_ticket data
+      issue_id, create_response = create_youtrack_ticket data
+      success = create_response.eql? "Created"
+
+      success ? (success = update_ticket(issue_id, data)) : (return success)
+      success ? update_dependencies([issue_id, data['id']]) : success
+    end
+
+    def update_ticket issue_id, data
+      success = set_platform(issue_id, data['platform'])
+      success ? (success = set_summary_and_description(issue_id, data['summary'], data['description'])) : (return success)
+      success ? (success = set_type(issue_id, data['type'])) : (return success)
+      success ? (success = set_import_identifier(issue_id, "#{data['project']}-#{data['id']}")) : (return success)
+      success ? (success = set_design_reference(issue_id, "#{data['references']}")) : (return success) unless data['references'].nil?
+
+      success
+    end
+
+    def update_dependencies issue
+      issue_id = issue[0]
+      issue_level = issue[1]
+
+      if @stack.empty?
+        @stack.push [issue_id, issue_level]
+      else
+        last_issue = @stack.last
+        last_issue_id = last_issue[0]
+        last_issue_level = last_issue[1]
+
+        if issue_level.length <= last_issue_level.length
+          @stack.pop
+          update_dependencies issue
+        else
+          success = create_dependency last_issue_id, issue_id
+          @stack.push issue
+
+          success
+        end
+      end
+    end
+
+    # YouTrack API calls
+
+    def is_issue_exists? data
+      find_response_xml = REXML::Document.new(@youtrack_connection.get("#{@youtrack_path_prefix}rest/issue/byproject/#{data['project']}?filter=Import+Identifier:+#{data['project']}-#{data['id']}", { 'Cookie' => @youtrack_cookie, 'Content-Type' => 'text/plain; charset=utf-8' }).body)
+      find_response_xml.elements['issues'].length > 0 ? find_response_xml.elements['issues/issue'].attributes['id'] : nil
+    end
+
+    def create_youtrack_ticket data
+      response = @youtrack_connection.put("#{@youtrack_path_prefix}rest/issue?project=#{data['project']}&summary=#{data['summary']}&description=#{data['description']}&priority=#{data['priority']}", nil, { 'Cookie' => @youtrack_cookie, 'Content-Type' => 'text/plain; charset=utf-8' })
+      return response.header["Location"].split("/").last, response.header.msg
+    end
+
+    def create_dependency parent_id, child_id
+      response = @youtrack_connection.post("#{@youtrack_path_prefix}rest/issue/#{parent_id}/execute?command=parent+for+#{child_id}&disableNotifications=true", nil, { 'Cookie' => @youtrack_cookie })
+      response.header.msg.eql? "OK"
+    end
+
+    def set_summary_and_description issue_id, summary, description
+      return true if summary.nil?
+
+      response = @youtrack_connection.post("#{@youtrack_path_prefix}rest/issue/#{issue_id}/?summary=#{summary}&description=#{description}&disableNotifications=true", nil, { 'Cookie' => @youtrack_cookie })
+      response.header.msg.eql? "OK"
+    end
+
+    def set_platform issue_id, platform
+      return true if platform.nil?
+
+      response = @youtrack_connection.post("#{@youtrack_path_prefix}rest/issue/#{issue_id}/execute?command=Platform+#{platform}&disableNotifications=true", nil, { 'Cookie' => @youtrack_cookie })
+      response.header.msg.eql? "OK"
+    end
+
+    def set_type issue_id, type
+      return true if type.nil?
+
+      response = @youtrack_connection.post("#{@youtrack_path_prefix}rest/issue/#{issue_id}/execute?command=Type+#{type}&disableNotifications=true", nil, { 'Cookie' => @youtrack_cookie })
+      response.header.msg.eql? "OK"
+    end
+
+    def set_import_identifier issue_id, import_id
+      return true if import_id.nil?
+
+      response = @youtrack_connection.post("#{@youtrack_path_prefix}rest/issue/#{issue_id}/execute?command=Import+Identifier+#{import_id}&disableNotifications=true", nil, { 'Cookie' => @youtrack_cookie })
+      response.header.msg.eql? "OK"
+    end
+
+    def set_design_reference issue_id, reference
+      return true if reference.nil?
+
+      response = @youtrack_connection.post("#{@youtrack_path_prefix}rest/issue/#{issue_id}/execute?command=Design+Reference+#{reference}&disableNotifications=true", nil, { 'Cookie' => @youtrack_cookie })
+      response.header.msg.eql? "OK"
+    end
+  end
+end

data/lib/trackinator/version.rb

@@ -0,0 +1,3 @@
+module Trackinator
+  VERSION = "0.0.1"
+end

data/lib/trackinator.rb

@@ -0,0 +1,5 @@
+require "trackinator/version"
+
+module Trackinator
+  # Your code goes here...
+end

data/trackinator.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/trackinator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Justin Beck"]
+  gem.email         = %w{justinbeck@mac.com}
+  gem.description   = <<-EOF
+    In order to introduce in to my main development process
+    I decided that creating a test plan prior to development
+    and then using that as the basis for my YouTrack tickets
+    would be a good approach.  Think of it as TDD at a macro
+    level.
+  EOF
+  gem.summary       = %q{Imports a spreadsheet in to YouTrack}
+  gem.homepage      = "https://github.com/justincbeck/trackinator"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "trackinator"
+  gem.require_paths = %w{lib}
+  gem.version       = Trackinator::VERSION
+
+  gem.add_dependency "gdata_19"
+  gem.add_dependency "trollop"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: trackinator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Justin Beck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gdata_19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    In order to introduce in to my main development process\n    I
+  decided that creating a test plan prior to development\n    and then using that
+  as the basis for my YouTrack tickets\n    would be a good approach.  Think of it
+  as TDD at a macro\n    level.\n"
+email:
+- justinbeck@mac.com
+executables:
+- trackinate
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/trackinate
+- lib/trackinator.rb
+- lib/trackinator/importer.rb
+- lib/trackinator/version.rb
+- trackinator.gemspec
+homepage: https://github.com/justincbeck/trackinator
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Imports a spreadsheet in to YouTrack
+test_files: []