urlpipe 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bfaf07a0fb70edbee60c2467ec2f6123bc8c879c4eced1567f9ecbd51cf26d7
-  data.tar.gz: fc6ad0f280bc76a769a38383b4848ab98cf578360a7cbbb74a793dd94910571f
+  metadata.gz: 53c82122c9c87b3c9d3d8e38f7778ecf84f5fd3ca00ebf3db1e5e00abcf5b43c
+  data.tar.gz: 178ba8a0c503ee130a32a6203675d92b14a17a63a96ca8caa37ae8f3d831a156
 SHA512:
-  metadata.gz: 6f8edccde9e41a55d017aa54c7d9da319212b6c074f37cc405d3efa37387345dc1ee956d690bf9d12cf840dbd5721f962cf233e491981b31f404836e8a58e0f5
-  data.tar.gz: fd35420d0c9087f63e65431b3c06092619201b538569a7d608b9c89559d6c7ba038a9712f16d6b5beae6563fa3d37002405154c04d66ea07c9686ca44c7930b9
+  metadata.gz: 658218d2666297e85fb0799ec523f03dc202a2fa8acb62cb9a39d199863c3cc4c057c72e44e834d1614f6c78c16897e4042f60a65c6562061300695f619caf9b
+  data.tar.gz: 976a9cc22127aac89c5d7bc8ff0d59cf9f100cb3050ed5338ddd86209263684e2ff8e002940e971ca7241b0998ab84177302821c609eb7b193f23214ab65fa5f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.1
+
+- `QuotaExceededError` and `ConcurrencyLimitError` carry `next_plan` and `upgrade_url`: the plan that lifts the limit, as a Hash with `name`, `monthly_price_cents`, `monthly_credits` and `max_concurrent_requests`, and the page to upgrade on. Both are `nil` when there is no plan to move to.
+
 ## 0.2.0
 
 - `pdf` returns the whole rendered page as a PDF (`POST /pdf`): a `Urlpipe::Pdf` with the decoded bytes, `mime_type`, `result_url` and `save`. `pdf_options:` choose the paper, orientation, margins, scale, backgrounds, the print or screen stylesheet and `single_page`.

data/README.md

@@ -55,7 +55,7 @@ Every method takes the URL first. These options work on all of them and are sent
 | `labels:` | Your own ids for the request, e.g. `{ client: "acme" }`. Returned with the result and the webhook. |
 | `residential:` | `true` fetches the page from a home broadband address. |
 | `report_to:` | A webhook URL the result is POSTed to (async calls). |
-| `page_options:` | `wait_for_selector`, `delay`, `block_ads`, `block_cookie_banners`, `block_popups`, `remove_selectors`. Not on `lighthouse`. |
+| `page_options:` | `wait_for_selector`, `scroll_to_bottom`, `delay`, `block_ads`, `block_cookie_banners`, `block_popups`, `remove_selectors`. Not on `lighthouse`. |
 | `idempotency_key:` | Sent as the `Idempotency-Key` header. |
 | `extra:` | A Hash merged into the request body, for API options this version doesn't name yet. |
 
@@ -233,8 +233,8 @@ Everything raised is a `Urlpipe::Error`, with `status`, `code` (the API's error
 | `Urlpipe::EmailUnverifiedError` | 403: confirm the email address on the account. |
 | `Urlpipe::InvalidRequestError` | 422 with a code: `invalid_url`, `invalid_max_age`, `invalid_options`, `invalid_labels`, `invalid_idempotency_key`, `idempotency_key_reused`, or a `report_to` the API won't deliver to. |
 | `Urlpipe::AnalysisFailedError` | 422: the page couldn't be analysed; the message says why. A scrape where every operation failed keeps the scrape on `body`. |
-| `Urlpipe::QuotaExceededError` | 429 on the Free plan: `limit`, `used`, `needed`, `resets_at`. |
-| `Urlpipe::ConcurrencyLimitError` | 429: `limit` requests already `running`. |
+| `Urlpipe::QuotaExceededError` | 429 on the Free plan: `limit`, `used`, `needed`, `resets_at`; `next_plan` (a Hash: `name`, `monthly_price_cents`, `monthly_credits`, `max_concurrent_requests`) and `upgrade_url`, or `nil`. |
+| `Urlpipe::ConcurrencyLimitError` | 429: `limit` requests already `running`; `next_plan` and `upgrade_url`, or `nil`. |
 | `Urlpipe::RateLimitedError` | 429: sending too fast; `retry_after` seconds. |
 | `Urlpipe::NotFoundError` | 404: no result for this token in this project. |
 | `Urlpipe::StaleResultError` | 410: the result is past the 30-day window. |

data/lib/urlpipe/errors.rb

@@ -44,25 +44,30 @@ module Urlpipe
 
   # 429 quota_exceeded (Free plan only): the month's credits are spent.
   class QuotaExceededError < Error
-    attr_reader :limit, :used, :needed, :resets_at
+    attr_reader :limit, :used, :needed, :resets_at, :next_plan, :upgrade_url
 
-    def initialize(message = nil, limit: nil, used: nil, needed: nil, resets_at: nil, **rest)
+    def initialize(message = nil, limit: nil, used: nil, needed: nil, resets_at: nil, next_plan: nil,
+                   upgrade_url: nil, **rest)
       super(message, **rest)
       @limit = limit
       @used = used
       @needed = needed
       @resets_at = resets_at
+      @next_plan = next_plan
+      @upgrade_url = upgrade_url
     end
   end
 
   # 429 concurrency_limit: too many of your requests are already running.
   class ConcurrencyLimitError < Error
-    attr_reader :limit, :running
+    attr_reader :limit, :running, :next_plan, :upgrade_url
 
-    def initialize(message = nil, limit: nil, running: nil, **rest)
+    def initialize(message = nil, limit: nil, running: nil, next_plan: nil, upgrade_url: nil, **rest)
       super(message, **rest)
       @limit = limit
       @running = running
+      @next_plan = next_plan
+      @upgrade_url = upgrade_url
     end
   end
 
@@ -160,9 +165,12 @@ module Urlpipe
       case code
       when "quota_exceeded"
         [QuotaExceededError,
-         { limit: hash["limit"], used: hash["used"], needed: hash["needed"], resets_at: hash["resets_at"] }]
+         { limit: hash["limit"], used: hash["used"], needed: hash["needed"], resets_at: hash["resets_at"],
+           next_plan: hash["next_plan"], upgrade_url: hash["upgrade_url"] }]
       when "concurrency_limit"
-        [ConcurrencyLimitError, { limit: hash["limit"], running: hash["running"] }]
+        [ConcurrencyLimitError,
+         { limit: hash["limit"], running: hash["running"], next_plan: hash["next_plan"],
+           upgrade_url: hash["upgrade_url"] }]
       when "rate_limited"
         [RateLimitedError, { retry_after: retry_after(headers, hash) }]
       else

data/lib/urlpipe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Urlpipe
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urlpipe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - URLpipe