lita-rally 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69fbe9f6b8d8878c919cfe737a9aa5424c8cfeaf
+  data.tar.gz: 5b5a75657b23de9bdaf7ca122057e500538d9b52
+SHA512:
+  metadata.gz: e60d126c94f11b2993501ca3997e1d885fa5ddc6d725edbf454ece01429a03085aec9fb04b4cb413afd18c12492aa1fdc9378ae551c26d92c972f397fdc65a5a
+  data.tar.gz: a38d3ccbeab0af552bd044bdf54c5539498487dad7bc74faa9c11d6139fd5aa0a20dd2da9ed44fe6aa01a8fd75633050fc6faafb420252f50a744a3be718d008

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Richard Li
+
+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,48 @@
+# lita-rally
+
+A port of
+[Hubot-Rally](https://github.com/github/hubot-scripts/blob/master/src/scripts/rally.coffee)
+with some enhancements. 
+
+## Installation
+
+Add lita-rally to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-rally"
+```
+
+
+## Configuration
+
+**Required:**
+
+```config.handlers.rally.username``` - Rally username
+
+```config.handlers.rally.password``` - Rally password
+
+**Optional:**
+
+```config.handlers.rally.api_version``` - API version, default 'v2.0'
+
+
+## Usage
+
+```
+lita rally me <FormattedID>
+```
+Show information about Rally object identified by FormattedID.
+
+```
+lita rally me release stats for <release_name>
+```
+Show defect and user story count for the release <release_name>
+
+```
+lita rally me release info for <release_name>
+```
+Show object IDs (defects, user story, etc.) for release <release_name>.
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/handlers/rally.rb

@@ -0,0 +1,259 @@
+require 'rest-client'
+require 'json'
+
+module Lita
+  module Handlers
+    class Rally < Handler
+      @@key_map = {
+        'de' => {
+          name: 'defect',
+          extra_output: [
+            'State',
+            'ScheduleState',
+            'Severity',
+            ['Release', '_refObjectName'],
+          ],
+        },
+        'ds' => {
+            name: 'defectsuite',
+            extra_output: [
+              'ScheduleState',
+            ]
+        },
+        'f' => {
+          name: 'feature',
+          query_path: 'portfolioitem/feature',
+          extra_output: [
+            ['State', '_refObjectName'],
+            ['Parent', '_refObjectName'],
+          ]
+        },
+        'i' => {
+          name: 'initiative',
+          query_path: 'portfolioitem/initiative',
+          extra_output: [
+            ['State', '_refObjectName'],
+            ['Parent', '_refObjectName'],
+          ]
+        },
+        't' => {
+          name: 'theme',
+          query_path: 'portfolioitem/theme',
+          extra_output: [
+            ['State', '_refObjectName'],
+            ['Parent', '_refObjectName'],
+          ]
+        },
+        'ta' => {
+          name: 'task',
+          extra_output: [
+            'State',
+            ['WorkProduct', '_refObjectName'],
+          ]
+        },
+        'tc' => {
+          name: 'testcase',
+          extra_output: [
+            ['WorkProduct', '_refObjectName'],
+            'Type',
+          ]
+        },
+        'us' => {
+          name: 'story',
+          query_path: 'hierarchicalrequirement',
+          link_path: 'userstory',
+          extra_output: [
+            'ScheduleState',
+            ['Parent', '_refObjectName'],
+            ['Feature', '_refObjectName'],
+          ]
+        }
+      }
+
+      config :username
+      config :password
+      config :api_version
+
+      route(/^rally me ([[:alpha:]]+)(\d+)/, :rally_show, command: true, help: {
+        'rally me <identifier>' => 'Show me that rally object'
+      })
+
+      route(/^rally me release stats for (.+)/, :rally_release_stats,
+            command: true, help: {
+        'rally me release count for <release>' => 'Count US and DE for release'
+      })
+
+      route(/^rally me release info for (.+)/, :rally_release_info,
+            command: true, help: {
+        'rally me release info for <release>' => 'Show release info'
+      })
+
+      def rally_show(response)
+        if config_validate
+          get_rally_object(response)
+        else
+          response.reply('Configuration failed to validate, '\
+                         'check your config')
+        end
+      end
+
+      def rally_release_stats(response)
+        if config_validate
+          get_rally_release_stat(response)
+        else
+          response.reply('Configuration failed to validate, '\
+                         'check your config')
+        end
+      end
+
+      def rally_release_info(response)
+        if config_validate
+          get_rally_release_info(response)
+        else
+          response.reply('Configuration failed to validate, '\
+                         'check your config')
+        end
+      end
+
+      private
+
+      def config_validate
+        (config.username && config.password) ? true : false
+      end
+
+      def get_rest
+        api_version = config.api_version ? config.api_version : 'v2.0'
+        RestClient::Resource.new(
+          "https://rally1.rallydev.com/slm/webservice/#{api_version}/",
+          user: config.username,
+          password: config.password,
+        )
+      end
+
+      def validate_release(rest, release)
+        query = "(Name = \"#{release}\")"
+        JSON.parse(
+          rest['release'].get(params: {query: query})
+        )['QueryResult']['TotalResultCount'] == 0
+      end
+
+      def get_rally_release_info(response)
+        rest = get_rest
+        release = response.matches[0][0]
+        if validate_release(rest, release)
+          response.reply("I can find anything about release: '#{release}'!")
+        else
+          query = "(Release.Name = \"#{release}\")"
+          defects = JSON.parse(
+            rest['defect'].get(
+              params: {
+                query: query,
+                fetch: 'true',
+                pagesize: '200',
+              }
+            )
+          )['QueryResult']['Results'].map {|r| r['FormattedID']}.join(' ')
+
+          us = JSON.parse(
+            rest['hierarchicalrequirement'].get(
+              params: {
+                query: query,
+                fetch: 'true',
+                pagesize: '200',
+              }
+            )
+          )['QueryResult']['Results'].map {|r| r['FormattedID']}.join(' ')
+
+          output = "Release info for: #{release}\n" \
+                   "Defects: #{defects}\n" \
+                   "User Stories: #{us}\n"
+          response.reply(output)
+        end
+      end
+
+      def get_rally_release_stat(response)
+        rest = get_rest
+        release = response.matches[0][0]
+        if validate_release(rest, release)
+          response.reply("I can find anything about release: '#{release}'!")
+        else
+          query = "(Release.Name = \"#{release}\")"
+          de_result = JSON.parse(
+            rest['defect'].get(params: {query: query})
+          )['QueryResult']
+          de_count = de_result['TotalResultCount']
+
+          us_result = JSON.parse(
+            rest['hierarchicalrequirement'].get(params: {query: query})
+          )['QueryResult']
+          us_count = us_result['TotalResultCount']
+
+          output = "Release stats for: #{release}\n" \
+                   "Defects count: #{de_count}\n" \
+                   "User Story count: #{us_count}\n"
+          response.reply(output)
+        end
+      end
+
+      def get_rally_object(response)
+        rest = get_rest
+        type = response.matches[0][0].downcase
+        id = response.matches[0][1]
+        if @@key_map[type]
+          query_path = (@@key_map[type][:query_path] || @@key_map[type][:name])
+          link_path = (@@key_map[type][:link_path] || query_path)
+          query_result = JSON.parse(
+            rest[query_path].get(
+              params: {
+                query: "(FormattedId = #{id})",
+                fetch: 'true'
+              }
+            )
+          )['QueryResult']
+          if query_result['TotalResultCount'] == 0
+            response.reply("Can't find your so called #{type}#{id} in Rally!")
+          else
+            result = query_result['Results'][0]
+            link = link_to_item(result, link_path)
+            output = ''
+            output += link + "\n" if link
+            output += "#{result['FormattedID']} - #{result['Name']}\n" \
+                      "Owner: #{result['Owner']['_refObjectName']}\n" \
+                      "Project: #{result['Project']['_refObjectName']}\n"
+            @@key_map[type][:extra_output].each do |field|
+              output += "#{field}: #{result[field]}\n" if
+                field.is_a?(String) && result[field]
+              output += "#{field[0]}: #{result[field[0]][field[1]]}\n" if
+                field.is_a?(Array) && result[field[0]]
+            end
+            output += "Description: #{strip_html(result['Description'])}\n"
+            response.reply(output)
+          end
+        else
+          response.reply("I don't know the type #{type}")
+        end
+      end
+
+      def link_to_item(result, type)
+        return false unless result['Project'] && result['ObjectID']
+        project_id = result['Project']['_ref'].split('/')[-1]
+        object_id = result['ObjectID']
+        "https://rally1.rallydev.com/#/#{project_id}/detail/#{type}/#{object_id}"
+      end
+
+      def strip_html(text)
+        text.gsub( '<br />', "\n\n"
+        ).gsub('&nbsp;', ' '
+        ).gsub('&gt;', '>'
+        ).gsub('&lt;', '<'
+        ).gsub('<div>', ''
+        ).gsub('</div>', "\n"
+        ).gsub(/<style.+\/style>/, ''
+        )
+      end
+
+    end
+
+    Lita.register_handler(Rally)
+  end
+end

data/lib/lita-rally.rb

@@ -0,0 +1,7 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/handlers/rally"

data/lita-rally.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-rally"
+  spec.version       = "0.1.0"
+  spec.authors       = ['Richard Li']
+  spec.email         = ['evilcat@wisewolfsolutions.com']
+  spec.description   = %q{lita bot Rally plugin}
+  spec.summary       = %q{lita bot Rally plugin}
+  spec.homepage      = "https://github.com/ecwws/lita-rally"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "lita", ">= 4.1"
+  spec.add_runtime_dependency "rest-client"
+  spec.add_runtime_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      rally:

data/spec/lita/handlers/rally_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe Lita::Handlers::Rally, lita_handler: true do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-rally"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: lita-rally
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Li
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: lita bot Rally plugin
+email:
+- evilcat@wisewolfsolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-rally.rb
+- lib/lita/handlers/rally.rb
+- lita-rally.gemspec
+- locales/en.yml
+- spec/lita/handlers/rally_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ecwws/lita-rally
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: lita bot Rally plugin
+test_files:
+- spec/lita/handlers/rally_spec.rb
+- spec/spec_helper.rb