cangaroo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d7be05c09c24fab1c3762ff2987c408f29171af
+  data.tar.gz: 627378f34edd49f3dd92283f736b2b07635057cd
+SHA512:
+  metadata.gz: 12591483c6345eb3b72f1d61ebd8f309a7241d10f50699a441536b762276168987171a43735e6e12e7181c230b28770f4848b88f72e308b5e8c293c8f0cbe43e
+  data.tar.gz: c46a47b09ca10ca5d4cb562c314c7a93e300ff86f5a6d95061074165b3cbcb64ac459d3eaeb89d525fc030a3e3708b2fb752d168aa494631166ac9eb57d51e1b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Nebulab
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cangaroo'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.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 }
+
+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')
+
+task default: :spec

data/app/controllers/cangaroo/application_controller.rb

@@ -0,0 +1,4 @@
+module Cangaroo
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/cangaroo/endpoint_controller.rb

@@ -0,0 +1,49 @@
+require_dependency 'cangaroo/application_controller'
+
+module Cangaroo
+  class EndpointController < ApplicationController
+    before_action :ensure_json_request
+    before_action :handle_request
+
+    rescue_from Exception, with: :handle_error
+
+    def create
+      if @command.success?
+        render json: @command.object_count, status: 202
+      else
+        render json: { error: @command.message },
+               status: @command.error_code
+      end
+    end
+
+    private
+
+    def handle_error
+      unless Rails.env.development?
+        render json: { error: 'Something went wrong!' }, status: 500
+      end
+    end
+
+    def handle_request
+      @command = HandleRequest.call(
+        key: key,
+        token: token,
+        json_body: params[:endpoint].to_json,
+        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
+      request.headers['X-Hub-Store']
+    end
+
+    def token
+      request.headers['X-Hub-Access-Token']
+    end
+  end
+end

data/app/interactors/cangaroo/authenticate_connection.rb

@@ -0,0 +1,19 @@
+module Cangaroo
+  class AuthenticateConnection
+    include Interactor
+
+    before :prepare_context
+
+    def call
+      context.source_connection ||
+        context.fail!(message: 'wrong credentials', error_code: 401)
+    end
+
+    private
+
+    def prepare_context
+      context.source_connection =
+        Cangaroo::Connection.authenticate(context.key, context.token)
+    end
+  end
+end

data/app/interactors/cangaroo/count_json_object.rb

@@ -0,0 +1,20 @@
+module Cangaroo
+  class CountJsonObject
+    include Interactor
+
+    before :prepare_context
+
+    def call
+      context.object_count = context.data.inject({}) do |o, (k, v)|
+        o[k] = v.size
+        o
+      end
+    end
+
+    private
+
+    def prepare_context
+      context.data = JSON.parse(context.json_body)
+    end
+  end
+end

data/app/interactors/cangaroo/handle_request.rb

@@ -0,0 +1,10 @@
+module Cangaroo
+  class HandleRequest
+    include Interactor::Organizer
+
+    organize Cangaroo::AuthenticateConnection,
+             Cangaroo::ValidateJsonSchema,
+             Cangaroo::CountJsonObject,
+             Cangaroo::PerformJobs
+  end
+end

data/app/interactors/cangaroo/perform_jobs.rb

@@ -0,0 +1,31 @@
+module Cangaroo
+  class PerformJobs
+    include Interactor
+
+    def call
+      data.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
+
+    def initialize_jobs(type, payload)
+      context.jobs.map do |klass|
+        klass.new(
+          connection: context.source_connection,
+          type: type,
+          payload: payload
+        )
+      end
+    end
+  end
+end

data/app/interactors/cangaroo/validate_json_schema.rb

@@ -0,0 +1,31 @@
+module Cangaroo
+  class ValidateJsonSchema
+    include Interactor
+
+    SCHEMA = {
+      'type': 'object',
+      'minProperties': 1,
+      'additionalProperties': false,
+      'patternProperties': {
+        '^[a-z]*$': {
+          'type': 'array',
+          'minItems': 1,
+          'items': {
+            'type': 'object',
+            'required': ['id'],
+            'properties': {
+              'id': {
+                'type': 'string'
+              }
+            }
+          }
+        }
+      }
+    }.freeze
+
+    def call
+      JSON::Validator.fully_validate(SCHEMA, context.json_body).empty? ||
+        context.fail!(message: 'wrong json schema', error_code: 500)
+    end
+  end
+end

data/app/jobs/cangaroo/job.rb

@@ -0,0 +1,63 @@
+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
+
+      def path(path)
+        self.webhook_path = path
+      end
+
+      def parameters(parameters)
+        self.webhook_parameters = parameters
+      end
+    end
+
+    def perform(*)
+      Cangaroo::Webhook::Client.new(destination_connection, path)
+        .post(transform, @job_id, parameters)
+    end
+
+    def perform?
+      fail NotImplementedError
+    end
+
+    def transform
+      { type.singularize => payload }
+    end
+
+    private
+
+    def source_connection
+      arguments.first.fetch(:connection)
+    end
+
+    def type
+      arguments.first.fetch(:type)
+    end
+
+    def payload
+      arguments.first.fetch(:payload)
+    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 || {}
+    end
+  end
+end

data/app/models/cangaroo/connection.rb

@@ -0,0 +1,12 @@
+module Cangaroo
+  class Connection < ActiveRecord::Base
+    serialize :parameters
+
+    validates :name, :url, :key, :token, presence: true
+    validates :name, :url, :key, :token, uniqueness: true
+
+    def self.authenticate(key, token)
+      where(key: key, token: token).first
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Cangaroo::Engine.routes.draw do
+  resources :endpoint, only: [:create], constraints: { format: :json }
+end

data/db/migrate/20151028172151_create_cangaroo_connections.rb

@@ -0,0 +1,12 @@
+class CreateCangarooConnections < ActiveRecord::Migration
+  def change
+    create_table :cangaroo_connections do |t|
+      t.string :name
+      t.string :url
+      t.string :key
+      t.string :token
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151030140821_add_parameters_to_cangaroo_connection.rb

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

data/lib/cangaroo.rb

@@ -0,0 +1,10 @@
+require 'cangaroo/engine'
+require 'interactor'
+require 'json-schema'
+require 'httparty'
+
+require 'cangaroo/webhook/error'
+require 'cangaroo/webhook/client'
+
+module Cangaroo
+end

data/lib/cangaroo/engine.rb

@@ -0,0 +1,17 @@
+module Cangaroo
+  class Engine < ::Rails::Engine
+    isolate_namespace Cangaroo
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    config.before_configuration do
+      Rails.configuration.cangaroo = ActiveSupport::OrderedOptions.new
+      Rails.configuration.cangaroo.jobs = []
+    end
+  end
+end

data/lib/cangaroo/version.rb

@@ -0,0 +1,3 @@
+module Cangaroo
+  VERSION = '1.0.0'
+end

data/lib/cangaroo/webhook/client.rb

@@ -0,0 +1,44 @@
+module Cangaroo
+  module Webhook
+    class Client
+      include HTTParty
+
+      format :json
+
+      attr_accessor :connection, :path
+
+      def initialize(connection, path)
+        @connection = connection
+        @path = path
+      end
+
+      def post(payload, request_id, parameters)
+        request_body = body(payload, request_id, parameters).to_json
+        req = self.class.post(url, headers: headers, body: request_body)
+        if req.response.code == '200'
+          req.parsed_response
+        else
+          fail Cangaroo::Webhook::Error, req.parsed_response['summary']
+        end
+      end
+
+      private
+
+      def url
+        URI.parse(
+          HTTParty.normalize_base_uri(connection.url)
+        ).merge(path.to_s).to_s
+      end
+
+      def headers
+        { 'X_HUB_TOKEN' => connection.token }
+      end
+
+      def body(payload, request_id, parameters)
+        { request_id: request_id,
+          parameters: connection.parameters.deep_merge(parameters)
+        }.merge(payload)
+      end
+    end
+  end
+end

data/lib/cangaroo/webhook/error.rb

@@ -0,0 +1,6 @@
+module Cangaroo
+  module Webhook
+    class Error < StandardError
+    end
+  end
+end

data/lib/tasks/cangaroo_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cangaroo do
+#   # Task goes here
+# end

data/spec/controllers/cangaroo/endpoint_controller_spec.rb

@@ -0,0 +1,72 @@
+require 'rails_helper'
+
+module Cangaroo
+  RSpec.describe EndpointController, type: :controller do
+    routes { Cangaroo::Engine.routes }
+    let(:connection) { create :cangaroo_connection }
+    let(:request_payload) { JSON.parse(load_fixture('json_payload_ok.json')) }
+
+    before do
+      request.headers['Content-Type'] = 'application/json'
+      request.headers['X-Hub-Store'] = connection.key
+      request.headers['X-Hub-Access-Token'] = connection.token
+    end
+
+    describe '#create' do
+      before do
+        post :create, request_payload
+      end
+
+      it 'accepts only application/json requests' do
+        expect(response.status).to eq(202)
+
+        request.headers['Content-Type'] = 'application/text'
+        post :create
+        expect(response.status).to eq(406)
+      end
+
+      context 'when success' do
+        let(:auth_headers) {}
+
+        it 'responds with 200' do
+          expect(response.status).to eq(202)
+        end
+
+        it 'responds with the number of objects received in payload' do
+          res = JSON.parse(response.body)
+          expect(res).to eq('orders' => 2, 'shipments' => 2)
+        end
+      end
+
+      context 'when error' do
+        before do
+          request.headers['X-Hub-Access-Token'] = 'wrongtoken'
+          post :create, request_payload
+        end
+
+        it 'responds with the command error code' do
+          expect(response.status).to eq(401)
+        end
+
+        it 'responds with error messages in the body' do
+          expect(JSON.parse(response.body)['error']).to be_present
+        end
+      end
+
+      context 'when an exception was raised' do
+        before do
+          HandleRequest.stub(:call).and_raise('An error')
+          post :create, request_payload
+        end
+
+        it 'responds with 500' do
+          expect(response.status).to eq(500)
+        end
+
+        it 'responds with error messages in the body' do
+          expect(JSON.parse(response.body)['error']).to eq 'Something went wrong!'
+        end
+      end
+    end
+  end
+end