websitescreenshotworld 0.1.3

data/lib/websitescreenshotworld/trigger_result.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WebsiteScreenshotWorld
+  # The answer to {AutoSchedule#trigger_now}. The capture itself arrives later by webhook.
+  #
+  # @!attribute [r] status
+  #   @return [String] one of {TriggerStatus}
+  # @!attribute [r] web_page_id
+  #   @return [String]
+  # @!attribute [r] triggered_by
+  #   @return [String] one of {TriggeredBy}
+  # @!attribute [r] triggered_at
+  #   @return [Time] when the capture was queued; for +already_pending+, the original trigger
+  # @!attribute [r] message
+  #   @return [String] one sentence for a person
+  TriggerResult = Data.define(:status, :web_page_id, :triggered_by, :triggered_at, :message) do
+    include Model::Raw
+
+    # @api private
+    def self.from_api(hash)
+      Model.build(self, hash, triggered_at: Model.time(hash["triggered_at"]))
+    end
+  end
+end

data/lib/websitescreenshotworld/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module WebsiteScreenshotWorld
+  # The library's version, sent in the User-Agent header.
+  VERSION = "0.1.3"
+end

data/lib/websitescreenshotworld/webhook.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module WebsiteScreenshotWorld
+  # Verifies webhook deliveries from both products.
+  #
+  # @example
+  #   event = WebsiteScreenshotWorld::Webhook.verify(
+  #     request.raw_post, request.headers["X-WSW-Signature"], ENV.fetch("WSW_WEBHOOK_SECRET")
+  #   )
+  module Webhook
+    # The header that carries the signature.
+    SIGNATURE_HEADER = "X-WSW-Signature"
+
+    # Seconds a delivery's timestamp may differ from the current time.
+    DEFAULT_TOLERANCE = 300
+
+    class << self
+      # Checks a delivery's signature and returns its event.
+      #
+      # @param payload [String] the request body exactly as received, not parsed and re-serialised
+      # @param signature_header [String, nil] the value of the +X-WSW-Signature+ header
+      # @param secret [String] the endpoint's signing secret
+      # @param tolerance [Integer] seconds the signed timestamp may be before or after +now+
+      # @param now [Time] the current time
+      # @return [Event] a subclass matching the event's type, or {UnknownEvent}
+      # @raise [SignatureVerificationError] when the header is missing or malformed, the timestamp is outside
+      #   the tolerance, or no signature matches
+      # @raise [ArgumentError] when +payload+ is not a String or +secret+ is empty
+      def verify(payload, signature_header, secret, tolerance: DEFAULT_TOLERANCE, now: Time.now)
+        raise ArgumentError, "payload must be the raw request body as a String" unless payload.is_a?(String)
+        raise ArgumentError, "secret must not be empty" if secret.to_s.empty?
+
+        timestamp, signatures = parse_header(signature_header.to_s)
+        if (now.to_i - timestamp).abs > tolerance
+          raise SignatureVerificationError, "The signature's timestamp is outside the #{tolerance}-second tolerance."
+        end
+
+        expected = OpenSSL::HMAC.hexdigest("SHA256", secret.to_s.b, "#{timestamp}.".b + payload.b)
+        unless signatures.any? { |signature| OpenSSL.secure_compare(expected, signature.downcase) }
+          raise SignatureVerificationError, "No signature in the #{SIGNATURE_HEADER} header matches the payload."
+        end
+
+        Event.from_api(Model.parse_json(payload))
+      end
+
+      private
+
+      def parse_header(header)
+        pairs = header.split(",").map { |part| part.split("=", 2).map(&:strip) }
+        [timestamp_from(pairs), signatures_from(pairs)]
+      end
+
+      def timestamp_from(pairs)
+        value = pairs.find { |name, _| name == "t" }&.last
+        return Integer(value, 10) if value&.match?(/\A\d+\z/)
+
+        raise SignatureVerificationError, "The #{SIGNATURE_HEADER} header has no valid timestamp."
+      end
+
+      def signatures_from(pairs)
+        signatures = pairs.filter_map { |name, value| value if name == "v1" }
+        return signatures unless signatures.empty?
+
+        raise SignatureVerificationError, "The #{SIGNATURE_HEADER} header has no v1 signature."
+      end
+    end
+  end
+end

data/lib/websitescreenshotworld.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "openssl"
+require "securerandom"
+require "tempfile"
+require "time"
+require "uri"
+
+require_relative "websitescreenshotworld/version"
+require_relative "websitescreenshotworld/tokens"
+require_relative "websitescreenshotworld/errors"
+require_relative "websitescreenshotworld/error_response"
+require_relative "websitescreenshotworld/model"
+require_relative "websitescreenshotworld/capture"
+require_relative "websitescreenshotworld/capture_file"
+require_relative "websitescreenshotworld/defaults"
+require_relative "websitescreenshotworld/catalog"
+require_relative "websitescreenshotworld/trigger_result"
+require_relative "websitescreenshotworld/event_data"
+require_relative "websitescreenshotworld/events"
+require_relative "websitescreenshotworld/webhook"
+require_relative "websitescreenshotworld/transport"
+require_relative "websitescreenshotworld/service"
+require_relative "websitescreenshotworld/instant_snap"
+require_relative "websitescreenshotworld/auto_schedule"
+require_relative "websitescreenshotworld/client"
+
+# Client for the Website Screenshot World APIs: Instant Snap captures, Auto Schedule triggers and webhook
+# verification. Start with {Client}.
+module WebsiteScreenshotWorld
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: websitescreenshotworld
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Silhouettec Solutions Private Limited
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Capture web pages as images, videos or PDFs with Instant Snap, trigger
+  scheduled captures with Auto Schedule, and verify Website Screenshot World webhooks.
+email:
+- support@websitescreenshotworld.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/websitescreenshotworld.rb
+- lib/websitescreenshotworld/auto_schedule.rb
+- lib/websitescreenshotworld/capture.rb
+- lib/websitescreenshotworld/capture_file.rb
+- lib/websitescreenshotworld/catalog.rb
+- lib/websitescreenshotworld/client.rb
+- lib/websitescreenshotworld/defaults.rb
+- lib/websitescreenshotworld/error_response.rb
+- lib/websitescreenshotworld/errors.rb
+- lib/websitescreenshotworld/event_data.rb
+- lib/websitescreenshotworld/events.rb
+- lib/websitescreenshotworld/instant_snap.rb
+- lib/websitescreenshotworld/model.rb
+- lib/websitescreenshotworld/service.rb
+- lib/websitescreenshotworld/tokens.rb
+- lib/websitescreenshotworld/transport.rb
+- lib/websitescreenshotworld/trigger_result.rb
+- lib/websitescreenshotworld/version.rb
+- lib/websitescreenshotworld/webhook.rb
+homepage: https://websitescreenshotworld.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://websitescreenshotworld.com
+  source_code_uri: https://github.com/websitescreenshotworld/websitescreenshotworld-ruby
+  changelog_uri: https://github.com/websitescreenshotworld/websitescreenshotworld-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/websitescreenshotworld/websitescreenshotworld-ruby/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby client for the Website Screenshot World Instant Snap and Auto Schedule
+  APIs.
+test_files: []