scrap_kit 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b98409a1148b80bc3f7a908779d3881f36fe3f8a8de2e1726135ea6488e24b2
-  data.tar.gz: a5b66ae5611527e93bee6167dfd4d365822f4122258054c781b09a290644ad80
+  metadata.gz: 9125aec53d6a517aa7679bc67df8c6ffd366d77afea643fae757ab7862767c0d
+  data.tar.gz: bbfa2cae0560461e7fb1f5af1cb672a0b5c11686e75696b24578861e0d14aa1c
 SHA512:
-  metadata.gz: 863a0c56ada01470ff55e655c8a1dfa2159d05aa3da5cf3107c7a48509ee31e292bd383955d4e45c2b5f1962f7ea659b5d893c6cd5a8d63fd4d72000b975f137
-  data.tar.gz: 9a1345ee740fbfcab5b984be2ecb9c6b57a23a715bd19e7cc77c002cc4e0a4115cb9eeed52c6cd1672f4ff7b6eb9c7082d4bc4173b5c5d3e37f2fa17db2bfce8
+  metadata.gz: f2f8e6b7cb709ec2db86696adf27ec64e9c5faf2c339248ef34cb31764155d11de7904e1e881b7a21ba933469ebbccee998db35748030544fd699cb41a2cd7e1
+  data.tar.gz: 79fcdcf90aae48eefdf83ed6e285114221047f007a15e7e5d3f5b357091b37f7f51e0778c6ad03f03caa0fa291666831f02a1459d426e522aef1f6c02b4b509d

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 # Changelog
 
+## [0.1.8] 2020-08-29
+
+### Changed/Added
+- Add new ways to declare selectors
+- Add steps
+
 ## [0.1.7] 2020-08-28
+
+### Changed/Added
 - Match selector condition by regexp or exact value
 
 ## [0.1.6] 2020-08-28
+
+### Changed/Added
 - Update activesupport requirement from = 6.0.2.1 to ~> 6.0
 - Fix bug when matching selector condition
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scrap_kit (0.1.7)
+    scrap_kit (0.1.8)
       activesupport (~> 6.0)
       watir (~> 6.16.5)
       webdrivers (~> 4.0)

data/README.md

@@ -81,6 +81,66 @@ output = recipe.run
 #=> {:posts=>[{:title=>"APIs de Internacionalización en JavaScript"}, {:title=>"Ejecutando comandos desde Ruby"}, {:title=>"Usando Higher-Order Components"}]}
 ```
 
+### Working with selectors
+
+Each attribute can be mapped to a selector, which can be any of the following types:
+
+* A string, which represents a CSS selector.
+
+```ruby
+".subnav__inner .ember-view:nth-child(1) > .status-summary__description"
+```
+
+* A hash, which can have any of the following options:
+  * `xpath: [String]`
+  * `css: [String]`
+  * `index: [Integer]`
+  * `tag_name: [String]`
+  * `text: [String]`
+
+```ruby
+{ text: "View Archive" }
+```
+
+* An array, which represents a path of selectors, where its last item must be a hash that matches a selector with an expected value.
+
+```ruby
+[".up-time-chart", { ".region-header .u-margin-Tm": "REGION" }]
+```
+
+Use any of them as it suits you best.
+
+### Writing steps
+
+Recipes can have a `steps` entry. This entry defines previous actions the scraper have to follow before extract the attributes. The following steps are supported:
+
+* **`goto`**: It instructs the scraper to go to a link inside the current page. Its value can be a hash or array selector, or a URL:
+
+```ruby
+{
+  goto: { text: "View Archive" }
+}
+```
+
+* **`click`**: It instructs the scraper to click on an element inside the current page. Its value can be a hash or array selector:
+
+```ruby
+{
+  click: { css: "[type=submit]" }
+}
+```
+
+* **`fill_form`**: It instructs the scraper to fill a form or any form field inside the current page. Its value is a hash where the keys are either a input's name or a CSS selector, and the values are the values to be entered into those fields:
+
+```ruby
+{
+  fill_form: {
+    gem_name: "ScrapKit",
+    author: "hpneo",
+  }
+}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/scrap_kit/recipe.rb

@@ -4,6 +4,20 @@ require "watir"
 
 module ScrapKit
   class Recipe
+    class << self
+      def load(source)
+        input = if source.is_a?(Hash)
+          source
+        elsif source.is_a?(IO)
+          JSON.parse(source.read)
+        else
+          JSON.parse(File.read(source))
+        end
+
+        new(input.deep_symbolize_keys)
+      end
+    end
+
     def initialize(url: nil, steps: [], attributes: {})
       @url = url
       @steps = steps
@@ -13,41 +27,61 @@ module ScrapKit
     def run
       output = {}
 
-      browser = Watir::Browser.new(:chrome, headless: true)
-      browser.goto @url
+      @browser = Watir::Browser.new(:chrome, headless: true)
+      @browser.goto @url
 
       @steps.each do |step|
-        run_step(browser, step)
+        run_step(step)
       end
 
       @attributes.each do |attribute_name, selector|
-        output[attribute_name] = extract_attribute(browser, selector)
+        output[attribute_name] = extract_attribute(@browser, selector)
       end
 
-      browser.close
-      browser = nil
+      @browser.close
+      @browser = nil
 
       output
     end
 
