urlscan 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9f5241757fe9214cf9004eed924fbd98d1739358ed6aed85fdcfe63b0bed22
-  data.tar.gz: da1a329d39519094e6fa21e3ba53c52b5c7051cd24d34eeb1aa47fdcadf58b55
+  metadata.gz: 8640ef2ba0a9b73834a5e8999d78223b363fe04643cfcea98a63a8172b486783
+  data.tar.gz: 2957bc3cd06d005275d8179aaaa8faf5a060993aa2c5c41cf261bc28769ed1af
 SHA512:
-  metadata.gz: a120a7c7e56bbc0c2585eab27284e78a31b995ad693497470cf3402a74a2027a878cb2036055c34e17a0cec42779306176594fbc1cbe3e81c7fe68a193924b7b
-  data.tar.gz: 85def877ac0d5dc4c6e99917ff9e820cc12414bea83b304a87090c29aa2f7be8f406fc137cf9825850fd134fb1b9fb3d8bbcc364905d67a66209680863548a96
+  metadata.gz: e882180e835209a6873b0c5032b8587ff2f225760cab8223364e72f7cb914d36f9f99dc9fc9537321ee644371fc0f125824cba4bd720730a5d043b9a0bf58f66
+  data.tar.gz: be54b70647a26856bdccc0c3e8a0c9abf955186c52e49c284e6e4ed98e499ed87f1629536129227bd0aeac9f9af28fa0fcde897c6fffdfeb50c53ffe89d5b954

data/.travis.yml

@@ -2,5 +2,5 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6
+  - 2.7
 before_install: gem install bundler -v 2.1

data/README.md

@@ -40,22 +40,23 @@ res = api.search("wikipedia.org")
 
 ## Supported API endpoints
 
-| HTTP Method | URI                     | API method                                                                    |
-|-------------|-------------------------|-------------------------------------------------------------------------------|
-| POST        | /scan                   | `UrlScan::Clients::Community#submit(url, is_public = true)`                   |
-| GET         | /result/`uuid`/         | `UrlScan::Clients::Community#result(uuid)`                                    |
-| GET         | /dom/`uuid`/            | `UrlScan::Clients::Community#dom(uuid)`                                       |
-| GET         | /screenshots/`uuid`.png | `UrlScan::Clients::Community#screenshot(uuid)`                                |
-| GET         | /search                 | `UrlScan::Clients::Community#search(q, size: 100, offset: 0, sort: "_score")` |
+| HTTP Method | URI                     | API method                                                            |
+|-------------|-------------------------|-----------------------------------------------------------------------|
+| POST        | /scan                   | `UrlScan::Clients::Community#submit(url, is_public = true)`           |
+| GET         | /result/`uuid`/         | `UrlScan::Clients::Community#result(uuid)`                            |
+| GET         | /dom/`uuid`/            | `UrlScan::Clients::Community#dom(uuid)`                               |
+| GET         | /screenshots/`uuid`.png | `UrlScan::Clients::Community#screenshot(uuid)`                        |
+| GET         | /search                 | `UrlScan::Clients::Community#search(q, size: 100, search_after: nil)` |
 
 ### Pro
 
-| HTTP Method | URI        | API method                                                        |
-|-------------|------------|-------------------------------------------------------------------|
-| GET         | /search    | `UrlScan::Clients::Pro#search(query: nil, filter: nil, size: 50)` |
-| GET         | /brands    | `UrlScan::Clients::Pro#brands`                                    |
-| GET         | /kits      | `UrlScan::Clients::Pro#kits`                                      |
-| GET         | /phishfeed | `UrlScan::Clients::Pro#phishfeed`                                 |
+| HTTP Method | URI                     | API method                                                        |
+|-------------|-------------------------|-------------------------------------------------------------------|
+| GET         | /search                 | `UrlScan::Clients::Pro#search(query: nil, filter: nil, size: 50)` |
+| GET         | /brands                 | `UrlScan::Clients::Pro#brands`                                    |
+| GET         | /kits                   | `UrlScan::Clients::Pro#kits`                                      |
+| GET         | /phishfeed              | `UrlScan::Clients::Pro#phishfeed`                                 |
+| GET         | /result/`uuid`/similar/ | `UrlScan::Clients::Pro#similar(uuid)`                             |
 
 ## CLI usage
 

data/lib/urlscan/clients/base.rb

@@ -18,7 +18,7 @@ module UrlScan
       private
 
       def url
-        @url ||= "https://#{self.class::HOST}/api/v#{self.class::VERSION}"
+        @url ||= "https://#{HOST}/api/v#{VERSION}"
       end
 
       def url_for(path)
@@ -61,17 +61,20 @@ module UrlScan
         end
       end
 
