shodanz 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64bf4789450bf85bdb1d354218d49c8bde71505e
-  data.tar.gz: ef3506930d1125e20c93a4d2126defdfba8ba797
+SHA256:
+  metadata.gz: e5da697873b94e412d3732b7a6ed529f83b9aa70bc2e14ae4b9a3ac8738659d4
+  data.tar.gz: f6636ec96aa077123f9e312e14259e1ddfadf6709225bc7c9b3b64b06c0ef611
 SHA512:
-  metadata.gz: 9ec386f513214a9782eab065267661b75657468dc685740758e10da26b8b51417754eab719907adc3b5840884eeae317167a91b314f0fc2dd0964a23155a1533
-  data.tar.gz: 6adda2fd0ac14b127c4de42325d1051cbd5bd4dea5ac2bb93858dfe9b5c31cdaaa903165fe1c71e72a281ed7e84fe5f59725df7debe67bca96f731f5851e33e1
+  metadata.gz: 4ca0447aa1e55d340da2959730edfb982565771adfe80bdc3a2206f4215669bf998c7cfc4c981c77635a3a58abb830f30b96ce29db46d7f72654166982d46f4e
+  data.tar.gz: f814bf859bbd66b80e85e3c9be339c4e68dde1717f389f49940910acfd648bd26178fd140d19d83935b632097d3525ff5c4688d860d8a30468b7d324e0754214

data/README.md

@@ -54,9 +54,8 @@ client.rest_api.host_count("apache")
 client.rest_api.host_count("apache", country: "US")
 client.rest_api.host_count("apache", country: "US", state: "MI")
 client.rest_api.host_count("apache", country: "US", state: "MI", city: "Detroit") 
