lita-mingle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e014b170818ae0f893089f47059ea8bbc6bc35b
+  data.tar.gz: f2ba74c34cb6e5ca770cf1cda27b79cf8c9d9fb5
+SHA512:
+  metadata.gz: e56de39f89e7b43b938f9eba48e1502bbb0097a08aa33f5ede61437a92965e543c8c945f9d40c8a2ff6843a81612920c5342449af238b2b524d81790715c14e4
+  data.tar.gz: b48b18a4be9c7f00c82d9a147c21ee8b0157dfbd27de613b7ac57b5a3e23837b39cd889b24b663f250cc7de878d66f099dc6aa1821080ded6bf4a3ddc3049e37

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
+vendor/

data/.rubocop.yml

@@ -0,0 +1,14 @@
+LineLength:
+  Max: 200
+
+FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+AbcSize:
+  Max: 25
+
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake
+before_install:
+  - gem update bundler
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

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

data/README.md

@@ -0,0 +1,69 @@
+# lita-mingle
+
+[![Build Status](https://travis-ci.org/visioncritical/lita-mingle.png?branch=master)](https://travis-ci.org/visioncritical/lita-mingle)
+
+A Lita Plugin for creating/updating cards in Mingle.
+
+## Installation
+
+Add lita-mingle to your Lita instance's Gemfile:
+
+```ruby
+gem "lita-mingle"
+```
+
+## Configuration
+
+This plugin comes with 4 configurations options:
+
+### Required
+
+* server - The URL for your Mingle server
+* user - A Mingle user
+* hmac_token - The HMAC token value for your specified user
+
+### Example
+
+```ruby
+config.handlers.mingle.server = 'https://your.mingle.server'
+config.handlers.mingle.user = 'hermes.conrad'
+config.handlers.mingle.hmac_token = 'HMACTOKEN'
+```
+
+### Optional
+
+* administrator - Your desired contact information. Will replace `%{administrator}` in the following line:
+
+`Please contact %{administrator}.`
+
+Defaults to: 'your Mingle administrator'.
+
+### Example
+
+```ruby
+config.handlers.mingle.administrator = '#some_channel'
+# OR
+config.handlers.mingle.administrator = '@some_group'
+# OR
+config.handlers.mingle.administrator = 'planetexpress@domain.local'
+```
+
+## Usage
+
+```
+mingle projects - Lists all the projects for a mingle server (id, name)
+mingle [PROJECT_ID] [CARD_TYPE] with name [CARD_NAME] - Creates a mingle card under the specified project
+mingle [PROJECT_ID] [CARD_NUM] [DESCRIPTION] - Updates the body of a specified mingle card
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Vision Critical
+
+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/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color -fd spec/lita'
+end
+
+task default: :spec
+
+# Style tests (Rubocop)
+namespace :style do
+  desc 'Run Ruby style checks'
+  RuboCop::RakeTask.new :ruby
+end
+
+# Run all style tasks
+desc 'Run all style checks'
+task style: ['style:ruby']

data/lib/helpers/api.rb

@@ -0,0 +1,34 @@
+require_relative 'patches/mingleapi'
+
+module MingleHelpers
+  module API
+    class Client < MingleAPI
+      MingleAPI::Http.send(:include, MingleHelpers::Patches::HTTPPut)
+      MingleAPI.send(:include, MingleHelpers::Patches::UpdateCard)
+
+      attr_reader :server, :connection
+
+      def initialize(server, user, hmac_token)
+        # @server = server
+        # @connection = MingleAPI.new(server, hmac: [user, hmac_token])
+        super(server, hmac: [user, hmac_token])
+      end
+
+      # Returns an array of hashes
+      # { :name, :identifier, :description }
+      def projects
+        super.collect(&:to_h)
+      end
+
+      # Returns the card URL
+      def create_card(project, attrs)
+        super(project, attrs).url
+      end
+
+      # Returns the card URL
+      def update_card(project, card_num, attrs)
+        super(project, card_num, attrs).url
+      end
+    end
+  end
+end

data/lib/helpers/patches/mingleapi.rb

@@ -0,0 +1,30 @@
+module MingleHelpers
+  module Patches
+    module HTTPPut
+      def put(url, params)
+        process(Net::HTTP::Put::Multipart, url, params)
+      end
+    end
+
+    module UpdateCard
+      def update_card(project, card_num, attrs)
+        params = [
+          ['card[name]', attrs[:name]],
+          ['card[card_type_name]', attrs[:type]],
+          ['card[description]', attrs[:description]]
+        ]
+        Array(attrs[:attachments]).each_with_index do |attachment, i|
+          path, content_type = attachment
+          params << ["attachments[#{i}]", UploadIO.new(File.new(path), content_type, File.basename(path))]
+        end
+        Array(attrs[:properties]).each_with_index do |prop, _i|
+          name, value = prop
+          params << ['card[properties][][name]', name]
+          params << ['card[properties][][value]', value]
+        end
+        @http.put(v2(:projects, project_identifier(project), :cards, card_num), params)
+        OpenStruct.new(number: card_num, url: url('projects', project_identifier(project), 'cards', card_num))
+      end
+    end
+  end
+end

data/lib/helpers/regex.rb

@@ -0,0 +1,7 @@
+module MingleHelpers
+  module Regex
+    LIST_PROJECTS_PATTERN = /([mM]ingle [pP]rojects?)/
+    CREATE_CARD_PATTERN   = /([mM]ingle)\s+(?<project>\w+)\s+(?<card_type>[\w\s]+)\swith\sname\s(?<name>.*)/
+    UPDATE_CARD_PATTERN   = /([mM]ingle)\s(?<project>\S+)\s(?<card_num>\d+)\s(?<description>.+)/m
+  end
+end

data/lib/lita-mingle.rb

@@ -0,0 +1,16 @@
+require 'lita'
+require 'mingle-api'
+require 'time'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require_relative 'helpers/api'
+require_relative 'helpers/regex'
+require 'lita/handlers/mingle'
+
+Lita::Handlers::Mingle.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+  __FILE__
+)

data/lib/lita/handlers/mingle.rb

@@ -0,0 +1,73 @@
+module Lita
+  module Handlers
+    class Mingle < Handler
+      include ::MingleHelpers::API
+      include ::MingleHelpers::Regex
+
+      config :server, required: true
+      config :user, required: true
+      config :hmac_token, required: true
+      config :administrator, default: 'your Mingle administrator'
+
+      route(
+        /\A#{LIST_PROJECTS_PATTERN}\z/,
+        :list_projects,
+        command: false,
+        help: { t('project.list.help.syntax') => t('project.list.help.desc') }
+      )
+
+      route(
+        /\A#{CREATE_CARD_PATTERN}\z/,
+        :create_card,
+        command: false,
+        help: { t('card.create.help.syntax') => t('card.create.help.desc') }
+      )
+
+      route(
+        /\A#{UPDATE_CARD_PATTERN}\z/,
+        :update_card,
+        command: false,
+        help: { t('card.update.help.syntax') => t('card.update.help.desc') }
+      )
+
+      def list_projects(response)
+        mingle = Client.new config.server, config.user, config.hmac_token
+        projects = mingle.projects
+        message = projects.each.inject('') do |list, hash|
+          list << t('project.list.reply', id: hash[:identifier], name: hash[:name]) + "\n"
+          list
+        end
+        response.reply message.prepend 'PROJECT ID -- NAME' + "\n"
+      rescue
+        response.reply t('project.list.error', administrator: config.administrator)
+      end
+
+      def create_card(response)
+        data = response.match_data
+        begin
+          mingle = Client.new config.server, config.user, config.hmac_token
+          url = mingle.create_card data['project'], name: data['name'], type: data['card_type']
+          response.reply t('card.create.reply', url: url)
+        rescue
+          response.reply t('card.create.error', administrator: config.administrator)
+        end
+      end
+
+      def update_card(response)
+        data = response.match_data
+        begin
+          mingle = Client.new config.server, config.user, config.hmac_token
+          card = mingle.card(data['project'], data['card_num']).to_h
+          url = mingle.update_card data['project'], data['card_num'], name: card[:name],
+                                                                      type: card[:type],
+                                                                      description: data['description']
+          response.reply t('card.update.reply', url: url)
+        rescue
+          response.reply t('card.update.error', administrator: config.administrator)
+        end
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-mingle.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-mingle'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Riley Shott']
+  spec.email         = %w(riley.shott@visioncritical.com)
+  spec.description   = 'A Lita Plugin for creating/updating cards in Mingle'
+  spec.summary       = 'A Lita Plugin for creating/updating cards in Mingle'
+  spec.homepage      = 'https://github.com/visioncritical/lita-mingle'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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.7'
+  spec.add_runtime_dependency 'mingle-api', '>= 0.0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'rubocop', '>= 0.28.0'
+end

data/locales/en.yml

@@ -0,0 +1,24 @@
+en:
+  lita:
+    handlers:
+      mingle:
+        card:
+          create:
+            help:
+              syntax: "mingle [PROJECT_ID] [CARD_TYPE] with name [CARD_NAME]"
+              desc: "Creates a mingle card under the specified project"
+            reply: "Card created - %{url}"
+            error: "Card creation failed. Please contact %{administrator}."
+          update:
+            help:
+              syntax: "mingle [PROJECT_ID] [CARD_NUM] [DESCRIPTION]"
+              desc: "Updates the body of a specified mingle card"
+            reply: "Card updated - %{url}"
+            error: "Card update failed. Please contact %{administrator}."
+        project:
+          list:
+            help:
+              syntax: "mingle projects"
+              desc: "Lists all the projects for a mingle server (id, name)"
+            reply: "%{id} -- %{name}"
+            error: "Unable to list projects. Please contact %{administrator}."

data/spec/helpers/apistub.rb

@@ -0,0 +1,9 @@
+class ApiStub
+  def initialize(client)
+    @client = client
+  end
+
+  def list_projects
+    @client.projects.collect(&:to_h)
+  end
+end

data/spec/lita/handlers/mingle_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Lita::Handlers::Mingle, lita_handler: true do
+  it { is_expected.to route('Mingle project').to(:list_projects) }
+  it { is_expected.to route('Mingle Project').to(:list_projects) }
+  it { is_expected.to route('Mingle projects').to(:list_projects) }
+  it { is_expected.to route('Mingle Projects').to(:list_projects) }
+
+  it { is_expected.to route('mingle project').to(:list_projects) }
+  it { is_expected.to route('mingle Project').to(:list_projects) }
+  it { is_expected.to route('mingle projects').to(:list_projects) }
+  it { is_expected.to route('mingle Projects').to(:list_projects) }
+
+  it { is_expected.to route('mingle project card_type with name Guenter').to(:create_card) }
+  it { is_expected.to route('Mingle project card_type with name Guenter').to(:create_card) }
+
+  it { is_expected.to route('mingle project 1 Electronium Hat').to(:update_card) }
+  it { is_expected.to route('Mingle project 1 Electronium Hat').to(:update_card) }
+
+  before do
+    allow_any_instance_of(MingleAPI).to receive(:projects).and_return(response)
+    allow_any_instance_of(MingleAPI).to receive(:create_card).and_return(response)
+    allow_any_instance_of(MingleAPI).to receive(:card).and_return(response)
+    allow_any_instance_of(MingleHelpers::API::Client).to receive(:update_card).and_return(update_card_response)
+  end
+
+  let(:response) { double('MingleHelpers::API::Client') }
+  let(:projects_response) do
+    [OpenStruct.new(name: 'Mars University Expirement',
+                    identifier: 'marsu',
+                    description: 'See if a monkey could pass a course at Mars University')
+    ]
+  end
+  let(:create_card_response) do
+    'https://your.mingle.server/projects/marsu/cards/1'
+  end
+  let(:card_response) do
+    {
+      name: 'Mars University Expirement',
+      identifier: 'marsu',
+      description: 'See if a monkey could pass a course at Mars University'
+    }
+  end
+  let(:update_card_response) do
+    'https://your.mingle.server/projects/marsu/cards/1'
+  end
+
+  describe 'listing projects' do
+    it 'should be successful' do
+      allow(response).to receive(:collect).and_return(projects_response)
+
+      send_command('mingle projects')
+      expect(replies.last).to eq("PROJECT ID -- NAME\nmarsu -- Mars University Expirement\n")
+    end
+  end
+
+  describe 'creating a card' do
+    it 'should be successful' do
+      allow(response).to receive(:url).and_return(create_card_response)
+
+      send_command('mingle project Epic with name Guenter')
+      expect(replies.last).to eq('Card created - https://your.mingle.server/projects/marsu/cards/1')
+    end
+  end
+
+  describe 'updating a card' do
+    it 'should be successful' do
+      allow(response).to receive(:to_h).and_return(card_response)
+      allow(response).to receive(:url).and_return(update_card_response)
+
+      send_command('mingle project 1 Electronium Hat')
+      expect(replies.last).to eq('Card updated - https://your.mingle.server/projects/marsu/cards/1')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'lita-mingle'
+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
+
+RSpec.configure do |config|
+  config.before do
+    registry.register_handler(Lita::Handlers::Mingle)
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: lita-mingle
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Riley Shott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: mingle-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !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: pry-byebug
+  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: 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
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+description: A Lita Plugin for creating/updating cards in Mingle
+email:
+- riley.shott@visioncritical.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/helpers/api.rb
+- lib/helpers/patches/mingleapi.rb
+- lib/helpers/regex.rb
+- lib/lita-mingle.rb
+- lib/lita/handlers/mingle.rb
+- lita-mingle.gemspec
+- locales/en.yml
+- spec/helpers/apistub.rb
+- spec/lita/handlers/mingle_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/visioncritical/lita-mingle
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A Lita Plugin for creating/updating cards in Mingle
+test_files:
+- spec/helpers/apistub.rb
+- spec/lita/handlers/mingle_spec.rb
+- spec/spec_helper.rb