txgh-server 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b61f30ae875a1c12d037ce7123cece67a1bd4a12
-  data.tar.gz: 35536bb56e5cee37208c0c8a8f64e60347a0f88a
+  metadata.gz: 0a618f6c8f91abd2996e3e7589eeee8d644703f9
+  data.tar.gz: db946191d261517d34c339aa98424e46a72d0b0e
 SHA512:
-  metadata.gz: 5d1655be5e922b9e6157bbc4791ca9dddddc8316df4459d4d3418e127076c2b8933de70dd43de9caab17a6d08a4e978fbde5455425ff43c62c3a832412caa3c0
-  data.tar.gz: 1f6ebab2ba51bf04f9e49fb6d03afcb7a7faef63492bcd6a1d84672b7aa5a6a02b5cf43ddbc085ee39338106065ecac198fc4f862c5d97636ab2f5370d72d01b
+  metadata.gz: d09779408d47e28a776cbd8dc4e2ac36c1f9f56a9d2288f0beffddfc9f6ac3d84897b20dd968e5569506a47df5340e227adc499d888753a5ffcb9ff26e5ae33d
+  data.tar.gz: 38494763dc17346acb93efab18249efb1f9be9b03416b2ab1d8177fb6465c962a7b05e8541a4532af4bc785371f343a65d2a07f6362417be27157dba9ad4781c

data/lib/txgh-server/version.rb

@@ -1,3 +1,3 @@
 module TxghServer
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/txgh-server/webhooks/github/delete_attributes.rb

@@ -0,0 +1,50 @@
+module TxghServer
+  module Webhooks
+    module Github
+      class DeleteAttributes
+        ATTRIBUTES = [
+          :repo_name, :ref, :ref_type
+        ]
+
+        class << self
+          def from_webhook_payload(payload)
+            new(
+              ATTRIBUTES.each_with_object({}) do |attr, ret|
+                ret[attr] = public_send(attr, payload)
+              end
+            )
+          end
+
+          def repo_name(payload)
+            payload.fetch('repository').fetch('full_name')
+          end
+
+          def ref(payload)
+            payload.fetch('ref')
+          end
+
+          def ref_type(payload)
+            payload.fetch('ref_type')
+          end
+        end
+
+        attr_reader *ATTRIBUTES
+
+        def initialize(options = {})
+          ATTRIBUTES.each do |attr|
+            instance_variable_set(
+              "@#{attr}", options.fetch(attr) { options.fetch(attr.to_s) }
+            )
+          end
+        end
+
+        def to_h
+          ATTRIBUTES.each_with_object({}) do |attr, ret|
+            ret[attr] = public_send(attr)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/txgh-server/webhooks/github/delete_handler.rb

@@ -1,9 +1,17 @@
 module TxghServer
   module Webhooks
     module Github
-      class DeleteHandler < Handler
+      class DeleteHandler
+        include ResponseHelpers
 
-        include Txgh::CategorySupport
+        attr_reader :project, :repo, :logger, :attributes
+
+        def initialize(project, repo, logger, attributes)
+          @project = project
+          @repo = repo
+          @logger = logger
+          @attributes = attributes
+        end
 
         def execute
           perform_delete if should_handle_request?
@@ -22,13 +30,13 @@ module TxghServer
 
         def should_handle_request?
           # ref_type can be either 'branch' or 'tag' - we only care about branches
-          payload['ref_type'] == 'branch' &&
+          attributes.ref_type == 'branch' &&
             repo.should_process_ref?(branch) &&
             project.auto_delete_resources?
         end
 
         def branch
