cangaroo 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56de926de5b5e5d494a4a1f132e854a171191543
-  data.tar.gz: 94b41bce37f5b18794eabb1fa5a9cf623bb0087e
+  metadata.gz: 3896bc0334e02871b872a34472b292f0d4400970
+  data.tar.gz: d489f9fbfda6a5597107eecc7c0df1eb8ba32d64
 SHA512:
-  metadata.gz: e927e1bf09605b62d8690aeed1c14599949fc5c3d7b5611626a23d67eb6006b0ba33a091e1dbbc23398f322119b0889b4e8fc170bb41b39977e011caa3e79d07
-  data.tar.gz: 2f24253cc3a8a1f39f07ed74624963e59034c11da0d75d492367ee2642469622d6c8993a3dc1f150eca0df429875b48958444d36ee786f96b0ff7e82c02ec40a
+  metadata.gz: daab3c0a4a1a32e494f83bb2196e1037e9f223de107d810f546d224a8d2cff9b4d073c35282c82207f2d3e3b05ef4040ae094e082eaa74665ac0bbc077e2c829
+  data.tar.gz: a955392403bc2413366d76a7dd237cdfd009b75745dbbbe188a26de028ed8422b3f66cfbdf634aafa33badea145b4f1c4f392e7903d0a9041dabea123d3a5eaa

data/Rakefile

@@ -28,7 +28,7 @@ desc 'Run Cangaroo specs.'
 RSpec::Core::RakeTask.new(:spec)
 
 if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
-  task :default => :appraisal
+  task default: :appraisal
 end
 
 task default: :spec

data/app/controllers/cangaroo/endpoint_controller.rb

@@ -1,7 +1,5 @@
-require_dependency 'cangaroo/application_controller'
-
 module Cangaroo
-  class EndpointController < ApplicationController
+  class EndpointController < ActionController::Base
     before_action :ensure_json_request
     before_action :handle_request
 
@@ -19,51 +17,47 @@ module Cangaroo
     private
 
     def handle_error(exception)
-      if Rails.env.development?
-        raise(exception)
-      else
-        render json: { error: 'Something went wrong!' }, status: 500
-      end
+      raise(exception) if Rails.env.development?
+      render json: { error: 'Something went wrong!' }, status: 500
     end
 
     def handle_request
       @command = HandleRequest.call(
         key: key,
         token: token,
-        json_body: params[:endpoint].to_json,
+        json_body: JSON.parse(request.raw_post),
         jobs: Rails.configuration.cangaroo.jobs
       )
     end
 
     def ensure_json_request
       return if request.headers['Content-Type'] == 'application/json'
+
       render nothing: true, status: 406
     end
 
     def key
-      if Rails.configuration.cangaroo.basic_auth
-        if !ActionController::HttpAuthentication::Basic.has_basic_credentials?(request)
-          return nil
-        end
-
-        user, pass = ActionController::HttpAuthentication::Basic::user_name_and_password(request)
-        user
-      else
-        request.headers['X-Hub-Store']
-      end
+      return user if Rails.configuration.cangaroo.basic_auth
+      request.headers['X-Hub-Store']
     end
 
     def token
-      if Rails.configuration.cangaroo.basic_auth
-        if !ActionController::HttpAuthentication::Basic.has_basic_credentials?(request)
-          return nil
-        end
+      return password if Rails.configuration.cangaroo.basic_auth
+      request.headers['X-Hub-Access-Token']
+    end
 
-        user, pass = ActionController::HttpAuthentication::Basic::user_name_and_password(request)
-        pass
-      else
-        request.headers['X-Hub-Access-Token']
-      end
+    def user
+      user_and_password.try(:first)
+    end
+
+    def password
+      user_and_password.try(:last)
+    end
+
+    def user_and_password
+      return nil unless ActionController::HttpAuthentication::Basic.has_basic_credentials?(request)
+
+      ActionController::HttpAuthentication::Basic.user_name_and_password(request)
     end
   end
 end

data/app/interactors/cangaroo/count_json_object.rb

@@ -1,23 +1,13 @@
 module Cangaroo
   class CountJsonObject
-    include Cangaroo::Log
     include Interactor
 
-    before :prepare_context
-
     def call
-      context.object_count = context.data.inject({}) do |o, (k, v)|
+      context.object_count = context.json_body.each_with_object({}) do |(k, v), o|
         o[k] = v.size
-        o
       end
 
-      log.info 'total consumed payloads', count: context.object_count
-    end
-
-    private
-
-    def prepare_context
-      context.data = JSON.parse(context.json_body)
+      Cangaroo.logger.info 'total consumed payloads', count: context.object_count
     end
   end
 end

data/app/interactors/cangaroo/perform_jobs.rb