-    def run_step(browser, step)
+    def run_step(step)
+      return goto(step[:goto]) if step[:goto]
+      return click(step[:click]) if step[:click]
+      return fill_form(step[:fill_form]) if step[:fill_form]
+
+      nil
+    end
+
+    def find_element_by_name_or_selector(browser_or_element, name_or_selector)
+      element = browser_or_element.element(name: name_or_selector.to_s)
+      return element if element.exists?
+
+      element = browser_or_element.element(css: name_or_selector.to_s)
+      return element if element.exists?
+
+      nil
     end
 
     def elements_from_selector(browser_or_element, selector)
       if selector.is_a?(String)
         browser_or_element.elements(css: selector)
+      elsif selector.is_a?(Hash)
+        browser_or_element.elements(selector)
       elsif selector.is_a?(Array)
         *remainder, condition = selector
+        condition_key, condition_value = condition.first
         elements = browser_or_element
 
-        remainder.each do |item|
-          elements = elements.elements(css: item)
+        if remainder.empty?
+          elements = elements.elements(css: condition_key.to_s)
+        else
+          remainder.each do |item|
+            elements = elements.elements(css: item)
+          end
         end
 
         elements.filter do |element|
-          condition_key = condition.keys.first.to_s
-          condition_value = condition.values.first
-          found_element = element.element(css: condition_key)
+          found_element = element.element(css: condition_key.to_s)
           extracted_value = extract_value_from_element(found_element)
           extracted_value.match(condition_value) || extracted_value == condition_value
         end
@@ -64,36 +98,98 @@ module ScrapKit
       element&.text_content
     end
 
-    def extract_attribute(browser_or_element, selector_or_hash)
-      if selector_or_hash.is_a?(String)
-        extract_value_from_element(browser_or_element.element(css: selector_or_hash))
-      elsif selector_or_hash.is_a?(Hash)
-        selector = selector_or_hash[:selector]
-        selector_for_children_attributes = selector_or_hash[:children_attributes]
+    def extract_attribute(browser_or_element, selector_or_object)
+      if selector_or_object.is_a?(String)
+        extract_value_from_element(browser_or_element.element(css: selector_or_object))
+      elsif selector_or_object.is_a?(Array)
+        found_elements = elements_from_selector(browser_or_element, selector_or_object)
 
-        elements_from_selector(browser_or_element, selector).map do |element|
-          output = {}
+        if found_elements.size === 1
+          extract_value_from_element(found_elements.first)
+        else
+          found_elements.map do |element|
+            extract_value_from_element(element)
+          end
+        end
+      elsif selector_or_object.is_a?(Hash)
+        if selector_or_object[:selector] && selector_or_object[:children_attributes]
+          selector = selector_or_object[:selector]
+          selector_for_children_attributes = selector_or_object[:children_attributes]
 
-          selector_for_children_attributes.each do |child_attribute_name, child_selector|
-            output[child_attribute_name] = extract_attribute(element, child_selector)
+          elements_from_selector(browser_or_element, selector).map do |element|
+            output = {}
+
+            selector_for_children_attributes.each do |child_attribute_name, child_selector|
+              output[child_attribute_name] = extract_attribute(element, child_selector)
+            end
+
+            output
           end
+        else
+          found_elements = elements_from_selector(browser_or_element, selector_or_object)
+
+          if found_elements.size === 1
+            extract_value_from_element(found_elements.first)
+          else
+            found_elements.map do |element|
+              extract_value_from_element(element)
+            end
+          end
+        end
+      end
+    end
 
-          output
+    private
+
+    def goto(link_or_selector)
+      if link_or_selector.is_a?(String)
+        @browser.goto(link_or_selector)
+      elsif link_or_selector.is_a?(Array) || link_or_selector.is_a?(Hash)
+        if found_element = elements_from_selector(@browser, link_or_selector).first
+          found_element.click
         end
       end
+
+      sleep 0.5
+      @browser.wait_until do
+        @browser.ready_state == "complete"
+      end
+    rescue
+      nil
     end
 
-    class << self
-      def load(source)
-        input = if source.is_a?(Hash)
-          source
-        elsif source.is_a?(IO)
-          JSON.parse(source.read)
-        else
-          JSON.parse(File.read(source))
+    def click(selector)
+      if selector.is_a?(Array) || selector.is_a?(Hash)
+        if found_element = elements_from_selector(@browser, selector).first
+          found_element.click
         end
+      end
 
-        new(input.deep_symbolize_keys)
+      sleep 1
+      @browser.wait_until do
+        @browser.ready_state == "complete"
+      end
+
+    rescue
+      nil
+    end
+
+    def fill_form(form_data)
+      form_data.each do |name, value|
+        if element = find_element_by_name_or_selector(@browser.body, name.to_s)
+          element = element.to_subtype
+
+          if element.respond_to?(:set)
+            element.set(value)
+          elsif element.respond_to?(:select)
+            element.select(value)
+          end
+        end
+      end
+
+      sleep 0.25
+      @browser.wait_until do
+        @browser.ready_state == "complete"
       end
     end
   end

data/lib/scrap_kit/version.rb

@@ -1,3 +1,3 @@
 module ScrapKit
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrap_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Gustavo Leon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler