click_session 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d180275fd38f126e826853293950674857701ee
-  data.tar.gz: 86ed88478e1de5c0b2fd245819617c82f56e5d4b
+  metadata.gz: 9a68539042bc00feeb639ded737a7e67a9cf10cd
+  data.tar.gz: a557ea3a524b0185444fb3b3dd49220540c07c3b
 SHA512:
-  metadata.gz: 481b241d4dab8796a7a9c8fcd78e535f184c396859f135369a6ac722dd768f03f3be35c2884dc7918c224ee5aec25695328756b04baf15f747707641da934856
-  data.tar.gz: 1abddccdb8cbbc18b1c87fb7444c836633c28835b6490d432368df4632197c61f135ee47bbd6c6f4bb64fa3e4688bb30e166a17b88d103ee8cc1a001a97d5989
+  metadata.gz: 60a468b5b3f6109cde7556f6fe12575c2f26c63555c8d363956ac71268f1371c6fb07cac64fce844974098a408c7cdae3928cd63a27f50f6de8acf82e6110186
+  data.tar.gz: 65e1c0739b3e400b120ec3e43428602f7ba5822aa33cc66d3da36ff32fbd40f14c3991948cb0586fbd0a2ac0b7a04b759dbc88e8c7747f27f22e12398ab865e1

data/README.md

@@ -7,13 +7,17 @@ Modern web apps rely more and more on html to be loaded asyncronously after the
 The Capybara team has put a lot of thought into how these web apps can be tested and because of this, it also makes a good tool for scraping these web sites.
 
 ## Installation
+Add to `Gemfile`  
+```gem "click_session"```  
 
-## How to set up
+Run `bundle install`  
 
 ### Generate a migration
-`rails generate click_session:install`
+`rails generate click_session:install`  
 This will create a migration and generate an initializer with configuration parameters needed for click_session
 
+## How to set up
+
 ### Define the steps in a class
 Name the class ```ClickSessionRunner``` and add a method called ```run```.  
 
@@ -59,7 +63,22 @@ result = sync_click_session.run
 # --> result contains the serialized user data 
 ```
 
+Example of result hash:  
+```
+{
+  id: 1234,   
+  status: {
+    success: true,          # Boolean
+  },
+  data: {                   # This is the output of the Serialized model
+    name: "Joe",
+    facebook_avatar: "http://fb.com/i/joe.png"
+  }
+}
+```
+
 ### Run session asyncronously
+__1__ Create a new session
 ```ruby
 user = User.new
 async_click_session = ClickSession::Async.new(user)
@@ -67,16 +86,29 @@ result = async_click_session.run
 # --> saves the User
 # --> saves the SessionState
 # --> result contains the ID of the saved SessionState
+```
+Example of result
+```
+{
+  id: 1234,   
+  status: {
+    success: true,          # Boolean
+  }
+}
+```
 
+__2__ Run the rake task to process all the session that has not yet been executed
+```
 # $ rake click_session:process_active
 # --> run the steps in the ClickSessionRunner
+```
 
+__3__ Run the rake task that reports all the successful sessions
+```
 # $ rake click_session:report_successful
 # --> the request sent contains the serialized user data 
 ```
-
-### result hash
-Example:
+Example of payload posted to your webhook
 ```
 {
   id: 1234,   
@@ -89,6 +121,8 @@ Example:
   }
 }
 ```
+
+
 The only optional part of the result is the ```data```.
 
 ### Example of how to use it in a rails controller action
@@ -108,6 +142,11 @@ end
 
 ```
 
+### Additional methods available to use in the specified steps
+Method | Description
+------ | -----------
+`point_of_no_return`| This step prevents the processor running your steps to __NOT__ retry the steps if an error is raised. This is especially useful if you are automating a payment and you don't want the payment to be processed more than once. 
+
 ## Mandatory configurations
 ```ruby
 ClickSession.configure do | config |
@@ -119,7 +158,7 @@ end
 
 ```ruby
 ClickSession.configure do | config |
