cangaroo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce036cf738d21b2abbc18a18f4f19fad3b7523d0
-  data.tar.gz: d0ddb0558c19e926e8bbd23281517268a204a873
+  metadata.gz: 56de926de5b5e5d494a4a1f132e854a171191543
+  data.tar.gz: 94b41bce37f5b18794eabb1fa5a9cf623bb0087e
 SHA512:
-  metadata.gz: b94e951ab0f344154d40d9cef544589e9e4db49c2049a706fec02ffeb614554c934f2d5407beb7fc99084fefb73db6093be14a4a5ef3445a3f96601b0cb3dda5
-  data.tar.gz: 2893175b4d6680f957c061f22206ea2c83920bc67b158074388278236816f7c15a84b82a2922efda431f1cb174d418c270f89d93d99718dc375bfd7b4ca21fb7
+  metadata.gz: e927e1bf09605b62d8690aeed1c14599949fc5c3d7b5611626a23d67eb6006b0ba33a091e1dbbc23398f322119b0889b4e8fc170bb41b39977e011caa3e79d07
+  data.tar.gz: 2f24253cc3a8a1f39f07ed74624963e59034c11da0d75d492367ee2642469622d6c8993a3dc1f150eca0df429875b48958444d36ee786f96b0ff7e82c02ec40a

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Nebulab
+Copyright 2016 Nebulab
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,6 +5,14 @@ rescue LoadError
 end
 
 require 'rdoc/task'
+require 'bundler/gem_tasks'
+require 'appraisal'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -14,19 +22,13 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
-load 'rails/tasks/engine.rake'
-
 load 'rails/tasks/statistics.rake'
 
-Bundler::GemHelper.install_tasks
-
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
+desc 'Run Cangaroo specs.'
+RSpec::Core::RakeTask.new(:spec)
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-desc 'Run all specs in spec directory (excluding plugin specs)'
-RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default => :appraisal
+end
 
 task default: :spec

data/app/controllers/cangaroo/endpoint_controller.rb

@@ -18,8 +18,10 @@ module Cangaroo
 
     private
 
-    def handle_error
-      unless Rails.env.development?
+    def handle_error(exception)
+      if Rails.env.development?
+        raise(exception)
+      else
         render json: { error: 'Something went wrong!' }, status: 500
       end
     end
@@ -39,11 +41,29 @@ module Cangaroo
     end
 
     def key
-      request.headers['X-Hub-Store']
+      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
     end
 
     def token
-      request.headers['X-Hub-Access-Token']
+      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)
+        pass
+      else
+        request.headers['X-Hub-Access-Token']
+      end
     end
   end
 end

data/app/interactors/cangaroo/count_json_object.rb

@@ -1,5 +1,6 @@
 module Cangaroo
   class CountJsonObject
+    include Cangaroo::Log
     include Interactor
 
     before :prepare_context
@@ -9,6 +10,8 @@ module Cangaroo
         o[k] = v.size
         o
       end
+
+      log.info 'total consumed payloads', count: context.object_count
     end
 
     private

data/app/interactors/cangaroo/run_polls.rb

@@ -0,0 +1,12 @@
+module Cangaroo
+  class RunPolls
+    include Interactor
+
+    def call
+      context.jobs.each do |poll_job|
+        poll_job.new.enqueue
+      end
+    end
+
+  end
+end

data/app/interactors/cangaroo/validate_json_schema.rb

