kleya 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 272b77784c8f74811be0db9402ff4694220c0a212ca4d6af53e6b61ff2398df0
-  data.tar.gz: bb4451a8bb5bea56482ef1c48ae02b321da627218569fcca09ecd5c3d0b18b69
+  metadata.gz: eff98e2f9f6d36b1f9813df9531b6649f5791a7ebba7ba2597420165b17b1d1b
+  data.tar.gz: caafa5e7331acdfff97559ff5074d0fea116646a5913b53d6b3f142165682779
 SHA512:
-  metadata.gz: 74262f4d700dc1d2d1c3e5e224801e8e95bdb55d47326167ba6a4d8154139e89a08d92a2a8ddd95b3e4af2ef01d5bf0ff12d5529213f57f963771864ffb363c4
-  data.tar.gz: e1635c52e75051a00528aa59f4b70d58a28d7993ab1f1d414f60de869ed569198b3ccd726182393fc5169d31d1af4317aa0ab2a7d1b67c4f6c8b0a3d8db524da
+  metadata.gz: 9b3c354440ef1e46573c81ef777297185ce85bdced9ac521e52e170476c0fd8e0ac71400952d19bc82b71a865de27d5607ecf1f9501ff2803f78569308424971
+  data.tar.gz: 2cf4bcd76e4a2de54dd4b2a7363c10bfeb93195fdaa7d4a4c7846ffe1e372e45a512d5e9243da08eeb40053e95295dc1feae3e361f2e7260fefd8e4b9ea68367

data/README.md

@@ -56,7 +56,7 @@ browser.quit
 
 Kleya includes convenient viewport presets for social media platforms and common devices. You can pass any of the following values when initializing a browser instance.
 
-- `desktop`: default (1920x1080)
+- `desktop` default (1920x1080)
 
 - `x` (1200x675)
 - `facebook` (1200x630)
@@ -109,9 +109,10 @@ Kleya.capture('https://www.hellotext.com')
 
 Alongside the options you pass for the instance, there's some extra configurable settings you can tweak to your usecase.
 
-- `format`: specifies the format of the image captures, i.e `jpeg` or `png`.
-- `encoding`: specifies the encoding of the image, possible options is `binary` or `base64` (default). Regardless, the `Kleya::Artifact` object responds to `#binary` and `base64` when needed.
-- `quality`: an integer between 1 - 100 that determines the quality of the final image, higher quality images result in bigger sizes and may not work correctly in some situations such as the Open Graph (OG) protocol, you can tweak and test this. Defaults to `90`.
+- `format` specifies the format of the image captures, i.e `jpeg` or `png`.
+- `encoding` specifies the encoding of the image, possible options is `binary` or `base64` (default). Regardless, the `Kleya::Artifact` object responds to `#binary` and `base64` when needed.
+- `quality` an integer between 1 - 100 that determines the quality of the final image, higher quality images result in bigger sizes and may not work correctly in some situations such as the Open Graph (OG) protocol, you can tweak and test this. Defaults to `90`.
+- `area` specifies the area of the browser to capture, defaults to `viewport` for capturing only the visible part of the page. Supported values are `viewport` and `page` for full-page screenshots.
 
 ```ruby
 artifact = browser.capture('https://example.com', format: :jpeg, quality: 85, encoding: :base64)
@@ -181,12 +182,10 @@ end
 ## Roadmap
 
 - Wait strategies (`wait_for: '.element'`, `wait_until: :network_idle`)
-- Full page screenshots (not just viewport)
 - Built-in retry mechanism with configurable delays
 
 - Memory usage optimization for large batches
 - Request blocking (ads, analytics, fonts)
-- Custom user agents for mobile rendering
 
 - CLI tool for quick captures (`kleya capture https://example.com`)
 - Debug mode with browser preview

data/lib/kleya/browser.rb

@@ -30,6 +30,7 @@ module Kleya
     # @option options [Symbol] :format (:jpeg) image format (:jpeg, :png)
     # @option options [Integer] :quality (90) JPEG quality (1-100)
     # @option options [Symbol] :encoding (:base64) output encoding
+    # @option options [Symbol] :area (:viewport) the area to capture (:viewport, :page)
     # @return [Artifact] the screenshot artifact
     # @example Taking a X-optimized screenshot
     #   browser = Kleya::Browser.new(
@@ -43,12 +44,9 @@ module Kleya
       format = options[:format] || :jpeg
       quality = options[:quality] || 90
       encoding = options[:encoding] || :base64
+      full = options[:area] == :page
 
-      data = browser.screenshot(
-        format: format,
-        quality: quality,
-        encoding: encoding
-      )
+      data = browser.screenshot(format:, quality:, encoding:, full:)
 
       Artifact.new(data:, url:, viewport: @viewport, format:, quality:, encoding:)
     rescue Ferrum::TimeoutError

data/test/browser_test.rb

@@ -61,7 +61,7 @@ class BrowserTest < Minitest::Test
       @mock_ferrum.expect :goto, nil, ['https://example.com']
       # The screenshot method receives keyword arguments as a hash
       @mock_ferrum.expect :screenshot, 'fake_image_data' do |args|
-        args == { format: :jpeg, quality: 90, encoding: :base64 }
+        args == { format: :jpeg, quality: 90, encoding: :base64, full: false }
       end
 
       artifact = browser.capture('https://example.com')
@@ -84,7 +84,7 @@ class BrowserTest < Minitest::Test
       @mock_ferrum.expect :goto, nil, ['https://example.com']
       # The screenshot method receives keyword arguments as a hash
       @mock_ferrum.expect :screenshot, 'fake_png_data' do |args|
-        args == { format: :png, quality: 100, encoding: :binary }
+        args == { format: :png, quality: 100, encoding: :binary, full: false }
       end
 
       artifact = browser.capture('https://example.com',
@@ -100,6 +100,25 @@ class BrowserTest < Minitest::Test
 
     @mock_ferrum.verify
   end
+  
+  def test_capture_with_full_area
+    browser = Kleya::Browser.new
+
+    Ferrum::Browser.stub :new, @mock_ferrum do
+      @mock_ferrum.expect :goto, nil, ['https://example.com']
+      # The screenshot method receives keyword arguments as a hash
+      @mock_ferrum.expect :screenshot, 'fake_full_image_data' do |args|
+        args == { format: :jpeg, quality: 90, encoding: :base64, full: true }
+      end
+
+      artifact = browser.capture('https://example.com', area: :page)
+
+      assert_instance_of Kleya::Artifact, artifact
+      assert_equal('fake_full_image_data', artifact.instance_variable_get(:@data))
+    end
+
+    @mock_ferrum.verify
+  end
 
   def test_capture_handles_timeout_error
     browser = Kleya::Browser.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kleya
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Hellotext
 - Ahmed Khattab
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest