browserly 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f53fa92854c720723ff9cffdbb2e082b0119319b0e1be774d7c1fb8935c48d5c
-  data.tar.gz: 5b7e46847076cde7def8f31aebd8088e9d1eb372d855b0e40876fe3d947e35b8
+  metadata.gz: 864ffcdb27ce74199ab63cacc930eff3581253a1fabfbcbf8c98310eeeff2fbe
+  data.tar.gz: c10ed260d1d352e36b603226fd955b13850f009ce9205b0f20f38a240327a2fc
 SHA512:
-  metadata.gz: 312c8944b2adaf49f4e957c19037a088d664a6d57fce281447bf9be861e781940a0d88d01c8958616bb11c7d3a468107fcb843874dd3748f5d000c3b42172498
-  data.tar.gz: ba7099286f393e71685fd43112c8df6a9508a6ace23098d84fa254cc2750a288c062c3407c00f73027f238d924318e2ac0179a088a7193578a6b81fc0e9f52b8
+  metadata.gz: 941e32fcf720d90e5caa20013c84b2547d4206706853b82ee4ec1928983bb952eb39bbb31a0ae6159682fbfe2486c20b1448e76f5ec131a5769aa2239f1ba37f
+  data.tar.gz: 3903c22df8d2df3f215396bb43f9c712a79d6d580b1aecc7eceaf1db0bbe2f216be34c2a8838e3362d564ca73aa5091762fd79c4ef63d861b62fe13ca0bdba32

data/README.md

@@ -1,7 +1,8 @@
 # Browserly
-Is a simple tool that helps to create website screenshots using selenium + chrome driver. This gem creates pool of browsers thus increases speed of taking webpage screenshot.
+Is a simple tool that helps to create website screenshots using selenium + chrome driver. It also can work with remote selenium webdriver.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,8 +23,21 @@ $ gem install browserly
 
 ```ruby
 Browserly.configure do |config|
-  config.tmp_path = 'path/to/store/screenshots'
-  config.pool_size = 1 # count of browsers instance to start
+  config.output_dir = Rails.root.join('tmp', 'screenshots')
+  config.width = 1280
+  config.height = 780
+  config.remote_driver = true # default
+  config.remote_driver_url = "http://localhost:4444/wd/hub"
+  config.chrome_args = [
+    '--headless',
+    '--hide-scrollbars',
+    '--ignore-certificate-errors',
+    '--disable-popup-blocking',
+    '--disable-translate',
+    "--window-size=#{config.width},#{config.height}",
+    '--enable-font-antialiasing',
+    '--font-cache-shared-handle[6]'
+  ]
 end
 ```
 
@@ -34,8 +48,22 @@ screenshot = Browserly::Screenshot.new('http://example.com').perform
 screenshot.file #=> screenshot image file
 ```
 
+Also you can pass DOM ID as second parameter to get it height on the page. This height will be used as screenshot height.
+
+```ruby
+screenshot = Browserly::Screenshot.new('http://example.com', 'DOM_ID').perform
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to rubygems.org.
+
 ## Contributing
-Contribution directions go here.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/softeamco/browserly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/browserly.rb

@@ -1,8 +1,8 @@
-require 'singleton'
 require 'comandor'
 require 'selenium-webdriver'
+require 'browserly/errors/configuration_error'
 require 'browserly/configuration'
-require 'browserly/pool'
+require 'browserly/driver'
 require 'browserly/screenshot'
 require 'browserly/version'
 

data/lib/browserly/configuration.rb

@@ -1,9 +1,33 @@
 module Browserly
   class Configuration
-    attr_accessor :tmp_path
+    attr_accessor :output_dir,
+                  :width,
+                  :height,
+                  :remote_driver,
+                  :remote_driver_url,
+                  :chrome_args
 
     def initialize
-      @tmp_path = '../../tmp/screenshots'
+      @output_dir = File.join(Dir.tmpdir, 'siter_screenshots')
+
+      unless File.directory?(@output_dir)
+        FileUtils.mkdir_p(@output_dir)
+      end
+
+      @width = 1280
+      @height = 780
+      @remote_driver = true
+      @remote_driver_url = "http://localhost:4444/wd/hub"
+      @chrome_args = [
+        '--headless',
+        '--hide-scrollbars',
+        '--ignore-certificate-errors',
+        '--disable-popup-blocking',
+        '--disable-translate',
+        "--window-size=#{@width},#{@height}",
+        '--enable-font-antialiasing',
+        '--font-cache-shared-handle[6]'
+      ]
     end
   end
 end

data/lib/browserly/driver.rb

