shodanz 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48a791b83185c4a828cc55edfe28e5fb29580e968b4608d0e3e595032fc6c25f
-  data.tar.gz: 24416f67e74472a918a59393b353a65a88e42c15cac113650ffa3bbc8458de61
+  metadata.gz: 27e38f509164ad306e776ee41ba0c51c89a356faa14509624db69afedecded7f
+  data.tar.gz: 71e6a66e3e5203dd03e8c5402698db4c3d48094d218227fc80f28f6466bdf3fa
 SHA512:
-  metadata.gz: 040646faeb25075f1e6c76824825e35ea84fd22059857a0ec921117d23fe2ed2964ecfe23764ebb4068f597a52570f2a169136438406f2d852d91ecbf56924d8
-  data.tar.gz: 3931188b212c414005f88dedad8b8a7467c080cfc4ef00b0e37947c41491e471c2aa560664dc2148dd26c75f2712a99e98a5941fa9ce1303f72e858dafb5a6e2
+  metadata.gz: 56811bcfb9af3c46b83d2cd871e78f5a93c74b5e21727b6a7e2b2551122193036695e8fbc1b01e3d89389b9d133de00db6721548b36795e0539dcab71fe644fb
+  data.tar.gz: bcbe2fe02bcf4aa59a248a607a19e82e9a6c7db3e6a0b14ab762caf0d523dd1923b623e448d14b4aa6561e7fba7e3b10d0055617fe0dd561b668f6fa37e2e1a2

data/README.md

@@ -11,8 +11,9 @@ A modern Ruby [gem](https://rubygems.org/) for [Shodan](https://www.shodan.io/),
 ```ruby
 require "shodanz"
 
-client = Shodanz.client.new
+client = Shodanz.client.new(key: "YOUR_API_KEY")
 ```
+> You can also set the `SHODAN_API_KEY` environment variable instead of passing the API key as an argument when creating a client.
 
 ## REST API
 

data/lib/shodanz/client.rb

@@ -13,10 +13,19 @@ module Shodanz
     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
+    #
+    # Optionally provide your shodan API key, or the environment
+    # variable SHODAN_API_KEY will be used.
+    def initialize(key: ENV['SHODAN_API_KEY'])
+      raise "No API key has been found or provided! ( setup your SHODAN_API_KEY environment varialbe )" if key.nil?
+      # pass the given API key to each of the underlying clients
+      #
+      # Note: you can optionally change these API keys later, if you
+      # had multiple for whatever reason. ;)
+      #
+      @rest_api      = Shodanz.api.rest.new(key: key)
+      @streaming_api = Shodanz.api.streaming.new(key: key)
+      @exploits_api  = Shodanz.api.exploits.new(key: key)
     end
   end
 end

data/lib/shodanz/version.rb

@@ -1,3 +1,3 @@
 module Shodanz
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.0.5'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shodanz
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Kent 'picatz' Gruber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-27 00:00:00.000000000 Z
+date: 2018-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest