heracles-wrapper 0.0.1

data/spec/heracles-wrapper/config_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../../lib/heracles-wrapper/config', __FILE__)
+require 'minitest/autorun'
+describe 'Heracles::Wrapper::Config' do
+  subject {
+    Heracles::Wrapper::Config.new { |c|
+      c.api_key = expected_api_key
+    }
+  }
+  let(:expected_api_key) { '12345678901234567890123456789012'}
+  it 'should initialize with a block' do
+    subject.api_key.must_equal expected_api_key
+  end
+
+  it 'should have heracles base url' do
+    subject.heracles_base_url.must_equal Heracles::Wrapper::HERACLES_BASE_URL
+  end
+
+  it 'should allow heracles_base_url to be overwritten' do
+    expected_url = 'http://google.com'
+    subject.heracles_base_url.must_equal Heracles::Wrapper::HERACLES_BASE_URL
+    subject.heracles_base_url = expected_url
+    subject.heracles_base_url.must_equal expected_url
+  end
+end

data/spec/heracles-wrapper/exceptions_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../../lib/heracles-wrapper/exceptions', __FILE__)
+require 'minitest/autorun'
+require 'ostruct'
+describe Heracles::Wrapper::RequestFailure do
+  describe 'well formed response' do
+    subject { Heracles::Wrapper::RequestFailure.new(response) }
+    let(:response) {
+      OpenStruct.new(:code => expected_code, :body => expected_body)
+    }
+    let(:expected_code) { 123 }
+    let(:expected_body) { 'Hello' }
+    it('has #code') { subject.code.must_equal expected_code }
+    it('has #messages') { subject.messages.must_equal expected_body }
+    it('has #response') { subject.response.must_equal response }
+    it('has #to_s') { subject.to_s.must_equal "code: #{expected_code}" }
+  end
+  describe 'poorly formed response as per a timeout' do
+    subject { Heracles::Wrapper::RequestFailure.new(response) }
+    let(:response) { Object.new }
+    let(:expected_code) { 500 }
+    let(:expected_body) { '' }
+    it('has #code') { subject.code.must_equal expected_code }
+    it('has #messages') { subject.messages.must_equal expected_body }
+    it('has #response') { subject.response.must_equal response }
+    it('has #to_s') { subject.to_s.must_equal "code: #{expected_code}" }
+  end
+end

data/spec/heracles-wrapper/notification_response_spec.rb

@@ -0,0 +1,93 @@
+require File.expand_path(
+  '../../../lib/heracles-wrapper/notification_response', __FILE__
+)
+require 'minitest/autorun'
+
+describe Heracles::Wrapper::NotificationResponse do
+  subject { Heracles::Wrapper::NotificationResponse.new(params) }
+  describe 'well formed response' do
+    let(:expected_job_status) { 'ok'}
+    let(:expected_job_id) { '1234' }
+    let(:params) {
+      {
+        :job_id => expected_job_id,
+        :job_status => expected_job_status,
+        :notification_payload => {
+          :hello => { :world => [{:foo => 1},{:foo => 2},{:bar => 3}]}
+        }
+      }
+    }
+
+    it 'should extract methods based on keys' do
+      subject.must_respond_to :fetch
+      subject.fetch(:hello).must_equal(
+        params.fetch(:notification_payload).fetch(:hello)
+      )
+    end
+
+    it 'should have #job_status' do
+      subject.job_status.must_equal expected_job_status.to_sym
+    end
+    it 'should have #job_id' do
+      subject.job_id.must_equal expected_job_id.to_i
+    end
+
+    it 'should have #one_time_key' do
+      subject.must_respond_to :one_time_notification_key
+    end
+
+    it 'should have #notification_payload' do
+      subject.must_respond_to :notification_payload
+    end
+  end
+
+  describe 'poorly formed response' do
+    let(:params) { {} }
+
+    it 'should raise error' do
+      lambda { subject }.must_raise ArgumentError
+    end
+
+  end
+end
+
+describe Heracles::Wrapper do
+
+  require 'delegate'
+  class DelegateResponse < DelegateClass(Heracles::Wrapper::NotificationResponse)
+    attr_reader :pid
+    def initialize(params)
+      super(Heracles::Wrapper::NotificationResponse.new(params))
+      @pid = fetch(:pid)
+    end
+  end
+
+  describe DelegateResponse do
+    subject {DelegateResponse.new(params)}
+    let(:params) {
+      {
+        :job_id => '1234',
+        :job_status => 'ok',
+        :notification_payload => {
+          :pid => 'abc'
+        }
+      }
+    }
+    describe 'well formed' do
+      it 'has a job_id and includes locally defined methods' do
+        subject.job_id.must_equal 1234
+        subject.job_status.must_equal :ok
+        subject.pid.must_equal 'abc'
+      end
+    end
+
+    describe 'poorly formed' do
+      let(:params) { {:notification_payload => {:pid => 'abc'}} }
+      it 'fails as an underlying pre-condition is not met' do
+        lambda {
+          subject
+        }.must_raise ArgumentError
+      end
+    end
+  end
+end