@@ -3,17 +3,13 @@ module Cangaroo
     include Interactor
 
     def call
-      data.each do |type, payloads|
+      context.json_body.each do |type, payloads|
         payloads.each { |payload| enqueue_jobs(type, payload) }
       end
     end
 
     private
 
-    def data
-      @data ||= JSON.parse(context.json_body)
-    end
-
     def enqueue_jobs(type, payload)
       initialize_jobs(type, payload).select(&:perform?).each(&:enqueue)
     end
@@ -21,7 +17,7 @@ module Cangaroo
     def initialize_jobs(type, payload)
       context.jobs.map do |klass|
         klass.new(
-          connection: context.source_connection,
+          source_connection: context.source_connection,
           type: type,
           payload: payload
         )

data/app/interactors/cangaroo/run_polls.rb

@@ -7,6 +7,5 @@ module Cangaroo
         poll_job.new.enqueue
       end
     end
-
   end
 end

data/app/interactors/cangaroo/validate_json_schema.rb

@@ -8,16 +8,11 @@ module Cangaroo
       'minProperties': 1,
       'additionalProperties': false,
       'patternProperties': {
-        '^[a-z]*$': {
+        '^[a-z\-_]*$': {
           'type': 'array',
           'items': {
             'type': 'object',
-            'required': ['id'],
-            'properties': {
-              'id': {
-                'type': 'string'
-              }
-            }
+            'required': ['id']
           }
         }
       }
@@ -26,7 +21,7 @@ module Cangaroo
     before :prepare_context
 
     def call
-      validation_response = JSON::Validator.fully_validate(SCHEMA, context.json_body)
+      validation_response = JSON::Validator.fully_validate(SCHEMA, context.json_body.to_json)
 
       if validation_response.empty?
         return true

data/app/jobs/cangaroo/base_job.rb

@@ -0,0 +1,35 @@
+module Cangaroo
+  class BaseJob < Job
+    include Cangaroo::ClassConfiguration
+
+    class_configuration :connection
+    class_configuration :path, ''
+    class_configuration :parameters, {}
+    class_configuration :process_response, true
+
+    protected
+
+    def connection_request
+      Cangaroo::Webhook::Client.new(destination_connection, path).post(transform, job_id, parameters)
+    end
+
+    def restart_flow(response)
+      # if no json was returned, the response should be discarded
+      return if response.blank?
+
+      return unless process_response
+
+      command = Cangaroo::PerformFlow.call(
+        source_connection: destination_connection,
+        json_body: response,
+        jobs: Rails.configuration.cangaroo.jobs.reject{ |job| job == self.class }
+      )
+
+      fail Cangaroo::Webhook::Error, command.message unless command.success?
+    end
+
+    def destination_connection
+      @destination_connection ||= Cangaroo::Connection.find_by!(name: connection)
+    end
+  end
+end

data/app/jobs/cangaroo/job.rb

@@ -1,45 +1,15 @@
 module Cangaroo
   class Job < ActiveJob::Base
-    include Cangaroo::ClassConfiguration
+    include Cangaroo::LoggerHelper
 
     queue_as :cangaroo
 
-    class_configuration :connection
-    class_configuration :path, ''
-    class_configuration :parameters, {}
-
-    def perform(*)
-      restart_flow(connection_request)
-    end
-
     def perform?
       fail NotImplementedError
     end
 
-    def transform
-      { type.singularize => payload }
-    end
-
-    protected
-
-    def connection_request
-      Cangaroo::Webhook::Client.new(destination_connection, path)
-        .post(transform, @job_id, parameters)
-    end
-
-    def restart_flow(response)
-      # if no json was returned, the response should be discarded
-      return if response.blank?
-
-      PerformFlow.call(
-        source_connection: destination_connection,
-        json_body: response.to_json,
-        jobs: Rails.configuration.cangaroo.jobs
-      )
-    end
-
     def source_connection
-      arguments.first.fetch(:connection)
+      arguments.first.fetch(:source_connection)
     end
 
     def type
@@ -49,9 +19,5 @@ module Cangaroo
     def payload
       arguments.first.fetch(:payload)
     end
-
-    def destination_connection
-      @connection ||= Cangaroo::Connection.find_by!(name: connection)
-    end
   end
 end

data/app/jobs/cangaroo/poll_job.rb

@@ -1,67 +1,43 @@
 module Cangaroo
-  class PollJob < ActiveJob::Base
-    include Cangaroo::Log
-    include Cangaroo::ClassConfiguration
+  class PollJob < BaseJob
+    class_configuration :frequency, 1.day
 
-    queue_as :cangaroo
+    attr_reader :current_time
 
-    class_configuration :connection
-    class_configuration :frequency, 1.day
-    class_configuration :path, ''
-    class_configuration :parameters, {}
+    def transform
+      { last_poll: last_poll_timestamp.to_i }
+    end
 
     def perform(*)
-      log.set_context(self)
-
-      last_poll = Time.at(arguments.first.fetch(:last_poll)).to_datetime
-      current_time = DateTime.now
+      @current_time = DateTime.now
 
       if !perform?(current_time)
-        log.info 'skipping poll'
+        Cangaroo.logger.info 'skipping poll', job_tags
         return
       end
 
-      log.info 'initiating poll', last_poll: last_poll.to_i
-
-      response = Cangaroo::Webhook::Client.new(destination_connection, path)
-        .post({ last_poll: last_poll_timestamp.to_i }, @job_id, parameters)
-
-      log.info 'processing poll results'
+      restart_flow(connection_request)
 
-      command = HandleRequest.call(
-        key: destination_connection.key,
-        token: destination_connection.token,
-        json_body: response.to_json,
-        jobs: Rails.configuration.cangaroo.jobs
-      )
-
-      if !command.success?
-        fail Cangaroo::Webhook::Error, command.message
-      end
-
-      log.info 'updating last poll', last_poll: current_time
-
-      last_job_poll = Cangaroo::PollTimestamp.for_class(self.class)
-      last_job_poll.value = current_time
-      last_job_poll.save!
-
-      log.reset_context!
+      update_last_poll_timestamp
     end
 
     def perform?(execution_time)
       last_poll_timestamp.nil? ||
-      execution_time.to_i - last_poll_timestamp.to_i > self.class.frequency
+        execution_time.to_i - last_poll_timestamp.to_i > self.class.frequency
     end
 
     protected
 
-      def last_poll_timestamp
-        @last_poll_timestamp ||= Cangaroo::PollTimestamp.for_class(self.class).value
-      end
+    def update_last_poll_timestamp
+      Cangaroo.logger.info 'updating last poll', job_tags(last_poll: current_time)
 
-      def destination_connection
-        @connection ||= Cangaroo::Connection.find_by!(name: connection)
-      end
+      last_job_poll = Cangaroo::PollTimestamp.for_class(self.class)
+      last_job_poll.value = current_time
+      last_job_poll.save!
+    end
 
+    def last_poll_timestamp
+      @last_poll_timestamp ||= Cangaroo::PollTimestamp.for_class(self.class).value
+    end
   end
 end

data/app/jobs/cangaroo/push_job.rb

@@ -0,0 +1,15 @@
+module Cangaroo
+  class PushJob < BaseJob
+    def perform(*)
+      restart_flow(connection_request)
+    end
+
+    def perform?
+      fail NotImplementedError
+    end
+
+    def transform
+      { type.singularize => payload }
+    end
+  end
+end

data/app/models/cangaroo/connection.rb

@@ -13,8 +13,8 @@ module Cangaroo
 
     private
 
-      def set_default_parameters
-        self.parameters ||= {}
-      end
+    def set_default_parameters
+      self.parameters ||= {}
+    end
   end
 end

data/app/models/cangaroo/poll_timestamp.rb

@@ -7,11 +7,10 @@ module Cangaroo
     validates_uniqueness_of :job, scope: :connection
 
     def self.for_class(klass)
-      self.where(
+      where(
         job: klass.to_s,
         connection: Cangaroo::Connection.find_by!(name: klass.connection)
       ).first_or_initialize
     end
-
   end
 end

data/db/migrate/20151028172151_create_cangaroo_connections.rb

@@ -1,4 +1,4 @@
-class CreateCangarooConnections < ActiveRecord::Migration
+class CreateCangarooConnections < Cangaroo::Migration[4.2]
   def change
     create_table :cangaroo_connections do |t|
       t.string :name

data/db/migrate/20151030140821_add_parameters_to_cangaroo_connection.rb

@@ -1,4 +1,4 @@
-class AddParametersToCangarooConnection < ActiveRecord::Migration
+class AddParametersToCangarooConnection < Cangaroo::Migration[4.2]
   def change
     add_column :cangaroo_connections, :parameters, :text
   end

data/db/migrate/20160317020230_create_cangaroo_poll_timestamps.rb

@@ -1,4 +1,4 @@
-class CreateCangarooPollTimestamps < ActiveRecord::Migration
+class CreateCangarooPollTimestamps < Cangaroo::Migration[4.2]
   def change
     create_table :cangaroo_poll_timestamps do |t|
       t.string     :job
@@ -7,6 +7,6 @@ class CreateCangarooPollTimestamps < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :cangaroo_poll_timestamps, [:job], :name => 'index_cangaroo_poll_timestamps_on_job'
+    add_index :cangaroo_poll_timestamps, [:job], name: 'index_cangaroo_poll_timestamps_on_job'
   end
 end