puppeteer_entity 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 633fdd774eaaa00ceb3fe75f627b18f247839546a278bd8a978b2a6dc9bbc4b1
+  data.tar.gz: 89e521f5f856dbfba6dffc1d57de071a743b9a2708ef02a3831fef4b66dcc3e8
+SHA512:
+  metadata.gz: fb2bf515eaa92f4b89375be8aef47568c1aca6727016ba9b23c04ae0795fd19f79752c029a719743bc17f1e6d08dff58179a5d32e238de77822c1550f1da844c
+  data.tar.gz: ac8b09ae2c7a883aa271a0500400fbb4ea80bff89d9ebea18f11e4f565fdf869218b6e983b669f21e16cebdc31345f992af166b48408ba78b9c21658d82261eb

data/.rubocop.yml

@@ -0,0 +1,13 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+# Overwrite or add rules to create your own house style
+#
+# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+# Layout/SpaceInsideArrayLiteralBrackets:
+#   Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: always
+
+AllCops:
+  TargetRubyVersion: 3.3.5

data/.ruby-version

@@ -0,0 +1 @@
+3.3.5

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## 0.1.1
+
+* Drop support for Ruby < 3.1
+
+## 0.1.0
+
+* First release, yay!

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tomáš Celizna
+
+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,39 @@
+# PuppeteerEntity
+
+[![Test](https://github.com/tomasc/puppeteer_entity/actions/workflows/test.yml/badge.svg)](https://github.com/tomasc/puppeteer_entity/actions/workflows/test.yml)
+
+`PuppeteerEntity` is a Ruby gem that provides a simple and intuitive interface for interacting with Puppeteer, a headless Chrome browser. It allows you to take screenshots, capture content, and perform other actions on web pages.
+
+## Installation
+
+To install PuppeteerEntity, add it to your application's Gemfile and run `bundle install`:
+
+```bash
+bundle add puppeteer_entity
+```
+
+If you're not using Bundler, you can install the gem directly:
+
+```bash
+gem install puppeteer_entity
+```
+
+## Usage
+
+To use PuppeteerEntity, create a new instance of the `PuppeteerEntity::Screenshot` or `PuppeteerEntity::Content` class, passing the necessary arguments. Then, call the `response` method on the instance to get the HTTP response.
+
+```ruby
+args = { url: "https://example.com" }
+entity = PuppeteerEntity::Screenshot.new(args)
+response = entity.response
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/puppeteer_entity.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/docker-compose.yml

@@ -0,0 +1,7 @@
+services:
+  browserless:
+    image: ghcr.io/browserless/chromium:v2.21.1
+    ports:
+      - "4444:3000"
+    environment:
+      - MAX_CONCURRENT_SESSIONS=10

data/lib/puppeteer_entity/attributes/authenticate.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Authenticate < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :username, Types::Coercible::String
+      attribute :password, Types::Coercible::String
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/content.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Content < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute? :add_script_tag, Types::Array do
+        attributes_from Attributes::ScriptTag
+      end
+
+      attribute? :add_style_tag, Types::Array do
+        attributes_from Attributes::StyleTag
+      end
+
+      attribute? :authenticate do
+        attributes_from Attributes::Authenticate
+      end
+
+      # When bestAttempt is set to true, browserless attempt to proceed when "awaited" events fail or timeout. This includes things like goto, waitForSelector, and more.
+      attribute? :best_attempt, Types::Bool.optional
+
+      attribute? :cookies, Types::Array do
+        attributes_from Attributes::Cookie
+      end
+
+      attribute? :emulate_media_type, Types::Coercible::String.optional
+
+      attribute? :goto_options do
+        attributes_from Attributes::GotoOptions
+      end
+
+      attribute? :html, Types::Coercible::String.optional
+
+      attribute? :reject_request_pattern, Types::Array.of(Types::String).optional
+      attribute? :reject_resource_types, Types::Array.of(Types::Coercible::String.enum("cspviolationreport", "document", "eventsource", "fetch", "font", "image", "manifest", "media", "other", "ping", "prefetch", "preflight", "script", "signedexchange", "stylesheet", "texttrack", "websocket", "xhr")).optional
+      attribute? :request_interceptors, Types::Array.optional
+
+      attribute? :set_extra_http_headers, Types::Array.optional
+      attribute? :set_java_script_enabled, Types::Bool.optional
+
+      attribute? :url, Types::URL.optional
+      attribute? :user_agent, Types::Coercible::String.optional
+
+      attribute? :viewport do
+        attributes_from Attributes::Viewport
+      end
+
+      attribute? :wait_for_event do
+        attributes_from Attributes::WaitForEvent
+      end
+
+      attribute? :wait_for_function do
+        attributes_from Attributes::WaitForFunction
+      end
+
+      attribute? :wait_for_selector do
+        attributes_from Attributes::WaitForSelector
+      end
+
+      attribute? :wait_for_timeout, Types::Coercible::Integer.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/cookie.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Cookie < Dry::Struct
+      transform_keys(&:to_sym)
+      attribute :name, Types::Coercible::String
+      attribute :value, Types::Coercible::String
+      # The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
+      attribute? :url, Types::URL.optional
+      attribute? :domain, Types::Coercible::String.optional
+      attribute? :path, Types::Coercible::String.optional
+      attribute? :secure, Types::Bool.optional
+      attribute? :http_only, Types::Bool.optional
+      attribute? :same_site, Types::Coercible::String.enum("Lax", "None", "Strict").optional
+      attribute? :expires, Types::Coercible::Integer.optional
+      attribute? :priority, Types::Coercible::String.enum("High", "Low", "Medium").optional
+      attribute? :same_party, Types::Bool.optional
+      attribute? :source_scheme, Types::Coercible::String.enum("NonSecure", "Secure", "Unset").optional
+      # Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port. An unspecified port value allows protocol clients to emulate legacy cookie scope for the port. This is a temporary ability and it will be removed in the future.
+      attribute? :source_port, Types::Coercible::Integer.optional
+      # Cookie partition key. The site of the top-level URL the browser was visiting at the start of the request to the endpoint that set the cookie. If not set, the cookie will be set as not partitioned.
+      attribute? :partition_key, Types::Coercible::String.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/goto_options.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class GotoOptions < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # If provided, it will take preference over the referer header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.
+      attribute? :referer, Types::Coercible::String.optional
+      # If provided, it will take preference over the referer-policy header value set by {@link Page.setExtraHTTPHeaderspage.setExtraHTTPHeaders()}.
+      attribute? :referrer_policy, Types::Coercible::String.optional
+      # Maximum wait time in milliseconds. Pass 0 to disable the timeout.
+      # The default value can be changed by using the {@link Page.setDefaultTimeout} or {@link Page.setDefaultNavigationTimeout} methods.
+      attribute? :timeout, Types::Coercible::Integer.optional
+      # When to consider waiting succeeds. Given an array of event strings, waiting is considered to be successful after all events have been fired.
+      attribute? :wait_until, Types::Array.of(Types::Coercible::String.enum("domcontentloaded", "load", "networkidle0", "networkidle2")).optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/pdf.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Pdf < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute? :add_script_tag, Types::Array do
+        attributes_from Attributes::ScriptTag
+      end
+
+      attribute? :add_style_tag, Types::Array do
+        attributes_from Attributes::StyleTag
+      end
+
+      attribute? :authenticate do
+        attributes_from Attributes::Authenticate
+      end
+
+      # When bestAttempt is set to true, browserless attempt to proceed when "awaited" events fail or timeout. This includes things like goto, waitForSelector, and more.
+      attribute? :best_attempt, Types::Bool.optional
+
+      attribute? :block_modals, Types::Bool.optional
+
+      attribute? :cookies, Types::Array do
+        attributes_from Attributes::Cookie
+      end
+
+      attribute? :emulate_media_type, Types::Coercible::String.optional
+
+      attribute? :goto_options do
+        attributes_from Attributes::GotoOptions
+      end
+
+      attribute? :html, Types::Coercible::String.optional
+
+      attribute? :options do
+        attribute? :scale, Types::Float.optional.constrained(included_in: 0.1..2.0)
+        attribute? :display_header_footer, Types::Bool.optional
+        # HTML template for the print header. Should be valid HTML with the following classes used to inject values into them:
+        # * "date" formatted print date
+        # * "title" document title
+        # * "url" document location
+        # * "pageNumber" current page number
+        # * "totalPages" total pages in the document
+        attribute? :header_template, Types::Coercible::String.optional
+        # HTML template for the print footer. Has the same constraints and support for special classes as {@link PDFOptionsPDFOptions.headerTemplate}.
+        attribute? :footer_template, Types::Coercible::String.optional
+        # Print background graphics.
+        attribute? :print_background, Types::Bool.optional
+        attribute? :landscape, Types::Bool.optional
+        # Paper ranges to print, e.g. 1-5, 8, 11-13.
+        attribute? :page_ranges, Types::Coercible::String.optional
+        attribute? :format, Types::Coercible::String.enum("A0", "A1", "A2", "A3", "A4", "A5", "A6", "LEDGER", "LEGAL", "LETTER", "Ledger", "Legal", "Letter", "TABLOID", "Tabloid", "a0", "a1", "a2", "a3", "a4", "a5", "a6", "ledger", "legal", "letter", "tabloid").optional
+        # Sets the width of paper. You can pass in a number or a string with a unit.
+        attribute? :width, Types::Coercible::String.optional
+        # Sets the height of paper. You can pass in a number or a string with a unit.
+        attribute? :height, Types::Coercible::String.optional
+        # Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.
+        attribute? :prefer_css_page_size, Types::Bool.optional
+        attribute? :margin do
+          attribute? :top, Types::Coercible::String.optional
+          attribute? :bottom, Types::Coercible::String.optional
+          attribute? :left, Types::Coercible::String.optional
+          attribute? :right, Types::Coercible::String.optional
+        end
+        # The path to save the file to.
+        attribute? :path, Types::String.optional
+        # Hides default white background and allows generating pdfs with transparency.
+        attribute? :omit_background, Types::Bool.optional
+        # Generate tagged (accessible) PDF.
+        attribute? :tagged, Types::Bool.optional
+        # Timeout in milliseconds. Pass 0 to disable timeout.
+        attribute? :timeout, Types::Coercible::Integer.optional
+      end
+
+      attribute? :reject_request_pattern, Types::Array.of(Types::String).optional
+      attribute? :reject_resource_types, Types::Array.of(Types::Coercible::String.enum("cspviolationreport", "document", "eventsource", "fetch", "font", "image", "manifest", "media", "other", "ping", "prefetch", "preflight", "script", "signedexchange", "stylesheet", "texttrack", "websocket", "xhr")).optional
+      attribute? :request_interceptors, Types::Array.optional
+
+      attribute? :set_extra_http_headers, Types::Array.optional
+      attribute? :set_java_script_enabled, Types::Bool.optional
+
+      attribute? :url, Types::URL.optional
+      attribute? :user_agent, Types::Coercible::String.optional
+
+      attribute? :viewport do
+        attributes_from Attributes::Viewport
+      end
+
+      attribute? :wait_for_event do
+        attributes_from Attributes::WaitForEvent
+      end
+
+      attribute? :wait_for_function do
+        attributes_from Attributes::WaitForFunction
+      end
+
+      attribute? :wait_for_selector do
+        attributes_from Attributes::WaitForSelector
+      end
+
+      attribute? :wait_for_timeout, Types::Coercible::Integer.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/query.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Query < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock Origin and may cause certain sites to not load properly.
+      attribute? :block_ads, Types::Bool.optional
+      # Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API.
+      attribute? :launch do
+        attribute? :args, Types::Array.of(Types::String).optional
+        attribute? :default_viewport do
+          attributes_from Attributes::Viewport
+        end
+      end
+      # Whether or nor to record the session. The browser will run in "head-full" mode, and recording is started and closed via the embedded browserless API. Please refer to the "Recording" section in the live documentation site for more details.
+      attribute? :record, Types::Bool.optional
+      # Override the system-level timeout for this request. Accepts a value in milliseconds.
+      attribute? :timeout, Types::Integer.optional
+      # The authorization token
+      attribute? :token, Types::String.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/screenshot.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Screenshot < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute? :add_script_tag, Types::Array do
+        attributes_from Attributes::ScriptTag
+      end
+
+      attribute? :add_style_tag, Types::Array do
+        attributes_from Attributes::StyleTag
+      end
+
+      attribute? :authenticate do
+        attributes_from Attributes::Authenticate
+      end
+
+      # When bestAttempt is set to true, browserless attempt to proceed when "awaited" events fail or timeout. This includes things like goto, waitForSelector, and more.
+      attribute? :best_attempt, Types::Bool.optional
+
+      attribute? :cookies, Types::Array do
+        attributes_from Attributes::Cookie
+      end
+
+      attribute? :emulate_media_type, Types::Coercible::String.optional
+
+      attribute? :goto_options do
+        attributes_from Attributes::GotoOptions
+      end
+
+      attribute? :html, Types::Coercible::String.optional
+
+      attribute? :options do
+        attribute? :optimize_for_speed, Types::Bool.optional
+        attribute :type, Types::Coercible::String.default("png").enum("jpeg", "png", "webp")
+        # Quality of the image, between 0-100. Not applicable to png images.
+        attribute? :quality, Types::Integer.optional.constrained(included_in: 0..100)
+        # Capture the screenshot from the surface, rather than the view.
+        attribute? :from_surface, Types::Bool.optional
+        # When true, takes a screenshot of the full page.
+        attribute? :full_page, Types::Bool.optional
+        # Hides default white background and allows capturing screenshots with transparency.
+        attribute? :omit_background, Types::Bool.optional
+        # The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won't be saved to the disk.
+        attribute? :path, Types::String.optional
+        attribute? :clip do
+          attribute? :scale, Types::Float.optional
+          # the width of the element in pixels.
+          attribute :width, Types::Integer
+          # the height of the element in pixels.
+          attribute :height, Types::Integer
+          attribute :x, Types::Integer
+          attribute :y, Types::Integer
+        end
+        # Encoding of the image.
+        attribute? :encoding, Types::Coercible::String.optional.enum("base64", "binary")
+        # Capture the screenshot beyond the viewport.
+        attribute? :capture_beyond_viewport, Types::Bool.optional
+      end
+
+      attribute? :reject_request_pattern, Types::Array.of(Types::String).optional
+      attribute? :reject_resource_types, Types::Array.of(Types::Coercible::String.enum("cspviolationreport", "document", "eventsource", "fetch", "font", "image", "manifest", "media", "other", "ping", "prefetch", "preflight", "script", "signedexchange", "stylesheet", "texttrack", "websocket", "xhr")).optional
+      attribute? :request_interceptors, Types::Array.optional
+
+      attribute? :scroll_page, Types::Bool.optional
+      attribute? :selector, Types::Coercible::String.optional
+
+      attribute? :set_extra_http_headers, Types::Array.optional
+      attribute? :set_java_script_enabled, Types::Bool.optional
+
+      attribute? :url, Types::URL.optional
+      attribute? :user_agent, Types::Coercible::String.optional
+
+      attribute? :viewport do
+        attributes_from Attributes::Viewport
+      end
+
+      attribute? :wait_for_event do
+        attributes_from Attributes::WaitForEvent
+      end
+
+      attribute? :wait_for_function do
+        attributes_from Attributes::WaitForFunction
+      end
+
+      attribute? :wait_for_selector do
+        attributes_from Attributes::WaitForSelector
+      end
+
+      attribute? :wait_for_timeout, Types::Coercible::Integer.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/script_tag.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class ScriptTag < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # URL of the script to be added.
+      attribute? :url, Types::URL.optional
+      # Path to a JavaScript file to be injected into the frame.
+      attribute? :path, Types::String.optional
+      # JavaScript to be injected into the frame.
+      attribute? :content, Types::String.optional
+      # Sets the type of the script. Use module in order to load an ES2015 module.
+      attribute? :type, Types::Coercible::String.optional
+      # Sets the id of the script.
+      attribute? :id, Types::Coercible::String.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/style_tag.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class StyleTag < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # the URL of the CSS file to be added.
+      attribute? :url, Types::URL.optional
+      # The path to a CSS file to be injected into the frame.
+      attribute? :path, Types::String.optional
+      # Raw CSS content to be injected into the frame.
+      attribute? :content, Types::String.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/viewport.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class Viewport < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # The page width in CSS pixels.
+      attribute :width, Types::Coercible::Integer
+      # The page height in CSS pixels.
+      attribute :height, Types::Coercible::Integer
+      # Specify device scale factor. See {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio devicePixelRatio} for more info.
+      attribute? :device_scale_factor, Types::Coercible::Float.optional
+      # Whether the meta viewport tag is taken into account.
+      attribute? :is_mobile, Types::Bool.optional
+      # Specifies if the viewport is in landscape mode.
+      attribute? :is_landscape, Types::Bool.optional
+      # Specify if the viewport supports touch events.
+      attribute? :has_touch, Types::Bool.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/wait_for_event.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class WaitForEvent < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :event, Types::Coercible::String
+      attribute? :timeout, Types::Coercible::Integer
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/wait_for_function.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class WaitForFunction < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # The function, or statement, to be evaluated in browser context
+      attribute :fn, Types::Coercible::String
+      # An interval at which the pageFunction is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values: "raf" or "mutation"
+      attribute? :polling, Types::Coercible::String.optional
+      # Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.
+      attribute? :timeout, Types::Coercible::Integer.optional
+    end
+  end
+end

data/lib/puppeteer_entity/attributes/wait_for_selector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  module Attributes
+    class WaitForSelector < Dry::Struct
+      transform_keys(&:to_sym)
+
+      attribute :selector, Types::Coercible::String
+      attribute? :hidden, Types::Bool.optional
+      attribute? :timeout, Types::Coercible::Integer.optional
+      attribute? :visible, Types::Bool.optional
+    end
+  end
+end

data/lib/puppeteer_entity/base.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "dry/struct"
+require "http"
+require "active_support/core_ext/hash"
+
+module PuppeteerEntity
+  class Base < Dry::Struct
+    attribute? :browserless_url, Types::URL.default { ENV["BROWSERLESS_URL"] }
+    attribute? :retry_limit, Types::Integer.default { 3 }
+
+    attributes_from Attributes::Query
+
+    def response
+      url = url_with_query_params
+      json = as_body_json
+      retries = 0
+      begin
+        HTTP.headers(response_headers)
+            .post(url, json:)
+            .tap do |res|
+          raise RequestError.new(res.body.to_s) unless res.status.success?
+        rescue RequestError => e
+          retries = retries + 1
+          retries > retry_limit ? raise(e) : retry
+        end
+      end
+    end
+
+    private
+
+    def response_headers
+      {
+        content_type: "application/json"
+      }
+    end
+
+    def browserless_uri
+      raise NotImplementedError
+    end
+
+    def url_with_query_params
+      browserless_uri.tap do |uri|
+        uri.query = URI.encode_www_form(as_query_params)
+      end.to_s
+    end
+
+    def as_query_params
+      to_h
+        .slice(*Attributes::Query.attribute_names)
+        .reject { |_, v| v.blank? }
+        .deep_stringify_keys
+        .deep_transform_keys { |k| k.camelcase(:lower) }
+    end
+
+    def as_body_json
+      raise NotImplementedError
+    end
+  end
+end

data/lib/puppeteer_entity/content.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  class Content < Base
+    attributes_from Attributes::Content
+
+    transform_keys(&:to_sym)
+
+    private
+
+    def as_body_json
+      to_h
+        .slice(*Attributes::Content.attribute_names)
+        .reject { |_, v| v.blank? }
+        .deep_stringify_keys
+        .deep_transform_keys do |k|
+          case k
+          when "set_extra_http_headers" then "setExtraHTTPHeaders"
+          else k.camelcase(:lower)
+          end
+        end
+    end
+
+    def browserless_uri
+      URI.parse(browserless_url).tap do |uri|
+        uri.path = "/content"
+      end
+    end
+  end
+end

data/lib/puppeteer_entity/pdf.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  class Pdf < Base
+    attributes_from Attributes::Pdf
+
+    transform_keys(&:to_sym)
+
+    private
+
+    def response_headers
+      super.merge(
+        accept: "application/pdf"
+      )
+    end
+
+    def as_body_json
+      to_h
+        .slice(*Attributes::Pdf.attribute_names)
+        .reject { |_, v| v.blank? }
+        .deep_stringify_keys
+        .deep_transform_keys do |k|
+          case k
+          when "set_extra_http_headers" then "setExtraHTTPHeaders"
+          when "prefer_css_page_size" then "preferCSSPageSize"
+          else k.camelcase(:lower)
+          end
+        end
+    end
+
+    def browserless_uri
+      URI.parse(browserless_url).tap do |uri|
+        uri.path = "/pdf"
+      end
+    end
+  end
+end

data/lib/puppeteer_entity/screenshot.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  class Screenshot < Base
+    attributes_from Attributes::Screenshot
+
+    MIME_TYPES = {
+      "png" => "image/png",
+      "jpeg" => "image/jpeg",
+      "webp" => "image/webp"
+    }.freeze
+
+    transform_keys(&:to_sym)
+
+    private
+
+    def response_headers
+      type = to_h.dig(:options, :type) || "png"
+      super.merge(
+        accept: MIME_TYPES[type.downcase]
+      )
+    end
+
+    def as_body_json
+      to_h
+        .slice(*Attributes::Screenshot.attribute_names)
+        .reject { |_, v| v.blank? }
+        .deep_stringify_keys
+        .deep_transform_keys do |k|
+          case k
+          when "set_extra_http_headers" then "setExtraHTTPHeaders"
+          else k.camelcase(:lower)
+          end
+        end
+    end
+
+    def browserless_uri
+      URI.parse(browserless_url).tap do |uri|
+        uri.path = "/screenshot"
+      end
+    end
+  end
+end

data/lib/puppeteer_entity/types.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "dry/types"
+
+module PuppeteerEntity
+  module Types
+    include Dry.Types
+
+    URL = Strict::String.constrained(format: URI::DEFAULT_PARSER.make_regexp)
+  end
+end

data/lib/puppeteer_entity/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PuppeteerEntity
+  VERSION = "0.1.1"
+end

data/lib/puppeteer_entity.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module PuppeteerEntity
+  class Error < StandardError; end
+
+  class RequestError < Error; end
+
+  class IdLengthError < Error; end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: puppeteer_entity
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tomas Celizna
+- Asger Behncke Jacobsen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails-omakase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PuppeteerEntity provides a simple and intuitive interface for interacting
+  with Puppeteer, a headless Chrome browser.
+email:
+- mail@tomascelizna.com
+- a@asgerbehnckejacobsen.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/puppeteer_entity.rb
+- lib/puppeteer_entity/attributes/authenticate.rb
+- lib/puppeteer_entity/attributes/content.rb
+- lib/puppeteer_entity/attributes/cookie.rb
+- lib/puppeteer_entity/attributes/goto_options.rb
+- lib/puppeteer_entity/attributes/pdf.rb
+- lib/puppeteer_entity/attributes/query.rb
+- lib/puppeteer_entity/attributes/screenshot.rb
+- lib/puppeteer_entity/attributes/script_tag.rb
+- lib/puppeteer_entity/attributes/style_tag.rb
+- lib/puppeteer_entity/attributes/viewport.rb
+- lib/puppeteer_entity/attributes/wait_for_event.rb
+- lib/puppeteer_entity/attributes/wait_for_function.rb
+- lib/puppeteer_entity/attributes/wait_for_selector.rb
+- lib/puppeteer_entity/base.rb
+- lib/puppeteer_entity/content.rb
+- lib/puppeteer_entity/pdf.rb
+- lib/puppeteer_entity/screenshot.rb
+- lib/puppeteer_entity/types.rb
+- lib/puppeteer_entity/version.rb
+homepage: https://github.com/tomasc/puppeteer_entity
+licenses: []
+metadata:
+  homepage_uri: https://github.com/tomasc/puppeteer_entity
+  source_code_uri: https://github.com/tomasc/puppeteer_entity
+  changelog_uri: https://github.com/tomasc/puppeteer_entity/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: A Ruby gem for interacting with Puppeteer
+test_files: []