click_session 0.0.1

data/spec/click_session/web_runner_processor_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+require "click_session/configuration"
+require "support/test_unit_model"
+require "support/click_session_runner"
+
+describe ClickSession::WebRunnerProcessor do
+  describe "#process" do
+    let(:model) { create(:test_unit_model) }
+
+    before :each do
+      @notifier_stub = stub_notifier_in_configuration
+      mock_configuration_model_class_with(model)
+    end
+
+    context "when all requests are ok" do
+      it "returns the enriched model" do
+        web_runner = ok_web_runner_stub(model)
+        web_runner_processor = ClickSession::WebRunnerProcessor.new(web_runner)
+
+        enriched_model = web_runner_processor.process(model)
+
+        expect(enriched_model).to be_a(TestUnitModel)
+      end
+
+      def ok_web_runner_stub(model)
+        web_runner = ClickSessionRunner.new
+        allow(web_runner).
+          to receive(:run).
+          with(model)
+
+        allow(web_runner).
+          to receive(:reset)
+
+        allow(web_runner).
+          to receive(:save_screenshot).
+          and_return("a_file_name")
+
+        web_runner
+      end
+    end
+
+    context "when the placing of the order fails" do
+      before(:each) do
+        @times_called = 0
+      end
+
+      describe "but third retry succeeds" do
+        it "the state has changed to 'processed'" do
+          web_runner = third_time_ok_web_runner_stub(model)
+          web_runner_processor = ClickSession::WebRunnerProcessor.new(web_runner)
+
+          enriched_model = web_runner_processor.process(model)
+
+          expect(enriched_model).to be_a(TestUnitModel)
+        end
+
+        it "notifies about the rescued error" do
+          web_runner = third_time_ok_web_runner_stub(model)
+          web_runner_processor = ClickSession::WebRunnerProcessor.new(web_runner)
+
+          web_runner_processor.process(model)
+
+          expect(@notifier_stub).to have_received(:rescued_error).twice
+        end
+
+        def third_time_ok_web_runner_stub(model)
+          web_runner = ClickSessionRunner.new
+          allow(web_runner).
+            to receive(:run).
+            with(model) do | args |
+              @times_called += 1
+
+              raise StandardError, "Assertion failed" if @times_called < 3
+            end
+
+          allow(web_runner).to receive(:reset)
+
+          web_runner
+        end
+      end
+
+      describe "when all retry attempts fail" do
+        it "raises an error and notifies the status_notifier of each error" do
+          web_runner = all_requests_fail_web_runner_stub(model)
+          web_runner_processor = ClickSession::WebRunnerProcessor.new(web_runner)
+
+          expect { web_runner_processor.process(model) }.
+            to raise_error(ClickSession::TooManyRetriesError)
+          expect(@notifier_stub).
+            to have_received(:rescued_error).
+            exactly(3).times
+        end
+
+        def all_requests_fail_web_runner_stub(model)
+          web_runner = ClickSessionRunner.new
+
+          allow(web_runner).
+            to receive(:run).
+            with(model).
+            and_raise(StandardError.new)
+
+          allow(web_runner).
+            to receive(:reset)
+
+          web_runner
+        end
+      end
+    end
+
+    def stub_notifier_in_configuration
+      notifier_double = class_double(ClickSession::Notifier)
+      notifier_stub = ClickSession::Notifier.new
+
+      # Stub the methods
+      allow(notifier_stub).
+        to receive(:rescued_error)
+
+      # Add the stub to the double
+      allow(notifier_double).
+        to receive(:new).
+        and_return(notifier_stub)
+
+      # Make the configuration return our double
+      allow(ClickSession.configuration).
+        to receive(:notifier_class).
+        and_return(notifier_double)
+
+      notifier_stub
+    end
+  end
+
+  describe "#save_screenshot_for" do
+    it "delegates :save_screenshot to WebRunner" do
+      web_runner = ClickSessionRunner.new
+      allow(web_runner).to receive(:save_screenshot)
+      web_runner_processor = ClickSession::WebRunnerProcessor.new(web_runner)
+
+      web_runner_processor.save_screenshot("a_unique_name")
+
+      expect(web_runner).to have_received(:save_screenshot).with("a_unique_name")
+    end
+  end
+end