@@ -3,13 +3,13 @@ module Cangaroo
     include Interactor
 
     SCHEMA = {
+      'id': 'Cangaroo Object',
       'type': 'object',
       'minProperties': 1,
       'additionalProperties': false,
       'patternProperties': {
         '^[a-z]*$': {
           'type': 'array',
-          'minItems': 1,
           'items': {
             'type': 'object',
             'required': ['id'],
@@ -26,8 +26,13 @@ module Cangaroo
     before :prepare_context
 
     def call
-      JSON::Validator.fully_validate(SCHEMA, context.json_body).empty? ||
-        context.fail!(message: 'wrong json schema', error_code: 500)
+      validation_response = JSON::Validator.fully_validate(SCHEMA, context.json_body)
+
+      if validation_response.empty?
+        return true
+      end
+
+      context.fail!(message: validation_response.join(', '), error_code: 500)
     end
 
     private
@@ -35,6 +40,7 @@ module Cangaroo
     def prepare_context
       context.request_id = context.json_body.delete('request_id')
       context.summary = context.json_body.delete('summary')
+      context.parameters = context.json_body.delete('parameters')
     end
   end
 end

data/app/jobs/cangaroo/job.rb

@@ -1,21 +1,12 @@
 module Cangaroo
   class Job < ActiveJob::Base
-    queue_as :cangaroo
-
-    class_attribute :connection_name, :webhook_path, :webhook_parameters
-    class << self
-      def connection(name)
-        self.connection_name = name
-      end
+    include Cangaroo::ClassConfiguration
 
-      def path(path)
-        self.webhook_path = path
-      end
+    queue_as :cangaroo
 
-      def parameters(parameters)
-        self.webhook_parameters = parameters
-      end
-    end
+    class_configuration :connection
+    class_configuration :path, ''
+    class_configuration :parameters, {}
 
     def perform(*)
       restart_flow(connection_request)
@@ -37,6 +28,9 @@ module Cangaroo
     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,
@@ -57,19 +51,7 @@ module Cangaroo
     end
 
     def destination_connection
-      @connection ||= Cangaroo::Connection.find_by!(name: connection_name)
-    end
-
-    def connection_name
-      self.class.connection_name
-    end
-
-    def path
-      self.class.webhook_path || ''
-    end
-
-    def parameters
-      self.class.webhook_parameters || {}
+      @connection ||= Cangaroo::Connection.find_by!(name: connection)
     end
   end
 end

data/app/jobs/cangaroo/poll_job.rb

@@ -0,0 +1,67 @@
+module Cangaroo
+  class PollJob < ActiveJob::Base
+    include Cangaroo::Log
+    include Cangaroo::ClassConfiguration
+
+    queue_as :cangaroo
+
+    class_configuration :connection
+    class_configuration :frequency, 1.day
+    class_configuration :path, ''
+    class_configuration :parameters, {}
+
+    def perform(*)
+      log.set_context(self)
+
+      last_poll = Time.at(arguments.first.fetch(:last_poll)).to_datetime
+      current_time = DateTime.now
+
+      if !perform?(current_time)
+        log.info 'skipping poll'
+        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'
+
+      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!
+    end
+
+    def perform?(execution_time)
+      last_poll_timestamp.nil? ||
+      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 destination_connection
+        @connection ||= Cangaroo::Connection.find_by!(name: connection)
+      end
+
+  end
+end

data/app/models/cangaroo/connection.rb

@@ -2,11 +2,19 @@ module Cangaroo
   class Connection < ActiveRecord::Base
     serialize :parameters
 
-    validates :name, :url, :key, :token, presence: true
-    validates :name, :url, :key, :token, uniqueness: true
+    validates :name, :url, :token, presence: true, uniqueness: true
+    validates :key, presence: true, uniqueness: true, if: -> { !Rails.configuration.cangaroo.basic_auth }
+
+    after_initialize :set_default_parameters
 
     def self.authenticate(key, token)
       where(key: key, token: token).first
     end
+
+    private
+
+      def set_default_parameters
+        self.parameters ||= {}
+      end
   end
 end

data/app/models/cangaroo/poll_timestamp.rb

@@ -0,0 +1,17 @@
+module Cangaroo
+  class PollTimestamp < ActiveRecord::Base
+    serialize :value
+
+    belongs_to :connection
+
+    validates_uniqueness_of :job, scope: :connection
+
+    def self.for_class(klass)
+      self.where(
+        job: klass.to_s,
+        connection: Cangaroo::Connection.find_by!(name: klass.connection)
+      ).first_or_initialize
+    end
+
+  end
+end

data/db/migrate/20151030140821_add_parameters_to_cangaroo_connection.rb

@@ -1,5 +1,5 @@
 class AddParametersToCangarooConnection < ActiveRecord::Migration
   def change
-    add_column :cangaroo_connections, :parameters, :text, default: {}
+    add_column :cangaroo_connections, :parameters, :text
   end
 end

data/db/migrate/20160317020230_create_cangaroo_poll_timestamps.rb

@@ -0,0 +1,12 @@
+class CreateCangarooPollTimestamps < ActiveRecord::Migration
+  def change
+    create_table :cangaroo_poll_timestamps do |t|
+      t.string     :job
+      t.references :connection
+      t.text       :value
+      t.timestamps
+    end
+
+    add_index :cangaroo_poll_timestamps, [:job], :name => 'index_cangaroo_poll_timestamps_on_job'
+  end
+end

data/lib/cangaroo.rb

@@ -3,8 +3,10 @@ require 'interactor'
 require 'json-schema'
 require 'httparty'
 
+require 'cangaroo/logger'
 require 'cangaroo/webhook/error'
 require 'cangaroo/webhook/client'
+require 'cangaroo/class_configuration'
 
 module Cangaroo
 end

data/lib/cangaroo/class_configuration.rb

@@ -0,0 +1,24 @@
+module Cangaroo
+  module ClassConfiguration
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def class_configuration(key, default = nil)
+        class_attribute :"_#{key}"
+
+        define_singleton_method(key) do |*args|
+          if args.empty?
+            return self.send(:"_#{key}") || default
+          end
+
+          self.send(:"_#{key}=", args.first)
+        end
+
+        define_method(key) do
+          self.send(:"_#{key}") || default
+        end
+      end
+    end
+
+  end
+end

data/lib/cangaroo/engine.rb

@@ -12,6 +12,8 @@ module Cangaroo
     config.before_configuration do
       Rails.configuration.cangaroo = ActiveSupport::OrderedOptions.new
       Rails.configuration.cangaroo.jobs = []
+      Rails.configuration.cangaroo.poll_jobs = []
+      Rails.configuration.cangaroo.basic_auth = false
     end
   end
 end

data/lib/cangaroo/logger.rb

@@ -0,0 +1,66 @@
+require 'logger'
+
+module Cangaroo
+  module Log
+
+    def log
+      Cangaroo::Log::Writer.instance
+    end
+
+    class Writer
+      include Singleton
+
+      attr_reader :default_tags
+
+      def initialize
+        @l = Logger.new(STDOUT)
+        @default_tags = {}
+      end
+
+      def reset_context!
+        @default_tags = {}
+      end
+
+      def set_context(job)
+        reset_context!
+
+        @default_tags.merge!({
+          job: job.class.to_s,
+          job_id: job.job_id,
+          connection: job.class.connection
+        })
+      end
+
+      def error(msg, opts={})
+        @l.error("#{msg}: #{stringify_tags(opts)}")
+      end
+
+      def info(msg, opts={})
+        @l.info("#{msg}: #{stringify_tags(opts)}")
+      end
+
+      def debug(msg, opts={})
+        @l.debug("#{msg}: #{stringify_tags(opts)}")
+      end
+
+      def warn(msg, opts={})
+        @l.warn("#{msg}: #{stringify_tags(opts)}")
+      end
+
+      private
+
+        def stringify_tags(additional_tags)
+          additional_tags = additional_tags.dup
+
+          if translation = additional_tags.delete(:translation)
+            additional_tags[:translation_id] = translation.id
+            # TODO extract other important info from the translation
+          end
+
+          @default_tags.merge(additional_tags).map { |k,v| "#{k}=#{v}" }.join(' ')
+        end
+
+    end
+
+  end
+end