watchdoge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc87007d94c7fcac5e1eafccc71c3aae806adf2b3e7448a1f65e126bb10e049b
+  data.tar.gz: 1e194cbde4a75ecd82f365bff1be0e736c07b92e5555491e32ab20bda7a1412a
+SHA512:
+  metadata.gz: e27a802f2ea1a8b79d7ddf9638f3af28bacc90cbdf9a060d48e42c646ff334aae9431e0b898ef6c23d8311db2af06826edff0b321f393f3d652f8d4927cd639a
+  data.tar.gz: 50bd1bc2d8c3e21deb6e8bb112d2c1f68f3d518017d55be020617fd938dae623a41b99b89f46f0a55cec83e24b7d40783303a50d5a2cd71b155ecbde718c26aa

data/.gitignore

@@ -0,0 +1,3 @@
+.doge_cookie/
+.webdrivers/
+lib/test.rb

data/lib/watchdoge/configuration.rb

@@ -0,0 +1,28 @@
+require 'watir'
+
+module WatchDoge
+  class Configuration
+    attr_accessor :base_dir
+    attr_accessor :web_drivers_dir
+    attr_accessor :engine
+    attr_accessor :cookie_pool
+    attr_accessor :notifications
+
+    def initialize
+      @base_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+
+      @web_drivers_dir = @base_dir + "/.webdrivers"
+
+      # cuurently using local fs, probably support NoSQL also maybe?
+      @cookie_pool = @base_dir + '/.doge_cookie'
+
+      @engine = Watir::Browser
+
+      @notifications = {
+        # slack: {
+        #   incoming_url: SLACK_WEBHOOK
+        # }
+      }
+    end
+  end
+end

data/lib/watchdoge/cookie_pool.rb

@@ -0,0 +1,25 @@
+require 'yaml'
+require 'digest'
+
+module WatchDoge
+  module CookiePool
+    class << self
+      def source uuid, uri = nil
+        suffix = "_#{Digest::MD5.hexdigest(uri.to_s)[0..5]}" if uri
+
+        "#{WatchDoge.configuration.cookie_pool}/#{uuid}#{suffix}"
+      end
+
+      # TODO: implement these two methods return Cookie object in future.
+      # def save uuid, json
+      #   File.write source(uuid), json
+      # end
+
+      # def load uuid
+      #   return "" unless File.exist? source(uuid)
+
+      #   JSON.parse File.read(source(uuid))
+      # end
+    end
+  end
+end

data/lib/watchdoge/image_diff.rb

@@ -0,0 +1,32 @@
+module WatchDoge
+  module ImageDiff
+    OPACITY = 0.6
+    HIGHLIGHT_COLOR = "#F163FF#{(OPACITY * 256).to_i.to_s(16).upcase}"
+
+    class << self
+      def diff input_image, golden_image
+        return nil if input_image.pixels.hash == golden_image.pixels.hash
+
+        input_image.height.times do |y|
+          pixels = input_image.row(y)
+
+          if y >= golden_image.height
+            pixels.each_with_index do |pixel, x|
+              input_image.compose_pixel(x, y, HIGHLIGHT_COLOR)
+            end
+          else
+            golden_pixels = golden_image.row(y)
+
+            next if (pixels.hash == golden_pixels.hash)
+
+            pixels.each_with_index do |pixel, x|
+              input_image.compose_pixel(x, y, HIGHLIGHT_COLOR) if pixels[x] != golden_pixels[x]
+            end
+          end
+        end
+
+        input_image
+      end
+    end
+  end
+end

data/lib/watchdoge/install.rb

@@ -0,0 +1,15 @@
+require 'net_http_ssl_fix'
+require 'webdrivers'
+
+module WatchDoge
+  class << self
+    def install
+      Webdrivers.install_dir = configuration.web_drivers_dir
+
+      # TODO: Support other browser maybe?
+      Webdrivers::Geckodriver.update
+
+      Dir.mkdir configuration.cookie_pool unless File.directory? configuration.cookie_pool
+    end
+  end
+end

data/lib/watchdoge/notification/slack.rb