-client.rest_api.host_count("apache", country: "US", state: "MI", city: "Detroit") 
-client.rest_api.host_count("nginx".  facets: { country: 5 })
-client.rest_api.host_count("apache". facets: { country: 5 })
+client.rest_api.host_count("nginx",  facets: { country: 5 })
+client.rest_api.host_count("apache", facets: { country: 5 })
 ```
 
 #### Scan Targets

data/examples/debug.rb

@@ -2,8 +2,10 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'shodanz'
 require 'pry'
 
-rest_api      = Shodanz.api.rest.new
-streaming_api = Shodanz.api.streaming.new
-exploits_api  = Shodanz.api.exploits.new
+# rest_api      = Shodanz.api.rest.new
+# streaming_api = Shodanz.api.streaming.new
+# exploits_api  = Shodanz.api.exploits.new
+
+client = Shodanz.client.new
 
 binding.pry

data/examples/top_10_countries_running_apache_chart.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "shodanz"
+require "chart_js"
+
+module Top10
+  @rest_api = Shodanz.api.rest.new
+  def self.check(product)
+    begin
+      @rest_api.host_count(product: product, facets: { country: 10 })["facets"]["country"].collect { |x| x.values }.to_h.invert
+    rescue
+      puts "Unable to succesffully check the Shodan API."
+      exit 1
+    end
+  end
+end
+
+results = Top10.check("apache")
+
+ChartJS.bar do
+  file "top_10_apache.html"
+  data do
+    labels results.keys
+    dataset "Countries" do
+      color :random
+      data results.values
+    end 
+  end
+end

data/lib/shodanz.rb

@@ -1,13 +1,18 @@
-require "unirest"
-require "oj"
-require "shodanz/version"
-require "shodanz/api"
-require "shodanz/client"
+require 'unirest'
+require 'oj'
+require 'shodanz/version'
+require 'shodanz/api'
+require 'shodanz/client'
 
+# Shodanz is a modern Ruby gem for Shodan, the world's
+# first search engine for Internet-connected devices.
 module Shodanz
+  # Shortcut for {Shodanz::API}
   def self.api
     API
   end
+
+  # Shortcut for {Shodanz::Client}
   def self.client
     Client
   end

data/lib/shodanz/api.rb

@@ -1,29 +1,31 @@
-require_relative "apis/rest.rb"
-require_relative "apis/streaming.rb"
-require_relative "apis/exploits.rb"
+require_relative 'apis/rest.rb'
+require_relative 'apis/streaming.rb'
+require_relative 'apis/exploits.rb'
 
 module Shodanz
-  # There are 2 APIs for accessing Shodan: the REST API 
-  # and the Streaming API. The REST API provides methods 
-  # to search Shodan, look up hosts, get summary information 
-  # on queries and a variety of utility methods to make 
-  # developing easier. The Streaming API provides a raw, 
-  # real-time feed of the data that Shodan is currently 
-  # collecting. There are several feeds that can be subscribed 
-  # to, but the data can't be searched or otherwise interacted 
-  # with; it's a live feed of data meant for large-scale 
+  # There are 2 APIs for accessing Shodan: the REST API
+  # and the Streaming API. The REST API provides methods
+  # to search Shodan, look up hosts, get summary information
+  # on queries and a variety of utility methods to make
+  # developing easier. The Streaming API provides a raw,
+  # real-time feed of the data that Shodan is currently
+  # collecting. There are several feeds that can be subscribed
+  # to, but the data can't be searched or otherwise interacted
+  # with; it's a live feed of data meant for large-scale
   # consumption of Shodan's information.
+  #
+  # @author Kent 'picat' Gruber
   module API
     # REST API class.
     def self.rest
       REST
     end
-    
+
     # Streaming API class.
     def self.streaming
       Streaming
     end
-    
+
     # Exploits API class.
     def self.exploits
       Exploits

data/lib/shodanz/apis/exploits.rb

@@ -1,8 +1,7 @@
 module Shodanz
-
   module API
-    # The Exploits API provides access to several exploit 
-    # and vulnerability data sources. At the moment, it 
+    # The Exploits API provides access to several exploit
+    # and vulnerability data sources. At the moment, it
     # searches across the following:
     #  - Exploit DB
     #  - Metasploit
@@ -10,76 +9,80 @@ module Shodanz
     #
     # @author Kent 'picat' Gruber
     class Exploits
+      # @return [String]
       attr_accessor :key
-      
+
       # The path to the REST API endpoint.
-      URL = "https://exploits.shodan.io/api/"
+      URL = 'https://exploits.shodan.io/api/'.freeze
 
-      # @param key [String] SHODAN API key, defaulted to the *SHODAN_API_KEY* enviroment variable.
+      # @param key [String] SHODAN API key, defaulted to
+      # the *SHODAN_API_KEY* enviroment variable.
       def initialize(key: ENV['SHODAN_API_KEY'])
         self.key = key
-        warn "No key has been found or provided!" unless self.key?
+        warn 'No key has been found or provided!' unless key?
       end
 
       # Check if there's an API key.
+      # @return [String]
       def key?
-        return true if @key; false
+        return true if @key
+        false
       end
 
-      # Search across a variety of data sources for exploits and 
+      # Search across a variety of data sources for exploits and
       # use facets to get summary information.
       # == Example
       #   api.search("SQL", port: 443)
       #   api.search(port: 22)
       #   api.search(type: "dos")
-      def search(query = "", facets: {}, page: 1, **params)
+      def search(query = '', page: 1, **params)
         params[:query] = query
         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 
+      # 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 = "", facets: {}, page: 1, **params)
+      def count(query = '', page: 1, **params)
         params[:query] = query
         params = turn_into_query(params)
         facets = turn_into_facets(params)
         params[:page] = page
-        get("count", params.merge(facets))
+        get('count', params.merge(facets))
       end
 
       # Perform a direct GET HTTP request to the REST API.
       def get(path, **params)
         resp = Unirest.get "#{URL}#{path}?key=#{@key}", parameters: params
-        raise resp.body["error"] if resp.code != 200 and resp.body.has_key?("error")
+        if resp.code != 200 && resp.body.key?('error')
+          raise resp.body['error']
+        end
         resp.body
       end
 
       private
 
       def turn_into_query(params)
-        filters = params.reject { |key, value| key == :query }
+        filters = params.reject { |key, _| key == :query }
         filters.each do |key, value|
           params[:query] << " #{key}:#{value}"
         end
-        params.select { |key, value| key == :query }
+        params.select { |key, _| key == :query }
       end
 
       def turn_into_facets(facets)
-        filters = facets.reject { |key, value| key == :facets }
+        filters = facets.reject { |key, _| key == :facets }
         facets[:facets] = []
         filters.each do |key, value|
           facets[:facets] << "#{key}:#{value}"
         end
-        facets[:facets] = facets[:facets].join(",")
-        facets.select { |key, value| key == :facets }
+        facets[:facets] = facets[:facets].join(',')
+        facets.select { |key, _| key == :facets }
       end
-
     end
-
   end
 end

data/lib/shodanz/apis/rest.rb

@@ -5,6 +5,7 @@ module Shodanz
     # hosts, get summary information on queries and a variety 
     # of other utilities. This requires you to have an API key
     # which you can get from Shodan.
+    #
     # @author Kent 'picat' Gruber
     class REST
       attr_accessor :key
@@ -112,7 +113,7 @@ module Shodanz
       def crawl_for(**params)
         params[:query] = ""
         params = turn_into_query(params)
-        post("shodan/scan/internet", params)
+        post('shodan/scan/internet', params)
       end
 
       # Check the progress of a previously submitted scan request. 
@@ -122,49 +123,52 @@ 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) 
+        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.
       def profile
-        get("account/profile")
+        get('account/profile')
       end
 
       # Look up the IP address for the provided list of hostnames.
       def resolve(*hostnames)
-        get("dns/resolve", hostnames: hostnames.join(","))
+        get('dns/resolve', hostnames: hostnames.join(","))
       end
 
-      # Look up the hostnames that have been defined for the given list of IP addresses.
+      # Look up the hostnames that have been defined for the 
+      # given list of IP addresses.
       def reverse_lookup(*ips)
-        get("dns/reverse", ips: ips.join(","))
+        get('dns/reverse', ips: ips.join(","))
       end
 
-      # Shows the HTTP headers that your client sends when connecting to a webserver.
+      # Shows the HTTP headers that your client sends when 
+      # connecting to a webserver.
       def http_headers
-        get("tools/httpheaders")
+        get('tools/httpheaders')
       end
 
       # Get your current IP address as seen from the Internet.
       def my_ip
-        get("tools/my_ip")
+        get('tools/myip')
       end
 
-      # Calculates a honeypot probability score ranging from 0 (not a honeypot) to 1.0 (is a honeypot).
+      # Calculates a honeypot probability score ranging 
+      # from 0 (not a honeypot) to 1.0 (is a honeypot).
       def honeypot_score(ip)
         get("labs/honeyscore/#{ip}")
       end
@@ -177,38 +181,43 @@ module Shodanz
       # Perform a direct GET HTTP request to the REST API.
       def get(path, **params)
         resp = Unirest.get "#{URL}#{path}?key=#{@key}", parameters: params
-        raise resp if resp.code != 200 #and resp.body.has_key?("error")
+        if resp.code != 200
+          binding.pry
+          raise resp.body['error'] if resp.body.key?('error')
+          raise resp
+        end
         resp.body
       end
 
       # Perform a direct POST HTTP request to the REST API.
       def post(path, **params)
         resp = Unirest.post "#{URL}#{path}?key=#{@key}", parameters: params
-        raise resp.body["error"] if resp.code != 200 and resp.body.has_key?("error")
+        if resp.code != 200
+          raise resp.body['error'] if resp.body.key?('error')
+          raise resp
+        end
         resp.body
       end
 
       private
 
       def turn_into_query(params)
-        filters = params.reject { |key, value| key == :query }
+        filters = params.reject { |key, _| key == :query }
         filters.each do |key, value|
           params[:query] << " #{key}:#{value}"
         end
-        params.select { |key, value| key == :query }
+        params.select { |key, _| key == :query }
       end
 
       def turn_into_facets(facets)
-        filters = facets.reject { |key, value| key == :facets }
+        filters = facets.reject { |key, _| key == :facets }
         facets[:facets] = []
         filters.each do |key, value|
           facets[:facets] << "#{key}:#{value}"
         end
-        facets[:facets] = facets[:facets].join(",")
-        facets.select { |key, value| key == :facets }
+        facets[:facets] = facets[:facets].join(',')
+        facets.select { |key, _| key == :facets }
       end
-
     end
-
   end
 end

data/lib/shodanz/client.rb

@@ -1,22 +1,22 @@
 module Shodanz
+  # General client container class for all three
+  # of Shodan's available API endpoints in a
+  # convient place to use.
+  #
+  # @author Kent 'picat' Gruber
   class Client
+    # @return [Shodanz::API::REST]
+    attr_reader :rest_api
+    # @return [Shodanz::API::Streaming]
+    attr_reader :streaming_api
+    # @return [Shodanz::API::Exploits]
+    attr_reader :exploits_api
+
     # Create a new client to connect to any of the APIs.
     def initialize
       @rest_api      = Shodanz.api.rest.new
       @streaming_api = Shodanz.api.streaming.new
-      @exploits_api  = Shodanz.api.exploits.new  
-    end
-
-    def rest_api
-      @rest_api
-    end
-
-    def streaming_api
-      @streaming_api
-    end
-
-    def exploits_api
-      @exploits_api
+      @exploits_api  = Shodanz.api.exploits.new
     end
   end
 end

data/lib/shodanz/version.rb

@@ -1,3 +1,3 @@
 module Shodanz
-  VERSION = "1.0.2"
+  VERSION = '1.0.3'.freeze
 end

data/shodanz.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   
   spec.add_dependency "unirest", "1.1.2"
-  spec.add_dependency "json", "1.8.6"
-  spec.add_dependency "oj", "3.3.8"
+  spec.add_dependency "json" # specifying version breaks things, what?
+  spec.add_dependency "oj", "3.5.0"
   
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.16.1"
+  spec.add_development_dependency "rake", "~> 12.3.1"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shodanz
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Kent 'picatz' Gruber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest
@@ -28,72 +28,72 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.6
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.8
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.8
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.16.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.7.0
 description: Featuring full support for the REST, Streaming and Exploits API
 email:
 - kgruber1@emich.edu
@@ -111,6 +111,7 @@ files:
 - Rakefile
 - examples/debug.rb
 - examples/top_10_countries_running.rb
+- examples/top_10_countries_running_apache_chart.rb
 - lib/shodanz.rb
 - lib/shodanz/api.rb
 - lib/shodanz/apis/exploits.rb
@@ -139,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A modern Ruby gem for Shodan, the world's first search engine for Internet-connected