ipscanner-io 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d22b356fd16c6950e961822c81d0492f2c63bc60065714eb22573df3d9e5fa4a
-  data.tar.gz: 703bc0f59259dc31089f4340677a1367255379da07398034f9506f3ceeab4c15
+  metadata.gz: df858440c24cbe0277b8ee17f8e00e8f81c897286cdd474e4627779797873612
+  data.tar.gz: 8e4f7a77b7225b68a9d56cbe2b56b5e9b6ca356ff3623a18716164dcdea78257
 SHA512:
-  metadata.gz: 21add4a3fdb414c8e0f9b212e0f32698beb06d004814d80c7dcd9698ba414509aca8755274921487479362d739d8062cd9a3ae6c6c259fb7c606e553b3a3b5e1
-  data.tar.gz: b776fb21029185a662bc3e3fff0a68b4831101d2b21d3af84c902bef8156640d43cdba1cd5343baa416e791b4b1319618118d8d473f98848cfabed7c4563c3d7
+  metadata.gz: 343088adc303b451fdca73d1c8f1a8c1fb9dee443bade9b80288d94005f6787cfc9bb0679bcc99f06c84385f5d51125a87a2861aade1ca902ed504efff1c81cc
+  data.tar.gz: 32ef3a941da72a5d5e9cde5d24237ef8e913ef86ad3302714390988cee71981f8f4221e0487671af0bd28149959df0cc3c518874f12e9a160c9c78d1781e84c8

data/README.md

@@ -50,6 +50,17 @@ client.ip.demo("1.1.1.1")            # no key needed
 client.ip.myip                       # no key needed
 ```
 
+`vpn` and `proxy` carry `purity` (the score breakdown) on paid plans; a locked answer has `deductionCount` instead.
+
+### Email
+
+```ruby
+result = client.email.check("jane@outlok.com")
+# result["status"] "risky", result["reason"] "typo", result["suggestion"] "jane@outlook.com"
+```
+
+Checks syntax, throwaway domains, whether the domain receives mail, typos of big webmail domains and role addresses. The mailbox itself is not probed. One request per address.
+
 ### Bulk
 
 ```ruby
@@ -96,10 +107,11 @@ client.sites.policy("your-site-id")
 ### Gate
 
 ```ruby
-result = client.gate.verify(secret: "gs_...", token: gate_token, remote_ip: request.remote_ip)
+result = client.gate.verify(secret: "gs_...", token: gate_token, remote_ip: request.remote_ip,
+                             email: params["email"])
 ```
 
-`gate.verify` sends the site secret instead of the API key and is never retried.
+`gate.verify` sends the site secret instead of the API key and is never retried. `email` is optional; with it, `result["email"]` holds the check and its action, and `result["action"]` is the stricter of the network and email actions.
 
 ### Provenance
 

data/lib/ipscanner/client.rb

@@ -6,7 +6,7 @@ module IPScanner
     DEFAULT_BASE_URL = "https://ipscanner.io"
 
     attr_reader :ip, :bulk, :agentscan, :provenance, :account, :asn_directory, :crawlers,
-                :edge, :sites, :gate
+                :edge, :sites, :gate, :email
 
     def initialize(api_key: nil, base_url: nil, timeout: 30, max_retries: 2)
       api_key ||= ENV.fetch("IPSCANNER_API_KEY", nil)
@@ -24,6 +24,7 @@ module IPScanner
       @edge = Resources::Edge.new(http)
       @sites = Resources::Sites.new(http)
       @gate = Resources::Gate.new(http)
+      @email = Resources::Email.new(http)
     end
   end
 end

data/lib/ipscanner/http.rb

@@ -34,7 +34,11 @@ module IPScanner
     }.freeze
 
     def self.escape(segment)
-      segment.to_s.b.gsub(/[^A-Za-z0-9\-._~]/) { |c| format("%%%02X", c.ord) }
+      value = segment.to_s
+      # "." and ".." would be resolved to another endpoint, with the API key attached.
+      raise ArgumentError, "ipscanner: invalid path segment #{value.inspect}" if [".", ".."].include?(value)
+
+      value.b.gsub(/[^A-Za-z0-9\-._~]/) { |c| format("%%%02X", c.ord) }
     end
 
     def initialize(api_key:, base_url:, timeout:, max_retries:)

data/lib/ipscanner/resources/email.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module IPScanner
+  module Resources
+    # Email: address checks before a signup is accepted.
+    class Email < Base
+      # Checks one address: syntax, throwaway domains, mail servers, typos and role addresses. One request.
+      def check(email)
+        @http.post("/v1/email/check", { email: email })
+      end
+    end
+  end
+end

data/lib/ipscanner/resources/gate.rb

@@ -7,8 +7,10 @@ module IPScanner
     # Gate: server-side redemption of form tokens.
     class Gate < Base
       # Redeems a gate token with the site secret. Sends no API key and is never retried.
-      def verify(secret:, token:, remote_ip: nil)
-        @http.post("/v1/gate/verify", compact({ secret: secret, token: token, remote_ip: remote_ip }), auth: false)
+      # email (optional) adds an email check, one request.
+      def verify(secret:, token:, remote_ip: nil, email: nil)
+        body = compact({ secret: secret, token: token, remote_ip: remote_ip, email: email })
+        @http.post("/v1/gate/verify", body, auth: false)
       end
     end
   end

data/lib/ipscanner/version.rb

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

data/lib/ipscanner.rb

@@ -13,6 +13,7 @@ require_relative "ipscanner/resources/crawlers"
 require_relative "ipscanner/resources/edge"
 require_relative "ipscanner/resources/sites"
 require_relative "ipscanner/resources/gate"
+require_relative "ipscanner/resources/email"
 require_relative "ipscanner/client"
 
 # Ruby client for the IPScanner API.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipscanner-io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - IPScanner
@@ -28,6 +28,7 @@ files:
 - lib/ipscanner/resources/bulk.rb
 - lib/ipscanner/resources/crawlers.rb
 - lib/ipscanner/resources/edge.rb
+- lib/ipscanner/resources/email.rb
 - lib/ipscanner/resources/gate.rb
 - lib/ipscanner/resources/ip.rb
 - lib/ipscanner/resources/provenance.rb