-  config.processor_class = MyCustomProcessor
+  config.runner_class = MyCustomRunner 
   config.notifier_class = MyCustomNotifier
   config.serializer_class = MyCustomSerializer
   config.success_callback_url = "https://my.domain.com/webhook_success"
@@ -217,6 +256,12 @@ __Note:__ This requires you to add the S3 credentials and bucket name to the con
 
 
 ## Rake tasks
+In order to run the included rake tasks, you need to load them in your applications `Rakefile`  
+```
+spec = Gem::Specification.find_by_name 'click_session'
+load "#{spec.gem_dir}/lib/tasks/click_session.rake"
+```
+
 ### click_session:process_active
 Processes all the active click sessions, meaning the ones that are ready to be run.
 

data/Rakefile

@@ -1 +1,2 @@
 require "bundler/gem_tasks"
+import "./lib/tasks/click_session.rake"

data/click_session.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tobias@talltorp.se"]
   spec.summary       = "Navigates the web for you"
   spec.description   = "Navigates the web for you"
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/talltorp/click_session"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/click_session/configuration.rb

@@ -16,8 +16,7 @@ module ClickSession
   end
 
   class Configuration
-    attr_accessor :processor_class,
-      :success_callback_url,
+    attr_accessor :success_callback_url,
       :failure_callback_url,
       :serializer_class
 
@@ -37,8 +36,8 @@ module ClickSession
       @model_class = klass.to_s
     end
 
-    def processor_class
-      @processor_class ||=
+    def runner_class
+      @runner_class ||=
         begin
           if Kernel.const_defined?(:ClickSessionRunner)
             "ClickSessionRunner"
@@ -51,11 +50,11 @@ module ClickSession
           end
         end
 
-      @processor_class.constantize
+      @runner_class.constantize
     end
 
-    def processor_class=(klass)
-      @processor_class = klass.to_s
+    def runner_class=(klass)
+      @runner_class = klass.to_s
     end
 
     def serializer_class

data/lib/click_session/sync.rb

@@ -32,7 +32,7 @@ module ClickSession
 
     private
 
-    delegate :processor_class, :notifier_class, to: :clicksession_configuration
+    delegate :notifier_class, to: :clicksession_configuration
 
     def serialize_success_response
       serializer.serialize_success(click_session)
@@ -43,11 +43,7 @@ module ClickSession
     end
 
     def processor
-      @processor ||= ClickSession::WebRunnerProcessor.new(configured_web_runner)
-    end
-
-    def configured_web_runner
-      @web_runner ||= processor_class.new
+      @processor ||= ClickSession::WebRunnerProcessor.new
     end
 
     def configured_notifier

data/lib/click_session/version.rb

@@ -1,3 +1,3 @@
 module ClickSession
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/click_session/web_runner.rb

@@ -9,11 +9,14 @@ module ClickSession
   class WebRunner
     include Capybara::DSL
 
-    def initialize
+    attr_reader :processor
+
+    def initialize(processor)
       Capybara.default_driver = ClickSession.configuration.driver_client
       Capybara.javascript_driver = ClickSession.configuration.driver_client
       Capybara.run_server = false
       page = Capybara::Session.new(ClickSession.configuration.driver_client)
+      @processor = processor
     end
 
     def run(model)
@@ -31,6 +34,10 @@ module ClickSession
       S3FileUploader.new.upload_file(@file_name)
     end
 
+    def point_of_no_return
+      processor.stop_processing
+    end
+
     private
     def clear_cookies
       browser = Capybara.current_session.driver.browser

data/lib/click_session/web_runner_processor.rb

@@ -2,13 +2,12 @@ require_relative "./exceptions"
 
 module ClickSession
   class WebRunnerProcessor
-    def initialize(web_runner)
-      @web_runner = web_runner
+    def initialize
       @retries_made  = 0
       @making_requests = true
     end
 
-    delegate :notifier_class, to: :clicksession_configuration
+    delegate :runner_class, :notifier_class, to: :clicksession_configuration
 
     def process(model)
       while can_make_requests?
@@ -26,23 +25,22 @@ module ClickSession
       model
     end
 
