shodanz 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edfee7e174978325331ceb16d7d7f19a1cd7f7cdb6731269cf8f3bc9d9fdcb31
-  data.tar.gz: d89a612b5e3e90aa0ef9a288cf9650875f9a0031bf936d94b82d45852fb887ba
+  metadata.gz: 32aa0999f1cb087637e0abe8428bd70592f22a3761da87be09bcf1a2bd8c2d37
+  data.tar.gz: a6d8a053446c3163bb3ee7630c5663510e6568469cd0569e6c6d4ad67d1873a3
 SHA512:
-  metadata.gz: 3f9e3e19895688ad861517883165a0b06b965f89c28854d73bec521b7a0430ebd5394519aaf4fef5e5397c9c31520bff32eed9cbeed336f4c3932bf34b1c4f09
-  data.tar.gz: '09326a94bb100c9abe45715fc0430f4f8dedbfffbba359346b268d17b4c8523fbf3795c93cd054ed4b68af98e1166857385c8a6df5b66278d0fea56164bea6cc'
+  metadata.gz: d3c5e27187e510f5b811bee421194b269bcc1092bc4b212c7a172c342f1b6a4c932314e5198e89b16509ce6c1345714e232461e4c3b34de1bf2262797a435bdf
+  data.tar.gz: d66f4fc7e68963a54870b789a1b63ada8ffe3174947f6b641dfa8b43547d77ef37b73fc16ff7c4f8715244be8449037dcc5fa2b7028cf50424b43a6004c4297b

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  member:
+  push:
+    branches:
+    - master
+  schedule:
+  - cron: "0 9 * * *"
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+    - name: Rspec
+      env:
+        SHODAN_API_KEY: ${{secrets.SHODAN_API_KEY}}
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec
+

data/README.md

@@ -1,5 +1,8 @@
 # Shodanz
 