-          Txgh::Utils.absolute_branch(payload['ref'].sub(/^refs\//, ''))
+          Txgh::Utils.absolute_branch(attributes.ref.sub(/^refs\//, ''))
         end
 
       end

data/lib/txgh-server/webhooks/github/ping_handler.rb

@@ -6,7 +6,10 @@ module TxghServer
       class PingHandler
         include ResponseHelpers
 
-        def initialize(options = {})
+        attr_reader :logger
+
+        def initialize(logger)
+          @logger = logger
         end
 
         def execute

data/lib/txgh-server/webhooks/github/push_attributes.rb

@@ -0,0 +1,77 @@
+require 'set'
+
+module TxghServer
+  module Webhooks
+    module Github
+      class PushAttributes
+        ATTRIBUTES = [
+          :repo_name, :ref, :before, :after,
+          :added_files, :modified_files, :author
+        ]
+
+        class << self
+          def from_webhook_payload(payload)
+            new(
+              ATTRIBUTES.each_with_object({}) do |attr, ret|
+                ret[attr] = public_send(attr, payload)
+              end
+            )
+          end
+
+          def repo_name(payload)
+            payload.fetch('repository').fetch('full_name')
+          end
+
+          def ref(payload)
+            payload.fetch('ref')
+          end
+
+          def before(payload)
+            payload.fetch('before')
+          end
+
+          def after(payload)
+            payload.fetch('after')
+          end
+
+          def added_files(payload)
+            extract_files(payload, 'added')
+          end
+
+          def modified_files(payload)
+            extract_files(payload, 'modified')
+          end
+
+          def author(payload)
+            payload.fetch('head_commit').fetch('committer').fetch('name')
+          end
+
+          def extract_files(payload, state)
+            payload.fetch('commits').flat_map { |c| c[state] }.uniq
+          end
+        end
+
+        def files
+          @files ||= added_files + modified_files
+        end
+
+        attr_reader *ATTRIBUTES
+
+        def initialize(options = {})
+          ATTRIBUTES.each do |attr|
+            instance_variable_set(
+              "@#{attr}", options.fetch(attr) { options.fetch(attr.to_s) }
+            )
+          end
+        end
+
+        def to_h
+          ATTRIBUTES.each_with_object({}) do |attr, ret|
+            ret[attr] = public_send(attr)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/txgh-server/webhooks/github/push_handler.rb

@@ -1,10 +1,19 @@
-require 'base64'
 require 'set'
 
 module TxghServer
   module Webhooks
     module Github
-      class PushHandler < Handler
+      class PushHandler
+        include ResponseHelpers
+
+        attr_reader :project, :repo, :logger, :attributes
+
+        def initialize(project, repo, logger, attributes)
+          @project = project
+          @repo = repo
+          @logger = logger
+          @attributes = attributes
+        end
 
         def execute
           # Check if the branch in the hook data is the configured branch we want
@@ -14,31 +23,11 @@ module TxghServer
           if should_process?
             logger.info('found branch in github request')
 
-            tx_resources = tx_resources_for(branch)
-
-            modified_resources = added_and_modified_resources_for(tx_resources)
-            modified_resources += l10n_resources_for(tx_resources)
-
-            if repo.github_config_branch.include?('tags/')
-              modified_resources += tag_resources_for(tx_resources)
-            end
-
-            # Handle DBZ 'L10N' special case
-            if branch.include?("L10N")
-              logger.info('processing L10N tag')
-
-              # Create a new branch off tag commit
-              if branch.include?('tags/L10N')
-                repo.api.create_ref(repo.name, 'heads/L10N', payload['head_commit']['id'])
-              end
-            end
-
             updater = Txgh::ResourceUpdater.new(project, repo, logger)
-            categories = { 'author' => payload['head_commit']['committer']['name'] }
-            ref = repo.api.get_ref(repo.name, branch)
+            categories = { 'author' => attributes.author }
 
-            modified_resources.each do |resource|
-              updater.update_resource(resource, ref[:object][:sha], categories)
+            added_and_modified_resources.each do |resource|
+              updater.update_resource(resource, categories)
             end
           end
 
@@ -47,47 +36,20 @@ module TxghServer
 
         private
 
-        def tag_resources_for(tx_resources)
-          payload['head_commit']['modified'].each_with_object(Set.new) do |modified, ret|
-            logger.info("processing modified file: #{modified}")
-
-            if tx_resources.include?(modified)
-              ret << tx_resources[modified]
-            end
-          end
-        end
-
-        def l10n_resources_for(tx_resources)
-          payload['head_commit']['modified'].each_with_object(Set.new) do |modified, ret|
-            if tx_resources.include?(modified)
-              logger.info("setting new resource: #{tx_resources[modified].L10N_resource_slug}")
-              ret << tx_resources[modified]
-            end
-          end
-        end
-
         # finds the resources that were updated in each commit
-        def added_and_modified_resources_for(tx_resources)
-          payload['commits'].each_with_object(Set.new) do |commit, ret|
-            logger.info('processing commit')
+        def added_and_modified_resources
+          attributes.files.each_with_object(Set.new) do |file, ret|
+            logger.info("processing added/modified file: #{file}")
 
-            (commit['modified'] + commit['added']).each do |file|
-              logger.info("processing added/modified file: #{file}")
-
-              if tx_resources.include?(file)
-                ret << tx_resources[file]
-              end
+            if tx_resources.include?(file)
+              ret << tx_resources[file]
             end
           end
         end
 
         # Build an index of known Tx resources, by source file
-        def tx_resources_for(branch)
-          tx_config.resources.each_with_object({}) do |resource, ret|
-            logger.info('processing resource')
-
-            # If we're processing by branch, create a branch resource. Otherwise,
-            # use the original resource.
+        def tx_resources
+          @tx_resources ||= tx_config.resources.each_with_object({}) do |resource, ret|
             ret[resource.source_file] = if repo.process_all_branches?
               Txgh::TxBranchResource.new(resource, branch)  # maybe find instead?
             else
@@ -101,7 +63,7 @@ module TxghServer
         end
 
         def branch
-          @ref ||= payload['ref'].sub(/^refs\//, '')
+          @ref ||= attributes.ref.sub(/^refs\//, '')
         end
 
         def should_process?
@@ -115,7 +77,7 @@ module TxghServer
         def should_process_commit?
           # return false if 'after' commit sha is all zeroes (indicates branch
           # has been deleted)
-          !(payload.fetch('after', '') =~ /\A0+\z/)
+          !((attributes.after || '') =~ /\A0+\z/)
         end
 
       end

data/lib/txgh-server/webhooks/github/request_handler.rb

@@ -4,48 +4,14 @@ module TxghServer
   module Webhooks
     module Github
       class RequestHandler
-        class << self
-
-          include ResponseHelpers
+        include ResponseHelpers
 
+        class << self
           def handle_request(request, logger)
-            case request.env['HTTP_X_GITHUB_EVENT']
-              when 'push'
-                handle_push(request, logger)
-              when 'delete'
-                handle_delete(request, logger)
-              when 'ping'
-                handle_ping(request, logger)
-              else
-                handle_unexpected
-            end
+            new(request, logger).handle_request
           end
-
-          private
-
-          def handle_push(request, logger)
-            klass = TxghServer::Webhooks::Github::PushHandler
-            new(request, logger).handle(klass)
-          end
-
-          def handle_delete(request, logger)
-            klass = TxghServer::Webhooks::Github::DeleteHandler
-            new(request, logger).handle(klass)
-          end
-
-          def handle_ping(request, logger)
-            klass = TxghServer::Webhooks::Github::PingHandler
-            new(request, logger).handle(klass)
-          end
-
-          def handle_unexpected
-            respond_with_error(400, 'Unexpected event type')
-          end
-
         end
 
-        include ResponseHelpers
-
         attr_reader :request, :logger
 
         def initialize(request, logger)
@@ -53,16 +19,18 @@ module TxghServer
           @logger = logger
         end
 
-        def handle(klass)
+        def handle_request
           handle_safely do
-            handler = klass.new(
-              project: config.transifex_project,
-              repo: config.github_repo,
-              payload: payload,
-              logger: logger
-            )
-
-            handler.execute
+            case request.env['HTTP_X_GITHUB_EVENT']
+              when 'push'
+                handle_push
+              when 'delete'
+                handle_delete
+              when 'ping'
+                handle_ping
+              else
+                handle_unexpected
+            end
           end
         end
 
@@ -78,16 +46,38 @@ module TxghServer
           respond_with_error(500, "Internal server error: #{e.message}", e)
         end
 
+        def handle_push
+          attributes = PushAttributes.from_webhook_payload(payload)
+          PushHandler.new(project, repo, logger, attributes).execute
+        end
+
+        def handle_delete
+          attributes = DeleteAttributes.from_webhook_payload(payload)
+          DeleteHandler.new(project, repo, logger, attributes).execute
+        end
+
+        def handle_ping
+          PingHandler.new(logger).execute
+        end
+
+        def handle_unexpected
+          respond_with_error(400, 'Unexpected event type')
+        end
+
         def payload
-          @payload ||= if request.params[:payload]
-            JSON.parse(request.params[:payload])
-          else
-            JSON.parse(request.body.read)
+          @payload ||= begin
+            if request.params[:payload]
+              JSON.parse(request.params[:payload])
+            else
+              JSON.parse(request.body.read)
+            end
+          rescue JSON::ParserError
+            {}
           end
         end
 
         def github_repo_name
-          payload['repository']['full_name']
+          payload.fetch('repository', {})['full_name']
         end
 
         def config
@@ -98,6 +88,10 @@ module TxghServer
           config.github_repo
         end
 
+        def project
+          config.transifex_project
+        end
+
         def authentic_request?
           if repo.webhook_protected?
             GithubRequestAuth.authentic_request?(

data/lib/txgh-server/webhooks/github.rb

@@ -1,11 +1,13 @@
 module TxghServer
   module Webhooks
     module Github
-      autoload :DeleteHandler,  'txgh-server/webhooks/github/delete_handler'
-      autoload :Handler,        'txgh-server/webhooks/github/handler'
-      autoload :PingHandler,    'txgh-server/webhooks/github/ping_handler'
-      autoload :PushHandler,    'txgh-server/webhooks/github/push_handler'
-      autoload :RequestHandler, 'txgh-server/webhooks/github/request_handler'
+      autoload :DeleteAttributes, 'txgh-server/webhooks/github/delete_attributes'
+      autoload :DeleteHandler,    'txgh-server/webhooks/github/delete_handler'
+      autoload :Handler,          'txgh-server/webhooks/github/handler'
+      autoload :PingHandler,      'txgh-server/webhooks/github/ping_handler'
+      autoload :PushHandler,      'txgh-server/webhooks/github/push_handler'
+      autoload :PushAttributes,   'txgh-server/webhooks/github/push_attributes'
+      autoload :RequestHandler,   'txgh-server/webhooks/github/request_handler'
     end
   end
 end

data/lib/txgh-server/webhooks/transifex/hook_handler.rb

@@ -55,7 +55,7 @@ module TxghServer
 
         def tx_config
           @tx_config ||= Txgh::Config::TxManager.tx_config(project, repo, branch)
-        rescue ConfigNotFoundError, TxghError
+        rescue Txgh::ConfigNotFoundError, Txgh::TxghError
           nil
         end
 

data/spec/application_spec.rb

@@ -185,9 +185,9 @@ describe TxghServer::WebhookEndpoints do
 
       before(:each) do
         allow(TxghServer::Webhooks::Github::PushHandler).to(
-          receive(:new) do |options|
-            expect(options[:project].name).to eq(project_name)
-            expect(options[:repo].name).to eq(repo_name)
+          receive(:new) do |project, repo, logger, attributes|
+            expect(project.name).to eq(project_name)
+            expect(repo.name).to eq(repo_name)
             handler
           end
         )
@@ -199,6 +199,7 @@ describe TxghServer::WebhookEndpoints do
         )
 
         payload = GithubPayloadBuilder.push_payload(repo_name, ref)
+        payload.add_commit
 
         sign_with payload.to_json
         header 'X-GitHub-Event', 'push'
@@ -217,8 +218,11 @@ describe TxghServer::WebhookEndpoints do
       end
 
       it 'returns invalid request if event unrecognized' do
+        payload = GithubPayloadBuilder.push_payload(repo_name, ref)
+
+        sign_with payload.to_json
         header 'X-GitHub-Event', 'foobar'
-        post '/github'
+        post '/github', payload.to_json
 
         expect(last_response.status).to eq(400)
       end

data/spec/integration/hooks_spec.rb

@@ -8,7 +8,7 @@ require 'helpers/integration_setup'
 require 'uri'
 require 'yaml'
 
-include Txgh
+include TxghServer
 
 describe 'hook integration tests', integration: true do
   include Rack::Test::Methods
@@ -83,10 +83,6 @@ describe 'hook integration tests', integration: true do
     File.read(payload_path.join('github_postbody_release.json'))
   end
 
-  let(:github_postbody_l10n) do
-    File.read(payload_path.join('github_postbody_l10n.json'))
-  end
-
   let(:project_name) { 'test-project-88' }
   let(:repo_name) { 'txgh-bot/txgh-test-resources' }
 
@@ -146,14 +142,4 @@ describe 'hook integration tests', integration: true do
       expect(last_response).to be_ok
     end
   end
-
-  it 'verifies the github l10n hook endpoint works' do
-    VCR.use_cassette('github_l10n_hook_endpoint') do
-      sign_github_request(github_postbody_l10n)
-      header 'X-GitHub-Event', 'push'
-      header 'content-type', 'application/x-www-form-urlencoded'
-      post '/github', github_postbody_l10n
-      expect(last_response).to be_ok
-    end
-  end
 end

data/spec/webhooks/github/delete_attributes_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'helpers/github_payload_builder'
+
+include TxghServer
+include TxghServer::Webhooks::Github
+
+describe DeleteAttributes do
+  let(:repo_name) { 'my_repo' }
+  let(:ref) { 'heads/my_ref' }
+
+  let(:payload) do
+    GithubPayloadBuilder.delete_payload(repo_name, ref)
+  end
+
+  describe '#from_webhook_payload' do
+    let(:attributes) { DeleteAttributes.from_webhook_payload(payload.to_h) }
+
+    it 'pulls out repo name' do
+      expect(attributes.repo_name).to eq(repo_name)
+    end
+
+    it 'pulls out ref' do
+      expect(attributes.ref).to eq("refs/#{ref}")
+    end
+
+    it 'pulls out ref type' do
+      expect(attributes.ref_type).to eq('branch')
+    end
+  end
+end

data/spec/webhooks/github/delete_handler_spec.rb

@@ -9,12 +9,11 @@ describe DeleteHandler do
   include StandardTxghSetup
 
   let(:handler) do
-    DeleteHandler.new(
-      project: transifex_project,
-      repo: github_repo,
-      payload: payload.to_h,
-      logger: logger
-    )
+    DeleteHandler.new(transifex_project, github_repo, logger, attributes)
+  end
+
+  let(:attributes) do
+    DeleteAttributes.from_webhook_payload(payload.to_h)
   end
 
   let(:payload) do

data/spec/webhooks/github/ping_handler_spec.rb

@@ -1,11 +1,12 @@
 require 'spec_helper'
+require 'helpers/nil_logger'
 
 include TxghServer
 include TxghServer::Webhooks::Github
 
 describe PingHandler do
   let(:handler) do
-    PingHandler.new
+    PingHandler.new(NilLogger.new)
   end
 
   it 'responds with a 200 success' do

data/spec/webhooks/github/push_attributes_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'helpers/github_payload_builder'
+
+include TxghServer
+include TxghServer::Webhooks::Github
+
+describe PushAttributes do
+  let(:repo_name) { 'my_repo' }
+  let(:ref) { 'heads/my_ref' }
+  let(:added) { ['added_file.txt'] }
+  let(:modified) { ['modified_file.txt'] }
+
+  let(:payload) do
+    GithubPayloadBuilder.push_payload(repo_name, ref).tap do |payload|
+      payload.add_commit(added: added, modified: modified)
+    end
+  end
+
+  describe '#from_webhook_payload' do
+    let(:attributes) { PushAttributes.from_webhook_payload(payload.to_h) }
+
+    it 'pulls out repo name' do
+      expect(attributes.repo_name).to eq(repo_name)
+    end
+
+    it 'pulls out ref' do
+      expect(attributes.ref).to eq("refs/#{ref}")
+    end
+
+    it 'pulls out before sha' do
+      expect(attributes.before).to eq(payload.to_h['before'])
+    end
+
+    it 'pulls out after sha' do
+      expect(attributes.after).to eq(payload.to_h['after'])
+    end
+
+    it 'pulls out added files' do
+      expect(attributes.added_files.to_a).to eq(added)
+    end
+
+    it 'pulls out modified files' do
+      expect(attributes.modified_files.to_a).to eq(modified)
+    end
+
+    it 'combines all files into one handy array' do
+      expect(attributes.files.sort).to eq((added + modified).sort)
+    end
+
+    it 'pulls out the author' do
+      expect(attributes.author).to eq('Test User')
+    end
+  end
+end