+    def stop_processing
+      @making_requests = false
+    end
+
     delegate :save_screenshot, to: :web_runner
 
     private
-    attr_reader :web_runner
 
     def can_make_requests?
       @making_requests
     end
 
-    def stop_making_requests
-      @making_requests = false
-    end
-
     def run_steps_in_browser_with(model)
       web_runner.reset
       web_runner.run(model)
-      stop_making_requests
+      stop_processing
     end
 
     def make_note_of_error(error)
@@ -54,6 +52,10 @@ module ClickSession
       @retries_made > 2
     end
 
+    def web_runner
+      @web_runner ||= runner_class.new(self)
+    end
+
     def notifier
       @notifier ||= notifier_class.new
     end

data/lib/generators/click_session/initializers/click_session.rb

@@ -1,4 +1,4 @@
 ClickSession.configure do |config|
   config.model_class = RenameThisToYourOwnActiveModelClass
-  config.processor_class = ClickSessionRunner
+  config.runner_class = ClickSessionRunner
 end

data/lib/tasks/click_session.rake

@@ -6,16 +6,12 @@ namespace :click_session do
     def processor_for(session_state)
       ClickSession::ClickSessionProcessor.new(
         session_state,
-        ClickSession::WebRunnerProcessor.new(configured_web_runner),
+        ClickSession::WebRunnerProcessor.new,
         ClickSession.configuration.notifier_class.new,
         processor_options
       )
     end
 
