cangaroo 1.2.0 → 1.3.0

data/lib/cangaroo.rb

@@ -4,9 +4,18 @@ require 'json-schema'
 require 'httparty'
 
 require 'cangaroo/logger'
+require 'cangaroo/logger_helper'
 require 'cangaroo/webhook/error'
 require 'cangaroo/webhook/client'
 require 'cangaroo/class_configuration'
+require 'cangaroo/migration'
 
 module Cangaroo
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Cangaroo::Logger.instance
+    end
+  end
 end

data/lib/cangaroo/class_configuration.rb

@@ -2,23 +2,26 @@ module Cangaroo
   module ClassConfiguration
     extend ActiveSupport::Concern
 
+    # NOTE you must use the `_key` class attribute to nil out a class_cofiguration
+
     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
+            value = send(:"_#{key}")
+
+            return value.nil? ? default : value
           end
 
-          self.send(:"_#{key}=", args.first)
+          send(:"_#{key}=", args.first)
         end
 
         define_method(key) do
-          self.send(:"_#{key}") || default
+          self.class.send(key)
         end
       end
     end
-
   end
 end

data/lib/cangaroo/engine.rb

@@ -14,6 +14,8 @@ module Cangaroo
       Rails.configuration.cangaroo.jobs = []
       Rails.configuration.cangaroo.poll_jobs = []
       Rails.configuration.cangaroo.basic_auth = false
+      Rails.configuration.cangaroo.logger = nil
+      Rails.configuration.cangaroo.client_timeout = nil
     end
   end
 end

data/lib/cangaroo/logger.rb

@@ -1,66 +1,21 @@
-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
+  class Logger
+    include Singleton
 
-      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
+    attr_reader :logger
 
-      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
+    def initialize
+      @logger = Rails.configuration.cangaroo.logger || Rails.logger
+    end
 
-          @default_tags.merge(additional_tags).map { |k,v| "#{k}=#{v}" }.join(' ')
+    %i(log unknown debug info warn error).each do |log_method|
+      define_method log_method do |*params|
+        begin
+          @logger.send(log_method, *params)
+        rescue ArgumentError
+          @logger.send(log_method, params)
         end
-
+      end
     end
-
   end
 end

data/lib/cangaroo/logger_helper.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module Cangaroo
+  module LoggerHelper
+    extend ActiveSupport::Concern
+
+    def job_tags(tags = {})
+      tags.merge!(job: self.class.to_s,
+                  job_id: job_id,
+                  connection: self.class.connection.to_s)
+    end
+  end
+end

data/lib/cangaroo/migration.rb

@@ -0,0 +1,11 @@
+module Cangaroo
+  module Migration
+    def self.[](version)
+      if Rails.gem_version >= Gem::Version.new('5.0')
+        ActiveRecord::Migration[version]
+      else
+        ActiveRecord::Migration
+      end
+    end
+  end
+end

data/lib/cangaroo/version.rb

@@ -1,3 +1,3 @@
 module Cangaroo
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'.freeze
 end

data/lib/cangaroo/webhook/client.rb

@@ -21,23 +21,22 @@ module Cangaroo
         }
 
         if Rails.configuration.cangaroo.basic_auth
-          request_options.merge!(
-            basic_auth: {
-              username: connection.key,
-              password: connection.token
-            }
-          )
+          request_options[:basic_auth] = {
+            username: connection.key,
+            password: connection.token
+          }
+        end
+
+        if timeout = Rails.configuration.cangaroo.client_timeout
+          request_options[:timeout] = timeout
         end
 
         req = self.class.post(url, request_options)
 
-        if req.response.code == '200'
-          req.parsed_response
-        elsif req.response.code == '204'
-          ''
-        else
-          fail Cangaroo::Webhook::Error, (req.parsed_response['summary'] rescue req.response)
-        end
+        sanitized_response = sanitize_response(req)
+
+        fail Cangaroo::Webhook::Error, sanitized_response unless %w(200 201 202 204).include?(req.response.code)
+        sanitized_response
       end
 
       private
@@ -58,8 +57,21 @@ module Cangaroo
 
       def body(payload, request_id, parameters)
         { request_id: request_id,
-          parameters: connection.parameters.deep_merge(parameters)
-        }.merge(payload)
+          parameters: connection.parameters.deep_merge(parameters) }.merge(payload)
+      end
+
+      def sanitize_response(request)
+        if %w(200 201 202).include?(request.response.code)
+          request.parsed_response
+        elsif request.response.code == '204'
+          ''
+        else
+          begin
+            (request.parsed_response['summary'] || request.response.body)
+          rescue
+            request.response.body
+          end
+        end
       end
     end
   end

