lita-phraseapp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6f9231b81cf251462c73a668bfc06f0e956f673
+  data.tar.gz: 85cf24b953cbb981c2b3622f105c659c417dde04
+SHA512:
+  metadata.gz: 41d77c6c87bd85846e83903054dc88394eee920613523109bb86fc3e0aae746fb06d22deb431f0c242027e7cee58035da15fb20d1817408dbf308c803ee645a3
+  data.tar.gz: 0f0d7d473503a9bb942b0fbe2980c6772d38f1303571a86f8afa3cd1b1652a5a931293c59ffe559e6760ef314d9a0e64de4cba2d4d83a19ecae59bc063904db2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 James Healy
+
+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,33 @@
+# lita-phraseapp
+
+A lita plugin for interacting with phraseapp.com, a translation management app.
+
+## Installation
+
+Add this gem to your lita installation by including the following line in your Gemfile:
+
+    gem "lita-phraseapp"
+
+## Externally triggered events
+
+This handler can phraseapp events and trigger a variety of activities as appropriate. To
+get started, use the phraseapp web interface to configure a webhook that POSTs events to:
+
+    http://your-lita-bot.com/phraseapp
+
+### Locale Stats
+
+To print a summary of locale stats to a channel each time a file is uploaded to a project,
+edit your lita\_config.rb to include the following line.
+
+    config.handlers.phraseapp_stats.channel_name = "channel-name"
+
+## Chat commands
+
+This handler provides no additional chat commands. Yet.
+
+## TODO
+
+Possible ideas for new features, either via chat commands or externally triggered events:
+
+* more specs

data/lib/lita-phraseapp.rb

@@ -0,0 +1,4 @@
+require 'lita/phraseapp'
+require 'lita/phraseapp_gateway'
+require 'lita/phraseapp_event'
+require 'lita/phraseapp_stats'

data/lib/lita/phraseapp.rb

@@ -0,0 +1,22 @@
+require "lita"
+require_relative 'phraseapp_event'
+
+module Lita
+  module Handlers
+    # Interact with phraseapp via our slack team
+    class Phraseapp < Handler
+
+      config :api_key
+
+      http.post "/phraseapp", :phraseapp_event
+
+      def phraseapp_event(request, response)
+        event = PhraseappEvent.new(request.body.read)
+        robot.trigger(:phraseapp_event, event: event, api_key: config.api_key)
+      end
+
+    end
+
+    Lita.register_handler(Phraseapp)
+  end
+end

data/lib/lita/phraseapp_event.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+# Value object that wraps raw phraseapp webhook data and provides convenience
+# methods for querying it
+class PhraseappEvent
+  attr_reader :data
+
+  def initialize(data)
+    @data = JSON.load(data)
+  end
+
+  def name
+    @data.fetch("event")
+  end
+
+  def message
+    @data.fetch("message")
+  end
+
+  def project_name
+    @data.fetch("project", {}).fetch("name", nil)
+  end
+
+end

data/lib/lita/phraseapp_gateway.rb

@@ -0,0 +1,39 @@
+require 'phraseapp-ruby'
+require 'ostruct'
+
+class PhraseappGateway
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def project_name_to_id(name)
+    projects_list, err = phraseapp_client.projects_list(1, 20)
+    projects_list.select { |project|
+      project.name.downcase == name.downcase
+    }.map { |project|
+      project.id
+    }.first
+  end
+
+  def locales(project_id)
+    locales_list, err = phraseapp_client.locales_list(project_id, 1, 20)
+    locales = locales_list.flatten.map { |abbreviated_locale|
+      phraseapp_client.locale_show(project_id, abbreviated_locale.id)
+    }.flatten.compact.map { |locale|
+      OpenStruct.new(
+        name: locale.name,
+        total: locale.statistics['keys_total_count'],
+        completed: locale.statistics['translations_completed_count'],
+        percent: (BigDecimal.new(locale.statistics['translations_completed_count'].to_f / locale.statistics['keys_total_count'], 5) * 100).round(2)
+      )
+    }
+  end
+
+  private
+
+  def phraseapp_client
+    @phraseapp_client ||= PhraseApp::Client.new(
+      PhraseApp::Auth::Credentials.new(token: @api_key)
+    )
+  end
+end

data/lib/lita/phraseapp_stats.rb

@@ -0,0 +1,51 @@
+require "lita"
+require_relative 'phraseapp_event'
+require_relative 'phraseapp_gateway'
+
+module Lita
+  module Handlers
+    # Print phraseapp project stats to a channel
+    class PhraseappStats < Handler
+      config :channel_name
+
+      on :phraseapp_event, :print_event
+
+      def print_event(payload)
+        event = payload[:event]
+        print_stats(event) if event.name == "uploads:create"
+      end
+
+      private
+
+      def print_stats(event)
+        project_id = phraseapp_gateway.project_name_to_id(event.project_name)
+        if project_id
+          robot.send_message(target, "[phraseapp] #{event.message}")
+          robot.send_message(target, locale_stats_message(project_id))
+        end
+      end
+
+      def locale_stats_message(project_id)
+        locales = phraseapp_gateway.locales(project_id)
+        locales_to_message(locales)
+      end
+
+      def locales_to_message(locales)
+        "Locales:\n" + locales.map { |locale|
+          "- #{locale.name}: #{locale.completed}/#{locale.total} (#{locale.percent.to_s("F")}%)"
+        }.join("\n")
+      end
+
+      def target
+        Source.new(room: Lita::Room.find_by_name(config.channel_name) || "general")
+      end
+
+      def phraseapp_gateway
+        @gateway ||= PhraseappGateway.new(Lita.config.handlers.phraseapp.api_key)
+      end
+
+    end
+
+    Lita.register_handler(PhraseappStats)
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: lita-phraseapp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rdoc
+  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: lita
+  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: phraseapp-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Lita handler for interacting with phraseapp.com, a translation management
+  application
+email:
+- james.healy@theconversation.edu.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- lib/lita-phraseapp.rb
+- lib/lita/phraseapp.rb
+- lib/lita/phraseapp_event.rb
+- lib/lita/phraseapp_gateway.rb
+- lib/lita/phraseapp_stats.rb
+homepage: http://github.com/conversation/lita-phraseapp
+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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Lita handler for interacting with phraseapp.com, a translation management
+  application
+test_files: []