data/spec/heracles-wrapper/request/create_job_spec.rb

@@ -0,0 +1,163 @@
+require File.expand_path(
+  '../../../../lib/heracles-wrapper/request/create_job', __FILE__
+)
+require File.expand_path('../../../../lib/heracles-wrapper/config', __FILE__)
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+describe 'Heracles::Wrapper::Request::CreateJob' do
+  require 'webmock/minitest'
+
+  before(:all) do
+    ::WebMock.disable_net_connect!
+  end
+  after(:all) do
+    ::WebMock.allow_net_connect!
+  end
+
+  subject { Heracles::Wrapper::Request::CreateJob.new(config, options) }
+  let(:config) {
+    Heracles::Wrapper::Config.new {|c|
+      c.api_key = expected_api_key
+    }
+  }
+  let(:expected_api_key) { '12345678901234567890123456789012' }
+  let(:expected_workflow_name) { 'RabbitWarren' }
+  let(:expected_parent_job_id) { nil }
+  let(:options) {
+    {
+      :workflow_name => expected_workflow_name,
+      :parent_job_id => expected_parent_job_id,
+    }
+  }
+
+  describe "#call" do
+    let(:expected_job_id) { 123 }
+    let(:expected_job_location) {
+      File.join(subject.url.to_s, expected_job_id.to_s)
+    }
+
+    it 'makes remote call and waits for response' do
+      stub_request(:post, subject.url.to_s).
+      to_return(
+        {
+          :body => %({"job_id" : "#{expected_job_id}"}),
+          :status => 201,
+          :headers => {
+            :content_type => 'application/json',
+            :location => expected_job_location
+          }
+        }
+      )
+      subject.call.code.must_equal 201
+      subject.call.job_id.must_equal expected_job_id.to_i
+      subject.call.location.must_equal expected_job_location
+    end
+
+    it 'handles timeout' do
+      stub_request(:post, subject.url.to_s).to_timeout
+      lambda {
+        subject.call
+      }.must_raise Heracles::Wrapper::RequestFailure
+    end
+
+    it 'handles redirection' do
+      stub_request(:post, subject.url.to_s).to_return(:status => 302)
+      lambda {
+        subject.call
+      }.must_raise Heracles::Wrapper::RequestFailure
+    end
+
+    it 'handles 404' do
+      stub_request(:post, subject.url.to_s).to_return(:status => 404)
+      lambda {
+        subject.call
+      }.must_raise Heracles::Wrapper::RequestFailure
+    end
+
+    it 'handles 401' do
+      stub_request(:post, subject.url.to_s).to_return(:status => 401)
+      lambda {
+        subject.call
+      }.must_raise Heracles::Wrapper::RequestFailure
+    end
+
+    it 'handles 500' do
+      stub_request(:post, subject.url.to_s).to_return(:status => 500)
+      lambda {
+        subject.call
+      }.must_raise Heracles::Wrapper::RequestFailure
+    end
+  end
+
+  it 'has a #url' do
+    subject.url.must_be_kind_of URI
+  end
+
+  it 'has #parameters' do
+    subject.parameters.must_be_kind_of Hash
+  end
+
+  it 'has #config' do
+    subject.must_respond_to :config
+  end
+
+  it 'has #parent_job_id' do
+    subject.must_respond_to :parent_job_id
+  end
+
+  it 'has #workflow_name' do
+    subject.must_respond_to :workflow_name
+  end
+
+  describe "#as_json" do
+    describe 'bare metal' do
+      it 'has #as_json' do
+        subject.as_json.must_equal(
+          {
+            :api_key => expected_api_key,
+            :workflow_name => expected_workflow_name,
+            :parameters => {}
+          }
+        )
+      end
+    end
+
+    describe 'with parent_job_id' do
+      let(:expected_parent_job_id) { '1234' }
+      it 'has #as_json' do
+        subject.as_json.must_equal(
+          {
+            :api_key => expected_api_key,
+            :workflow_name => expected_workflow_name,
+            :parent_job_id => expected_parent_job_id,
+            :parameters => {}
+          }
+        )
+      end
+    end
+
+    describe 'with additional parameters' do
+      let(:expected_callback_url) { 'my callback_url' }
+      let(:options) {
+        {
+          :workflow_name => expected_workflow_name,
+          :parent_job_id => expected_parent_job_id,
+          :parameters => {
+            :callback_url => expected_callback_url,
+            :system_number => '1234'
+          }
+        }
+      }
+      it 'has #as_json' do
+        subject.as_json.must_equal(
+          {
+            :api_key => expected_api_key,
+            :workflow_name => expected_workflow_name,
+            :parameters => options[:parameters]
+          }
+        )
+      end
+    end
+  end
+end

