onyphe 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c0c310743c68f3c1da0c267cc273e0ce541957da85d50d691b28872bb496783
-  data.tar.gz: fdad61c790b15127d29d32e0cfa5c1a0f6a0c6e68183029251f955a7619cfc56
+  metadata.gz: bb197595f583cae4f7474231b924a3ea0adb24ba1921acc2452ab8154868b575
+  data.tar.gz: 91af3240e44f93e3f14c7c9f2d6fedbd33a89d6c97f89ffaa8ac4ac31a917861
 SHA512:
-  metadata.gz: 94e29972d127337203a38bea5dbc8d6beaed0db9acf7d7cb005161b4a86884239b4e8a667be3fc5c4c85e873cbd37c71152894b216137645741e3fde511043d9
-  data.tar.gz: ded4b90c9a5b3363c3f2d19c1a74ed6a1725bc9709bf73b6139e990b383bdc77f51f13f74896de298f2af9ad33f48566ed2240c52a9d61de229d9c5396052499
+  metadata.gz: 678cbca08957c71d3c6744b525491f08cb4efa3f8e6483a0fc55e3063bf2876c0207da3c3e40b86fefa88802ad7fdce135e2ad621c33dc6504d5f91d062cb44e
+  data.tar.gz: 8f96e012931f4551a0d3fbf29f60f10aeba8f7da071bbcdbd78ebcd4387bc5ec24058156da32e6baa522b322505c06db2dc1597e7d4be4dd2588f45192cc62c9

data/README.md

@@ -70,28 +70,6 @@ api.search.ctl(host: "vpn")
 api.search.onionscan("app.http.keywords": "dump")
 ```
 
-All the API response is wrapped by [OpenStruct](https://github.com/ruby/ostruct).
-
-It means you can access to a response through a property-like syntax.
-
-```rb
-res = api.sniffer("217.138.28.194")
-res.results.each do |result|
-  puts result.asn
-  puts result.ip
-  puts result.location
-  puts result.organization
-end
-```
-
-Or you can get a hash representative data by using `#to_h` method.
-
-```rb
-res = api.sniffer("217.138.28.194")
-p res.to_h
-# => {:count=>10, :error=>0, :max_page=>3, :myip=>"<MY_IP>", :page=>1, :results=>[{:@category=>"sniffer", :@timestamp=>"2018-11-15T00:35:37.000Z", :@type=>"doc", :asn=>"AS20952", :city=>"London", :country=>"GB", ...
-```
-
 #### Pagination
 
 Enumerable style pagination is not supported at the present time.
