locatine 0.02327 → 0.02637

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a584853859a41d1442f3037bef100dec0bb1d09e
-  data.tar.gz: 298cabc4969b4e454bb3d6bd9f5f2b5d091ff53c
+  metadata.gz: 8d969a9d3fc96c105d69b1d41f7ff8df92198d6d
+  data.tar.gz: 93ec07af0558fd08a13224686c9844775f3b36c9
 SHA512:
-  metadata.gz: 4a317d9efb1aab542d551d90272ee912edb9b7ee36df13ad74292d1ac377848995d19a786104a5db89480f636bf14d77c3b3f1271d4b408732729d8f0498baa8
-  data.tar.gz: 99dbade69774c044b519d78e5c3ec3b0ba7469eb803e9cff80eee1fa3549bd566460ffaaf2c3c95e7a7817bd83c6dd2254101ef50666a76503a91a19a06b117f
+  metadata.gz: 6f7d7af25a50b8aeb293f3795574999e87debe5adfd3149bb3e9855257a5cf4f47c2f980c57a8582b7b65890abafc665c3d96ab39604eb4ae615bdc636489d11
+  data.tar.gz: 3883f1e882b88f038dcacd6520d408126e9c82b9178a5cfb2d5069d4b14a7327e25651d08a45ab447f8b4a0366341482aefc7414668d06e08aeebaa13ef2ffd0

data/README.md

@@ -16,7 +16,11 @@ That's it.
 
 ## Stage of development:
 
-Version of Locatine is **0.02327** only. It means so far this is an alfa. You can use it in a real project if you are a risky person.
+Version of Locatine is **0.02637** only. It means so far this is an alfa. You can use it in a real project if you are a risky person.
+
+## Attention
+
+Beginning with the next version locatine (especially locatine-daemon) will be refactored dramatically. It is highly possible that the next version will be not completable with that one.
 
 ## Installation
 
@@ -98,7 +102,8 @@ Locatine::Search.new(json: "./Locatine_files/default.json",
                      visual_search: false,
                      no_fail: false,
                      trusted: [],
-                     untrusted: [])
+                     untrusted: [],
+                     autolearn: nil)
 ```
 
 ### json
@@ -155,6 +160,18 @@ If you are sure that some attribute (or something) is not good(generated by rand
 
 On the other hand you can force locatine to always trust something with trusted.
 
+### autolearn
+
+Determines wether Locatine will study elements by default or not.
+
+If true Locatine will always check element for changes even if it is found properly (to catch for example adding of a new attribute). This is slow.
+
+If false Locatine will study element only in case when it is lost.
+
+If not stated Locatine will use false until it is not facing any lost element. After the first lost element it will be studying everything (true).
+
+Notice that if autolearn is false Locatine is not bumping the stability values of attributes for elements which were found normally.
+
 ## Changing options on fly
 
 You can get or set these values on fly. Like:
@@ -229,7 +246,7 @@ vars = {tag: random_tag} # The tag
 vars = {attribute_name: random_attr} # If attribute is dynamic (use name of the attribute)
 # And two lines work with visual_search == true only
 vars = {css_option: random_value} # If your css is dynamic
-vars = {x: random_x} # x, y, width, height for element size and position
+vars = {x: random_x} # x, y for element position
 ```
 
 And if you do not like it you can do:
@@ -361,3 +378,131 @@ s.exact(name: "something") == s.find(name: "something", exact: true)
 s.check(name: "something") == s.find(name: "something", tolerance: 0)
 s.check_collection(name: "something") == s.collect(name: "something", tolerance: 0)
 ```
+
+## Using as a daemon
+
+Locatine daemon is a web server based on sinatra. You can run it from your code like:
+
+```ruby
+require 'locatine'
+Locatine::Daemon.set :port, 7733 #Your port goes here
+Locatine::Daemon.run!
+```
+
+Also you can do it with terminal:
+
+```bash
+locatine-daemon.rb -port=7733
+```
+
+You can see a python3 example in the [example](https://github.com/sseleznevqa/locatine/tree/master/example) folder. Main idea is
+
+1. Run daemon
+2. Ask daemon for the app path
+3. Run your browser with the app as extension
+4. Turn on the learn
+5. Provide data to the daemon for connect (browser name, session_id, connect url, proxy)
+6. Use API calls to teach daemon how to find elements
+7. After that you can start browser without the app
+8. Provide data for connect
+9. Now you can ask daemon to find your element via API call. And it will answer with a valid xpath you can use.
+
+### API
+
+#### GET call to /app
+
+returns path to locatine application in order to start chrome with it.
+
+Example of response:
+
+```
+{"app": "/some/path/to/app"}
+```
+
+#### GET call to /stop
+
+stops Locatine daemon.
+
+Returns:
+
+```
+{"result": "dead"}
+```
+
+#### POST call to /connect
+
+allows Locatine Daemon to connect existing browser instance
+
+POST data:
+
+```
+{'browser': 'chrome', 'session_id': session_id, 'url': 'http://whatever_is_browser_ip:port_opened_by_browser_for_selenium', 'proxy': 'optionally' }
+```
+
+Answer:
+
+```
+{"result": "true"}
+```
+
+#### POST call to /set
+
+is to control options of locatine search. Sending to set data ==
+
+```
+{"learn": "true"}
+```
+
+Answer:
+
+```
+{"result": "true"}
+```
+
+is the same as
+
+```ruby
+search.learn = true
+```
+
+#### POST call to /lctr
+
+is to find and return locator of an element found by locatine
+
+POST data just the same as for find or lctr method. It's like:
+
+```
+{"name": "some name", "scope": "Default", "exact": "false" ...}
+```
+
+Answer:
+
+```
+{"xpath": "//YOUR[@xpath='goes here']"}
+```
+
+### GET /chromedriver || /geckodriver || /iedriver
+
+returns path to the binary retrieved by locatine (using webdrivers gem)
+
+Answer:
+
+```
+{"path": "path/to/the/binary"}
+```
+
+### POST call to /chromedriver || /geckodriver || /iedriver
+
+is to force locatine to use your webdriver (for example for using old version of browser)
+
+POST data:
+
+```
+{"version": "2.46"}
+```
+
+Answer:
+
+```
+{"version": "2.46"}
+```

data/bin/locatine-daemon.rb

@@ -0,0 +1,8 @@
+#!Locatine-daemon...
+require 'locatine'
+args = Hash[ ARGV.join(' ').scan(/--?([^=\s]+)(?:=(\S+))?/) ]
+args = args.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+args.each_pair do |key, value|
+  Locatine::Daemon.set key, value
+end
+Locatine::Daemon.run!

data/lib/locatine.rb

@@ -1,3 +1,4 @@
 require 'locatine/search'
 require 'locatine/scope'
 require 'locatine/version'
+require 'locatine/daemon'

data/lib/locatine/app/background.js

@@ -1,6 +1,5 @@
 chrome.browserAction.onClicked.addListener(
   function(tab) {
-    console.log("WAS here");
     chrome.windows.create( {'url': 'popup.html',
                             'type': 'popup',
                             'width': 640,

data/lib/locatine/app/content.css

@@ -20,7 +20,7 @@ div[locatinestyle=true] {
   display: block;
   z-index: 2147483646;
   color: #FF99AA;
-  font-size: 45px;
+  font-size: 4vw;
   text-align: center;
   cursor: default;
 }
@@ -30,11 +30,6 @@ div[locatinestyle=false] {
   width: 0%;
 }
 
-div[locatinestyle=blocked] {
-  height: 0%;
-  width: 0%;
-}
-
 [locatineclass=foundbylocatine]
   {animation: locatine_found 6s infinite;
    -webkit-appearance: none;

data/lib/locatine/app/content.js

@@ -20,6 +20,7 @@ async function creatingDiv(){
   locatine_create_element(document.body, "div", options, "");
   const magic_cover = document.getElementById('locatine_magic_div');
   magic_cover.onclick = function(e) {locatine_magic_click(e)};
+  await set_value('locatine_confirm', 'new')
   document.body.onkeypress = async function(e) {
     if (e.which == 13) {
       await set_value('locatine_confirm', true)
@@ -45,21 +46,24 @@ async function setTitleHint(magicDiv){
     await set_value('locatine_title', magicDiv.getAttribute("locatinetitle"));
     await set_value('locatine_hint', magicDiv.getAttribute("locatinehint"));
     magicDiv.setAttribute("locatinetitle", "ok");
-    let op = 1;
-    magicDiv.innerHTML = await get_value("locatine_title");
-    let timer = setInterval(function () {
-      if ((magicDiv.style.opacity == 1) && (op < 0.97)) {
-        clearInterval(timer);// If other process changed opacity.
-      };
-      if (op <= 0.2) {
-        clearInterval(timer);
-        magicDiv.style.opacity = 0;
-        magicDiv.innerHTML = "";
-      }
-      magicDiv.style.opacity = op;
-      magicDiv.style.filter = 'alpha(opacity=' + op * 100 + ")";
-      op -= op * 0.03;
-    }, 50);
+    let status = await get_value('magic_div');
+    if (status) {
+      let op = 1;
+      magicDiv.innerHTML = await get_value("locatine_title");
+      let timer = setInterval(function () {
+        if ((magicDiv.style.opacity == 1) && (op < 0.97)) {
+          clearInterval(timer);// If other process changed opacity.
+        };
+        if (op <= 0.2) {
+          clearInterval(timer);
+          magicDiv.style.opacity = 0;
+          magicDiv.innerHTML = "";
+        }
+        magicDiv.style.opacity = op;
+        magicDiv.style.filter = 'alpha(opacity=' + op * 100 + ")";
+        op -= op * 0.03;
+      }, 50);
+    }
   }
 }
 
@@ -116,7 +120,7 @@ async function getSelected(value){
 };
 
 async function locatine_magic_click(e) {
-  document.getElementById("locatine_magic_div").setAttribute("locatinestyle", "blocked");
+  document.getElementById("locatine_magic_div").setAttribute("locatinestyle", "false");
   const value = document.elementFromPoint(e.clientX, e.clientY);
   document.getElementById("locatine_magic_div").setAttribute("locatinestyle", "true");
   const tagName = value.tagName;
@@ -139,7 +143,7 @@ function locatine_create_element(dom, tag, attrs, inner) {
 
 setInterval(async function(){
   if (document.getElementById("locatine_magic_div")) {
-    if (document.getElementById("locatine_magic_div").getAttribute("locatinestyle") != "blocked") {
+    if (document.getElementById("locatine_magic_div").getAttribute("locatinestyle") != "false") {
       await refreshData()
     }
   } else {

data/lib/locatine/app/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "Locatine app",
-  "version": "0.02327",
+  "version": "0.02637",
   "description": "Messaging from browser to main app",
   "devtools_page": "devtools.html",
   "permissions": ["activeTab", "storage", "contextMenus", "tabs"],

data/lib/locatine/app/popup.js

@@ -20,8 +20,10 @@ async function correct_buttons() {
   } else {
     document.getElementById("mode").setAttribute("value", "You are in single selection mode")
   };
-  document.getElementById("mainTitle").innerText = await get_value("locatine_title");
-  document.getElementById("hint").innerText = await get_value("locatine_hint");
+  if (await get_value("locatine_title")) {
+    document.getElementById("mainTitle").innerText = await get_value("locatine_title");
+    document.getElementById("hint").innerText = await get_value("locatine_hint");
+  }
   if ((document.getElementById("nameHandler").value != await get_value("locatineName")) && (!document.hasFocus())){
     document.getElementById("nameHandler").value = (await get_value("locatineName") || "");
   }

data/lib/locatine/daemon.rb

@@ -0,0 +1,93 @@
+require 'sinatra/base'
+require 'json'
+require 'locatine/daemon_helpers'
+
+module Locatine
+  #
+  # Locatine daemon based on sinatra
+  #
+  # run Locatine::Daemon.run!
+  class Daemon < Sinatra::Base
+    include Locatine::DaemonHelpers
+    configure do
+      set :search, nil
+    end
+
+    get '/app' do
+      { app: File.join(Locatine::HOME, 'app').to_s }.to_json
+    end
+
+    get '/' do
+      redirect 'https://github.com/sseleznevqa/locatine#using-as-a-daemon'
+    end
+
+    get '/stop' do
+      Locatine::Daemon.quit!
+      { result: 'dead' }.to_json
+    end
+
+    post '/chromedriver' do
+      Webdrivers::Chromedriver.required_version = params['version']
+      { version: Webdrivers::Chromedriver.required_version }.to_json
+    end
+
+    get '/chromedriver' do
+      { path: Webdrivers::Chromedriver.update }.to_json
+    end
+
+    post '/geckodriver' do
+      Webdrivers::Geckodriver.required_version = params['version']
+      { version: Webdrivers::Geckodriver.required_version }.to_json
+    end
+
+    get '/geckodriver' do
+      { path: Webdrivers::Geckodriver.update }.to_json
+    end
+
+    post 'iedriver' do
+      Webdrivers::IEdriver.required_version = params['version']
+      { version: Webdrivers::IEdriver.required_version }.to_json
+    end
+
+    get '/iedriver' do
+      { path: Webdrivers::IEdriver.update }.to_json
+    end
+
+    post '/connect' do
+      steal
+      { result: true }.to_json
+    end
+
+    post '/lctr' do
+      data = Hash[params.map { |k, v| [k.to_sym, v] }]
+      data.each { |k, v| data[k] = false if v == 'false' }
+      search.lctr(data).to_json
+    end
+
+    post '/set' do
+      hash = params
+      search.json = hash['json'] if hash['json']
+      warn 'You cannot set browser like this. Use /connect' if hash['browser']
+      params.each_pair do |key, value|
+        unless (key == 'browser') || (key == 'json')
+          value = false if value == 'false'
+          search.instance_variable_set("@#{key}", value)
+        end
+      end
+      { result: true }.to_json
+    end
+
+    def search
+      return settings.search unless settings.search.nil?
+
+      settings.search = Locatine::Search.new
+      settings.search.browser.quit
+      settings.search
+    end
+
+    def params
+      request.body.rewind
+      JSON.parse request.body.read
+    end
+  end
+end

data/lib/locatine/daemon_helpers.rb

@@ -0,0 +1,52 @@
+module Locatine
+  #
+  # Usefull things daemon can do
+  module DaemonHelpers
+    private
+
+    def steal
+      cast_ghost_browser
+      disguise_session
+      disguise_server_url
+      disguise_http
+      disguise_proxy unless params['proxy'].to_s.empty?
+    end
+
+    def bridge
+      search.browser.wd.send(:bridge)
+    end
+
+    def b_http
+      bridge.send(:http)
+    end
+
+    def disguise_session
+      bridge.instance_variable_set('@session_id', params['session_id'])
+    end
+
+    def disguise_server_url
+      uri = URI.parse(params['url'])
+      b_http.instance_variable_set('@server_url', uri)
+    end
+
+    def disguise_http
+      b_http.instance_variable_set('@http', make_net)
+    end
+
+    def disguise_proxy
+      b_http.instance_variable_set('@proxy', params['proxy'])
+    end
+
+    def make_net
+      parsed = URI.parse(params['url'])
+      path = parsed.path == '/' ? '' : parsed.path
+      Net::HTTP.new("#{parsed.host}#{path}", parsed.port)
+    end
+
+    def cast_ghost_browser
+      search.browser = Watir::Browser.new(params['browser'].to_sym)
+      search.browser.quit
+      search.browser.instance_variable_set('@closed', false)
+    end
+  end
+end