data/spec/heracles-wrapper/request_success_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(
+  '../../../lib/heracles-wrapper/request_success', __FILE__
+)
+require File.expand_path('../../../lib/heracles-wrapper/config', __FILE__)
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'ostruct'
+
+describe 'Heracles::Wrapper::RequestSuccess' do
+  subject { Heracles::Wrapper::RequestSuccess.new(http_response) }
+  let(:expected_job_id) { 1234 }
+  let(:expected_messages) { ['one message'] }
+  let(:expected_code) { 201 }
+  let(:expected_location) { 'http://somewhere.over/the/rainbown' }
+  let(:http_response) {
+    OpenStruct.new(
+      :body => %(
+        {
+          "job_id": #{expected_job_id},
+          "messages": #{expected_messages.inspect}
+        }
+      ),
+      :headers => { :location => expected_location },
+      :code => expected_code
+    ).tap { |obj|
+      def obj.foo_bar; 'Baz'; end
+    }
+  }
+
+  it 'has #code' do
+    subject.code.must_equal expected_code
+  end
+
+  it 'has #job_id' do
+    subject.job_id.must_equal expected_job_id
+  end
+
+  it 'has #location' do
+    subject.location.must_equal expected_location
+  end
+
+  it 'has #messages' do
+    subject.messages.must_equal expected_messages
+  end
+
+  it 'delegates everything else to the http_response' do
+    subject.foo_bar.must_equal 'Baz'
+  end
+end