data/spec/factories/cangaroo_connections.rb

@@ -1,9 +1,33 @@
+require 'securerandom'
+
 FactoryGirl.define do
   factory :cangaroo_connection, class: 'Cangaroo::Connection' do
     name :store
     url 'www.store.com'
     parameters { { first: 'first', second: 'second' } }
-    key '1e4e888ac66f8dd41e00c5a7ac36a32a9950d271'
-    token '8d49cddb4291562808bfca1bee8a9f7cf947a987'
+    key { SecureRandom.hex }
+    token { SecureRandom.hex }
+
+    factory :store do
+      parameters nil
+    end
+
+    factory :erp do
+      parameters nil
+      name :erp
+      url 'www.erp.com'
+    end
+
+    factory :mail do
+      parameters nil
+      name :mail
+      url 'www.mail.com'
+    end
+
+    factory :warehouse do
+      parameters nil
+      name :warehouse
+      url 'www.warehouse.com'
+    end
   end
 end

data/spec/features/push_flow_spec.rb

@@ -0,0 +1,79 @@
+require 'rails_helper'
+require 'securerandom'
+
+RSpec.describe 'Push flow' do
+  let(:store_payload) { load_fixture('json_payload_ok.json') }
+  let(:payed_order) { JSON.parse(store_payload)['orders'].last }
+  let(:store) { Cangaroo::Connection.find_by(name: 'store') }
+  let(:headers) {
+    { 'Content-Type' => 'application/json',
+      'X-Hub-Store' => store.key,
+      'X-Hub-Access-Token' => store.token }
+  }
+
+  let!(:erp_api) {
+    stub_api(job: Cangaroo::ErpJob,
+             request_body: { order: { id: payed_order['id'], state: payed_order['state'] } },
+             response_body: {
+               'summary' => "Successfully updated order for #{payed_order['id']}",
+               'orders' => [{ id: payed_order['id'], state: 'confirmed' }]
+             })
+  }
+
+  let!(:update_order_store_api) {
+    stub_api(job: Cangaroo::StoreJob, request_body: { order: { id: payed_order['id'], state: anything } })
+  }
+
+  let!(:confirm_mail_api) {
+    stub_api(job: Cangaroo::ConfirmOrderMailJob, request_body: { order: { id: payed_order['id'], state: 'confirmed' } })
+  }
+
+  let!(:warehouse_api) {
+    stub_api(job: Cangaroo::WarehouseJob,
+             request_body: { order: { id: payed_order['id'], state: 'confirmed' } },
+             response_body: {
+               'summary' => "Successfully shipped order #{payed_order['id']}",
+               'orders' => [{ id: payed_order['id'], state: 'shipped' }]
+             })
+  }
+
+  let!(:shipped_mail_api) {
+    stub_api(job: Cangaroo::ShippedOrderMailJob, request_body: { order: { id: payed_order['id'], state: 'shipped' } })
+  }
+
+  before do
+    Rails.configuration.cangaroo.jobs = [Cangaroo::ErpJob,
+                                         Cangaroo::StoreJob,
+                                         Cangaroo::ConfirmOrderMailJob,
+                                         Cangaroo::WarehouseJob,
+                                         Cangaroo::ShippedOrderMailJob]
+
+    post endpoint_index_path, params: store_payload, headers: headers
+  end
+
+  describe 'when new order in state cart coming from store' do
+    it 'calls the erp api that responds with order in confirmed state' do
+      expect(erp_api).to have_been_requested
+    end
+
+    context 'then' do
+      it 'calls mail api to send confirmation email to user' do
+        expect(confirm_mail_api).to have_been_requested
+      end
+
+      it 'calls warehouse to send the package and responds with order in shipped state' do
+        expect(warehouse_api).to have_been_requested
+      end
+
+      context 'then' do
+        it 'calls mail api to send shipped email to user' do
+          expect(shipped_mail_api).to have_been_requested
+        end
+      end
+    end
+
+    it 'calls the store api to update the order state twice' do
+      expect(update_order_store_api).to have_been_requested.twice
+    end
+  end
+end

data/spec/fixtures/json_payload_ok.json

@@ -18,5 +18,7 @@
          "id":"S53565543",
          "state":"waiting"
       }
-   ]
+   ],
+   "line_items": [],
+   "line-items": []
 }

data/spec/interactors/cangaroo/count_json_object_spec.rb