-      def auth_header
-        { "API-KEY": key }
+      def default_headers
+        @default_headers ||= { "API-KEY": key }.compact
       end
 
-      def get(path, &block)
-        get = Net::HTTP::Get.new(url_for(path))
+      def get(path, params = {}, &block)
+        uri = url_for(path)
+        uri.query = URI.encode_www_form(params)
+
+        get = Net::HTTP::Get.new(uri, default_headers)
         request(get, &block)
       end
 
       def post(path, json, &block)
-        post = Net::HTTP::Post.new(url_for(path), auth_header)
+        post = Net::HTTP::Post.new(url_for(path), default_headers)
         post.content_type = "application/json"
         post.body = json.to_json
 

data/lib/urlscan/clients/community.rb

@@ -5,8 +5,6 @@ module UrlScan
     class Community < Base
       # @return [Hash]
       def submit(url, is_public = true)
-        raise ArgumentError, "API key is required for this method." if key.nil?
-
         params = { url: url, public: is_public ? "on" : "off" }
         post("/scan/", params) { |json| json }
       end
@@ -26,10 +24,9 @@ module UrlScan
       end
 
       # @return [Hash]
-      def search(q, size: 100, offset: 0, sort: "_score")
-        params = { q: q, size: size, offset: offset, sort: sort }
-        query = URI.encode_www_form(params)
-        get("/search/?#{query}") { |json| json }
+      def search(q, size: 100, search_after: nil)
+        params = { q: q, size: size, search_after: search_after }.compact
+        get("/search/", params) { |json| json }
       end
     end
   end

data/lib/urlscan/clients/pro.rb

@@ -8,37 +8,30 @@ module UrlScan
 
       # @return [Hash]
       def search(query: nil, filter: nil, size: 50)
-        raise ArgumentError, "API key is required for this method." if key.nil?
-
         filter = build_filter(filter)
-        params = { q: query, size: size }.compact
-        uri_query = URI.encode_www_form(params)
-        uri_query << "&filter=#{filter}" if filter
-
-        get("/search?#{uri_query}") { |json| json }
+        params = { q: query, size: size, filter: filter }.compact
+        get("/search", params) { |json| json }
       end
 
       # @return [Hash]
       def brands
-        raise ArgumentError, "API key is required for this method." if key.nil?
-
         get("/brands") { |json| json }
       end
 
       # @return [Hash]
       def kits
-        raise ArgumentError, "API key is required for this method." if key.nil?
-
         get("/kits") { |json| json }
       end
 
       # @return [Hash]
       def phishfeed(q: "result.task.time:>now-24h", format: "json")
-        raise ArgumentError, "API key is required for this method." if key.nil?
-
         params = { q: q, format: format }
-        query = URI.encode_www_form(params)
-        get("/phishfeed?#{query}") { |json| json }
+        get("/phishfeed", params) { |json| json }
+      end
+
+      # @return [Hash]
+      def similar(uuid)
+        get("/result/#{uuid}/similar") { |json| json }
       end
 
       private
@@ -50,12 +43,7 @@ module UrlScan
       end
 
       def url
-        @url ||= "https://#{self.class::HOST}/api/v#{self.class::VERSION}/pro"
-      end
-
-      def get(path, &block)
-        get = Net::HTTP::Get.new(url_for(path), auth_header)
-        request(get, &block)
+        @url ||= "https://#{HOST}/api/v#{VERSION}/pro"
       end
     end
   end

data/lib/urlscan/commands/community.rb

@@ -22,11 +22,10 @@ module UrlScan
 
       desc "search [QUERY]", "search for scans by [QUERY]"
       method_option :size, type: :numeric, default: 100
-      method_option :offset, type: :numeric, default: 0
-      method_option :sort, type: :string, default: "_score"
+      method_option :search_after, type: :string
       def search(query)
         with_error_handling do
-          res = api.search(query, size: options["size"], offset: options["offset"], sort: options["sort"])
+          res = api.search(query, size: options["size"], search_after: options["search_after"])
           puts JSON.pretty_generate(res)
         end
       end

data/lib/urlscan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UrlScan
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/urlscan.gemspec

@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "coveralls", "~> 0.8"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "vcr", "~> 5.0"
-  spec.add_development_dependency "webmock", "~> 3.7"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.8"
 
   spec.add_runtime_dependency "thor", "~> 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: urlscan
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Manabu Niseki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
 - manabu.niseki@gmail.com
 executables:
@@ -137,12 +137,13 @@ files:
 - lib/urlscan/commands/pro.rb
 - lib/urlscan/exceptions.rb
 - lib/urlscan/version.rb
+- renovate.json
 - urlscan.gemspec
 homepage: https://github.com/ninoseki/urlscan
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby API client for urlscan.io
 test_files: []