@@ -0,0 +1,33 @@
+module Browserly
+  class Driver
+    attr_reader :chrome_args, :driver
+
+    def initialize(remote, chrome_args)
+      @remote = remote
+      @chrome_args = chrome_args
+
+      return remote_driver if remote
+      local_driver
+    end
+
+    private
+
+    def local_driver
+      @driver = Selenium::WebDriver.for :chrome, options: options
+    end
+
+    def remote_driver
+      raise ConfigurationError, :remote_driver_url unless Browserly.configuration.remote_driver_url
+
+      caps = Selenium::WebDriver::Remote::Capabilities.chrome("chromeOptions" => options)
+
+      @driver = Selenium::WebDriver.for :remote,
+                              url: Browserly.configuration.remote_driver_url,
+                              desired_capabilities: caps
+    end
+
+    def options
+      { args: chrome_args }
+    end
+  end
+end

data/lib/browserly/errors/configuration_error.rb

@@ -0,0 +1,7 @@
+module Browserly
+  class ConfigurationError < StandardError
+    def message
+      "Config failed: #{super}"
+    end
+  end
+end

data/lib/browserly/screenshot.rb

@@ -3,36 +3,44 @@
 module Browserly
   class Screenshot
     extend Comandor
+    attr_reader :file
 
-    attr_reader :browser, :pool, :file, :selector
-
-    def initialize(url, selector = '')
+    def initialize(url, height_selector = '')
       @url = url
-      @pool = Browserly::Pool.instance
-      @browser = pool.take_browser
-      @selector = selector
+      @height_selector = height_selector
     end
 
     def perform
-      take_screenshot! && release_browser!
+      take! && close_session!
+    end
+
+    def driver
+      @driver ||= Browserly::Driver.new(Browserly.configuration.remote_driver, Browserly.configuration.chrome_args).driver
     end
 
     private
 
-    def take_screenshot!
-      browser.navigate.to @url
-      height = browser.execute_script(js) || 780
-      browser.manage.window.resize_to(1280, height)
-      @file = browser.save_screenshot(filename)
+    def take!
+      driver.navigate.to @url
+      @height = driver.execute_script(js) unless @height_selector.nil? || @height_selector == ''
+      @height ||= Browserly.configuration.height
+      driver.manage.window.resize_to(Browserly.configuration.width, @height)
+      @file = driver.save_screenshot(filename)&.path
+      return true if File.exist?(@file)
+      error(:file, 'Unable to save file')
+      false
     end
 
-    def release_browser!
-      pool.release!(browser)
+    def close_session!
+      return true if driver.close && driver.quit
+    rescue => e
+      error(:session, e.message)
+      false
     end
 
     def js
       <<-JAVASCRIPT
-        element = document.getElementById('#{selector}');
+        element = document.getElementById('#{@height_selector}');
 
         if(element != null) {
           return element.clientHeight;
@@ -43,7 +51,7 @@ module Browserly
     end
 
     def filename
-      File.join(Browserly.configuration.tmp_path, "#{Time.now.to_i}.png")
+      File.join(Browserly.configuration.output_dir, "#{Time.now.to_i}.png")
     end
   end
 end

data/lib/browserly/version.rb

@@ -1,3 +1,3 @@
 module Browserly
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browserly
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexander Selivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,30 +28,30 @@ dependencies:
   name: comandor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.141.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.141.0
 description: Website screenshot for Ruby uses Selenium with Chrome Driver
 email:
 - selivandex@gmail.com
@@ -64,7 +64,8 @@ files:
 - Rakefile
 - lib/browserly.rb
 - lib/browserly/configuration.rb
-- lib/browserly/pool.rb
+- lib/browserly/driver.rb
+- lib/browserly/errors/configuration_error.rb
 - lib/browserly/screenshot.rb
 - lib/browserly/version.rb
 homepage: http://github.com/softeamco/browserly

data/lib/browserly/pool.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Browserly
-  class Pool
-    include ::Singleton
-    attr_reader :browsers
-
-    def initialize
-      @browsers = SizedQueue.new(Browserly.configuration.pool_size)
-      Browserly.configuration.pool_size.times { @browsers.push(new_browser) }
-    end
-
-    def take_browser
-      @browsers.pop
-    end
-
-    def release!(browser)
-      @browsers.push(browser)
-    end
-
-    def terminate_all!
-      @browsers.each(&:quit)
-    end
-
-    private
-
-    def new_browser
-      options = Selenium::WebDriver::Chrome::Options.new(
-        args: [
-          '--headless',
-          '--hide-scrollbars',
-          '--ignore-certificate-errors',
-          '--disable-popup-blocking',
-          '--disable-translate',
-          '--window-size=1280,780',
-          '--enable-font-antialiasing',
-          '--font-cache-shared-handle[6]'
-        ]
-      )
-      Selenium::WebDriver.for :chrome, options: options
-    end
-  end
-end