txgh 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41d11b7b8102cca5e57f005f206a07ae1e80b37b
-  data.tar.gz: 00d3f323be5b4e668d4ad92e89d4211027899346
+  metadata.gz: 602ce638efdadb764883e26d1c3636e84bdd5ede
+  data.tar.gz: 11f75ef7992aad2dc8e08a5c63e49f5faf0b140d
 SHA512:
-  metadata.gz: 7a609ee7470a0787d7c350ab62fd871eabd615fcf9645d5f9807de6644587da41e52596dcb28437bb568f8a0cc937598db56b9f1e9ccd5358d5a682e02d8cf55
-  data.tar.gz: 99d8736582500541ba8967d5d621d55a49eec61dd3c0138a0c54f886963112cd52aff95348ce6faa880728e47b7ac4be0cd767ef57b7711c66427dad7dcbfb94
+  metadata.gz: 4ffa50d6b1b08c2b754983f4b899ae9f4e25ae224c239efffda00ea3115a94b8873bd1c8a4583cc360036fcc548a7bbd7850d74df3f3299ab17a45325e7f24e3
+  data.tar.gz: 58f00d04c536bb5f66a7cb4762bee31bbbf1a59a226f24d62ddc4deb9c53baf0648a89925b995a44308ce68d525f8c03f5b13d700c2d2273f91321933efc97a8

data/lib/txgh/events.rb

@@ -0,0 +1,35 @@
+module Txgh
+  class Events
+    ERROR_CHANNEL = 'errors'
+
+    attr_reader :channel_hash
+
+    def initialize
+      @channel_hash = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def subscribe(channel, &block)
+      channel_hash[channel] << block
+    end
+
+    def publish(channel, options = {})
+      channel_hash.fetch(channel, []).each do |callback|
+        callback.call(options)
+      end
+    rescue => e
+      publish_error(e)
+    end
+
+    def channels
+      channel_hash.keys
+    end
+
+    private
+
+    def publish_error(e)
+      # if nobody has subscribed to error events, raise original error
+      callbacks = channel_hash.fetch(ERROR_CHANNEL) { raise e }
+      callbacks.each { |callback| callback.call(e) }
+    end
+  end
+end

data/lib/txgh/github_api.rb

@@ -79,5 +79,9 @@ module Txgh
       end
     end
 
+    def create_status(repo, sha, state, options = {})
+      client.create_status(repo, sha, state, options)
+    end
+
   end
 end

data/lib/txgh/github_status.rb

@@ -0,0 +1,87 @@
+module Txgh
+  class GithubStatus
+    class State
+      PENDING = 'pending'
+      SUCCESS = 'success'
+      ERROR   = 'error'
+      FAILURE = 'failure'
+
+      class << self
+        def pending; PENDING; end
+        def success; SUCCESS; end
+        def error; ERROR; end
+        def failure; failure; end
+      end
+    end
+
+    ALL_COMPLETE_DESCRIPTION = "Translations complete!"
+    TARGET_URL_TEMPLATE = "https://www.transifex.com/%{organization}/%{project_slug}/%{resource_slug}/"
+    DESCRIPTION_TEMPLATE = "%{complete}/%{total} translations complete."
+    CONTEXT = 'continuous-localization/txgh'
+
+    attr_reader :project, :repo, :tx_resource
+
+    def initialize(project, repo, tx_resource)
+      @project = project
+      @repo = repo
+      @tx_resource = tx_resource
+    end
+
+    def update(sha)
+      repo.api.create_status(
+        repo.name, sha, state, {
+          context: context, target_url: target_url, description: description
+        }
+      )
+    end
+
+    private
+
+    def context
+      CONTEXT
+    end
+
+    def target_url
+      TARGET_URL_TEMPLATE % {
+        organization: project.organization,
+        project_slug: tx_resource.project_slug,
+        resource_slug: tx_resource.resource_slug
+      }
+    end
+
+    def state
+      if all_complete?
+        State.success
+      else
+        State.pending
+      end
+    end
+
+    def description
+      if all_complete?
+        ALL_COMPLETE_DESCRIPTION
+      else
+        DESCRIPTION_TEMPLATE % stat_totals
+      end
+    end
+
+    def all_complete?
+      stats.all? do |locale, details|
+        details['completed'] == '100%'
+      end
+    end
+
+    def stat_totals
+      @stat_totals ||= { complete: 0, total: 0 }.tap do |counts|
+        stats.each_pair do |locale, details|
+          counts[:total] += details['translated_entities'] + details['untranslated_entities']
+          counts[:complete] += details['translated_entities']
+        end
+      end
+    end
+
+    def stats
+      @stats ||= project.api.get_stats(*tx_resource.slugs)
+    end
+  end
+end

data/lib/txgh/resource_committer.rb

@@ -16,12 +16,25 @@ module Txgh
 
         if translations
           repo.api.commit(repo.name, branch, { file_name => translations })
+          fire_event_for(tx_resource, branch, language)
         end
       end
     end
 
     private
 
+    def fire_event_for(tx_resource, branch, language)
+      head = repo.api.get_ref(repo.name, branch)
+      sha = head[:object][:sha]
+
+      Txgh.events.publish(
+        'github.resource.committed', {
+          project: project, repo: repo, resource: tx_resource, sha: sha,
+          language: language
+        }
+      )
+    end
+
     def download(tx_resource, branch, language)
       downloader = ResourceDownloader.new(
         project, repo, branch, {

data/lib/txgh/resource_updater.rb

@@ -31,12 +31,22 @@ module Txgh
           else
             upload_whole(tx_resource, file, categories)
           end
+
+          fire_event_for(tx_resource, commit_sha)
         end
       end
     end
 
     private
 
+    def fire_event_for(tx_resource, commit_sha)
+      Txgh.events.publish(
+        'transifex.resource.updated', {
+          project: project, repo: repo, resource: tx_resource, sha: commit_sha
+        }
+      )
+    end
+
     def upload_whole(tx_resource, file, categories)
       content = contents_of(file['sha'])
 

data/lib/txgh/transifex_api.rb

@@ -50,9 +50,15 @@ module Txgh
     end
 
     def create(tx_resource, content, categories = [])
+      name = if tx_resource.branch
+        "#{tx_resource.source_file} (#{tx_resource.branch})"
+      else
+        tx_resource.source_file
+      end
+
       payload = {
         slug: tx_resource.resource_slug,
-        name: tx_resource.source_file,
+        name: name,
         i18n_type: tx_resource.type,
         categories: CategorySupport.join_categories(categories.uniq),
         content: get_content_io(tx_resource, content)

data/lib/txgh/version.rb

@@ -1,3 +1,3 @@
 module Txgh
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/lib/txgh.rb

@@ -7,9 +7,11 @@ module Txgh
   autoload :Config,                'txgh/config'
   autoload :DiffCalculator,        'txgh/diff_calculator'
   autoload :EmptyResourceContents, 'txgh/empty_resource_contents'
+  autoload :Events,                'txgh/events'
   autoload :GithubApi,             'txgh/github_api'
   autoload :GithubRepo,            'txgh/github_repo'
   autoload :GithubRequestAuth,     'txgh/github_request_auth'
+  autoload :GithubStatus,          'txgh/github_status'
   autoload :Handlers,              'txgh/handlers'
   autoload :Hooks,                 'txgh/app'
   autoload :MergeCalculator,       'txgh/merge_calculator'
@@ -40,6 +42,18 @@ module Txgh
     def providers
       Txgh::Config::Providers
     end
+
+    def events
+      @events ||= Events.new
+    end
+
+    def update_status_callback(options)
+      project = options.fetch(:project)
+      repo = options.fetch(:repo)
+      resource = options.fetch(:resource)
+
+      GithubStatus.new(project, repo, resource).update(options.fetch(:sha))
+    end
   end
 
   # default set of tx config providers
@@ -50,4 +64,12 @@ module Txgh
   # default set of base config providers
   key_manager.register_provider(providers::FileProvider, YAML)
   key_manager.register_provider(providers::RawProvider,  YAML)
+
+  events.subscribe('transifex.resource.updated') do |options|
+    update_status_callback(options)
+  end
+
+  events.subscribe('github.resource.committed') do |options|
+    update_status_callback(options)
+  end
 end

data/spec/events_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+include Txgh
+
+describe Events do
+  let(:events) { Events.new }
+
+  describe '#subscribe and #channels' do
+    it "adds a channel if it doesn't already exist" do
+      expect(events.channels).to be_empty
+      events.subscribe('foo.bar')
+      expect(events.channels).to eq(['foo.bar'])
+    end
+
+    it 'adds the proc to the list of callbacks for the channel' do
+      events.subscribe('foo.bar') { 'baz' }
+      expect(events.channel_hash['foo.bar'].first.call).to eq('baz')
+    end
+  end
+
+  describe '#publish' do
+    it 'notifies all subscribers' do
+      received = []
+      events.subscribe('foo.bar') { |arg| received << "foo.bar #{arg}" }
+      events.subscribe('foo.bar') { |arg| received << "foo.bar2 #{arg}" }
+      events.publish('foo.bar', 'baz')
+      expect(received).to eq([
+        'foo.bar baz', 'foo.bar2 baz'
+      ])
+    end
+
+    it 'publishes errors through a special errors channel' do
+      errors = []
+      events.subscribe('errors') { |e| errors << e }
+      events.subscribe('foo.bar') { raise 'jelly beans' }
+      expect { events.publish('foo.bar') }.to_not raise_error
+      expect(errors.first.message).to eq('jelly beans')
+    end
+
+    it 'raises errors if there are no error subscribers' do
+      events.subscribe('foo.bar') { raise 'jelly beans' }
+      expect { events.publish('foo.bar') }.to raise_error('jelly beans')
+    end
+  end
+end

data/spec/github_status_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'helpers/standard_txgh_setup'
+
+include Txgh
+
+describe GithubStatus do
+  include StandardTxghSetup
+
+  describe '#update' do
+    let(:status) { GithubStatus.new(transifex_project, github_repo, resource) }
+    let(:resource) { tx_config.resource(resource_slug) }
+    let(:sha) { 'abc123shashasha' }
+
+    let(:stats) do
+      supported_languages.each_with_object({}) do |language, ret|
+        ret[language] = {
+          'translated_entities' => 10, 'untranslated_entities' => 0,
+          'completed' => '100%'
+        }
+      end
+    end
+
+    before(:each) do
+      allow(transifex_api).to receive(:get_stats).and_return(stats)
+    end
+
+    context 'with all resources at 100%' do
+      it 'reports status as success' do
+        expect(github_api).to receive(:create_status) do |repo, commit_sha, state, options|
+          expect(repo).to eq(repo_name)
+          expect(commit_sha).to eq(sha)
+          expect(state).to eq(GithubStatus::State.success)
+          expect(options[:description]).to eq('Translations complete!')
+          expect(options[:context]).to eq('continuous-localization/txgh')
+          expect(options[:target_url]).to eq(
+            "https://www.transifex.com/#{organization}/#{project_name}/#{resource_slug}/"
+          )
+        end
+
+        status.update(sha)
+      end
+    end
+
+    context 'with one language at less than 100%' do
+      let(:stats) do
+        {
+          'pt' => {
+            'translated_entities' => 10, 'untranslated_entities' => 0,
+            'completed' => '100%'
+          },
+          'ja' => {
+            'translated_entities' => 5, 'untranslated_entities' => 5,
+            'completed' => '50%'
+          }
+        }
+      end
+
+      it 'reports status as pending' do
+        expect(github_api).to receive(:create_status) do |repo, commit_sha, state, options|
+          expect(state).to eq(GithubStatus::State.pending)
+          expect(options[:description]).to eq('15/20 translations complete.')
+        end
+
+        status.update(sha)
+      end
+    end
+  end
+end

data/spec/handlers/transifex/hook_handler_spec.rb

@@ -31,6 +31,10 @@ describe HookHandler do
     allow(downloader).to(receive(:first)).and_return([
       "translations/#{language}/sample.yml", translations
     ])
+
+    allow(github_api).to receive(:get_ref).and_return(
+      object: { sha: '123abcshashasha' }
+    )
   end
 
   it 'downloads translations and pushes them to the correct branch (head)' do

data/spec/helpers/standard_txgh_setup.rb

@@ -18,6 +18,7 @@ module StandardTxghSetup
   let(:supported_languages) { [language] }
   let(:translations) { 'translation file contents' }
   let(:diff_point) { nil }
+  let(:organization) { 'myorg' }
 
   let(:project_config) do
     {
@@ -28,7 +29,8 @@ module StandardTxghSetup
       'tx_config' => "raw://#{tx_config_raw}",
       'webhook_secret' => 'abc123',
       'auto_delete_resources' => 'true',
-      'languages' => supported_languages
+      'languages' => supported_languages,
+      'organization' => organization
     }
   end
 

data/spec/helpers/test_events.rb

@@ -0,0 +1,12 @@
+class TestEvents < Txgh::Events
+  attr_reader :published
+
+  def initialize
+    @published = []
+    super
+  end
+
+  def publish(channel, options = {})
+    published << { channel: channel, options: options }
+  end
+end