data/spec/click_session/web_runner_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+require "click_session/configuration"
+
+describe ClickSession::WebRunner do
+  describe "#save_screenshot" do
+    context 'when screenshot was successful' do
+      before :each do
+        ClickSession.configure do | config |
+          config.enable_screenshot = true
+          config.screenshot = {
+            s3_bucket: 'unit-s3-bucket',
+            s3_key_id: 'unit-s3-key-id',
+            s3_access_key: 'unit-s3-access-key'
+          }
+          allow(ClickSession.configuration).
+            to receive(:screenshot_enabled?).
+            and_return(true)
+
+          allow(ClickSession.configuration).
+            to receive(:screenshot).
+            and_return({
+              s3_bucket: 'unit-s3-bucket',
+              s3_key_id: 'unit-s3-key-id',
+              s3_access_key: 'unit-s3-access-key'
+            })
+        end
+      end
+
+      it "saves the screenshot in an s3 bucket" do
+        runner = ClickSession::WebRunner.new
+        stub_capybara
+        stub_s3
+
+        runner.save_screenshot("unit-id")
+      end
+
+      it "returns the url to the saved screenshot" do
+        runner = ClickSession::WebRunner.new
+        stub_capybara
+        stub_s3
+
+        screenshot_url = runner.save_screenshot("unit-id")
+
+        expect(screenshot_url).to be_a(String)
+      end
+
+      def stub_capybara
+        allow_any_instance_of(Capybara::Session).
+          to receive(:save_screenshot)
+      end
+
+      def stub_s3
+        expect_any_instance_of(ClickSession::S3FileUploader).
+          to receive(:upload_file).
+          with(/unit-id/).
+          and_return("https://unit-bucket.s3.aws.com/filename.png")
+      end
+    end
+
+    context 'when the screenshot fails' do
+      it "does not try to save anything" do
+        runner = ClickSession::WebRunner.new
+
+        allow_any_instance_of(Capybara::Session).
+          to receive(:save_screenshot).
+          and_raise
+
+        expect_any_instance_of(ClickSession::S3FileUploader).
+          not_to receive(:upload_file).
+          with(/unit-id/)
+
+        expect { runner.save_screenshot("unit-id") }.
+          to raise_error
+      end
+    end
+  end
+end