-    def configured_web_runner
-      ClickSession.configuration.processor_class.new
-    end
-
     def processor_options
       if ClickSession.configuration.screenshot_enabled?
         {

data/spec/click_session/click_session_processor_spec.rb

@@ -226,8 +226,7 @@ describe ClickSession::ClickSessionProcessor do
     end
 
     def mock_succesful_web_runner_processor
-      processor_stub = DummyWebRunner.new
-      web_runner_processor_mock = ClickSession::WebRunnerProcessor.new(processor_stub)
+      web_runner_processor_mock = ClickSession::WebRunnerProcessor.new
 
       allow(web_runner_processor_mock).
         to receive(:process).
@@ -246,8 +245,7 @@ describe ClickSession::ClickSessionProcessor do
     end
 
     def mock_failing_web_runner_processor
-      processor_stub = DummyWebRunner.new
-      web_runner_processor_mock = ClickSession::WebRunnerProcessor.new(processor_stub)
+      web_runner_processor_mock = ClickSession::WebRunnerProcessor.new
 
       allow(web_runner_processor_mock).
         to receive(:process).

data/spec/click_session/configuration_spec.rb

@@ -8,7 +8,7 @@ describe ClickSession::Configuration do
     end
 
     it 'provides defaults' do
-      expect(ClickSession.configuration.processor_class).to eq(ClickSessionRunner)
+      expect(ClickSession.configuration.runner_class).to eq(ClickSessionRunner)
       expect(ClickSession.configuration.serializer_class).to eq(ClickSession::WebhookModelSerializer)
       expect(ClickSession.configuration.notifier_class).to eq(ClickSession::Notifier)
       expect(ClickSession.configuration.driver_client).to eq(:poltergeist)
@@ -24,7 +24,7 @@ describe ClickSession::Configuration do
     it 'raises a helpful error if ClickSessionRunner is undefined' do
       allow(Kernel).to receive_messages(const_defined?: false)
 
-      expect { ClickSession.configuration.processor_class }.
+      expect { ClickSession.configuration.runner_class }.
         to raise_error(NameError, %r{https://github\.com/talltorp/click_session})
     end
   end
@@ -45,15 +45,15 @@ describe ClickSession::Configuration do
       expect(ClickSession.configuration.model_class).to eq(DummyModelClass)
     end
 
-    it "stores the processor_class" do
+    it "stores the runner_class" do
       class DummyProcessorClass
       end
 
       ClickSession.configure do | config |
-        config.processor_class = DummyProcessorClass
+        config.runner_class = DummyProcessorClass
       end
 
-      expect(ClickSession.configuration.processor_class).to eq(DummyProcessorClass)
+      expect(ClickSession.configuration.runner_class).to eq(DummyProcessorClass)
     end
 
     it "stores the serializer_class" do

data/spec/click_session/sync_spec.rb

@@ -11,9 +11,7 @@ describe ClickSession::Sync do
       @notifier_stub = stub_notifier_in_configuration
       mock_configuration_model_class_with(model)
 
-      processor_stub = ClickSession::WebRunner.new
-      mock_configuration_processor_class_with(processor_stub)
-      @web_runner_processor_stub = stub_web_runner_processor_with( processor_stub )
+      @web_runner_processor_stub = stub_web_runner_processor
     end
 
     context 'when processing is successful' do
@@ -85,13 +83,12 @@ describe ClickSession::Sync do
         end
       end
 
-      it "uses the web_runner and notifier from the configuration" do
+      it "uses the notifier from the configuration" do
         sync_click_session = ClickSession::Sync.new(model)
 
         sync_click_session.run
 
         expect(ClickSession.configuration).to have_received(:notifier_class)
-        expect(ClickSession.configuration).to have_received(:processor_class)
       end
 
       it "changes the state of the click_session to 'success_reported'" do
@@ -160,7 +157,7 @@ describe ClickSession::Sync do
       and_return(processor_stub)
 
     allow(ClickSession.configuration).
-      to receive(:processor_class).
+      to receive(:web_ruunner_class).
       and_return(processor_double)
   end
 
@@ -171,7 +168,7 @@ describe ClickSession::Sync do
       and_return(notifier_mock)
 
     allow(ClickSession.configuration).
-      to receive(:processor_class).
+      to receive(:runner_class).
       and_return(notifier_double)
 
     notifier_mock
@@ -184,8 +181,8 @@ describe ClickSession::Sync do
   end
 
 
-  def stub_web_runner_processor_with(processor_stub)
-    web_runner_processor_stub = ClickSession::WebRunnerProcessor.new(processor_stub)
+  def stub_web_runner_processor
+    web_runner_processor_stub = ClickSession::WebRunnerProcessor.new
 
     allow(web_runner_processor_stub).
       to receive(:process).

data/spec/click_session/web_runner_processor_spec.rb

@@ -14,29 +14,14 @@ describe ClickSession::WebRunnerProcessor do
 
     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)
+        web_runner_processor = ClickSession::WebRunnerProcessor.new
+        web_runner = ok_web_runner_stub(model, web_runner_processor)
+        stub_web_runner_in_configuration_with(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
@@ -46,8 +31,10 @@ describe ClickSession::WebRunnerProcessor do
 
       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)
+          web_runner_processor = ClickSession::WebRunnerProcessor.new
+          web_runner = third_time_ok_web_runner_stub(model, web_runner_processor)
+          stub_web_runner_in_configuration_with(web_runner)
+
 
           enriched_model = web_runner_processor.process(model)
 
@@ -55,16 +42,18 @@ describe ClickSession::WebRunnerProcessor do
         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 = ClickSession::WebRunnerProcessor.new
+          web_runner = third_time_ok_web_runner_stub(model, web_runner_processor)
+          stub_web_runner_in_configuration_with(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
+        def third_time_ok_web_runner_stub(model, processor)
+          web_runner = ClickSessionRunner.new(processor)
           allow(web_runner).
             to receive(:run).
             with(model) do | args |
@@ -81,8 +70,10 @@ describe ClickSession::WebRunnerProcessor do
 
       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)
+          web_runner_processor = ClickSession::WebRunnerProcessor.new
+          web_runner = all_requests_fail_web_runner_stub(model, web_runner_processor)
+          stub_web_runner_in_configuration_with(web_runner)
+
 
           expect { web_runner_processor.process(model) }.
             to raise_error(ClickSession::TooManyRetriesError)
@@ -90,54 +81,101 @@ describe ClickSession::WebRunnerProcessor do
             to have_received(:rescued_error).
             exactly(3).times
         end
+      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)
+      context "when further retries have been explicitly canceled" do
+        it "no more requests are made" do
+          web_runner_processor = ClickSession::WebRunnerProcessor.new
+          web_runner = ok_web_runner_stub(model, web_runner_processor)
+          stub_web_runner_in_configuration_with(web_runner)
 
-          allow(web_runner).
-            to receive(:reset)
+          web_runner_processor.stop_processing
+          enriched_model = web_runner_processor.process(model)
 
-          web_runner
+          expect(web_runner).not_to receive(:run)
         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 = ClickSession::WebRunnerProcessor.new
+      model = create(:test_unit_model)
+      web_runner = ok_web_runner_stub(model, web_runner_processor)
+      stub_web_runner_in_configuration_with(web_runner)
+
 
       web_runner_processor.save_screenshot("a_unique_name")
 
       expect(web_runner).to have_received(:save_screenshot).with("a_unique_name")
     end
   end
+
+  def stub_web_runner_in_configuration_with(web_runner_stub)
+    web_runner_double = class_double(ClickSession::WebRunner)
+
+    # Add the stub to the double
+    allow(web_runner_double).
+      to receive(:new).
+      and_return(web_runner_stub)
+
+    # Make the configuration return our double
+    allow(ClickSession.configuration).
+      to receive(:runner_class).
+      and_return(web_runner_double)
+
+    web_runner_stub
+  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
+
+  def ok_web_runner_stub(model, processor)
+    web_runner = ClickSessionRunner.new(processor)
+    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
+
+  def all_requests_fail_web_runner_stub(model, processor)
+    web_runner = ClickSessionRunner.new(processor)
+
+    allow(web_runner).
+      to receive(:run).
+      with(model).
+      and_raise(StandardError.new)
+
+    allow(web_runner).
+      to receive(:reset)
+
+    web_runner
+  end
 end

data/spec/click_session/web_runner_spec.rb

@@ -2,6 +2,18 @@ require "spec_helper"
 require "click_session/configuration"
 
 describe ClickSession::WebRunner do
+  describe "#point_of_no_return" do
+    it "tells its processor it should stop retrying errors" do
+      processor = ClickSession::WebRunnerProcessor.new
+      allow(processor).to receive(:stop_processing)
+      web_runner = ClickSession::WebRunner.new(processor)
+
+      web_runner.point_of_no_return
+
+      expect(processor).to have_received(:stop_processing).once
+    end
+  end
+
   describe "#save_screenshot" do
     context 'when screenshot was successful' do
       before :each do
@@ -27,7 +39,8 @@ describe ClickSession::WebRunner do
       end
 
       it "saves the screenshot in an s3 bucket" do
-        runner = ClickSession::WebRunner.new
+        processor = ClickSession::WebRunnerProcessor.new
+        runner = ClickSession::WebRunner.new(processor)
         stub_capybara
         stub_s3
 
@@ -35,7 +48,8 @@ describe ClickSession::WebRunner do
       end
 
       it "returns the url to the saved screenshot" do
-        runner = ClickSession::WebRunner.new
+        processor = ClickSession::WebRunnerProcessor.new
+        runner = ClickSession::WebRunner.new(processor)
         stub_capybara
         stub_s3
 
@@ -59,7 +73,8 @@ describe ClickSession::WebRunner do
 
     context 'when the screenshot fails' do
       it "does not try to save anything" do
-        runner = ClickSession::WebRunner.new
+        processor = ClickSession::WebRunnerProcessor.new
+        runner = ClickSession::WebRunner.new(processor)
 
         allow_any_instance_of(Capybara::Session).
           to receive(:save_screenshot).

data/spec/support/click_session_runner.rb

@@ -1,5 +1,6 @@
-class ClickSessionRunner
+class ClickSessionRunner < ClickSession::WebRunner
   def process
 
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_session
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Tobias Talltorp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -263,7 +263,7 @@ files:
 - spec/support/dummy_web_runner.rb
 - spec/support/schema.rb
 - spec/support/test_unit_model.rb
-homepage: ''
+homepage: https://github.com/talltorp/click_session
 licenses:
 - MIT
 metadata: {}