data/spec/heracles-wrapper/test_helper_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path('../../../lib/heracles-wrapper/test_helper', __FILE__)
+require 'minitest/autorun'
+require 'webmock/minitest'
+
+describe Heracles::Wrapper::TestHelper do
+  include Heracles::Wrapper::TestHelper
+  require 'webmock/minitest'
+
+  before(:all) do
+    Heracles::Wrapper.configure { |c| c.api_key = 1234 }
+    ::WebMock.disable_net_connect!
+  end
+  after(:all) do
+    Heracles::Wrapper.clear_config!
+    ::WebMock.allow_net_connect!
+  end
+
+  let(:input_parameters) {
+    {
+      :workflow_name => 'TacoBuilder',
+      :parameters => {
+        :hello => 'world'
+      }
+    }
+  }
+
+  describe '#with_heracles_service_failure_stub' do
+    let(:expected_message) {'No Soup For You'}
+    it 'should require expected message' do
+      with_heracles_service_failure_stub(:create_job, [expected_message]) do
+        caller = Heracles::Wrapper.service(:create_job, input_parameters)
+        lambda {
+          value = caller.call
+        }.must_raise(Heracles::Wrapper::RequestFailure, /#{expected_message}/)
+      end
+    end
+  end
+
+  describe "#with_heracles_service_stub" do
+    it 'should return an object that adheres to request_success' do
+      with_heracles_service_stub(:create_job) do
+        @response = Heracles::Wrapper.service(
+          :create_job, input_parameters
+        ).call
+        @response.job_id.must_be_kind_of Fixnum
+        @response.messages.must_be_kind_of Array
+        @response.code.must_be_kind_of Fixnum
+        @response.location.must_be_kind_of String
+      end
+    end
+
+    it 'should be non destructive to the caller' do
+      @original_create_job_service = Heracles::Wrapper.create_job_service
+
+      with_heracles_service_stub(:create_job) do
+        @original_create_job_service.wont_be_same_as(
+          Heracles::Wrapper.create_job_service
+        )
+      end
+
+      Heracles::Wrapper.create_job_service.must_equal(
+        @original_create_job_service
+      )
+    end
+    let(:expected_job_id) { 1234 }
+    let(:expected_code) { 201 }
+    let(:expected_location) { "http://somewhere/jobs/#{expected_job_id}"}
+
+    def stub_live_http_request
+      stub_request(
+        :post,
+        File.join(Heracles::Wrapper.config.heracles_base_url, 'jobs')
+      ).
+      to_return(
+        {
+          :body => %({"job_id" : "#{expected_job_id}"}),
+          :status => expected_code,
+          :headers => {
+            :content_type => 'application/json',
+            :location => expected_location
+          }
+        }
+      )
+    end
+    let(:expected_response) {
+      {
+        :job_id => expected_job_id,
+        :code => expected_code,
+        :location => expected_location
+      }
+    }
+    it 'should respond like other systems' do
+      @stubbed_response = nil
+      with_heracles_service_stub(:create_job, expected_response) do
+        @stubbed_response = Heracles::Wrapper.service(
+          :create_job, input_parameters
+        )
+      end
+
+      stub_live_http_request
+      @full_response = Heracles::Wrapper.service(
+        :create_job, input_parameters
+      )
+
+      @stubbed_response.config.must_equal @full_response.config
+      @stubbed_response.workflow_name.must_equal @full_response.workflow_name
+      @stubbed_response.parent_job_id.must_equal @full_response.parent_job_id
+      @stubbed_response.parameters.must_equal @full_response.parameters
+
+      @stubbed_response.call.job_id.must_equal @full_response.call.job_id
+
+    end
+  end
+end

data/spec/heracles-wrapper_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../../lib/heracles-wrapper', __FILE__)
+require 'minitest/autorun'
+describe 'Heracles::Wrapper' do
+  subject { Heracles::Wrapper }
+  before(:each) do
+    Heracles::Wrapper.clear_config!
+  end
+  before(:each) do
+    Heracles::Wrapper.clear_config!
+  end
+  describe 'improperly configured' do
+    it "should raise exception on .config if it wasn't set" do
+      lambda { subject.config }.must_raise(
+        Heracles::Wrapper::ConfigurationError,
+        /config not set/
+      )
+    end
+    it "should raise exception on .config if API Key is nil" do
+      subject.configure {|c| c.api_key = nil }
+      lambda { subject.config }.must_raise(
+        Heracles::Wrapper::ConfigurationError,
+        /api_key is invalid/
+      )
+    end
+  end
+  describe 'properly configured' do
+    before(:each) do
+      Heracles::Wrapper.configure do |c|
+        c.api_key = expected_api_key
+      end
+    end
+    let(:expected_api_key) { '12345678901234567890123456789012'}
+    it 'has .config' do
+      subject.config.must_be_kind_of Heracles::Wrapper::Config
+    end
+
+    let(:expected_workflow_name) { 'MyWorkflowName' }
+    let(:expected_request_parameters) { { :hello => 'World' } }
+    it 'has .build_request_for_create_job that responds to call' do
+      request = subject.service(
+        :create_job,
+        :workflow_name => expected_workflow_name,
+        :parameters => expected_request_parameters
+      )
+      request.parent_job_id.must_equal nil
+      request.workflow_name.must_equal expected_workflow_name
+      request.parameters.must_equal expected_request_parameters
+      request.must_respond_to :call
+    end
+  end
+end

data/spec/rails/generators/heracles/wrapper/install/install_generator_spec.rb

@@ -0,0 +1,31 @@
+gem 'rails'
+require File.expand_path(
+  File.join(
+    '../../../../../../../',
+    'lib/rails/generators/heracles/wrapper/install/install_generator'
+  ), __FILE__
+)
+class Heracles::Wrapper::InstallGeneratorTest < Rails::Generators::TestCase
+  tests Heracles::Wrapper::InstallGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test 'generates config when api key is provided' do
+    @api_key = 'generic-api-key'
+    run_generator(%w(-k generic-api-key))
+    assert_file 'config/initializers/heracles-wrapper.rb' do |config|
+      assert_match('Heracles::Wrapper.configure do |config|', config)
+      assert_match(
+        "config.api_key = #{@api_key.inspect}",
+        config
+      )
+    end
+
+  end
+
+  test 'does not generate config when api key is omitted' do
+    @api_key = 'generic-api-key'
+    run_generator
+    assert_no_file 'config/initializers/heracles-wrapper.rb'
+  end
+end

data/spec/rails/generators/heracles/wrapper/notification_response/notification_response_generator_spec.rb

@@ -0,0 +1,44 @@
+gem 'rails'
+TO_GEM_ROOT = "../../../../../../../"
+require File.expand_path(
+  File.join(
+    TO_GEM_ROOT, 'lib/rails/generators/heracles/wrapper',
+    '/notification_response/notification_response_generator'
+  ), __FILE__
+)
+module Heracles::Wrapper
+  class NotificationResponseGeneratorTest < Rails::Generators::TestCase
+    tests Heracles::Wrapper::NotificationResponseGenerator
+    destination(
+      File.expand_path(File.join(TO_GEM_ROOT,"tmp", File.dirname(__FILE__)))
+    )
+    setup :prepare_destination
+
+    test 'should generate model with a name' do
+      run_generator(%w(MonkeyPatch))
+      assert_file 'app/models/monkey_patch.rb' do |file|
+        assert_match(
+          /^#{%(require 'heracles/wrapper/notification_response')}$/,
+          file
+        )
+        assert_match(
+          /^#{%(require 'delegate')}$/,
+          file
+        )
+        assert_match(
+          /^class\ MonkeyPatch\ \<\ DelegateClass\(Heracles::Wrapper::NotificationResponse\)$/,
+          file
+        )
+        assert_method(:initialize, file)
+      end
+    end
+
+    test 'should generate spec with a name' do
+      run_generator(%w(MonkeyPatch))
+      assert_file 'spec/models/monkey_patch_spec.rb' do |file|
+        assert_match(/^require 'spec_helper'/, file)
+        assert_match(/^describe MonkeyPatch do$/, file)
+      end
+    end
+  end
+end