screenshots_pagepixels 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20a62b5eca4d9d981ceff650494787478b56810b4ddb30e543bc4a8aaee9aaeb
+  data.tar.gz: 82c12736d4dd429fa36023b6cc401bf92f3f59f0fb4d1d66b83b091f6e8ea4ea
+SHA512:
+  metadata.gz: 5cd44d16146cd75d9dc782bf1267af031b8c3103903a505d3d2aa9060f582fb26316d3ecbe45b4c02afa3315de00c023beb50c68db12e4910f511f1eaa4ee3fc
+  data.tar.gz: 5e689ddfd6067f07888571d2c1bd334a23bbe1d8542e6709df7312566cbbd3812ce90ae96889915328a141fd90c273abb67e610f75742aa6c36334dd38e8de25

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-05
+
+- 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 occamsfreelance@gmail.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,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in screenshots_pagepixels.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Anthony L
+
+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,205 @@
+# PagePixels Screenshots
+
+PagePixels is an API and web interface that provides automated screenshot capturing and change notifications for your web pages. With PagePixels, you can easily capature immediate screenshots, schedule recurring screenshots, set up change notifications, and use multi-step screenshotting functionality to complete forms, click links, and login to websites prior to taking screenshots.
+
+## Getting Started
+To use PagePixels, sign up for a free account and obtain your API key. No payment information is required. You can sign up and create an API key by visiting the PagePixels website https://pagepixels.com.
+
+Once you have your API key, you can start making requests to the API.
+
+## Installation
+
+To install the `screenshots_pagepixels` gem, you can use the following command:
+
+```
+gem install screenshots_pagepixels
+```
+
+Alternatively, you can add the following line to your Gemfile:
+
+```
+gem 'screenshots_pagepixels'
+```
+
+And then run `bundle install` to install the gem.
+
+Once the gem is installed, you can require it in your Ruby code:
+
+```ruby
+require 'screenshots_pagepixels'
+```
+
+## Usage
+The `PagePixelsScreenshots` RubyGem provides a simple and intuitive way to interface with the PagePixels API. The `PagePixelsScreenshots::Client` class provides the following methods.
+
+Learn more about configuring your screenshots for your needs by here:
+
+https://pagepixels.com/app/documentation#api-options
+
+### `snap(options = {})`
+Captures a screenshot of a web page immediately.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+options = { url: 'https://www.example.com' }
+client.snap(options)
+```
+
+### `create_screenshot_config(options = {})`
+Creates a new screenshot configuration, which can include a automatically recurring schedule, multi-step configurations, and more. 
+
+Learn more about multi-step (click links, complete forms, login to websites, etc) functionality here: 
+
+https://pagepixels.com/app/documentation#multi-step-screenshots
+
+Learn more about configuring scheduled screenshots here: 
+
+https://pagepixels.com/app/documentation#scheduled-screenshots
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+options = { url: 'https://www.example.com', scheduled_screenshot: true, scheduled_every: 1, scheduled_interval: 'days' }
+client.create_screenshot_config(options)
+```
+
+### `screenshot_configs(options = {})`
+Allows you to retrieve your screenshot configurations.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.screenshot_configs
+```
+
+### `get_screenshot_config(id)`
+Gets a specific screenshot configuration.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.get_screenshot_config('your-screenshot-config-id')
+```
+
+### `update_screenshot_config(id, options = {})`
+Updates a specific screenshot configuration.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+options = { scheduled_every: 2 }
+client.update_screenshot_config('your-screenshot-config-id', options)
+```
+
+### `delete_screenshot_config(id)`
+Deletes a specific screenshot configuration.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.delete_screenshot_config('your-screenshot-config-id')
+```
+
+### `screenshot_config_screenshots(id, options = {})`
+Retrieves a list of screenshots that were taken with a specific screenshot configuration.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.screenshot_config_screenshots('your-screenshot-config-id')
+```
+
+### `screenshot_config_change_notifications(id, options = {})`
+Provides an array of all Change Notifications for a specific screenshot configuration.
+
+Learn more about configuring change notifications for your screenshots here: 
+
+https://pagepixels.com/app/documentation#screenshot-change-notifications
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.screenshot_config_change_notifications('your-screenshot-config-id')
+```
+
+### `job_status(job_id)`
+Retrieves the status of a specific screenshot job associated with a screenshot configuration.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.job_status('your-job-id')
+```
+
+### `capture_screenshot(id)`
+Immediately captures a screenshot using a specific screenshot configuration. This bypasses all scheduling to take a screenshot immediately.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.capture_screenshot('your-screenshot-config-id')
+```
+
+### `screenshots(options = {})`
+Retrieves a list of all screenshots taken with your PagePixels account.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.screenshots
+```
+
+### `change_notifications(options = {})`
+Provides an array of all Change Notifications for all screenshot configurations.
+
+```ruby
+require 'screenshots_pagepixels'
+
+client = PagePixelsScreenshots::Client.new('your-api-key')
+client.change_notifications
+```
+
+# Some additional helpful information.
+
+## Scheduling
+With PagePixels, you can schedule recurring screenshots of your web pages. You can schedule screenshots through the user interface as well if needed.
+
+The following options are available for scheduling:
+
+| Option               | Expected Value        |
+| --------------------| ----------------------|
+| scheduled_screenshot | true or false         |
+| scheduled_every      | Integer greater than 1|
+| scheduled_interval   | Any of: minutes, hours, days, weeks, months, years |
+
+## Multi-Step Screenshots
+PagePixels also provides the ability to use multi-step functionality to complete forms, navigate to different pages, click links and buttons, and login to your favorite websites prior to taking your screenshot.
+
+The following actions are available for use with the multi-step functionality:
+
+| Action                   | Example                                                            |
+| ------------------------| -------------------------------------------------------------------|
+| Click                    | {"type": "click", "selector": "#your-selector"}                    |
+| Hover                    | {"type": "hover", "selector": "#your-selector"}                    |
+| Change Notification      | {"type": "change", "selector": "#your-selector", "send_to": "webhook", url: "https://example.com/webhook-url"} |
+| Goto URL                 | {"type": "redirect", "value": "https://example.com"}               |
+| Run Javascript           | {"type": "javascript", "value": "console.log('my javascript');"}    |
+| Insert CSS               | {"type": "css", "value": "#selector{ color: red }"}                 |
+| Text Field Input         | {"type": "text_field", "selector": "#the-text-field", "value": "your-value"} |
+| Dropdown Field Selection | {"type": "select", "selector": "#the-dropdown-field", "value": "selected value"} |
+| Checkbox Field Input     | {"type": "checkbox", "selector": "#the-checkbox-field", "value":true} |
+| Press Enter              | (to submit hidden forms) {"type": "submit"}                         |
+| Wait X milliseconds      | {"type": "wait", "value": "5000"}                                   |
+| Wait for Selector        | {"type": "wait_for_selector", "selector": "#your-selector"}         |

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/screenshots_pagepixels/client.rb

@@ -0,0 +1,125 @@
+module ScreenshotsPagepixels
+  class Client
+    include HTTParty
+    base_uri 'https://api.pagepixels.com'
+
+    def initialize(bearer_token)
+      @bearer_token = bearer_token
+    end
+
+    def snap(options = {})
+      get_request('/snap', options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def screenshot_configs(options = {})
+      get_request('/screenshot_configs', options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def create_screenshot_config(options = {})
+      post_request('/screenshot_configs', options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def get_screenshot_config(id)
+      get_request("/screenshot_configs/#{id}")
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def update_screenshot_config(id, options = {})
+      patch_request("/screenshot_configs/#{id}", options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def delete_screenshot_config(id)
+      delete_request("/screenshot_configs/#{id}")
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def screenshot_config_screenshots(id, options = {})
+      get_request("/screenshot_configs/#{id}/screenshots", options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def screenshot_config_change_notifications(id, options = {})
+      get_request("/screenshot_configs/#{id}/change_notifications", options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def job_status(job_id)
+      get_request("/jobs/#{job_id}")
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def capture_screenshot(id)
+      post_request("/screenshot_configs/#{id}/capture")
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def screenshots(options = {})
+      get_request('/screenshots', options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def change_notifications(options = {})
+      get_request('/change_notifications', options)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    private
+
+    def get_request(path, options = {})
+      headers = { 'Authorization' => "Bearer #{@bearer_token}" }
+      response = self.class.get(path, query: options, headers: headers)
+      if path == "/snap" && !options[:json]
+        return response.body 
+      else
+        JSON.parse(response.body)
+      end
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def post_request(path, options = {})
+      headers = { 'Authorization' => "Bearer #{@bearer_token}", 'Content-Type' => 'application/json' }
+      response = self.class.post(path, body: options.to_json, headers: headers)
+      JSON.parse(response.body)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def patch_request(path, options = {})
+      headers = { 'Authorization' => "Bearer #{@bearer_token}", 'Content-Type' => 'application/json' }
+      response = self.class.patch(path, body: options.to_json, headers: headers)
+      JSON.parse(response.body)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def delete_request(path)
+      headers = { 'Authorization' => "Bearer #{@bearer_token}" }
+      response = self.class.delete(path, headers: headers)
+      JSON.parse(response.body)
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def handle_exception(exception)
+      puts "An error occurred: #{exception.message}"
+      raise exception
+    end
+  end
+end

data/lib/screenshots_pagepixels/version.rb

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

data/lib/screenshots_pagepixels.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require_relative "screenshots_pagepixels/version"
+require_relative "screenshots_pagepixels/client"
+
+module ScreenshotsPagepixels
+  class Error < StandardError; end
+end

data/screenshots_pagepixels.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/screenshots_pagepixels/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "screenshots_pagepixels"
+  spec.version = ScreenshotsPagepixels::VERSION
+  spec.authors = ["PagePixels LLC"]
+  spec.email = ["support@pagepixels.com"]
+
+  spec.summary = "A Ruby Gem for interacting with the PagePixels API for automated screenshot capturing, multi-step screenshots (login to web pages, click links, etc), and change notifications"
+  spec.description = "PagePixels Screenshots is a Ruby Gem that provides a simple and easy-to-use interface for working with the PagePixels API. With this gem, you can easily capture screenshots, manage screenshot configurations, create recurring screenshot schedules, setup multi-step screenshots, and more. PagePixels Screenshots provides convenient methods that wrap around the API endpoints, making it easy to get started and integrate with your application."
+  spec.homepage = "https://pagepixels.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PagePixels/screenshots_pagepixels-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/PagePixels/screenshots_pagepixels-ruby/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      puts f.inspect
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor]) || File.extname(f) == '.gem'
+    end
+  end
+  puts spec.files.inspect
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'httparty', '~> 0.18.1'
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/sig/screenshots_pagepixels.rbs

@@ -0,0 +1,4 @@
+module ScreenshotsPagepixels
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: screenshots_pagepixels
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PagePixels LLC
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: PagePixels Screenshots is a Ruby Gem that provides a simple and easy-to-use
+  interface for working with the PagePixels API. With this gem, you can easily capture
+  screenshots, manage screenshot configurations, create recurring screenshot schedules,
+  setup multi-step screenshots, and more. PagePixels Screenshots provides convenient
+  methods that wrap around the API endpoints, making it easy to get started and integrate
+  with your application.
+email:
+- support@pagepixels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/screenshots_pagepixels.rb
+- lib/screenshots_pagepixels/client.rb
+- lib/screenshots_pagepixels/version.rb
+- screenshots_pagepixels.gemspec
+- sig/screenshots_pagepixels.rbs
+homepage: https://pagepixels.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://pagepixels.com
+  source_code_uri: https://github.com/PagePixels/screenshots_pagepixels-ruby
+  changelog_uri: https://github.com/PagePixels/screenshots_pagepixels-ruby/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem for interacting with the PagePixels API for automated screenshot
+  capturing, multi-step screenshots (login to web pages, click links, etc), and change
+  notifications
+test_files: []