+[![Gem Version](https://badge.fury.io/rb/shodanz.svg)](https://badge.fury.io/rb/shodanz)
+[![Yard Docs](http://img.shields.io/badge/shodanz-docs-blue.svg)](https://www.rubydoc.info/gems/shodanz/)
+
 A modern, async Ruby [gem](https://rubygems.org/) for [Shodan](https://www.shodan.io/), the world's first search engine for Internet-connected devices.
 
 ## Installation
@@ -24,9 +27,8 @@ require 'shodanz'
 
 client = Shodanz.client.new
 
-# Asyncronously stream live banner info from shodan
-# and check the IP addresses against the expierimental
-# honeypot scoring service to find potential honeypots.
+# Asynchronously stream banner info from shodan  and check any
+# IP addresses against the experimental honeypot scoring service.
 client.streaming_api.banners do |banner|
   if ip = banner['ip_str']
     Async do

data/examples/async_honeypot_detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'async'
 require 'shodanz'
@@ -12,7 +14,7 @@ client.streaming_api.banners do |banner|
     rescue Shodanz::Errors::RateLimited
       sleep rand
       retry
-    rescue # any other errors
+    rescue StandardError # any other errors
       next
     end
   end

data/lib/shodanz/apis/exploits.rb

@@ -45,24 +45,24 @@ module Shodanz
       #   api.search("SQL", port: 443)
       #   api.search(port: 22)
       #   api.search(type: "dos")
-      def search(query = '', page: 1, **params)
+      def search(query = '', facets: {}, page: 1, **params)
         params[:query] = query
-        params = turn_into_query(params)
-        facets = turn_into_facets(facets)
+        params = turn_into_query(**params)
+        facets = turn_into_facets(**facets)
         params[:page] = page
-        get('search', params.merge(facets))
+        get('search', **params.merge(**facets))
       end
 
       # This method behaves identical to the "/search" method with
       # the difference that it doesn't return any results.
       # == Example
       #   api.count(type: "dos")
-      def count(query = '', page: 1, **params)
+      def count(query = '', facets: {}, page: 1, **params)
         params[:query] = query
-        params = turn_into_query(params)
-        facets = turn_into_facets(params)
+        params = turn_into_query(**params)
+        facets = turn_into_facets(**facets)
         params[:page] = page
-        get('count', params.merge(facets))
+        get('count', **params.merge(**facets))
       end
     end
   end

data/lib/shodanz/apis/rest.rb

@@ -49,7 +49,7 @@ module Shodanz
       #   # Only return the list of ports and the general host information, no banners.
       #   rest_api.host("8.8.8.8", minify: true)
       def host(ip, **params)
-        get("shodan/host/#{ip}", params)
+        get("shodan/host/#{ip}", **params)
       end
 
       # This method behaves identical to "/shodan/host/search" with the only
@@ -64,9 +64,9 @@ module Shodanz
       #   rest_api.host_count("apache", country: "US", state: "MI", city: "Detroit")
       def host_count(query = '', facets: {}, **params)
         params[:query] = query
-        params = turn_into_query(params)
-        facets = turn_into_facets(facets)
-        get('shodan/host/count', params.merge(facets))
+        params = turn_into_query(**params)
+        facets = turn_into_facets(**facets)
+        get('shodan/host/count', **params.merge(**facets))
       end
 
       # Search Shodan using the same query syntax as the website and use facets
@@ -75,19 +75,19 @@ module Shodanz
       #   rest_api.host_search("apache", country: "US", facets: { city: "Detroit" }, page: 1, minify: false)
       def host_search(query = '', facets: {}, page: 1, minify: true, **params)
         params[:query] = query
-        params = turn_into_query(params)
-        facets = turn_into_facets(facets)
+        params = turn_into_query(**params)
+        facets = turn_into_facets(**facets)
         params[:page] = page
         params[:minify] = minify
-        get('shodan/host/search', params.merge(facets))
+        get('shodan/host/search', **params.merge(**facets))
       end
 
       # This method lets you determine which filters are being used by
       # the query string and what parameters were provided to the filters.
       def host_search_tokens(query = '', **params)
         params[:query] = query
-        params = turn_into_query(params)
-        get('shodan/host/search/tokens', params)
+        params = turn_into_query(**params)
+        get('shodan/host/search/tokens', **params)
       end
 
       # This method returns a list of port numbers that the crawlers are looking for.
@@ -122,8 +122,8 @@ module Shodanz
       #   rest_api.crawl_for(port: 80, protocol: "http")
       def crawl_for(**params)
         params[:query] = ''
-        params = turn_into_query(params)
-        post('shodan/scan/internet', params)
+        params = turn_into_query(**params)
+        post('shodan/scan/internet', **params)
       end
 
       # Check the progress of a previously submitted scan request.
@@ -133,21 +133,21 @@ module Shodanz
 
       # Use this method to obtain a list of search queries that users have saved in Shodan.
       def community_queries(**params)
-        get('shodan/query', params)
+        get('shodan/query', **params)
       end
 
       # Use this method to search the directory of search queries that users have saved in Shodan.
       def search_for_community_query(query, **params)
         params[:query] = query
-        params = turn_into_query(params)
-        get('shodan/query/search', params)
+        params = turn_into_query(**params)
+        get('shodan/query/search', **params)
       end
 
       # Use this method to obtain a list of popular tags for the saved search queries in Shodan.
       def popular_query_tags(size = 10)
         params = {}
         params[:size] = size
-        get('shodan/query/tags', params)
+        get('shodan/query/tags', **params)
       end
 
       # Returns information about the Shodan account linked to this API key.

data/lib/shodanz/apis/streaming.rb

@@ -54,7 +54,7 @@ module Shodanz
       #     puts data
       #   end
       def banners(**params)
-        slurp_stream('shodan/banners', params) do |data|
+        slurp_stream('shodan/banners', **params) do |data|
           yield data
         end
       end
@@ -67,7 +67,7 @@ module Shodanz
       #     puts data
       #   end
       def banners_within_asns(*asns, **params)
-        slurp_stream("shodan/asn/#{asns.join(',')}", params) do |data|
+        slurp_stream("shodan/asn/#{asns.join(',')}", **params) do |data|
           yield data
         end
       end

data/lib/shodanz/apis/utils.rb

@@ -14,32 +14,32 @@ module Shodanz
     module Utils
       # Perform a direct GET HTTP request to the REST API.
       def get(path, **params)
-        return sync_get(path, params) unless Async::Task.current?
+        return sync_get(path, **params) unless Async::Task.current?
 
-        async_get(path, params)
+        async_get(path, **params)
       end
 
       # Perform a direct POST HTTP request to the REST API.
       def post(path, **params)
-        return sync_post(path, params) unless Async::Task.current?
+        return sync_post(path, **params) unless Async::Task.current?
 
-        async_post(path, params)
+        async_post(path, **params)
       end
 
       # Perform the main function of consuming the streaming API.
       def slurp_stream(path, **params)
         if Async::Task.current?
-          async_slurp_stream(path, params) do |result|
+          async_slurp_stream(path, **params) do |result|
             yield result
           end
         else
-          sync_slurp_stream(path, params) do |result|
+          sync_slurp_stream(path, **params) do |result|
             yield result
           end
         end
       end
 
-      def turn_into_query(params)
+      def turn_into_query(**params)
         filters = params.reject { |key, _| key == :query }
         filters.each do |key, value|
           params[:query] << " #{key}:#{value}"
@@ -47,7 +47,7 @@ module Shodanz
         params.select { |key, _| key == :query }
       end
 
-      def turn_into_facets(facets)
+      def turn_into_facets(**facets)
         return {} if facets.nil?
 
         filters = facets.reject { |key, _| key == :facets }
@@ -81,10 +81,8 @@ module Shodanz
         # build up url string based on special params
         url = "#{@url}#{path}?key=#{@key}"
         # special params
-        %w[query ips hostnames].each do |param|
-          if (value = params.delete(param))
-            url += "&#{param}=#{value}"
-          end
+        params.each do |param,value|
+          url += "&#{param}=#{value}" unless value.is_a?(String) && value.empty?
         end
         resp = @internet.get(url)
 
@@ -137,37 +135,37 @@ module Shodanz
 
       def async_get(path, **params)
         Async::Task.current.async do
-          getter(path, params)
+          getter(path, **params)
         end
       end
 
       def sync_get(path, **params)
         Async do
-          getter(path, params)
+          getter(path, **params)
         end.wait
       end
 
       def async_post(path, **params)
         Async::Task.current.async do
-          poster(path, params)
+          poster(path, **params)
         end
       end
 
       def sync_post(path, **params)
         Async do
-          poster(path, params)
+          poster(path, **params)
         end.wait
       end
 
       def async_slurp_stream(path, **params)
         Async::Task.current.async do
-          slurper(path, params) { |data| yield data }
+          slurper(path, **params) { |data| yield data }
         end
       end
 
       def sync_slurp_stream(path, **params)
         Async do
-          slurper(path, params) { |data| yield data }
+          slurper(path, **params) { |data| yield data }
         end.wait
       end
     end

data/lib/shodanz/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shodanz
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/shodanz.gemspec

@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'async', '~> 1.17.1'
-  spec.add_dependency 'async-http', '~> 0.38.1'
+  spec.add_dependency 'async-http', '>= 0.38.1', '< 0.51.0'
+  spec.add_dependency 'async', '>= 1.17.1', '< 1.25.0'
 
-  spec.add_development_dependency 'async-rspec', '~> 1.12.1'
-  spec.add_development_dependency 'bundler', '~> 1.17.2'
+  spec.add_development_dependency 'async-rspec', '~> 1.14.0'
+  spec.add_development_dependency 'bundler', '~> 2.1.2'
   spec.add_development_dependency 'pry', '~> 0.12.2'
-  spec.add_development_dependency 'rake', '~> 12.3.2'
+  spec.add_development_dependency 'rake', '~> 13.0.0'
   spec.add_development_dependency 'rb-readline', '~> 0.5.5'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
 end

metadata

@@ -1,71 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: shodanz
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Kent 'picatz' Gruber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: async
+  name: async-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 0.38.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: 0.38.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
 - !ruby/object:Gem::Dependency
-  name: async-http
+  name: async
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.38.1
+        version: 1.17.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.38.1
+        version: 1.17.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.1
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.2
+        version: 2.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.2
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +98,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.9.0
 description: Featuring full support for the REST, Streaming and Exploits API
 email:
 - kgruber1@emich.edu
@@ -129,6 +141,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -173,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 3.0.0.beta1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A modern, async Ruby gem for Shodan, the world's first search engine for