@@ -0,0 +1,40 @@
+require 'chunky_png'
+require 'json'
+require 'net/http'
+require 'uri'
+
+module WatchDoge
+  module Notification
+    class Slack
+      def initialize opt
+        @incoming_url = opt[:incoming_url]
+      end
+
+      def push message
+        body = _slack_body(message).to_json
+        Net::HTTP.post URI(@incoming_url),
+                       body,
+                       "Content-Type" => "application/json"
+      end
+
+      private
+
+      def _slack_body message
+        case message
+        when String
+          {
+            text: message
+          }
+        when ChunkyPNG::Image
+          data = ['data:image/png;base64,', message.to_blob].pack('A*m').gsub(/\n/, '')
+
+          {
+            attachments: [{
+              image_url: data
+            }]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/watchdoge/notification.rb

@@ -0,0 +1,28 @@
+module WatchDoge
+  module Notification
+    Dir["#{File.expand_path File.dirname(__FILE__)}/notification/*.rb"].each {|file| require file }
+
+    class << self
+      def push message
+        sources =  WatchDoge.configuration.notifications
+
+        raise "can't find notification sources in configuration" if sources.empty?
+
+        sources.each do |source_sym, source_args|
+          source_class = get_source_class source_sym
+          source = source_class.new source_args
+          source.push message
+        end
+      end
+
+      private
+
+      def get_source_class source_sym
+        case source_sym
+        when :slack
+          WatchDoge::Notification::Slack
+        end
+      end
+    end
+  end
+end

data/lib/watchdoge/version.rb

@@ -0,0 +1,3 @@
+module WatchDoge
+  Version = '0.0.1'
+end

data/lib/watchdoge/worker.rb

@@ -0,0 +1,118 @@
+module WatchDoge
+  module PDFUtil
+    def pdf_screenshot
+      # no such thing as on_loaded for gecko pdf-viewer
+      sleep 3
+
+      firefox_pdf_viewer_id = 'viewer'
+      firefox_scaler_id = 'scaleSelect'
+      scale_factor = '0.75'
+
+      #resize to 75%
+      @core.select({id: firefox_scaler_id}).select(scale_factor)
+
+      fullpage_screenshot({id: firefox_pdf_viewer_id})
+    end
+  end
+
+  class Worker
+    include WatchDoge::PDFUtil
+
+    def initialize uuid, opt={}
+      _before_initialize
+
+      @uuid = uuid
+
+      default_opt = {
+        width: 1024,
+        height: 768,
+        headless: true
+      }.merge(opt)
+
+      @core = WatchDoge.configuration.engine.new :firefox, default_opt
+
+      # for generate uri hash
+      @landed_page = nil
+
+      # flag that cookie is loaded
+      @cookie_loaded = false
+
+      @width = default_opt[:width]
+      @height = default_opt[:height]
+
+      # initilize width/height
+      @core.window.resize_to @width, @height
+
+      _after_initialize
+    end
+
+    def fullpage_screenshot **kwargs
+      _resize_by_document(kwargs) do
+        return @core.screenshot
+      end
+    end
+
+    def close
+      _save_cookie
+      @core.close
+    end
+
+    def goto uri
+      @core.goto uri
+
+      @landed_page = uri
+
+      _load_cookie unless _cookie_loaded?
+
+      @core.refresh
+    end
+
+    # for dev only
+    def core
+      @core
+    end
+
+    private
+    # callbacks before/after init
+    def _before_initialize
+      Selenium::WebDriver::Firefox::Service.driver_path = WatchDoge.configuration.web_drivers_dir + "/geckodriver"
+    end
+    def _after_initialize
+    end
+
+    # for cookie load/save
+    def _cookie_loaded?
+      @cookie_loaded
+    end
+    def _save_cookie
+      @core.cookies.save WatchDoge::CookiePool.source(@uuid, @landed_page)
+    end
+    def _load_cookie
+      source = WatchDoge::CookiePool.source(@uuid, @landed_page)
+      return unless File.exist? source
+
+      @core.cookies.load source
+      @cookie_loaded = true
+    end
+
+    def _resize_by_document **kwargs
+      target =
+        if kwargs.empty?
+          @core.body
+        else
+          @core.element(**kwargs)
+        end
+
+      @core.window.resize_to [target.width, 5000].min, [target.height, 20000].min
+      yield
+      @core.window.resize_to @width, @height
+    end
+
+    # try delegate all methods to @core
+    def method_missing(method_name, *args)
+      result = @core.__send__(method_name, *args)
+
+      result
+    end
+  end
+end

data/lib/watchdoge.rb

@@ -0,0 +1,25 @@
+require 'pry'
+require 'watchdoge/install'
+require 'watchdoge/version'
+require 'watchdoge/configuration'
+require 'watchdoge/cookie_pool'
+require 'watchdoge/worker'
+require 'watchdoge/notification'
+require 'watchdoge/image_diff'
+
+module WatchDoge
+  class << self
+    def base_dir
+      configuration.base_dir
+    end
+
+    def configure(&block)
+      yield(configuration)
+      configuration
+    end
+
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+  end
+end

data/watchdoge.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'watchdoge'
+  s.version     = '0.0.1'
+  s.date        = '2019-07-22'
+  s.summary     = "dogi"
+  s.description = "A collection of web test tools"
+  s.authors     = ["Shen Lee"]
+  s.email       = 'no-reply@gmail.com'
+  s.files       = ["lib/watchdoge.rb"]
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ["lib"]
+
+  s.add_dependency "chunky_png", "~> 1.3", "> 1.3.10"
+  s.add_dependency "net_http_ssl_fix", "~> 0.0.10"
+  s.add_dependency "webdrivers", "~> 4.1", "> 4.1.0"
+  s.add_dependency "watir", "~> 6.16", "> 6.16.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: watchdoge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shen Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: net_http_ssl_fix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.16.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.16.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.16'
+description: A collection of web test tools
+email: no-reply@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- lib/watchdoge.rb
+- lib/watchdoge/configuration.rb
+- lib/watchdoge/cookie_pool.rb
+- lib/watchdoge/image_diff.rb
+- lib/watchdoge/install.rb
+- lib/watchdoge/notification.rb
+- lib/watchdoge/notification/slack.rb
+- lib/watchdoge/version.rb
+- lib/watchdoge/worker.rb
+- watchdoge.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: dogi
+test_files: []