browserless 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8ad9380593ba502308410252efb6a5da70305dd575231474a417657feccd712
-  data.tar.gz: bfcddc1b3535536f20c1c410450f29be18523e720065d775684657524982cf19
+  metadata.gz: 14f47b6657d20f63991dbacbae3c9ec7c7cc8408896a2e94f37680741156cbc9
+  data.tar.gz: 459c77a3d92d28ea270cec0b2bfa3c230e752ecd4820eebc6f14a152c90c9205
 SHA512:
-  metadata.gz: cf17d6a3fbb1029cf9fa8662ade49b6c874cbfa47058fa47d40a01701681e3a3548f663fda94c6c954985e842c4d1a5e82149f2a04a0026bfc6fffe3da3bd2e7
-  data.tar.gz: a326196257e2872002b3d60d40ca1b59172dd4822dd120a811f95c58c0ab0f218e876a6b0d08b02302e4137a703ef06c9f07dd89b3d341b99ceeb79f5a57a4fd
+  metadata.gz: 12204ed5fe0e0fd23d904836aa780a412ac318e8e54009f1cb28af61e6dac809651ca94e7aadd24ea9dc07a02122e0e5afc05a14f38f20ead4441987e5049ac8
+  data.tar.gz: 04e2eaac1111ccd04e2ab294b88cc6e957a52abb86c81ae9feb467757035898ebee6a3e1a1fb3e99f7ea5997df1724a096423271f5da23bed4c0a6cf73fdb6cc

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.0.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-04
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at thomasvanholder@hey.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in browserless.gemspec
+gemspec
+
+gem "httparty" # , "~> 0.18"
+
+group :test do
+  gem "rake", "~> 13.0"
+  gem "standard", "~> 1.3"
+  gem "minitest"
+  gem "debug"
+end

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    browserless (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    debug (1.7.2)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    io-console (0.6.0)
+    irb (1.6.3)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    minitest-reporters (1.6.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reline (0.3.3)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    standard (1.26.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  browserless!
+  debug
+  httparty
+  minitest
+  minitest-reporters (~> 1.1)
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Thomas Van Holder
+
+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,169 @@
+# Browserless Gem
+
+Introducing the "Browserless" gem - a Ruby gem that provides a convenient wrapper around the [Browserless PDF API](https://www.browserless.io/docs/pdf). Browserless relies on puppeteer to convert modern CSS into a PDF. The goal of this gem is to enables developers to easily generate PDF documents from the HTML you already have.
+
+By utilizing a managed service such as [Browserless.io](https://www.browserless.io/), you can concentrate on your core application functionality while relying on a simple API call to address your PDF generation requirements.
+
+The free trial of browerless includes upto 1,000 PDFs a month, 10 concurrent browsers. 
+
+__Benefits__
+- turn your existing HTML and CSS into a PDF
+- supports modern CSS frameworks such as TailwindCSS
+- no need to install, run and maintain puppeteer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'browserless'
+```
+
+And then execute:
+**
+    $ bundle install**
+
+Or install it yourself as:
+
+    $ gem install browserless
+
+## Configuration
+Add your Browserless.io API key in an initializer file, like `config/browserless.rb`. You can set default configuration options in the initializer.
+
+```rb
+Browserless.configure do |config|
+  config.api_key = "your_api_key_here"
+  config.emulate_media = "print" # choose between print or screen (default)
+  config.style_tag = File.read(Rails.root.join("app/assets/builds/application.css")) # Pass public asset URL or CSS string content  
+  config.options = {
+    landscape: false # default
+    print_background: false,
+    format: "A4" # default https://pptr.dev/api/puppeteer.paperformat#remarks
+    display_header_footer: false, # default 
+    header_template: "<div>...</div>", # ensure display_header_footer is true
+    footer_template: "<div>...</div>", # ensure display_header_footer is true
+    margin: {
+      top: "2cm",
+      left: "0.5cm",
+      right: "0.5cm",
+      bottom: "2cm"
+    },
+  }
+end
+```
+
+__api_key__
+Make sure to replace `"your_api_key_here"` with your actual Browserless.io API key.
+
+__emulate_media__
+You can specify the media type by passing in the optional `emulate_media` keyword argument. Choose between `screen` (default) or `print`. 
+
+>TailwindCSS supports the [print modifier](https://tailwindcss.com/docs/hover-focus-and-other-states#print-styles), so you can conditional add styles to only be displayed with the PDF is being generated.
+
+__style_tag__
+You can use both a public URL or pass the CSS as a string to add CSS to your PDF. Note that browserless can't asses any url refering to your local environment. Therefore, in your local environment pass the CSS as a string.
+
+```rb
+def css_asset
+  if Rails.env.production?
+    ActionController::Base.helpers.asset_path("application.css")
+  else
+    File.read(Rails.root.join("app/assets/builds/application.css"))
+  end
+end
+
+Browserless.configure do |config|
+  # ... 
+  config.style_tag = css_asset
+end
+```
+
+## Usage
+
+Here's an example of how to use the `Browserless::Client` to generate a PDF from HTML content:
+
+```rb
+client = Browserless::Client.new(html: "<html></html>")
+pdf_data = client.to_pdf
+```
+
+You can customize the PDF generation by passing options. Passed in options will overwrite options set in the intializer.
+
+```rb
+client = Browserless::Client.new(
+  html: "<html>...</html>", 
+  emulate_media: "print",
+  options: {
+    landscape: true
+    display_header_footer: true
+    }
+  )
+pdf_data = client.to_pdf
+```
+
+You can pass the following options:
+
+- `landscape` default false
+- `print_background` default false
+- `margin` default none
+- `format` default A4
+- `header_template` default empty
+- `footer_template`default X of X page
+- `display_header_footer` default true
+
+Note that the above options are nested in an options hash.
+
+## Rails example
+
+```rb
+class Policy
+ # ...
+ def to_pdf
+    html = ApplicationController.render(
+      partial: "policies/document",
+      locals: { policy: policy}
+    )
+
+    Browserless::Client.new(
+      html: html,
+      options: {
+        display_header_footer: true
+      }
+    ).to_pdf
+  end
+end
+
+class PoliciesController
+   # ...
+  def show
+    # ... 
+    respond_to do |format|
+      format.pdf {
+        send_data @policy.to_pdf, type: "application/pdf", disposition: "attachment", filename: "privacy_policy.pdf"
+      }
+  end
+end
+```
+
+In your view::
+```rb
+link_to "Download", policy_path(@policy, format: :pdf)
+```
+
+## 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/thomasvanholder/browserless. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thomasvanholder/browserless/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Browserless project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thomasvanholder/browserless/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+require "rake/testtask"
+
+task default: :standard
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/**/*_test.rb"]
+  test.warning = false
+end
+desc "Run tests"
+task default: :test

data/lib/browserless/client.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "options"
+require_relative "style_tag"
+
+module Browserless
+  class ApikeyError < StandardError; end
+
+  class Client
+    attr_reader :html, :url, :style_tag, :emulate_media, :options
+
+    def initialize(html:, options: {}, **kwargs)
+      @html = html
+      @options = Options.new(**options).to_h
+      @style_tag = StyleTag.new(kwargs[:style_tag]).to_h
+      @emulate_media = config_value(:emulate_media, kwargs[:emulate_media]) || "screen"
+      @url = Browserless.configuration.url
+    end
+
+    def to_pdf
+      temp_file = Tempfile.new
+      save_pdf_to_temp_file(temp_file)
+
+      temp_file.read
+    ensure
+      temp_file.close
+      temp_file.unlink
+    end
+
+    private
+
+    def save_pdf_to_temp_file(temp_file)
+      File.open(temp_file, "wb") do |file|
+        file.binmode
+
+        HTTParty.post(Browserless.configuration.url, headers: Browserless::Client.headers, body: browserless_options.to_json, stream_body: true) do |fragment|
+          handle_fragment(fragment, file)
+        end
+      end
+    end
+
+    def handle_fragment(fragment, file)
+      case fragment.code
+      when 401
+        error = ApikeyError.new("Unauthorized. Please check if you have a valid Browserless API key")
+        raise error
+      when 301, 302
+        print "skip writing for redirect"
+      when 200
+        print "."
+        file.write(fragment)
+      else
+        puts fragment
+        raise StandardError, "Non-success status code while streaming #{fragment.code}"
+      end
+    end
+
+    def browserless_options
+      {
+        html: html,
+        safeMode: safe_mode,
+        emulateMedia: emulate_media,
+        addStyleTag: [style_tag],
+        options: options
+      }
+    end
+
+    def safe_mode
+      # Longer pages can crash trigger a "Page Crashed!" error. Safemode on by default.
+      # https://www.browserless.io/docs/pdf
+      true
+    end
+
+    def config_value(key, value)
+      value || Browserless.configuration.send(key)
+    end
+
+    class << self
+      def headers
+        {
+          "Cache-Control": "no-cache",
+          "Content-Type": "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/browserless/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Browserless
+  class ConfigurationError < StandardError; end
+
+  class Configuration
+    attr_writer :api_key
+    attr_accessor :options, :emulate_media, :style_tag
+
+    BASE_URL = "https://chrome.browserless.io/pdf?token="
+
+    def initialize
+      @api_key = nil
+    end
+
+    def api_key
+      return @api_key if @api_key
+
+      error = "Api key missing. Check if you have defined an api key in the config/browserless.rb file."
+      raise ConfigurationError, error
+    end
+
+    def url
+      "#{BASE_URL}#{api_key}"
+    end
+  end
+end

data/lib/browserless/options.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Browserless
+  class Options
+    HEADER_TEMPLATE = "<div></div>" # empty header
+    FOOTER_TEMPLATE = "<div style='font-size: 11px; margin-left: 40px; font: Helvetica'><span class='pageNumber'></span> of <span class='totalPages'></span></div>"
+
+    attr_reader :display_header_footer, :margin, :pdf_format, :print_background, :header_template, :footer_template, :options, :landscape
+
+    def initialize(**options)
+      @options = options
+      @landscape = config_value(:landscape) || false
+      @margin = config_value(:margin) || {}
+      @pdf_format = config_value(:format) || "A4"
+      @print_background = config_value(:print_background) || false
+      @header_template = config_value(:header_template) || HEADER_TEMPLATE
+      @footer_template = config_value(:footer_template) || FOOTER_TEMPLATE
+      @display_header_footer = config_value(:display_header_footer) || false
+    end
+
+    def to_h
+      {
+        landscape: landscape,
+        displayHeaderFooter: display_header_footer,
+        printBackground: print_background,
+        margin: margin,
+        format: pdf_format,
+        headerTemplate: header_template,
+        footerTemplate: footer_template
+      }
+    end
+
+    private
+
+    def config_value(key)
+      return options[key] if Browserless.configuration.options.nil?
+
+      options[key] || Browserless.configuration.options[key]
+    end
+  end
+end

data/lib/browserless/style_tag.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Browserless
+  class StyleTag
+    attr_reader :style_tag
+
+    def initialize(style_tag = nil)
+      @style_tag = style_tag
+    end
+
+    def to_h
+      return {content: nil} if config_value.nil?
+
+      config_value.start_with?("http") ? {url: config_value} : {content: config_value}
+    end
+
+    private
+
+    def config_value
+      style_tag || Browserless.configuration.style_tag
+    end
+  end
+end

data/lib/browserless/version.rb

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

data/lib/browserless.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "json"
+require "httparty"
+
+require_relative "browserless/configuration"
+require_relative "browserless/client"
+require_relative "browserless/version"
+
+module Browserless
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browserless
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Thomas Van Holder
@@ -90,7 +90,21 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/browserless.rb
+- lib/browserless/client.rb
+- lib/browserless/configuration.rb
+- lib/browserless/options.rb
+- lib/browserless/style_tag.rb
+- lib/browserless/version.rb
 homepage: https://github.com/thomasvanholder/browserless
 licenses:
 - MIT