@@ -99,7 +77,7 @@ Enumerable style pagination is not supported at the present time.
 You can specify page index by passing `page` argument to the method.
 
 ```rb
-res = api.search.threatlist(country: "RU", page = 1)
+res = api.search.threatlist(country: "RU", page: 1)
 page = res.page
 max_page = res.max_page
 

data/lib/onyphe.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "onyphe/response"
 require "onyphe/api"
 
 require "onyphe/validator"

data/lib/onyphe/api.rb

@@ -6,40 +6,88 @@ module Onyphe
   class API
     extend Forwardable
 
-    attr_reader :search
+    attr_reader :api_key
 
+    #
+    # API client initialization
+    #
+    # @param [String] api_key ONYPHE API key
+    #
     def initialize(api_key = ENV["ONYPHE_API_KEY"])
-      raise(ArgumentError, "'api_key' argument is required") unless api_key
-
-      @ctl = Clients::Ctl.new(api_key)
-      @datascan = Clients::Datascan.new(api_key)
-      @forward = Clients::Forward.new(api_key)
-      @geoloc = Clients::Geoloc.new(api_key)
-      @inetnum = Clients::Inetnum.new(api_key)
-      @ip = Clients::IP.new(api_key)
-      @md5 = Clients::MD5.new(api_key)
-      @onionscan = Clients::Onionscan.new(api_key)
-      @pastries = Clients::Pastries.new(api_key)
-      @reverse = Clients::Reverse.new(api_key)
-      @sniffer = Clients::Sniffer.new(api_key)
-      @synscan = Clients::Synscan.new(api_key)
-      @threatlist = Clients::Threatlist.new(api_key)
-
-      @search = Clients::Search.new(api_key)
-    end
-
-    def_delegator :@ctl, :get_by_domain, :ctl
-    def_delegator :@datascan, :get_by_query, :datascan
-    def_delegator :@forward, :get_by_ip, :forward
-    def_delegator :@geoloc, :get_by_ip, :geoloc
-    def_delegator :@inetnum, :get_by_ip, :inetnum
-    def_delegator :@ip, :get_by_ip, :ip
-    def_delegator :@md5, :get_by_md5, :md5
-    def_delegator :@onionscan, :get_by_onion, :onionscan
-    def_delegator :@pastries, :get_by_ip, :pastries
-    def_delegator :@reverse, :get_by_ip, :reverse
-    def_delegator :@sniffer, :get_by_ip, :sniffer
-    def_delegator :@synscan, :get_by_ip, :synscan
-    def_delegator :@threatlist, :get_by_ip, :threatlist
+      @api_key = api_key
+      raise ArgumentError, "'api_key' argument is required" unless api_key
+    end
+
+    def search
+      @search ||= Clients::Search.new(api_key)
+    end
+
+    private
+
+    def _ctl
+      @_ctl ||= Clients::Ctl.new(api_key)
+    end
+
+    def _datascan
+      @_datascan ||= Clients::Datascan.new(api_key)
+    end
+
+    def _forward
+      @_forward ||= Clients::Forward.new(api_key)
+    end
+
+    def _geoloc
+      @_geoloc ||= Clients::Geoloc.new(api_key)
+    end
+
+    def _inetnum
+      @_inetnum ||= Clients::Inetnum.new(api_key)
+    end
+
+    def _ip
+      @_ip ||= Clients::IP.new(api_key)
+    end
+
+    def _md5
+      @_md5 ||= Clients::MD5.new(api_key)
+    end
+
+    def _onionscan
+      @_onionscan ||= Clients::Onionscan.new(api_key)
+    end
+
+    def _pastries
+      @_pastries ||= Clients::Pastries.new(api_key)
+    end
+
+    def _reverse
+      @_reverse ||= Clients::Reverse.new(api_key)
+    end
+
+    def _sniffer
+      @_sniffer ||= Clients::Sniffer.new(api_key)
+    end
+
+    def _synscan
+      @_synscan ||= Clients::Synscan.new(api_key)
+    end
+
+    def _threatlist
+      @_threatlist ||= Clients::Threatlist.new(api_key)
+    end
+
+    def_delegator :_ctl, :get_by_domain, :ctl
+    def_delegator :_datascan, :get_by_query, :datascan
+    def_delegator :_forward, :get_by_ip, :forward
+    def_delegator :_geoloc, :get_by_ip, :geoloc
+    def_delegator :_inetnum, :get_by_ip, :inetnum
+    def_delegator :_ip, :get_by_ip, :ip
+    def_delegator :_md5, :get_by_md5, :md5
+    def_delegator :_onionscan, :get_by_onion, :onionscan
+    def_delegator :_pastries, :get_by_ip, :pastries
+    def_delegator :_reverse, :get_by_ip, :reverse
+    def_delegator :_sniffer, :get_by_ip, :sniffer
+    def_delegator :_synscan, :get_by_ip, :synscan
+    def_delegator :_threatlist, :get_by_ip, :threatlist
   end
 end

data/lib/onyphe/cli.rb

@@ -7,67 +7,67 @@ module Onyphe
   class CLI < Thor
     desc "ctl DOMAIN", "It will return information for the given domain name X509 certificate information from CTLs with history of changes"
     def ctl(domain)
-      with_error_handling { puts api.ctl(domain).to_h.to_json }
+      with_error_handling { puts api.ctl(domain).to_json }
     end
 
     desc "datascan IP/STRING", "It will return datascan information for the given IPv{4,6} address or string with history of changes"
     def datascan(query)
-      with_error_handling { puts api.datascan(query).to_h.to_json }
+      with_error_handling { puts api.datascan(query).to_json }
     end
 
     desc "forward IP", "It will return forward DNS lookup information for the given IPv{4,6} address with history of changes"
     def forward(ip)
-      with_error_handling { puts api.forward(ip).to_h.to_json }
+      with_error_handling { puts api.forward(ip).to_json }
     end
 
     desc "geoloc IP", "It will return geolocation information for the given IPv{4,6} address"
     def geoloc(ip)
-      with_error_handling { puts api.geoloc(ip).to_h.to_json }
+      with_error_handling { puts api.geoloc(ip).to_json }
     end
 
     desc "inetnum IP", "It will return inetnum information for the given IPv{4,6} address with history of changes"
     def inetnum(ip)
-      with_error_handling { puts api.inetnum(ip).to_h.to_json }
+      with_error_handling { puts api.inetnum(ip).to_json }
     end
 
     desc "ip IP", "It will return a summary of all information for the given IPv{4,6} address"
     def ip(ip)
-      with_error_handling { puts api.ip(ip).to_h.to_json }
+      with_error_handling { puts api.ip(ip).to_json }
     end
 
     desc "md5 MD5", "It will return information for the given datamd5 filter from datascan information category with history of changes"
     def md5(md5)
-      with_error_handling { puts api.md5(md5).to_h.to_json }
+      with_error_handling { puts api.md5(md5).to_json }
     end
 
     desc "onionscan ONION", "It will return information for the given onion domain with history of changes"
     def onionscan(onion)
-      with_error_handling { puts api.onionscan(onion).to_h.to_json }
+      with_error_handling { puts api.onionscan(onion).to_json }
     end
 
     desc "pastries IP", "It will return pastries information for the given IPv{4,6} address with history of changes"
     def pastries(ip)
-      with_error_handling { puts api.pastries(ip).to_h.to_json }
+      with_error_handling { puts api.pastries(ip).to_json }
     end
 
     desc "reverse IP", "It will return reverse DNS lookup information for the given IPv{4,6} address with history of changes"
     def reverse(ip)
-      with_error_handling { puts api.reverse(ip).to_h.to_json }
+      with_error_handling { puts api.reverse(ip).to_json }
     end
 
     desc "sniffer IP", "It will return information for the given IP address with history of changes"
     def sniffer(ip)
-      with_error_handling { puts api.sniffer(ip).to_h.to_json }
+      with_error_handling { puts api.sniffer(ip).to_json }
     end
 
     desc "synscan IP", "It will return synscan information for the given IPv{4,6} address with history of changes."
     def synscan(ip)
-      with_error_handling { puts api.synscan(ip).to_h.to_json }
+      with_error_handling { puts api.synscan(ip).to_json }
     end
 
     desc "threattlist IP", "It will return threatlist information for the given IPv{4,6} address with history of change"
     def threatlist(ip)
-      with_error_handling { puts api.threatlist(ip).to_h.to_json }
+      with_error_handling { puts api.threatlist(ip).to_json }
     end
 
     no_commands do

data/lib/onyphe/client.rb

@@ -36,10 +36,13 @@ module Onyphe
     def request(req)
       Net::HTTP.start(HOST, 443, https_options) do |http|
         http_response = http.request(req)
-        raise(Error, "Unsupported response code returned: #{http_response.code}") unless http_response.code.start_with?("20")
+        code = http_response.code
+        raise Error, "Unsupported response code returned: #{http_response.code}" unless code.start_with?("20")
 
-        response = JSON.parse(http_response.body, object_class: Response)
-        raise(Error, response.message) if response.error.to_i.positive?
+        response = JSON.parse(http_response.body)
+        error = response.dig("error")
+        message = response.dig("message")
+        raise Error, message if error&.to_i&.positive?
 
         yield response
       end

data/lib/onyphe/clients/ctl.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Ctl < Client
-      def get_by_domain(domain, page = 1)
+      def get_by_domain(domain, page: 1)
         raise ArgumentError, "Invalid domain: #{domain}" unless Validator.valid_domain?(domain)
 
         get("/ctl/#{domain}", page: page) { |json| json }

data/lib/onyphe/clients/datascan.rb

@@ -5,7 +5,7 @@ require "addressable/uri"
 module Onyphe
   module Clients
     class Datascan < Client
-      def get_by_query(query, page = 1)
+      def get_by_query(query, page: 1)
         query = Addressable::URI.encode(query)
         get("/datascan/#{query}", page: page) { |json| json }
       end

data/lib/onyphe/clients/forward.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Forward < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/forward/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/geoloc.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Geoloc < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/geoloc/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/inetnum.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Inetnum < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/inetnum/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/ip.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class IP < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/ip/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/md5.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class MD5 < Client
-      def get_by_md5(md5, page = 1)
+      def get_by_md5(md5, page: 1)
         raise ArgumentError, "Invalid md5: #{md5}" unless Validator.valid_md5?(md5)
 
         get("/md5/#{md5}", page: page) { |json| json }

data/lib/onyphe/clients/onionscan.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Onionscan < Client
-      def get_by_onion(onion, page = 1)
+      def get_by_onion(onion, page: 1)
         raise ArgumentError, "Invalid oninon domain: #{onion}" unless Validator.valid_onion_domain?(onion)
 
         get("/onionscan/#{onion}", page: page) { |json| json }

data/lib/onyphe/clients/pastries.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Pastries < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/pastries/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/reverse.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Reverse < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/reverse/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/search.rb

@@ -5,39 +5,39 @@ require "addressable/uri"
 module Onyphe
   module Clients
     class Search < Client
-      def datascan(params, page = 1)
+      def datascan(params, page: 1)
         search("datascan", params, page)
       end
 
-      def synscan(params, page = 1)
+      def synscan(params, page: 1)
         search("synscan", params, page)
       end
 
-      def inetnum(params, page = 1)
+      def inetnum(params, page: 1)
         search("inetnum", params, page)
       end
 
-      def threatlist(params, page = 1)
+      def threatlist(params, page: 1)
         search("threatlist", params, page)
       end
 
-      def pastries(params, page = 1)
+      def pastries(params, page: 1)
         search("pastries", params, page)
       end
 
-      def resolver(params, page = 1)
+      def resolver(params, page: 1)
         search("resolver", params, page)
       end
 
-      def sniffer(params, page = 1)
+      def sniffer(params, page: 1)
         search("sniffer", params, page)
       end
 
-      def ctl(params, page = 1)
+      def ctl(params, page: 1)
         search("ctl", params, page)
       end
 
-      def onionscan(params, page = 1)
+      def onionscan(params, page: 1)
         search("onionscan", params, page)
       end
 

data/lib/onyphe/clients/sniffer.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Sniffer < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/sniffer/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/synscan.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Synscan < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/synscan/#{ip}", page: page) { |json| json }

data/lib/onyphe/clients/threatlist.rb

@@ -3,7 +3,7 @@
 module Onyphe
   module Clients
     class Threatlist < Client
-      def get_by_ip(ip, page = 1)
+      def get_by_ip(ip, page: 1)
         raise ArgumentError, "Invalid IP address: #{ip}" unless Validator.valid_ip?(ip)
 
         get("/threatlist/#{ip}", page: page) { |json| json }

data/lib/onyphe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onyphe
-  VERSION = "0.2.3"
+  VERSION = "1.0.0"
 end

data/onyphe.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "coveralls", "~> 0.8"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onyphe
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Manabu Niseki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +159,6 @@ files:
 - lib/onyphe/clients/sniffer.rb
 - lib/onyphe/clients/synscan.rb
 - lib/onyphe/clients/threatlist.rb
-- lib/onyphe/response.rb
 - lib/onyphe/validator.rb
 - lib/onyphe/version.rb
 - onyphe.gemspec
@@ -182,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: ONYPHE API wrapper for Ruby

data/lib/onyphe/response.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-
-module Onyphe
-  class Response < OpenStruct
-    def openstruct_to_hash(object, hash = {})
-      return object unless object.respond_to?(:each_pair)
-
-      object.each_pair do |key, value|
-        hash[key] = case value
-                    when OpenStruct then openstruct_to_hash(value)
-                    when Array then value.map { |v| openstruct_to_hash(v) }
-                    else value
-                    end
-      end
-      hash
-    end
-
-    def to_h
-      openstruct_to_hash(self)
-    end
-  end
-end