@@ -3,11 +3,13 @@ require 'rails_helper'
 describe Cangaroo::CountJsonObject do
   subject(:context) { Cangaroo::CountJsonObject.call(json_body: json_body) }
 
-  let(:json_body) { load_fixture('json_payload_ok.json') }
+  let(:json_body) { JSON.parse(load_fixture('json_payload_ok.json')) }
 
   describe '.call' do
     it 'provides the object_count' do
-      expect(context.object_count).to eq('orders' => 2, 'shipments' => 2)
+      expect(context.object_count)
+        .to eq('orders' => 2, 'shipments' => 2,
+               'line_items' => 0, 'line-items' => 0)
     end
 
     it 'succeeds' do

data/spec/interactors/cangaroo/perform_jobs_spec.rb

@@ -22,7 +22,7 @@ describe Cangaroo::PerformJobs do
     let(:job_b) { double('job_b', perform?: false, enqueue: nil) }
 
     context 'payload with objects' do
-      let(:json_body) { load_fixture('json_payload_ok.json') }
+      let(:json_body) { JSON.parse(load_fixture('json_payload_ok.json')) }
 
       it 'instantiates jobs' do
         context
@@ -42,7 +42,7 @@ describe Cangaroo::PerformJobs do
     end
 
     context 'payload with no objects' do
-      let(:json_body) { load_fixture('json_payload_empty.json') }
+      let(:json_body) { JSON.parse(load_fixture('json_payload_empty.json')) }
 
       it 'succeeds' do
         context
@@ -52,6 +52,5 @@ describe Cangaroo::PerformJobs do
         expect(job_b).to_not have_received(:enqueue)
       end
     end
-
   end
 end

data/spec/jobs/cangaroo/poll_job_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Cangaroo::PollJob, type: :job do
   end
 
   let(:job_class) { FakePollJob }
-  let(:job) { job_class.new({ last_poll: Time.now.to_i }) }
+  let(:job) { job_class.new(last_poll: Time.now.to_i) }
   let(:successful_pull_payload) { parse_fixture('json_payload_ok.json') }
 
   before do
@@ -46,9 +46,7 @@ RSpec.describe Cangaroo::PollJob, type: :job do
   end
 
   describe '#perform' do
-
     context 'pull is successful' do
-
       before do
         allow(Cangaroo::HandleRequest).to receive(:call).
           and_return(double(success?: true))
@@ -58,7 +56,9 @@ RSpec.describe Cangaroo::PollJob, type: :job do
       end
 
       it 'updates the poll timestamp' do
-        Cangaroo::Webhook::Client.any_instance.stub(:post).and_return(successful_pull_payload)
+        allow_any_instance_of(Cangaroo::Webhook::Client)
+          .to receive(:post)
+          .and_return(successful_pull_payload)
 
         job.perform
 
@@ -69,30 +69,30 @@ RSpec.describe Cangaroo::PollJob, type: :job do
       end
 
       it 'handles a empty response' do
-        Cangaroo::Webhook::Client.any_instance.stub(:post).and_return('')
+        allow_any_instance_of(Cangaroo::Webhook::Client)
+          .to receive(:post)
+          .and_return('')
 
         job.perform
       end
 
       it 'handles a response with a empty array' do
-        Cangaroo::Webhook::Client.any_instance.stub(:post).and_return(
-          parse_fixture('json_payload_empty.json')
-        )
+        allow_any_instance_of(Cangaroo::Webhook::Client)
+          .to receive(:post)
+          .and_return(parse_fixture('json_payload_empty.json'))
 
         job.perform
       end
-
     end
 
     context 'pull fails' do
-
       before do
-        Cangaroo::Webhook::Client.any_instance.stub(:post).and_return(parse_fixture('json_payload_ok.json'))
+        allow_any_instance_of(Cangaroo::Webhook::Client)
+          .to receive(:post)
+          .and_return(parse_fixture('json_payload_ok.json'))
 
-        allow(Cangaroo::HandleRequest).to receive(:call).and_return(double(
-          success?: false,
-          message: 'bad failure'
-        ))
+        allow(Cangaroo::PerformFlow).to receive(:call).and_return(double(success?: false,
+                                                                         message: 'bad failure'))
       end
 
       it 'does not update timestamp if pull fails' do
@@ -100,8 +100,6 @@ RSpec.describe Cangaroo::PollJob, type: :job do
 
         expect(Cangaroo::PollTimestamp.for_class(FakePollJob).id).to be_nil
       end
-
     end
   end
-
 end