data/spec/click_session/webhook_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe ClickSession::Webhook do
+  describe "#call" do
+    let(:url) { "http://test.unit/success" }
+
+    let(:message) {
+      {
+        token: "abc",
+        id: "cde",
+      }
+    }
+
+    describe "when successful" do
+      before(:each) do
+        stub_request(:post, "http://test.unit/success").
+         with(:body => '{"token":"abc","id":"cde"}',
+              :headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'Content-Length'=>'26', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+         to_return(:status => 200, :body => "", :headers => {})
+      end
+
+      it "it sends the message to the url" do
+        webhook = ClickSession::Webhook.new(url)
+
+        webhook.call(message)
+
+        assert_requested :post, url,
+          {
+            body: '{"token":"abc","id":"cde"}',
+            times: 1
+          }
+      end
+
+      it "sends the request as json" do
+        webhook = ClickSession::Webhook.new(url)
+
+        webhook.call(message)
+
+        assert_requested :post, url,
+          {
+            headers: {
+              'Content-Type' => 'application/json',
+              'Accept' => 'application/json',
+            },
+            times: 1
+          }
+      end
+    end
+
+    describe "when there is a timeout" do
+      it "raises an error" do
+        stub_request(:post, "http://test.unit/success").
+          with(:body => '{"token":"abc","id":"cde"}',
+              :headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'Content-Length'=>'26', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+          to_timeout
+
+        webhook = ClickSession::Webhook.new(url)
+
+        expect{ webhook.call(message) }.to raise_error
+      end
+    end
+
+    describe "when the response has a HTTP error code" do
+      it "raises an error" do
+        stub_request(:post, "http://test.unit/success").
+          with(:body => '{"token":"abc","id":"cde"}',
+              :headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip, deflate', 'Content-Length'=>'26', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+          to_return(:status => 503, :body => "", :headers => {})
+        webhook = ClickSession::Webhook.new(url)
+
+        expect{ webhook.call(message) }.to raise_error
+      end
+    end
+  end
+end

data/spec/factories/test_unit_model_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :test_unit_model do
+    name "unit test name attribute"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require "click_session"
+require "factory_girl_rails"
+require "factories/test_unit_model_factory"
+require "shoulda-matchers"
+require "active_record"
+require "webmock/rspec"
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Use memeory database when testing
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+require 'support/schema'
+
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.order = :random
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end
+
+# Helper methods
+def mock_configuration_model_class_with(model)
+  model_double = class_double(TestUnitModel)
+
+  allow(model_double).
+    to receive(:find_by_id).
+    with(model.id).
+    and_return(model)
+
+  allow(ClickSession.configuration).
+    to receive(:model_class).
+    and_return(model_double)
+
+  model
+end

data/spec/support/click_session_runner.rb

@@ -0,0 +1,5 @@
+class ClickSessionRunner
+  def process
+
+  end
+end

data/spec/support/dummy_web_runner.rb

@@ -0,0 +1,2 @@
+class DummyWebRunner
+end

data/spec/support/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :session_states, :force => true do |t|
+    t.integer "webhook_attempts", default: 0, null: false
+    t.integer "state",            default: 0, null: false
+    t.integer "model_record"
+    t.string  "screenshot_url"
+    t.timestamps null: false
+  end
+
+  create_table :test_unit_models, :force => true do |t|
+    t.string  "name"
+    t.timestamps null: false
+  end
+end

data/spec/support/test_unit_model.rb

@@ -0,0 +1,3 @@
+class TestUnitModel < ActiveRecord::Base
+
+end

metadata

@@ -0,0 +1,310 @@
+--- !ruby/object:Gem::Specification
+name: click_session
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tobias Talltorp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-v1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.63'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.45'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Navigates the web for you
+email:
+- tobias@talltorp.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- click_session.gemspec
+- lib/click_session.rb
+- lib/click_session/async.rb
+- lib/click_session/click_session_processor.rb
+- lib/click_session/configuration.rb
+- lib/click_session/exceptions.rb
+- lib/click_session/failure_status_reporter.rb
+- lib/click_session/notifier.rb
+- lib/click_session/response_serializer.rb
+- lib/click_session/s3_connection.rb
+- lib/click_session/s3_file_uploader.rb
+- lib/click_session/session_state.rb
+- lib/click_session/status_reporter.rb
+- lib/click_session/successful_status_reporter.rb
+- lib/click_session/sync.rb
+- lib/click_session/version.rb
+- lib/click_session/web_runner.rb
+- lib/click_session/web_runner_processor.rb
+- lib/click_session/webhook.rb
+- lib/click_session/webhook_model_serializer.rb
+- lib/generators/click_session/db/migration/create_session_states.rb
+- lib/generators/click_session/initializers/click_session.rb
+- lib/generators/click_session/install_generator.rb
+- lib/tasks/click_session.rake
+- spec/click_session/async_spec.rb
+- spec/click_session/click_session_processor_spec.rb
+- spec/click_session/configuration_spec.rb
+- spec/click_session/failure_status_reporter_spec.rb
+- spec/click_session/notifier_spec.rb
+- spec/click_session/response_serializer_spec.rb
+- spec/click_session/s3_file_uploader_spec.rb
+- spec/click_session/session_state_spec.rb
+- spec/click_session/status_reporter_spec.rb
+- spec/click_session/successful_status_reporter_spec.rb
+- spec/click_session/sync_spec.rb
+- spec/click_session/web_runner_processor_spec.rb
+- spec/click_session/web_runner_spec.rb
+- spec/click_session/webhook_spec.rb
+- spec/factories/test_unit_model_factory.rb
+- spec/spec_helper.rb
+- spec/support/click_session_runner.rb
+- spec/support/dummy_web_runner.rb
+- spec/support/schema.rb
+- spec/support/test_unit_model.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Navigates the web for you
+test_files:
+- spec/click_session/async_spec.rb
+- spec/click_session/click_session_processor_spec.rb
+- spec/click_session/configuration_spec.rb
+- spec/click_session/failure_status_reporter_spec.rb
+- spec/click_session/notifier_spec.rb
+- spec/click_session/response_serializer_spec.rb
+- spec/click_session/s3_file_uploader_spec.rb
+- spec/click_session/session_state_spec.rb
+- spec/click_session/status_reporter_spec.rb
+- spec/click_session/successful_status_reporter_spec.rb
+- spec/click_session/sync_spec.rb
+- spec/click_session/web_runner_processor_spec.rb
+- spec/click_session/web_runner_spec.rb
+- spec/click_session/webhook_spec.rb
+- spec/factories/test_unit_model_factory.rb
+- spec/spec_helper.rb
+- spec/support/click_session_runner.rb
+- spec/support/dummy_web_runner.rb
+- spec/support/schema.rb
+- spec/support/test_unit_model.rb