vizreview 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9669457c4a826133190d6f8658e0289745cd93bda9c6faa1260bc7f0ef2fad02
-  data.tar.gz: b0005bbf4a2c71face463b967cc8a1bef84eb2bf138d3af23fc280cae4b4c1e7
+  metadata.gz: 5894a98186be334a2c6c510e8bc98ac5352b1fcf8c281e07fdbf5ca38a170e0a
+  data.tar.gz: d2168cd6f07e24c38674b4b35b409cf5cdec807bfabebaa78354fe5297dff4dc
 SHA512:
-  metadata.gz: 1d9da4a0b5034495db28d9f67e06c0221d48c82c1fd50160dc197b1f8f1df0f15204a093e6f7709156250cf5a310fb2267a185293a48d36b70d2bd7895343409
-  data.tar.gz: abd2ad062619ad0477fdd344d425ab27044d8f542b41f59c265bf8f8a105b58d7eeb85ba8822d89763e47d970626aa6f2687379f57eadd570c0d262af1a59a46
+  metadata.gz: 5a0404d5568b744c10acefb88420a0a7b67525b069858859322a83f365caa172dadfca5d08aa592b1661d8b3d2a2a152774e3ee1b7c15471ded40f5dbd6e9fb3
+  data.tar.gz: 78aa4f7a9181384fbc9e5b470511ce6eaa149da73f06dac13751ac8cb210eda7620fcff9850c791254d9cbbe64ecca880e72e66261104e839239ec4f374c6666

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in vizreview.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    vizreview (1.0.0)
+      chunky_png (~> 1.3.7)
+      typhoeus (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chunky_png (1.3.10)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vizreview!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,32 @@
+SOFTWARE DEVELOPMENT KIT (SDK) LICENSE AGREEMENT
+DEVELOPMENT KIT (SDK) LICENSE AGREEMENT
+
+This Software License Agreement (the "Agreement") governs use of the SDK by you, and/or the entity on whose behalf you are downloading the SDK ("you"). BY DOWNLOADING, INSTALLING, OR OTHERWISE ACCESSING OR USING THE SDK, YOU AGREE THAT YOU HAVE READ, UNDERSTOOD, AND AGREE TO BE BOUND BY THE AGREEMENT. IF YOU DO NOT AGREE, YOU MAY NOT USE THE SDK. Accordingly, you and VizReview acknowledge and agree as follows:
+
+1. LIMITED LICENSE. Subject to your complete and ongoing compliance with all the terms and conditions set forth in this Agreement, including without limitation all license limitations and restrictions set forth herein, VizReview grants you the following limited, non-exclusive, non-transferable, non-sublicensable, revocable licenses to:
+
+a. use, and (where applicable) authorize your employees to use, the Documentation internally solely in connection with developing your own branded applications that interoperate with the Service ("Applications");
+
+b. incorporate unmodified Libraries into your Application, solely for the purpose of enabling interoperability with the Service, solely in accordance with all applicable Documentation and applicable terms, and subject to you obtaining and maintaining an API key from VizReview, to distribute Libraries so incorporated in your compliant Application to end users in executable form (except and solely to the extent that the Libraries are written in a language that is traditionally delivered for runtime interpretation in source code form); and
+
+c. use, modify, and redistribute the Sample Code pursuant to the applicable open source license, as identified in the headers or associated Documentation.
+
+2. RESTRICTIONS. By accessing or using the SDK, you represent, warrant, and covenant that (a) you are a person or business entity engaged in the development of software applications, and (b) in the case of a business entity, you have the full power and authority to bind such entity to the terms of this Agreement. References to "you" herein shall refer to you, and/or the entity on whose behalf you are using the SDK, and all individual users of the SDK on behalf of such entity. You acknowledge that the foregoing license does not include any right to (i) redistribute, sell, lease, license, or modify any portion of the SDK, or (ii) distribute, deploy, or otherwise utilize Applications on a public, production, commercial, or other similar purpose other than internal use for evaluation and the development of non-public, experimental Applications (any other public, production, commercial, or similar use requires a separate agreement with VizReview), or (iii) use or implement any undocumented feature or API, or use any documented feature or API other than in accordance with applicable documentation. You may not reproduce, distribute, publicly display, or publicly perform any part of the SDK, except as provided herein or in the applicable open source license. Except if, and solely to the extent that, such a restriction is not authorized herein, or impermissible under applicable law or applicable Third Party Software (defined below) license terms, you may not (y) decompile, reverse engineer, or otherwise access or attempt to access the source code for the SDK not made available to you in source code form, or make or attempt to make any modification to the SDK; or (z) remove, obscure, interfere with or circumvent any feature of the SDK, including without limitation any copyright or other intellectual property notices, security, or access control mechanism. You may not use the SDK for any purpose other than interoperating with the Service in a manner for which the SDK and Service are expressly designed. If you are prohibited under applicable law from using the SDK, you may not use them, and you will comply with all applicable laws and regulations (including without limitation laws and regulations related to export controls) in connection with your use of the SDK. Without limiting the generality of the foregoing, you represent and warrant that the SDK will not be shipped, transferred or exported into any country or used in any manner prohibited by the United States Export Administration Act or any other export laws, restrictions or regulations (collectively the "Export Laws"). In addition, if the SDK is identified as export controlled items under the Export Laws, you represent and warrant that you are not a citizen, or otherwise located within, an embargoed nation (including without limitation Crimea, Cuba, Iran, North Korea, Sudan, or Syria and that you are not otherwise prohibited under the Export Laws from receiving the SDK. You may not use the SDK for any purpose, or use the SDK in the development of any Application that is for the purpose of lifesaving, emergency response, or otherwise for deployment in any circumstance in which failure would be likely to lead to property damage, environmental damage, personal injury, or death. ANY USE IN VIOLATION OF THE FOREGOING LIMITATIONS AND RESTRICTIONS IS STRICTLY PROHIBITED, AND UNLICENSED.
+
+3. RESERVATION OF RIGHTS. The SDK is owned by VizReview and licensed, not sold, to you. The SDK, content, visual interfaces, interactive features, information, graphics, design, compilation, computer code, products, services, and all other elements of the SDK and related documentation (the "VizReview Materials"), are protected by copyright, trade dress, patent, and trademark laws of the United States and other jurisdictions, international conventions, and all other relevant intellectual property and proprietary rights, and applicable laws. As between you and VizReview, all VizReview Materials, including intellectual property rights therein and thereto, are the sole and exclusive property of VizReview or its subsidiaries or affiliated companies and/or its third-party licensors. You may not to sell, license, distribute, copy, modify, publicly perform or display, transmit, publish, edit, adapt, create derivative works from, or make any use of the VizReview Materials except as expressly authorized hereunder. VizReview reserves all rights not expressly granted in this Agreement. You do not acquire any right, title or interest to the VizReview Materials, whether by implication, estoppel, or otherwise, except for the limited rights set forth in this Agreement.
+
+4. CONFIDENTIALITY. The SDK (including as embodied in or utilized by any Application) is the confidential and proprietary information of VizReview, and you may not, during the term or thereafter, disclose them to any third party, or to use them for any purpose other than as expressly provided herein, without a separate written agreement with VizReview authorizing you to do so.
+
+5. FEEDBACK. If you provide VizReview with any comments, bug reports, feedback, enhancements, or modifications proposed or suggested by you for the SDK or the Service ("Feedback"), such Feedback is provided on a non-confidential basis (notwithstanding any notice to the contrary you may include in any accompanying communication), and VizReview shall have the right to use such Feedback at its discretion, including, but not limited to the incorporation of such suggested changes into the VizReview Materials, SDK or Service. You hereby grant VizReview a perpetual, irrevocable, transferable, sublicensable, nonexclusive license under all rights necessary to so incorporate and use your Feedback for any purpose, including to make and sell products and services.
+
+6. THIRD PARTY SOFTWARE. The SDK consists of a package of components, including certain third party software ("Third Party Software") that are provided by their authors under separate license terms (the "Third Party Terms"), as described in more detail in the SDK. Your use of the Third Party Software in conjunction with the SDK in a manner consistent with this Agreement is permitted, however, you may have broader rights under the applicable Third Party Terms and nothing in this Agreement is intended to impose further restrictions on your use of the Third Party Software.
+
+7. TERM AND TERMINATION. This Agreement will remain in effect until terminated. The Agreement, and your rights and licenses hereunder, will terminate immediately upon your breach of the Agreement. You may terminate the Agreement by uninstalling and ceasing all use of the SDK. VizReview may terminate this Agreement at any time for any reason, including without limitation any actual or suspected misuse or abuse by you of the SDK or any violation of this Agreement. Following any termination of this Agreement, you must immediately uninstall and cease use of the SDK, and destroy all copies. Sections 2, 3, 4, 5, 6, 7, 8, 8, 9, 10, and 11 shall survive any termination of this Agreement.
+
+8. WARRANTY DISCLAIMER AND LIMITATION OF LIABILITY. THE SDK AND ALL ASSOCIATED DOCUMENTATION, LIBRARIES, AND SAMPLE CODE ARE PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, VizReview DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OR CONDITIONS OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, TITLE, QUALITY, RESULTS, AND NON-INFRINGEMENT. VizReview EXPRESSLY DISCLAIMS ANY WARRANTIES OF ANY KIND WITH RESPECT TO THE ACCURACY OR FUNCTIONALITY OF THE SDK, AND WITH RESPECT TO THE ACCURACY, VALIDITY, OR COMPLETENESS OF ANY INFORMATION OR FEATURES AVAILABLE THROUGH THE SDK, OR THE QUALITY OR CONSISTENCY OF THE SDK OR RESULTS OBTAINED THROUGH ITS USE. UNDER NO CIRCUMSTANCES WILL VizReview BE LIABLE FOR ANY CONSEQUENTIAL, SPECIAL, INDIRECT, INCIDENTAL OR PUNITIVE DAMAGES WHATSOEVER ARISING OUT OF THE USE OR INABILITY TO USE THE SDK, EVEN IF VizReview HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY. IN NO EVENT WILL VizReview'S AGGREGATE LIABILITY FOR DAMAGES ARISING OUT OF THIS AGREEMENT OR THE TERMS EXCEED THE GREATER OF AMOUNTS PAID BY YOU FOR THE SDK, IF ANY, OR $50USD. SOME JURISDICTIONS DO NOT ALLOW LIMITATIONS ON IMPLIED WARRANTIES OR THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, SO THE ABOVE LIMITATIONS MAY NOT APPLY TO YOU. IN SUCH AN EVENT THE ABOVE LIMITATIONS AND EXCLUSIONS WILL BE ENFORCED TO THE MAXIMUM EXTENT PERMITTED UNDER APPLICABLE LAW.
+
+9. INDEMNITY. You agree to indemnify, defend and hold VizReview and its affiliates, officers, directors, suppliers, licensors, and other customers harmless from and against any and all liability and costs, including reasonable attorneys' fees incurred by such parties, in connection with or arising out of your Applications, your use or misuse of the SDK, or your violation of this Agreement, any applicable law or regulation.
+
+10. GOVERNING LAW; VENUE. Any claim relating to the SDK or Service shall be governed by the laws of California, without regard to conflict of laws provisions. Disputes arising under this shall be resolved in, and subject to the sole and exclusive jurisdiction of the state and federal courts located in the Northern District of California.
+
+11. MISCELLANEOUS. This Agreement is the entire agreement between you and VizReview, and supersedes any and all prior agreements, negotiations, or other communications between you and VizReview, whether oral or written, with respect to the subject matter hereof, and, except as expressly provided herein, cannot be modified except in writing signed by both parties. In the event that any provision of this Agreement is held to be invalid or unenforceable, then: (a) such provision shall be deemed reformed to the extent strictly necessary to render such provision valid and enforceable, or if not capable of such reformation shall be deemed severed from this Agreement; and (b) the validity and enforceability of all of the other provisions hereof, shall in no way be affected or impaired thereby. You may not assign this Agreement without the prior written consent of VizReview, whether expressly or by operation of law, including in connection with a merger or change of control, and any such attempted assignment shall be void and of no effect. VizReview may assign this Agreement without restriction and without any notice to you. Subject to the foregoing, this Agreement shall be binding on the parties and their respective successors and permitted assigns. You acknowledge and understand that if VizReview is unable to provide the SDK as a result of a force majeure event VizReview will not be in breach of this Agreement. A force majeure event means any event beyond the control of VizReview. The failure to exercise, or delay in exercising, a right, power or remedy provided in this Agreement or by law shall not constitute a waiver of that right, power or remedy. VizReview's waiver of any obligation or breach of this Agreement shall not operate as a waiver of any other obligation or subsequent breach of the Agreement. The English language version of this Agreement shall be the official and controlling version, and any translation provided is solely for convenience. The SDK is a "Commercial Item" as that term is defined at 48 C.F.R. 2.101, consisting of "Commercial Computer Software" and "Commercial Computer Software Documentation." If and to the extent the SDK is supplied to or purchased by or on behalf of a United States government entity or an entity licensing the SDK for or on behalf of a United States government entity, the SDK is licensed (a) only as a Commercial Item and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions of this agreement.

data/lib/vizreview.rb

@@ -1,5 +1,16 @@
 require "vizreview/version"
+require 'vizreview/image'
+require 'vizreview/rectangle'
+require 'vizreview/screenshot_provider'
+require 'vizreview/browser'
+require 'vizreview/configuration'
+require 'vizreview/service'
+require 'vizreview/logger'
+require 'vizreview/client'
+require 'vizreview/snapshot'
+require 'vizreview/utils/git_utils'
+require 'vizreview/version_info_providers/git_provider'
+require 'vizreview/version_info_providers/provider_detector'
 
-module Vizreview
-  # Your code goes here...
+module VizReview
 end

data/lib/vizreview/browser.rb

@@ -0,0 +1,2 @@
+require_relative './browser/page_manager'
+require_relative './browser/info_provider'

data/lib/vizreview/browser/info_provider.rb

@@ -0,0 +1,39 @@
+module VizReview
+  module Browser
+    class InfoProvider
+      def initialize(driver)
+        @driver = driver
+      end
+
+      def page_rect
+        metrics = driver.execute_script(JS_GET_PAGE_METRICS).with_indifferent_access
+        max_width = [metrics[:scroll_width], metrics[:body_scroll_width]].max
+        max_height = [metrics[:body_client_height], metrics[:body_scroll_height]].max
+        return Rectangle.new(0, 0, max_width, max_height)
+      end
+
+      def pixel_ratio
+        driver.execute_script('return window.devicePixelRatio')
+      end
+
+      def browser_name
+        driver.browser.browser
+      end
+
+      private
+
+      attr_reader :driver
+
+      JS_GET_PAGE_METRICS = <<-JS.freeze
+        return {
+          scroll_width: document.documentElement.scrollWidth,
+          body_scroll_width: document.body.scrollWidth,
+          client_height: document.documentElement.clientHeight,
+          body_client_height: document.body.clientHeight,
+          scroll_height: document.documentElement.scrollHeight,
+          body_scroll_height: document.body.scrollHeight
+        };
+      JS
+    end
+  end
+end

data/lib/vizreview/browser/page_manager.rb

@@ -0,0 +1,49 @@
+module VizReview
+  module Browser
+    class PageManager
+      def initialize(driver)
+        @driver = driver
+      end
+
+      def screenshot
+        # currOverflow = scrollOverflow
+        # scrollOverflow = 'hidden' if hideScrollbars
+        img = driver.browser.screenshot_as(:png)
+        # scrollOverflow = currOverflow
+        Image.from_string(img)
+      end
+
+      def scroll_to(x, y)
+        driver.execute_script("window.scrollTo(#{x}, #{y})")
+      end
+
+      def hide_scrollbars
+        res = overflow = scroll_overflow
+        driver.execute_script('document.querySelector("html").style.overflow = "hidden";')
+        res = yield if block_given?
+        driver.execute_script("document.querySelector(\"html\").style.overflow = \"#{overflow}\";")
+        res
+      end
+
+      def apply_viewport(viewport)
+        curr_size = driver.browser.manage.window.size
+        return yield(curr_size.width, curr_size.height) if viewport.nil?
+        driver.browser.manage.window.resize_to(
+          viewport[:width] || curr_size.width, viewport[:height] || curr_size.height
+        )
+        new_size = driver.browser.manage.window.size
+        res = yield(new_size.width, new_size.height)
+        driver.browser.manage.window.resize_to(curr_size.width, curr_size.height)
+        res
+      end
+
+      private
+
+      attr_reader :driver
+
+      def scroll_overflow
+        driver.execute_script('return document.querySelector("html").style.overflow;')
+      end
+    end
+  end
+end

data/lib/vizreview/client.rb

@@ -0,0 +1,68 @@
+module VizReview
+  class Client
+    API_URL = 'https://app.vizreview.io'
+
+    class << self
+      attr_reader :config, :conn, :version_service, :version_id, :uploader,
+        :snapshot_service, :version_info_provider
+
+      def start
+        Logger.prefix = 'VizReview - '
+        @config = default_config
+        yield(config) if block_given?
+        Logger.level = config.log_level
+        raise 'Token not provided in VizReview::Client.start block' if config.token.nil?
+        auth = Service::Auth.new(config.token)
+        @conn = Service::APIConnection.new(url: config.api_url, auth: auth)
+        @version_info_provider = VersionInfoProviders::ProviderDetector.retrieve
+        @version_service = Service::Version.new(conn)
+        @uploader = Service::ParallelUploader.new(pool_size: 4)
+        @snapshot_service = Service::Snapshot.new(conn)
+        initiate_version!
+      end
+
+      def finish
+        raise 'VizReview client has not been started.' if version_id.nil?
+        uploader&.stop
+        version_service&.complete(version_id)
+      end
+
+      def capture!(driver, name:, viewport: nil)
+        raise 'VizReview client has not been started.' if version_id.nil?
+        viewport = config.default_viewport if viewport.nil?
+        viewport = [viewport] unless viewport.is_a?(Array)
+        driver = driver.driver if driver.respond_to?(:driver)
+        info_provider = Browser::InfoProvider.new(driver)
+        page_manager = Browser::PageManager.new(driver)
+        screenshot_provider = ScreenshotProvider.new(page_manager, info_provider)
+
+        # For each viewport, take a screenshot
+        snapshots = []
+        viewport.each do |vp|
+          snapshots << screenshot_provider.snap!(full: true, viewport: vp)
+        end
+
+        snapshots.each { |snapshot| upload_snapshot(name, snapshot) }
+      end
+
+      private
+
+      def initiate_version!
+        branch = version_info_provider.branch
+        version = version_service.create(branch)
+        @version_id = JSON.parse(version.body)['id']
+      end
+
+      def upload_snapshot(name, snapshot)
+        tmp = snapshot.image.save_temp
+        result = snapshot_service.create(version_id, snapshot: snapshot, name: name)
+        upload_url = JSON.parse(result.body)['uploadUrl']
+        uploader.upload(upload_url, tmp.path)
+      end
+
+      def default_config
+        Configuration.new(api_url: API_URL)
+      end
+    end
+  end
+end

data/lib/vizreview/configuration.rb

@@ -0,0 +1,11 @@
+module VizReview
+  class Configuration
+    attr_accessor :api_url, :token, :log_level, :default_viewport
+
+    def initialize(api_url:)
+      @api_url = api_url
+      @log_level = :fatal
+      @default_viewport = nil
+    end
+  end
+end

data/lib/vizreview/image.rb

@@ -0,0 +1,51 @@
+require 'chunky_png'
+
+module VizReview
+  class Image
+    class << self
+      def from_string(img_str)
+        stream = ::ChunkyPNG::Datastream.from_string(img_str)
+        image = ::ChunkyPNG::Image.from_datastream(stream)
+        new(image)
+      end
+
+      def create(width, height)
+        new(::ChunkyPNG::Image.new(width, height))
+      end
+    end
+
+    def initialize(image)
+      @image = image
+    end
+
+    def draw!(image, x ,y)
+      self.image.replace!(image.image, x, y)
+    end
+
+    def save_temp
+      tmp = Tempfile.new
+      image.save(tmp.path)
+      tmp
+    end
+
+    def to_blob
+      image.to_datastream.to_blob
+    end
+
+    def save(path)
+      image.save(path)
+    end
+
+    def width
+      image.width
+    end
+
+    def height
+      image.height
+    end
+
+    protected
+
+    attr_reader :image
+  end
+end

data/lib/vizreview/logger.rb

@@ -0,0 +1,39 @@
+module VizReview
+  class Logger
+    class << self
+      LOG_LEVELS = [:debug, :info, :warn, :fatal]
+
+      @level = :fatal
+
+      def level=(level)
+        raise ArgumentError.new('Invalid log level') unless level.to_sym.in?(LOG_LEVELS)
+        @level = level.to_sym
+      end
+
+      def log(msg)
+        puts "#{prefix}#{msg}".strip
+      end
+
+      def debug(msg)
+        return unless log?(:debug)
+        log("[DEBUG] #{msg}")
+      end
+
+      def prefix=(prefix)
+        @prefix = prefix
+      end
+
+      def prefix
+        @prefix || ''
+      end
+
+      private
+
+      def log?(level)
+        curr_index = LOG_LEVELS.index(@level)
+        level_index = LOG_LEVELS.index(level)
+        level_index >= curr_index
+      end
+    end
+  end
+end

data/lib/vizreview/rectangle.rb

@@ -0,0 +1,35 @@
+module VizReview
+  class Rectangle
+    OVERLAP = 4
+
+    attr_reader :x, :y, :width, :height
+
+    def initialize(x, y, width, height)
+      @x = x
+      @y = y
+      @width = width
+      @height = height
+    end
+
+    def subdivide(sub_width, sub_height)
+      rects = []
+      top = x
+      while (top < height)
+        bottom = [top + sub_height, height].min
+        left = y
+        while (left < width)
+          right = [left + sub_width, width].min
+          rects << Rectangle.new(
+            right - sub_width,
+            bottom - sub_height,
+            sub_width,
+            sub_height,
+          )
+          left += sub_width
+        end
+        top += sub_height
+      end
+      rects
+    end
+  end
+end

data/lib/vizreview/screenshot_provider.rb

@@ -0,0 +1,46 @@
+module VizReview
+  class ScreenshotProvider
+    def initialize(page, info_provider)
+      @page = page
+      @info_provider = info_provider
+    end
+
+    def snap!(full: true, viewport: nil)
+      page.hide_scrollbars do
+        page.apply_viewport(viewport) do |width, height|
+          img = full ? full_snap! : page.screenshot
+          Snapshot.new(
+            image: img,
+            viewport: { width: width, height: height },
+            browser: {
+              name: info_provider.browser_name,
+              version: nil,
+            },
+          )
+        end
+      end
+    end
+
+    private
+
+    def full_snap!
+      ratio = info_provider.pixel_ratio
+      rect = info_provider.page_rect
+
+      img = page.screenshot
+      sub_width = (img.width / ratio).round
+      sub_height = (img.height / ratio).round
+
+      base = Image.create(rect.width * ratio, rect.height * ratio)
+
+      rect.subdivide(sub_width, sub_height).each do |subrect|
+        page.scroll_to(subrect.x, subrect.y)
+        img = page.screenshot
+        base.draw!(img, subrect.x * ratio, subrect.y * ratio)
+      end
+      base
+    end
+
+    attr_reader :page, :info_provider
+  end
+end

data/lib/vizreview/service.rb

@@ -0,0 +1,12 @@
+require_relative './service/connection'
+require_relative './service/api_connection'
+require_relative './service/auth'
+require_relative './service/parallel_uploader'
+require_relative './service/google_uploader'
+require_relative './service/version'
+require_relative './service/snapshot'
+
+module VizReview
+  module Service
+  end
+end

data/lib/vizreview/service/api_connection.rb

@@ -0,0 +1,22 @@
+module VizReview
+  module Service
+    class APIConnection < Connection
+      def initialize(url:, auth:)
+        super(auth: auth)
+        @url = url
+      end
+
+      def post(path, body: nil, headers: {})
+        super("#{url}#{path}", body: body, headers: headers)
+      end
+
+      def put(path, body: nil, headers: {})
+        super("#{url}#{path}", body: body, headers: headers)
+      end
+
+      private
+
+      attr_reader :url
+    end
+  end
+end

data/lib/vizreview/service/auth.rb

@@ -0,0 +1,17 @@
+module VizReview
+  module Service
+    class Auth
+      def initialize(token)
+        @token = token
+      end
+
+      def headers
+        { 'Authorization' => "Bearer #{token}" }
+      end
+
+      private
+
+      attr_reader :token
+    end
+  end
+end

data/lib/vizreview/service/connection.rb

@@ -0,0 +1,34 @@
+require 'typhoeus'
+require 'json'
+
+module VizReview
+  module Service
+    class Connection
+      def initialize(auth: nil)
+        @auth = auth
+      end
+
+      def post(url, body: nil, headers: {}, verbose: false)
+        Logger.debug("POST #{url} - #{{ body: body.to_s[0..255], headers: headers }}")
+        res = Typhoeus.post(url, body: body, headers: headers.merge(auth_headers), verbose: verbose)
+        Logger.debug("Response (POST #{url}): { response_code: #{res.response_code}, body: #{res.body} }")
+        res
+      end
+
+      def put(url, body: nil, headers: {}, verbose: false)
+        Logger.debug("PUT #{url} - #{{ body: body.to_s[0..255], headers: headers }}")
+        res = Typhoeus.put(url, body: body, headers: headers.merge(auth_headers), verbose: verbose)
+        Logger.debug("Response (PUT #{url}): { response_code: #{res.response_code}, body: #{res.body} }")
+        res
+      end
+
+      private
+
+      attr_reader :auth
+
+      def auth_headers
+        auth&.headers || {}
+      end
+    end
+  end
+end

data/lib/vizreview/service/google_uploader.rb

@@ -0,0 +1,34 @@
+require 'thread'
+require 'digest'
+
+module VizReview
+  module Service
+    class GoogleUploader
+      def initialize(conn = Connection.new)
+        @conn = conn
+      end
+
+      def upload(url, image_path)
+        image_file = File.open(image_path, 'rb')
+        image = image_file.read
+        md5 = Digest::MD5.base64digest(image)
+
+        Logger.debug("GoogleUploader: Uploading image #{url} (md5: #{md5}, file_size: #{image_file.size})")
+        res = conn.put(url, body: image, headers: {
+          'Content-Type' => 'image/png',
+          'Content-MD5' => md5,
+          'Content-Length' => image_file.size.to_s,
+        })
+        if res.response_code == 200
+          Logger.debug("GoogleUploader: Uploaded image #{url}")
+        else
+          Logger.debug("GoogleUploader: Failed to upload image #{url} (#{res.response_code}) #{res.body}")
+        end
+      end
+
+      private
+
+      attr_reader :conn
+    end
+  end
+end

data/lib/vizreview/service/parallel_uploader.rb

@@ -0,0 +1,52 @@
+require 'thread'
+require 'uri'
+
+module VizReview
+  module Service
+    class ParallelUploader
+      DEFAULT_POOL_SIZE = 4
+      EXIT_CODE = 1
+
+      def initialize(pool_size: DEFAULT_POOL_SIZE)
+        @pool_size = pool_size
+        @queue = Queue.new
+        @workers = start_pool
+      end
+
+      def upload(url, image_path)
+        queue.push({ url: url, image_path: image_path })
+      end
+
+      def stop
+        Logger.debug("ParallelUploader: Stopping uploader pool...")
+        pool_size.times { queue.push(EXIT_CODE) }
+        @workers.each { |worker| worker.join }
+        Logger.debug("ParallelUploader: Uploader pool completely stopped")
+      end
+
+      private
+
+      attr_reader :pool_size, :workers, :queue
+
+      def start_pool
+        Logger.debug("ParallelUploader: Starting uploader pool (pool_size: #{pool_size})")
+        (1..pool_size).map do |index|
+          Logger.debug("ParallelUploader: Starting uploader thread ##{index}...")
+          Thread.new do
+            Logger.debug("ParallelUploader: Uploader thread ##{index} started")
+            begin
+              uploader = GoogleUploader.new
+              while (data = @queue.pop(false))
+                Logger.debug("ParallelUploader: Uploader thread ##{index} received #{data}")
+                break if data == EXIT_CODE
+                uploader.upload(data[:url], data[:image_path])
+              end
+            rescue ThreadError
+            end
+            Logger.debug("ParallelUploader: Uploader thread ##{index} exiting...")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vizreview/service/snapshot.rb

@@ -0,0 +1,33 @@
+require 'digest'
+
+module VizReview
+  module Service
+    class Snapshot
+      def initialize(conn)
+        @conn = conn
+      end
+
+      def create(version_id, snapshot:, name:)
+        md5 = Digest::MD5.base64digest(snapshot.image.to_blob)
+        conn.post('/snapshots/', body: {
+          versionId: version_id,
+          name: name,
+          width: snapshot.image.width,
+          height: snapshot.image.height,
+          viewport: snapshot.viewport,
+          browser: snapshot.browser,
+          contentType: 'image/png',
+          contentMd5: md5
+        })
+      end
+
+      def complete(id)
+        conn.put("/versions/#{id}/complete", body: { branch: branch })
+      end
+
+      private
+
+      attr_reader :conn
+    end
+  end
+end

data/lib/vizreview/service/version.rb

@@ -0,0 +1,23 @@
+module VizReview
+  module Service
+    class Version
+      def initialize(conn)
+        @conn = conn
+      end
+
+      def create(branch)
+        Logger.debug("Creating new version from branch #{branch}...")
+        conn.post('/versions/', body: { branch: branch })
+      end
+
+      def complete(id)
+        Logger.debug("Marking version #{id} as complete...")
+        conn.put("/versions/#{id}/complete")
+      end
+
+      private
+
+      attr_reader :conn
+    end
+  end
+end

data/lib/vizreview/snapshot.rb

@@ -0,0 +1,11 @@
+module VizReview
+  class Snapshot
+    attr_reader :image, :browser, :viewport
+
+    def initialize(image:, browser:, viewport:)
+      @image = image
+      @browser = browser
+      @viewport = viewport
+    end
+  end
+end

data/lib/vizreview/utils/git_utils.rb

@@ -0,0 +1,20 @@
+module VizReview
+  module Utils
+    class GitUtils
+      class << self
+        def installed?
+          res = `git rev-parse --git-dir 2> /dev/null`
+          !res.empty?
+        rescue
+          false
+        end
+
+        def branch
+          branch = `git symbolic-ref HEAD 2>/dev/null`
+          return nil if branch.empty?
+          branch.strip.gsub(/^refs\/heads\//, "")
+        end
+      end
+    end
+  end
+end

data/lib/vizreview/version.rb

@@ -1,3 +1,3 @@
 module Vizreview
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/vizreview/version_info_providers/git_provider.rb

@@ -0,0 +1,13 @@
+module VizReview
+  module VersionInfoProviders
+    class GitProvider
+      def initialize
+        raise 'Git must be initialized in the project' unless Utils::GitUtils.installed?
+      end
+
+      def branch
+        Utils::GitUtils.branch
+      end
+    end
+  end
+end

data/lib/vizreview/version_info_providers/provider_detector.rb

@@ -0,0 +1,11 @@
+module VizReview
+  module VersionInfoProviders
+    class ProviderDetector
+      class << self
+        def retrieve
+          GitProvider.new
+        end
+      end
+    end
+  end
+end

data/vizreview.gemspec

@@ -24,4 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "chunky_png", "~> 1.3.7"
+  spec.add_dependency "typhoeus", "~> 1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vizreview
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Felipe Correia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-31 00:00:00.000000000 Z
+date: 2018-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: 
 email:
 - info@vizreview.io
@@ -64,12 +92,35 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/vizreview.rb
+- lib/vizreview/browser.rb
+- lib/vizreview/browser/info_provider.rb
+- lib/vizreview/browser/page_manager.rb
+- lib/vizreview/client.rb
+- lib/vizreview/configuration.rb
+- lib/vizreview/image.rb
+- lib/vizreview/logger.rb
+- lib/vizreview/rectangle.rb
+- lib/vizreview/screenshot_provider.rb
+- lib/vizreview/service.rb
+- lib/vizreview/service/api_connection.rb
+- lib/vizreview/service/auth.rb
+- lib/vizreview/service/connection.rb
+- lib/vizreview/service/google_uploader.rb
+- lib/vizreview/service/parallel_uploader.rb
+- lib/vizreview/service/snapshot.rb
+- lib/vizreview/service/version.rb
+- lib/vizreview/snapshot.rb
+- lib/vizreview/utils/git_utils.rb
 - lib/vizreview/version.rb
+- lib/vizreview/version_info_providers/git_provider.rb
+- lib/vizreview/version_info_providers/provider_detector.rb
 - vizreview.gemspec
 homepage: http://vizreview.io
 licenses: []