vizzly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83c5bb29a091449d684562effec3161f0ddab82fe2be22b3d357cb66723d44b9
+  data.tar.gz: 1a97c02f6b0d670a6841d9536ee7fe434340b5ca210bf315f764a03e350e360c
+SHA512:
+  metadata.gz: 64a47f4a33270a9a82c4c1edbe267e4ef2eedd7f0f096859f28a306aa53d90401ffb3440cc5f7191a2138e2a6ac732dc1214b4d029c911e3d7d705f30a692056
+  data.tar.gz: f16bd4924bcfc9a2ddadbe0d639f01267853a1d2107dab97eb65e2d7ff1f01d63a21bd8db82a76cb4d1c281bacde9bc3fae38d194733dfb26f1f465a98ff68b3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Stubborn Mule Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Vizzly Ruby Client
+
+A lightweight Ruby client SDK for capturing screenshots and sending them to Vizzly for visual
+regression testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vizzly'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install vizzly
+```
+
+## Usage
+
+### Basic Usage
+
+```ruby
+require 'vizzly'
+
+# Take a screenshot
+image_data = File.binread('screenshot.png')
+Vizzly.screenshot('homepage', image_data)
+```
+
+### With Options
+
+```ruby
+Vizzly.screenshot('checkout-page', image_data,
+  properties: {
+    browser: 'chrome',
+    viewport: { width: 1920, height: 1080 }
+  },
+  threshold: 5
+)
+```
+
+### Using a Client Instance
+
+```ruby
+client = Vizzly::Client.new
+client.screenshot('login-form', image_data)
+
+# Check if client is ready
+puts "Ready: #{client.ready?}"
+
+# Get client info
+puts client.info
+```
+
+### Integration with Test Frameworks
+
+#### RSpec + Capybara
+
+```ruby
+RSpec.describe 'Homepage', type: :feature do
+  it 'displays the homepage correctly' do
+    visit '/'
+    expect(page).to have_content('Welcome')
+
+    # Take a screenshot for visual regression testing
+    image_data = page.driver.browser.screenshot_as(:png)
+    Vizzly.screenshot('homepage', image_data)
+  end
+
+  it 'displays the checkout page' do
+    visit '/checkout'
+    fill_in 'Email', with: 'test@example.com'
+
+    # Take a screenshot with properties
+    image_data = page.driver.browser.screenshot_as(:png)
+    Vizzly.screenshot('checkout-form', image_data,
+      properties: {
+        browser: 'chrome',
+        viewport: { width: 1920, height: 1080 }
+      }
+    )
+  end
+end
+```
+
+## Configuration
+
+The client automatically discovers a running Vizzly TDD server by looking for `.vizzly/server.json`
+in the current and parent directories.
+
+You can also configure via environment variables:
+
+- `VIZZLY_SERVER_URL` - Server URL (e.g., `http://localhost:47392`)
+- `VIZZLY_BUILD_ID` - Build identifier for grouping screenshots
+
+## Development
+
+After checking out the repo, run tests:
+
+```bash
+ruby test/vizzly_test.rb
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vizzly-testing/cli.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/vizzly.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'base64'
+
+# Vizzly visual regression testing client
+module Vizzly
+  class Error < StandardError; end
+
+  # Default port for local TDD server
+  DEFAULT_TDD_PORT = 47392
+
+  class Client
+    attr_reader :server_url, :disabled
+
+    def initialize(server_url: nil)
+      @server_url = server_url || discover_server_url
+      @disabled = false
+      @warned = false
+    end
+
+    # Take a screenshot for visual regression testing
+    #
+    # @param name [String] Unique name for the screenshot
+    # @param image_data [String] PNG image data as binary string
+    # @param options [Hash] Optional configuration
+    # @option options [Hash] :properties Additional properties to attach
+    # @option options [Integer] :threshold Pixel difference threshold (0-100)
+    # @option options [Boolean] :full_page Whether this is a full page screenshot
+    #
+    # @return [Hash, nil] Response data or nil if disabled/failed
+    #
+    # @example
+    #   client = Vizzly::Client.new
+    #   image_data = File.binread('screenshot.png')
+    #   client.screenshot('homepage', image_data)
+    #
+    # @example With options
+    #   client.screenshot('checkout', image_data,
+    #     properties: { browser: 'chrome', viewport: { width: 1920, height: 1080 } },
+    #     threshold: 5
+    #   )
+    def screenshot(name, image_data, options = {})
+      return nil if disabled?
+
+      unless @server_url
+        warn_once('Vizzly client not initialized. Screenshots will be skipped.')
+        disable!
+        return nil
+      end
+
+      image_base64 = Base64.strict_encode64(image_data)
+
+      payload = {
+        name: name,
+        image: image_base64,
+        buildId: ENV.fetch('VIZZLY_BUILD_ID', nil),
+        threshold: options[:threshold] || 0,
+        fullPage: options[:full_page] || false,
+        properties: options[:properties] || {}
+      }.compact
+
+      uri = URI("#{@server_url}/screenshot")
+
+      begin
+        response = Net::HTTP.start(uri.host, uri.port, read_timeout: 30) do |http|
+          request = Net::HTTP::Post.new(uri)
+          request['Content-Type'] = 'application/json'
+          request.body = JSON.generate(payload)
+          http.request(request)
+        end
+
+        unless response.is_a?(Net::HTTPSuccess)
+          error_data = begin
+            JSON.parse(response.body)
+          rescue JSON::ParserError, StandardError
+            {}
+          end
+
+          # In TDD mode with visual differences, log but don't raise
+          if response.code == '422' && error_data['tddMode'] && error_data['comparison']
+            comp = error_data['comparison']
+            diff_percent = comp['diffPercentage']&.round(2) || 0.0
+
+            # Extract port from server_url
+            port = begin
+              @server_url.match(/:(\d+)/)[1]
+            rescue StandardError
+              DEFAULT_TDD_PORT.to_s
+            end
+            dashboard_url = "http://localhost:#{port}/dashboard"
+
+            warn "⚠️  Visual diff: #{comp['name']} (#{diff_percent}%) → #{dashboard_url}"
+
+            return {
+              success: true,
+              status: 'failed',
+              name: comp['name'],
+              diffPercentage: comp['diffPercentage']
+            }
+          end
+
+          raise Error,
+                "Screenshot failed: #{response.code} #{response.message} - #{error_data['error'] || 'Unknown error'}"
+        end
+
+        JSON.parse(response.body)
+      rescue Error => e
+        # Re-raise Vizzly errors (like visual diffs)
+        raise if e.message.include?('Visual diff')
+
+        warn "Vizzly screenshot failed for #{name}: #{e.message}"
+
+        if e.message.include?('Connection refused') || e.is_a?(Errno::ECONNREFUSED)
+          warn "Server URL: #{@server_url}/screenshot"
+          warn 'This usually means the Vizzly server is not running or not accessible'
+          warn 'Check that the server is started and the port is correct'
+        elsif e.message.include?('404') || e.message.include?('Not Found')
+          warn "Server URL: #{@server_url}/screenshot"
+          warn 'The screenshot endpoint was not found - check server configuration'
+        end
+
+        # Disable the SDK after first failure to prevent spam
+        disable!('failure')
+
+        nil
+      rescue StandardError => e
+        warn "Vizzly screenshot failed for #{name}: #{e.message}"
+        disable!('failure')
+        nil
+      end
+    end
+
+    # Wait for all queued screenshots to be processed
+    # (Simple client doesn't need explicit flushing)
+    #
+    # @return [true]
+    def flush
+      true
+    end
+
+    # Check if the client is ready to capture screenshots
+    #
+    # @return [Boolean]
+    def ready?
+      !disabled? && !@server_url.nil?
+    end
+
+    # Disable screenshot capture
+    #
+    # @param reason [String] Optional reason for disabling
+    def disable!(reason = 'disabled')
+      @disabled = true
+      return if reason == 'disabled'
+
+      warn "Vizzly SDK disabled due to #{reason}. Screenshots will be skipped for the remainder of this session."
+    end
+
+    # Check if screenshot capture is disabled
+    #
+    # @return [Boolean]
+    def disabled?
+      @disabled
+    end
+
+    # Get client information
+    #
+    # @return [Hash] Client state information
+    def info
+      {
+        enabled: !disabled?,
+        server_url: @server_url,
+        ready: ready?,
+        build_id: ENV.fetch('VIZZLY_BUILD_ID', nil),
+        disabled: disabled?
+      }
+    end
+
+    private
+
+    def warn_once(message)
+      return if @warned
+
+      warn message
+      @warned = true
+    end
+
+    # Discover Vizzly server URL from environment or auto-discovery
+    def discover_server_url
+      # First check environment variable
+      return ENV['VIZZLY_SERVER_URL'] if ENV['VIZZLY_SERVER_URL']
+
+      # Then try auto-discovery
+      auto_discover_tdd_server
+    end
+
+    # Auto-discover local TDD server by checking for server.json
+    def auto_discover_tdd_server
+      dir = Dir.pwd
+      root = File.expand_path('/')
+
+      until dir == root
+        server_json_path = File.join(dir, '.vizzly', 'server.json')
+
+        if File.exist?(server_json_path)
+          begin
+            server_info = JSON.parse(File.read(server_json_path))
+            port = server_info['port'] || DEFAULT_TDD_PORT
+            return "http://localhost:#{port}"
+          rescue JSON::ParserError, Errno::ENOENT
+            # Invalid JSON or file disappeared, continue searching
+          end
+        end
+
+        dir = File.dirname(dir)
+      end
+
+      nil
+    end
+  end
+
+  class << self
+    # Get or create the shared client instance
+    #
+    # @return [Client]
+    def client
+      @client ||= Client.new
+    end
+
+    # Take a screenshot using the shared client
+    #
+    # @see Client#screenshot
+    def screenshot(name, image_data, options = {})
+      client.screenshot(name, image_data, options)
+    end
+
+    # Flush the shared client
+    #
+    # @see Client#flush
+    def flush
+      client.flush
+    end
+
+    # Check if the shared client is ready
+    #
+    # @see Client#ready?
+    def ready?
+      client.ready?
+    end
+
+    # Reset the shared client (useful for testing)
+    def reset!
+      @client = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: vizzly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vizzly
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-10-07 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight client SDK for capturing screenshots and sending them to
+  Vizzly for visual regression testing
+email:
+- support@vizzly.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/vizzly.rb
+homepage: https://github.com/vizzly-testing/cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vizzly-testing/cli
+  source_code_uri: https://github.com/vizzly-testing/cli
+  changelog_uri: https://github.com/vizzly-testing/cli/blob/main/clients/ruby/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Vizzly visual regression testing client for Ruby
+test_files: []