true_automation 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad9533605c7a55ad8e9528f286a5968967617ecc
-  data.tar.gz: f1f1ee18fdc71fbe0d3e69f46e0e71f67621b1f2
+  metadata.gz: 3355f74c9a473cd7b9b70072486452f12ed52ca1
+  data.tar.gz: c3c07946636cc8afc43ff29170a07bf8a8ef1813
 SHA512:
-  metadata.gz: 82bf853bbeb06701deecb8aad1bf6179741d28e473c8a0bcb24582a587d08355a8f16c79a4aecea9bf3fdac63ae898f676e0f75f5f3e0d03b63fcc83497b389d
-  data.tar.gz: '02258e95a4cdcf96c3df1a2cbb65019b51b1719fe8fd04c5e0b0ea805bc11d1607cc7b944a9a399d122a6485a602f7adcca1455f68872e02462047ae3e98a544'
+  metadata.gz: 87a85bc1280d4d0c812a8508f52b156c0f6c626a36e52c9eec9cc97dd32ffbe74e9a25a29150a60ba097ee7ef4ed90e042f94d8ff97f6c58f2e192510b3e0999
+  data.tar.gz: 96ca25ec16a59b3736ecf92c81e69b9ce20dd10f3393abd539fbba66698bc9ba167208743a3f78eeee5db01208b73b082b25842be067b662e461180e38519679

data/README.md

@@ -7,13 +7,17 @@
 **true_automation** gem provides helper DSL method, that can be used instead of Selenium/Capybara locators. 
 Initial setup aim is to make `ta` method visible for your code. 
 
-You need **trueautomation** npm package installed globally first. It requires NodeJS 9+. 
-We recommend to use [nvm](https://github.com/creationix/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows)
-to install Node.
+You need TrueAutomation.IO client installed first.
 
-When right version of Node is installed run the following command:
+To install it just run the following command in your terminal. Using cURL:
 
-    $ npm install -g trueautomation
+    curl -o- http://trueautomation.io/installer.sh | bash
+    
+Or using wget
+
+    wget -qO-  http://trueautomation.io/installer.sh | bash
+    
+Then restart your terminal to start using TrueAutomation.IO
 
 
 ### Automatic Setup
@@ -23,8 +27,8 @@ in your project. Currently we support Capybara/RSpec automatic setup only.
 
 #### Capybara/RSpec
 
-For Capybara/RSpec projects TrueAutomation installer adds **true_automation** gem to the Gemfile, and includes TrueAutomation
-DSL to `rspec_helper.rb`. 
+For Capybara/RSpec projects TrueAutomation installer adds **true_automation** gem to the Gemfile, includes TrueAutomation
+DSL to `rspec_helper.rb` and replaces WebDriver with TrueAutomaton.IO Driver
 
 #### Other
 
@@ -43,6 +47,48 @@ And then execute:
 
     $ bundle install
     
+#### Using TrueAutomaton.IO Capybara WebDriver
+
+```ruby
+require 'true_automation/driver/capybara'
+```
+
+To initialize WebDriver for Capybara
+```ruby
+TrueAutomation::Driver::Capybara.new(app, port: 9515)
+```
+
+#### Controlling TrueAutomation.IO Driver lifecycle
+
+```ruby
+require 'true_automation/client'
+```
+
+Initialize the client
+
+```ruby
+ta_client = TrueAutomation::Client.new
+```
+
+Start the client:
+```ruby
+ta_client.start(port: 9515)
+```
+
+Wait until client is started:
+```ruby
+ta_client.wait_until_start
+```
+
+Stop the client:
+```ruby
+ta_client.stop
+```
+
+Client automatically writes the log in `./log/trueautomation-<date-time>.log`
+
+#### Using TrueAutomation.IO locators
+    
 Add TrueAutomation DSL to your test file
 
  ```ruby

data/lib/true_automation/client.rb

@@ -1,42 +1,28 @@
 require 'open3'
 require 'json'
+require 'mkmf'
 
 module TrueAutomation
   class Client
     @pid = nil
 
-    def start
-      begin
-        node_ver = `node -v`
-        node_ver = node_ver[1..-1]
-        node_versions = node_ver.split('.')
-        major_version = node_versions[0]
+    def start(options)
 
-        if major_version.to_i < 9
-          puts "Node version #{node_ver} found. TrueAutomation.IO requires Node 9+ to run."
-          exit
-        end
-      rescue e
-        puts 'Node executable can not be found. node version 9+ is required to run TrueAutomation.IO tests.'
-        exit
-      end
-
-      begin
-        trueautomation_version = `trueautomation --version`
+      @port = options[:port] || 9515
+      @executable = ENV['TRUEAUTOMATION_EXEC'] || 'trueautomation'
 
-        puts "TrueAutomation.IO client #{trueautomation_version.strip}"
-      rescue e
-        puts 'TrueAutomation.IO npm package is not installed. Run `npm install -g trueautomation` to install it first.'
-        exit
+      if find_executable(@executable).nil?
+        raise "`#{@executable}` not found. Can not find TrueAutomation.IO client"
       end
 
-      Dir.mkdir('log') unless File.exist?('log')
+      trueautomation_version = `#{@executable} --version`
+      puts "TrueAutomation.IO client #{trueautomation_version.strip}"
 
+      Dir.mkdir('log') unless File.exist?('log')
       logfile = "log/trueautomation-#{Time.now.strftime('%Y%m%dT%H%M%S')}.log"
 
-      @pid = spawn('trueautomation start', out: logfile)
-
-      puts "Started TrueAutomation.IO client with pid #{@pid}"
+      @pid = spawn("#{@executable} --log-file #{logfile} --port #{@port}")
+      puts "Started TrueAutomation.IO client with pid #{@pid} listening to port #{@port}"
 
       @pid
     end
@@ -61,7 +47,7 @@ module TrueAutomation
     private
 
     def check_connection
-      Socket.tcp('localhost', 9515, connect_timeout: 2) { true } rescue false
+      Socket.tcp('localhost', @port, connect_timeout: 2) { true } rescue false
     end
   end
 end

data/lib/true_automation/driver/capybara.rb

@@ -4,20 +4,22 @@ module TrueAutomation
   module Driver
     class Capybara < Capybara::Selenium::Driver
       def initialize(app, **options)
+        @port = options.delete(:port) || 9515
+
         super(app, options)
 
         @ta_client = TrueAutomation::Client.new
 
-        @options.merge!({browser: :remote,
-                        url: 'http://localhost:9515/',
+        @options.merge!(browser: :remote,
+                        url: "http://localhost:#{@port}/",
                         desired_capabilities: {
                             browser: :chrome
-                        }})
+                        })
       end
 
       def browser
         unless @browser
-          @ta_client.start
+          @ta_client.start(port: @port)
 
           @ta_client.wait_until_start
 

data/lib/true_automation/version.rb

@@ -1,3 +1,3 @@
 module TrueAutomation
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: true_automation
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - TrueAutomation.IO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2018-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler