ipscanner-io 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ea296db01a984ba8d7229954dc752f1daf4a8c53ac9316724a7ed563d89f49
-  data.tar.gz: 189505d178d0f44e8622cedc5104aeb84d9849a1c1d440051c9b75fa9c8bcb61
+  metadata.gz: b7a8b3d5d555b9e2144338cbac64916afe040753ab2bdb4c79d7cfb02f72d72c
+  data.tar.gz: ef4d623e45c017b03fa384e7d82a40caf3a00917405d0b49078a03ad006ccd42
 SHA512:
-  metadata.gz: a6a9d4b0640499a25f03939275d1d133fa709351a9159472da883d6860810f4445e67e3d44e3a53936cb00510931a843ebaf1d2a0afecedc4ed674723d5821a4
-  data.tar.gz: 66727a60ddf55a4499edbc3b4be1a8bcd3be7b05aafe8446d27055bbb274587e5d35925220aaa16790518568ae1ea1cca57da0bec4ab1023ba076812de6454dd
+  metadata.gz: e9a249af17bac70daa3d8e29a907ee6df249311b9e6d8786d36305ce3003f41af29770e5ab9cd85fbb8e6a46f8e5e944aebbf0ebd935c5ce395a5757de3dee57
+  data.tar.gz: 8a853e728a652899252ae604027244119baba699909bef53033541364b435bc0d2d7c5facce138cfb63f582aeeddc25c87b9a83165d17512567726ad39a70204

data/README.md

@@ -32,6 +32,8 @@ puts result["purity"]["grade"]
 
 Every method returns the parsed JSON response as a Hash with the same string keys the API sends.
 
+`vpnProvider` names the VPN brand when known. On the Free plan, premium fields come back as `nil` and are listed in `locked`, with `planRequired` naming the plan that unlocks them.
+
 ## Usage
 
 ### IP
@@ -48,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
@@ -79,6 +92,27 @@ client.agentscan.allowlist
 client.agentscan.self_check
 ```
 
+### Edge
+
+```ruby
+client.edge.check(ip: "203.0.113.7", site: "your-site-id", user_agent: request.user_agent)
+```
+
+### Sites
+
+```ruby
+client.sites.policy("your-site-id")
+```
+
+### Gate
+
+```ruby
+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. `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
 
 ```ruby
@@ -147,7 +181,7 @@ IPScanner::Client.new(
 )
 ```
 
-Keyless endpoints (`ip.demo`, `ip.myip`, `asn_directory`, `crawlers`) work without an API key.
+Keyless endpoints (`ip.demo`, `ip.myip`, `asn_directory`, `crawlers`, `gate.verify`) work without an API key.
 
 ## Licence
 

data/lib/ipscanner/client.rb

@@ -5,7 +5,8 @@ module IPScanner
   class Client
     DEFAULT_BASE_URL = "https://ipscanner.io"
 
-    attr_reader :ip, :bulk, :agentscan, :provenance, :account, :asn_directory, :crawlers
+    attr_reader :ip, :bulk, :agentscan, :provenance, :account, :asn_directory, :crawlers,
+                :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)
@@ -20,6 +21,10 @@ module IPScanner
       @account = Resources::Account.new(http)
       @asn_directory = Resources::AsnDirectory.new(http)
       @crawlers = Resources::Crawlers.new(http)
+      @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

@@ -48,8 +48,8 @@ module IPScanner
       request(Net::HTTP::Get, path, query: query, raw: raw)
     end
 
-    def post(path, body = {})
-      request(Net::HTTP::Post, path, body: body)
+    def post(path, body = {}, auth: true)
+      request(Net::HTTP::Post, path, body: body, auth: auth)
     end
 
     def stream(path, body)
@@ -78,14 +78,14 @@ module IPScanner
 
     private
 
-    def request(klass, path, query: nil, body: nil, raw: false)
+    def request(klass, path, query: nil, body: nil, raw: false, auth: true)
       uri = build_uri(path, query)
       attempts = 0
       loop do
         attempts += 1
         begin
           res = with_errors do
-            connection(uri, @timeout).start { |http| http.request(build_request(klass, uri, body)) }
+            connection(uri, @timeout).start { |http| http.request(build_request(klass, uri, body, auth: auth)) }
           end
         rescue ConnectionError
           raise unless retryable?(klass, attempts)
@@ -135,11 +135,11 @@ module IPScanner
       http
     end
 
-    def build_request(klass, uri, body)
+    def build_request(klass, uri, body, auth: true)
       req = klass.new(uri)
       req["Accept"] = "application/json"
       req["User-Agent"] = "ipscanner-ruby/#{VERSION}"
-      req["Authorization"] = "Bearer #{@api_key}" if @api_key && !@api_key.empty?
+      req["Authorization"] = "Bearer #{@api_key}" if auth && @api_key && !@api_key.empty?
       unless body.nil?
         req["Content-Type"] = "application/json"
         req.body = JSON.generate(body)

data/lib/ipscanner/resources/bulk.rb

@@ -9,7 +9,7 @@ module IPScanner
       EVENT_DEFAULTS = {
         "type" => "", "index" => 0, "total" => 0, "input" => "", "reason" => "",
         "message" => "", "error" => "", "ip" => "", "verdict" => "", "classification" => "",
-        "confidence" => 0.0, "anonymized" => false, "score" => 0, "grade" => "",
+        "confidence" => 0.0, "anonymized" => false, "vpnProvider" => "", "score" => 0, "grade" => "",
         "isTorExit" => false, "asn" => "", "asnName" => "", "asnType" => "", "country" => "",
         "processed" => 0, "failed" => 0, "metered" => 0
       }.freeze
@@ -24,7 +24,7 @@ module IPScanner
         return enum_for(:stream, ips: ips, input: input) unless block_given?
 
         @http.stream("/v1/ip/bulk", body(ips, input)) do |line|
-          event = EVENT_DEFAULTS.merge(line)
+          event = EVENT_DEFAULTS.merge(line.compact)
           if event["type"] == "done"
             event["complete"] = event["reason"] == "complete" &&
                                 event["processed"] + event["failed"] >= event["total"]

data/lib/ipscanner/resources/edge.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module IPScanner
+  module Resources
+    # Edge: one verdict per request from Agentscan and the network check.
+    class Edge < Base
+      # Classifies a request for a site. Metered at 2 units.
+      def check(ip:, site: nil, user_agent: nil, ja4: nil, headers: nil, headless_flags: nil, request_id: nil)
+        body = {
+          site: site, ip: ip, user_agent: user_agent, ja4: ja4, headers: headers,
+          headless_flags: headless_flags, request_id: request_id
+        }
+        @http.post("/v1/edge/check", compact(body))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module IPScanner
+  module Resources
+    # 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.
+      # 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
+end

data/lib/ipscanner/resources/sites.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module IPScanner
+  module Resources
+    # Sites registered for edge checks and the gate.
+    class Sites < Base
+      # Current policy for a site. Not metered.
+      def policy(id)
+        @http.get("/v1/sites/#{escape(id)}/policy")
+      end
+    end
+  end
+end

data/lib/ipscanner/version.rb

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

data/lib/ipscanner.rb

@@ -10,6 +10,10 @@ require_relative "ipscanner/resources/provenance"
 require_relative "ipscanner/resources/account"
 require_relative "ipscanner/resources/asn_directory"
 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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - IPScanner
@@ -27,8 +27,12 @@ files:
 - lib/ipscanner/resources/base.rb
 - 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
+- lib/ipscanner/resources/sites.rb
 - lib/ipscanner/version.rb
 homepage: https://ipscanner.io
 licenses: