screenshotone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b687af4b650f7718ca1ed4d9fd7fcf11c92d769a0eb404294886defa40dbdbf
+  data.tar.gz: ff1ae3c0ecc7490e26e19af9c239ffef4d82fc39795609a417324a48f2c01607
+SHA512:
+  metadata.gz: d4508fb8448afbf74bd09be16acf196685c5b2857c292baa7e2721a806f0d100c845bedf3121110b69380a0609808dd676695aa2dfd14146189e0db530ea52dd
+  data.tar.gz: 86bb2291c7641013ee7b0ac28018d4dd7c59271adeccf2f0639493e600d4c35899318bb14d24a3723bef718165576ef3a17635f9a5939c0eebbf8a08273c705b

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tavo@hey.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in screenshotone_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0.6"
+gem "minitest", "~> 5.16.3"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    screenshotone (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.16.3)
+    rake (13.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.16.3)
+  rake (~> 13.0.6)
+  screenshotone!
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Gustavo Garcia
+
+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,65 @@
+# Screenshot API Ruby Gem
+This is a simple wrapper to interact with the ScreenshotOne API with Ruby.
+It's based on the [API guide](https://screenshotone.com/docs/getting-started/)
+
+## Usage
+Add this gem to your Gemfile:
+```rb
+gem 'screenshotone'
+```
+
+Then you need to initialize a Client with your `access_key` and an optional `secret_key`
+(in case you want sign all the request for publicly sharing the urls).
+
+```rb
+# If you don't need to add a signature
+client = ScreenshotOne::Client.new('my_access_key')
+
+# If you do need to add a signature
+client = ScreenshotOne::Client.new('my_access_key', 'my_secret_key')
+```
+
+Now you need to define the options of the screenshot
+```rb
+# You can set any available option, in a camel_case format, for example:
+options = ScreenshotOne::TakeOptions.new(url: 'https://example.com').
+            full_page(true).
+            delay(2).
+            geolocation_latitude(48.857648).
+            geolocation_longitude(2.294677).
+            geolocation_accuracy(50)
+
+# Verify all the parameters are valid (we will validate the parameters that should be
+# numeric, booleans or that accept only certain values)
+options.valid?
+=> true
+```
+
+And finally:
+```rb
+# To simply get the final url:
+client.generate_take_url(options)
+=> "https://api.screenshotone.com/take?url=https%3A%2F%2Fexample.com..."
+
+# To actually get the image (the response body of a request to the previous url)
+client.take(options)
+=> "\xFF\xD8\xFF\xE0\x00\x10JFIF\x00\x01\x01\x00\x00\x01\x00\x01\x00\x00\xFF\..."
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 tags, 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/screenshotone/rubysdk. 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/screenshotone/rubysdk/blob/main/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 PlausibleApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/screenshotone/rubysdk/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "screenshotone"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/screenshotone/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'json'
+require "net/http"
+require "uri"
+require "cgi"
+
+module ScreenshotOne
+  class Client
+
+    BASE_URL = "https://api.screenshotone.com"
+
+    def initialize(access_key, secret_key = nil)
+      @access_key = access_key
+      @secret_key = secret_key
+    end
+
+    def generate_take_url(options)
+      raise Error.new('Argument is not a ScreenshotOne::TakeOptions instance') unless options.is_a?(TakeOptions)
+      raise Error.new('TakeOptions is not valid') unless options.valid?
+
+      query = options.to_hash
+      query[:access_key] = @access_key
+      query_string = URI.encode_www_form(query)
+      if @secret_key
+        query_string << "&signature=#{OpenSSL::HMAC.hexdigest("sha256", @secret_key, query_string)}"
+      end
+
+      "#{BASE_URL}/take?#{query_string}"
+    end
+
+    def take(options)
+      uri = URI.parse(generate_take_url(options))
+      res = Net::HTTP.get_response(uri)
+      return res.body if res.is_a?(Net::HTTPSuccess)
+      raise Error.new(res.body)
+    end
+
+  end
+end

data/lib/screenshotone/error.rb

@@ -0,0 +1,4 @@
+module ScreenshotOne
+  class Error < StandardError
+  end
+end

data/lib/screenshotone/take_options.rb

@@ -0,0 +1,89 @@
+module ScreenshotOne
+  class TakeOptions
+
+    OPTIONS = [
+      :url,
+      :html,:markdown, :selector, :format, :response_type,
+      :full_page, :full_page_scroll, :full_page_scroll_delay, :full_page_scroll_by,
+      :viewport_device, :viewport_width, :viewport_height,
+      :device_scale_factor, :viewport_mobile, :viewport_has_touch, :viewport_landscape,
+      :image_quality, :image_width, :image_height,
+      :omit_background, :dark_mode, :reduced_motion, :media_type, :hide_selectors,
+      :scripts, :scripts_wait_until, :styles, :click,
+      :block_cookie_banners, :block_chats, :block_ads, :block_trackers, :block_requests, :block_resources,
+      :geolocation_latitude, :geolocation_longitude, :geolocation_accuracy,
+      :proxy, :user_agent, :authorization, :cookies, :headers, :time_zone,
+      :wait_until, :delay, :timeout, :wait_for_selector,
+      :cache, :cache_ttl, :cache_key,
+      :store, :storage_path, :storage_bucket, :storage_class,
+      :error_on_selector_not_found
+    ]
+    BOOLEAN_OPTIONS = [
+      :full_page, :full_page_scroll, :viewport_mobile, :viewport_has_touch, :viewport_landscape, :omit_background,
+      :dark_mode, :reduced_motion, :block_cookie_banners, :block_chats, :block_ads, :block_trackers,
+      :cache, :store, :error_on_selector_not_found
+    ]
+    NUMERIC_OPTIONS = [
+      :full_page_scroll_delay, :full_page_scroll_by, :viewport_width, :viewport_height,
+      :device_scale_factor, :image_width, :image_height,
+      :geolocation_latitude, :geolocation_longitude, :geolocation_accuracy,
+      :delay, :timeout, :cache_ttl
+    ]
+    ENUM_OPTIONS = {
+      format: %w(png jpeg jpg webp gif jp2 tiff avif heif html),
+      response_type: %w(by_format empty),
+      scripts_wait_until: %w(load domcontentloaded networkidle0 networkidle2),
+      block_resources: %w(document stylesheet image media font script texttrack xhr fetch eventsource websocket manifest other),
+      time_zone: %w(America/Santiago Asia/Shanghai Europe/Berlin America/Guayaquil Europe/Madrid Pacific/Majuro Asia/Kuala_Lumpur Pacific/Auckland Europe/Lisbon Europe/Kiev Asia/Tashkent Europe/London),
+      wait_until: %w(load domcontentloaded networkidle0 networkidle2),
+      storage_class: %w(standard reduced_redundancy standard_ia onezone_ia intelligent_tiering glacier deep_archive outposts glacier_ir)
+    }
+
+    def initialize(url: nil)
+      @url = url
+    end
+
+    OPTIONS.each do |option|
+
+      define_method(option) do |*value|
+        return instance_variable_get("@#{option}") if value.empty?
+
+        instance_variable_set("@#{option}", value[0])
+        self
+      end
+
+      define_method("#{option}?") do
+        !!instance_variable_get("@#{option}")
+      end
+    end
+
+    def to_hash
+      instance_variables.each_with_object({}) do |var, hash|
+        hash[var.to_s.delete('@')] = instance_variable_get(var)
+      end
+    end
+
+    def valid?
+      ENUM_OPTIONS.each do |option, values|
+        if send("#{option}?")
+          return false unless values.include?(send(option).to_s)
+        end
+      end
+
+      BOOLEAN_OPTIONS.each do |option|
+        if send("#{option}?")
+          return false unless [true, false].include?(send(option))
+        end
+      end
+
+      NUMERIC_OPTIONS.each do |option|
+        if send("#{option}?")
+          return false unless send(option).to_f.to_s == send(option).to_s || send(option).to_i.to_s == send(option).to_s
+        end
+      end
+
+      true
+    end
+
+  end
+end

data/lib/screenshotone/version.rb

@@ -0,0 +1,3 @@
+module ScreenshotOne
+  VERSION = "0.0.1"
+end

data/lib/screenshotone.rb

@@ -0,0 +1,7 @@
+require 'screenshotone/version'
+
+module ScreenshotOne
+  autoload :Client, "screenshotone/client"
+  autoload :TakeOptions, "screenshotone/take_options"
+  autoload :Error, "screenshotone/error"
+end

data/screenshotone.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/screenshotone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "screenshotone"
+  spec.version       = ScreenshotOne::VERSION
+  spec.authors       = ["Gustavo Garcia", "Dmytro Krasun"]
+  spec.email         = ["tavo@hey.com", "support@screenhotone.com"]
+
+  spec.summary       = 'A simple ScreenshotOne API wrapper for Ruby'
+  spec.description   = 'A very humble wrapper for the ScreenshotOne API.'
+  spec.homepage      = "https://github.com/screenshotone/rubysdk"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: screenshotone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gustavo Garcia
+- Dmytro Krasun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-21 00:00:00.000000000 Z
+dependencies: []
+description: A very humble wrapper for the ScreenshotOne API.
+email:
+- tavo@hey.com
+- support@screenhotone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/screenshotone.rb
+- lib/screenshotone/client.rb
+- lib/screenshotone/error.rb
+- lib/screenshotone/take_options.rb
+- lib/screenshotone/version.rb
+- screenshotone.gemspec
+homepage: https://github.com/screenshotone/rubysdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/screenshotone/rubysdk
+  source_code_uri: https://github.com/screenshotone/rubysdk
+  changelog_uri: https://github.com/screenshotone/rubysdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A simple ScreenshotOne API wrapper for Ruby
+test_files: []