censu 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 689085dedc6c546aab344362dafad21976d0d9ad42c3402873b907745cdb41f0
-  data.tar.gz: b0e0c0eb6a0f03b25289e827834f322ac6293bff8869d09355ed87592a457c13
+  metadata.gz: af8770860ef1c212a40039c69c74ab333edac166d8c070e1ccb4adf027caa535
+  data.tar.gz: 8b78c15ee59f19dd999ed69488b508be26931cfd6766ff747f8a179088f4d9e7
 SHA512:
-  metadata.gz: 1db979e480c89463f6218b9ce05df6e8e13f30fe74a87dabf414943bc9e8f07e52afb1ab07274c1814ac27f2713231529165304e1c8ae2e319066e97de8af535
-  data.tar.gz: 98e8fde7d80fba0033d882ff5f65d387982c3113875c1bc4a10ec377c0940fd3d2625279384af2431f2ea3c2ebce024a0dea7be2e41352ef106c5b99fc33d80c
+  metadata.gz: a032559c4b00a88f655afc64b17fa3bcf9b4f445c826539b473c6e202f3c2583e8290a77c46077069cd4944c04ba91abb721c62a4f4ceae403dd058a9e97d0e8
+  data.tar.gz: b8f51ba142b1d75c286f9fba9ea3fe209d99cc9d55d983293bd0296d6c8734dec0560284e9d3627e95ed908701b53788344a6d12fb14a02b93600236df9a19c6

data/.rspec

@@ -1 +1,3 @@
---colour --format documentation
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,141 +1,148 @@
 # Relaxed.Ruby.Style
 ## Version 2.2
 
+AllCops:
+  TargetRubyVersion: 2.5
+
 Style/Alias:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylealias
+  StyleGuide: https://relaxed.ruby.style/#stylealias
 
 Style/AsciiComments:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleasciicomments
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
 
 Style/BeginBlock:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
 
 Style/BlockDelimiters:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
 
 Style/CommentAnnotation:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylecommentannotation
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
 
 Style/Documentation:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
 
 Layout/DotPosition:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#layoutdotposition
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
 
 Style/DoubleNegation:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
 
 Style/EndBlock:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleendblock
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
 
 Style/FormatString:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
 
 Style/IfUnlessModifier:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
 
 Style/Lambda:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylelambda
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
 
 Style/ModuleFunction:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
 
 Style/MultilineBlockChain:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
 
 Style/NegatedIf:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
 
 Style/NegatedWhile:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
 
 Style/ParallelAssignment:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
 
 Style/PercentLiteralDelimiters:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
 
 Style/PerlBackrefs:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
 
 Style/Semicolon:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
 
 Style/SignalException:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
 
 Style/SingleLineBlockParams:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
 
 Style/SingleLineMethods:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
 
 Layout/SpaceBeforeBlockBraces:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#layoutspacebeforeblockbraces
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
 
 Layout/SpaceInsideParens:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#layoutspaceinsideparens
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
 
 Style/SpecialGlobalVars:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
 
 Style/StringLiterals:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
 
 Style/TrailingCommaInArguments:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainarguments
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
 
 Style/TrailingCommaInArrayLiteral:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainarrayliteral
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
 
 Style/TrailingCommaInHashLiteral:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainhashliteral
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/SymbolArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesymbolarray
 
 Style/WhileUntilModifier:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
 
 Style/WordArray:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#stylewordarray
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
 
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
 
 Lint/AssignmentInCondition:
   Enabled: false
-  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
 
 Metrics/AbcSize:
   Enabled: false
@@ -163,4 +170,3 @@ Metrics/ParameterLists:
 
 Metrics/PerceivedComplexity:
   Enabled: false
-

data/README.md

@@ -20,7 +20,7 @@ require 'censys'
 api = Censys::API.new(uid, secret)
 ```
 
-Initialize the API using `$CENSYS_ID` and `$CENSYS_SECRET` environment variables:
+Initialize the API by using `$CENSYS_ID` and `$CENSYS_SECRET` environment variables:
 
 ```ruby
 api = Censys::API.new
@@ -96,7 +96,7 @@ end
 
 ## Requirements
 
-* [ruby] >= 2.4
+- Ruby 2.4 / 2.5
 
 ## Install
 

data/censys.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'censys/version'
 

data/lib/censu.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'censys/api'
 require 'censys/version'

data/lib/censys.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'censys/api'
 require 'censys/version'

data/lib/censys/account.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'censys/account/quota'
+
+module Censys
+  class Account
+    attr_reader :api_id
+    attr_reader :email
+    attr_reader :first_login
+    attr_reader :last_login
+    attr_reader :login
+    attr_reader :quota
+
+    def initialize(attributes)
+      @api_id       = attributes["api_id"]
+      @email        = attributes["email"]
+      @first_login  = attributes["first_login"]
+      @last_login   = attributes["last_login"]
+      @login        = attributes["login"]
+      @quota        = Quota.new(attributes["quota"])
+    end
+  end
+end

data/lib/censys/account/quota.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Censys
+  class Account
+    class Quota
+      attr_reader :used
+      attr_reader :resets_at
+      attr_reader :allowance
+
+      def initialize(attributes)
+        @used       = attributes["used"]
+        @resets_at  = attributes["resets_at"]
+        @allowance  = attributes["allowance"]
+      end
+    end
+  end
+end

data/lib/censys/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'censys/exceptions'
 require 'censys/search'
 require 'censys/report'
@@ -5,6 +7,7 @@ require 'censys/ipv4'
 require 'censys/website'
 require 'censys/certificate'
 require 'censys/data'
+require 'censys/account'
 
 require 'net/https'
 require 'json'
@@ -12,8 +15,8 @@ require 'json'
 module Censys
   class API
     VERSION = 1
-    HOST = 'www.censys.io'.freeze
-    URL = "https://#{HOST}/api/v#{VERSION}".freeze
+    HOST = 'www.censys.io'
+    URL = "https://#{HOST}/api/v#{VERSION}"
 
     class Resource
       def initialize(type, api)
@@ -188,6 +191,12 @@ module Censys
       end
     end
 
+    def account
+      get("/account") do |response|
+        Account.new(response)
+      end
+    end
+
     private
 
     #

data/lib/censys/autonomous_system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Censys
   class AutonomousSystem
     # @return [String]

data/lib/censys/certificate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'time'
 
 module Censys

data/lib/censys/data.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'censys/data/response'

data/lib/censys/data/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'censys/data/result'
 require 'censys/data/series_list'
 require 'censys/data/series'

data/lib/censys/data/result.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 require 'time'
 
 module Censys
   module Data
     class Result
       attr_reader :id
-
       attr_reader :files
-
       attr_reader :timestamp
 
       def initialize(attributes)

data/lib/censys/data/series.rb

@@ -1,20 +1,15 @@
+# frozen_string_literal: true
+
 module Censys
   module Data
     class Series
       attr_reader :id
-
       attr_reader :port
-
       attr_reader :protocol
-
       attr_reader :subprotocol
-
       attr_reader :destination
-
       attr_reader :name
-
       attr_reader :description
-
       attr_reader :results
 
       def initialize(attributes)

data/lib/censys/data/series_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Censys
   module Data
     class SeriesList

data/lib/censys/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Censys
   class Document
     #

data/lib/censys/document/has_asn.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'censys/autonomous_system'
 
 module Censys

data/lib/censys/document/has_http_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'censys/http_response'
 
 module Censys
@@ -9,7 +11,7 @@ module Censys
       # @return [HTTPResponse]
       #
       def http_response
-        @http_reponse ||= HTTPResponse.new(@attributes.dig("80", "http"))
+        @http_response ||= HTTPResponse.new(@attributes.dig("80", "http"))
       end
     end
   end

data/lib/censys/document/has_location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'censys/location'
 
 module Censys

data/lib/censys/document/has_services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Censys
   class Document
     module HasServices

data/lib/censys/exceptions.rb

@@ -1,16 +1,13 @@
+# frozen_string_literal: true
+
 module Censys
-  class ResponseError < RuntimeError
-  end
+  class ResponseError < StandardError; end
 
-  class AuthenticationError < ResponseError
-  end
+  class AuthenticationError < ResponseError; end
 
-  class NotFound < ResponseError
-  end
+  class NotFound < ResponseError; end
 
-  class RateLimited < ResponseError
-  end
+  class RateLimited < ResponseError; end
 
-  class InternalServerError < ResponseError
-  end
+  class InternalServerError < ResponseError; end
 end