passivetotalx 0.1.0

data/lib/passivetotal/clients/monitor.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  module Client
+    class Monitor < Base
+      #
+      # Retrieve all alerts associated with an artifact or project.
+      # http://api.passivetotal.org/api/docs/#api-Monitor-GetV2Monitor
+      #
+      # @param [String, nil] project the project to filter on
+      # @param [String, nil] artifact the artifact to filter on
+      # @param [String, nll] start filter results to after this datetime
+      # @param [String, nil] end filter results to before this datetime
+      #
+      # @return [Hash]
+      #
+      def alerts(project: nil, artifact: nil, start_at: nil, end_at: nil)
+        params = {
+          project: project,
+          artifact: artifact,
+          start: start_at,
+          end: end_at,
+        }.compact
+
+        _get("/monitor", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/passivetotal/clients/project.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  module Client
+    class Project < Base
+      #
+      # Add project tags.
+      # http://api.passivetotal.org/api/docs/#api-Project-PostV2ProjectTag
+      #
+      # @param [String] project the project id to update
+      # @param [String] tags the tags or tag to add (list or str)
+      #
+      # @return [Hash]
+      #
+      def add_tags(project, tags)
+        params = {
+          project: project,
+          tags: tags,
+        }.compact
+
+        _get("/project/tag", params) { |json| json }
+      end
+
+      #
+      # Create a new project
+      # http://api.passivetotal.org/api/docs/#api-Project-PutV2Project
+      #
+      # @param [String] name name of the project
+      # @param [String] visibility the visibility
+      # @param [String, nil] description the description
+      # @param [String, nil] featured whether to feature the project
+      # @param [String, nil] tags sets the project's tags to this list
+      #
+      # @return [Hash]
+      #
+      def create(name, visibility:, description: nil, featured: nil, tags: nil)
+        params = {
+          name: name,
+          visibility: visibility,
+          description: description,
+          featured: featured,
+          tags: tags,
+        }.compact
+
+        _put("/project", params) { |json| json }
+      end
+
+      #
+      # Delete project
+      # http://api.passivetotal.org/api/docs/#api-Project-DeleteV2Project
+      #
+      # @param [String] project the project id to delete
+      #
+      # @return [Hash]
+      #
+      def delete(project)
+        params = {
+          project: project,
+        }.compact
+
+        _delete("/project", params) { |json| json }
+      end
+
+      #
+      # Retrieves a project or projects by search filter
+      # http://api.passivetotal.org/api/docs/#api-Project-GetV2Project
+      #
+      # @param [String, nil] project filter by project id
+      # @param [String, nil] owner filter by owner (an email or organization id)
+      # @param [String, nil] creator filter by creator email
+      # @param [String, nil] organization filter by organization
+      # @param [String, nil] visibility filter by visibility
+      # @param [String, nil] featured filter by featured status
+      #
+      # @return [Hash]
+      #
+      def get(project: nil, owner: nil, creator: nil, organization: nil, visibility: nil, featured: nil)
+        params = {
+          project: project,
+          owner: owner,
+          creator: creator,
+          organization: organization,
+          visibility: visibility,
+          featured: featured,
+        }.compact
+
+        _get("/project", params) { |json| json }
+      end
+
+      #
+      # Remove project tags.
+      # http://api.passivetotal.org/api/docs/#api-Project-DeleteV2ProjectTag
+      #
+      # @param [String] project the project id to update
+      # @param [Array<String>] tags the tags or tag to remove (list or str)
+      #
+      # @return [Hash]
+      #
+      def remove_tags(project, tags)
+        params = {
+          project: project,
+          tags: tags,
+        }.compact
+
+        _delete("/project/tag", params) { |json| json }
+      end
+
+      #
+      # Set project tags.
+      # http://api.passivetotal.org/api/docs/#api-Project-PutV2ProjectTag
+      #
+      # @param [String] project the project id to update
+      # @param [Array<String>] tags the tags or tag to set to (list or str)
+      #
+      # @return [Hash]
+      #
+      def set_tags(project, tags)
+        params = {
+          project: project,
+          tags: tags,
+        }.compact
+
+        _put("/project/tag", params) { |json| json }
+      end
+
+      #
+      # Updates a project denoted by project ID
+      # http://api.passivetotal.org/api/docs/#api-Project-PostV2Project
+      #
+      # @param [String] project the project id to update
+      # @param [String, nil] name the new name
+      # @param [String, nil] description the new description
+      # @param [String, nil] visibility ,"private","analyst"] the new visibility
+      # @param [String, nil] featured whether to feature the project
+      # @param [String, nil] tags sets the project's tags to this list
+      #
+      # @return [Hash]
+      #
+      def update(project, name: nil, description: nil, visibility: nil, featured: nil, tags: nil)
+        params = {
+          project: project,
+          name: name,
+          description: description,
+          visibility: visibility,
+          featured: featured,
+          tags: tags,
+        }.compact
+
+        _post("/project", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/passivetotal/clients/ssl.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  module Client
+    class SSL < Base
+      #
+      # Retrieves the SSL certificate history for a given certificate SHA-1 hash or IP address.
+      # http://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetV2SslCertificateHistory
+      #
+      # @param [String] query SHA-1 hash or associated IP address for which to retrieve certificate history
+      #
+      # @return [Hash]
+      #
+      def history(query)
+        params = {
+          query: query,
+        }.compact
+
+        _get("/ssl-certificate/history", params) { |json| json }
+      end
+
+      #
+      # Retrieves an SSL certificate by its SHA-1 hash.
+      # http://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetV2SslCertificate
+      #
+      # @param [String] query SHA-1 hash of the certificate to retrieve
+      #
+      # @return [Hash]
+      #
+      def get(query)
+        params = {
+          query: query,
+        }.compact
+
+        _get("/ssl-certificate", params) { |json| json }
+      end
+
+      #
+      # Retrieves SSL certificates for a given keyword.
+      # http://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetV2SslCertificateSearchKeyword
+      #
+      # @param [String] query keyword on which to search
+      #
+      # @return [Hash]
+      #
+      def keyword(query)
+        params = {
+          query: query,
+        }.compact
+
+        _get("/ssl-certificate/search/keyword", params) { |json| json }
+      end
+
+      #
+      # Retrieves SSL certificates for a given field value.
+      # http://api.passivetotal.org/api/docs/#api-SSL_Certificates-GetV2SslCertificateSearch
+      #
+      # @param [String] query field value for which to search
+      # @param [String] field field by which to search
+      #
+      # @return [Hash]
+      #
+      def search(query:, field:)
+        params = {
+          field: field,
+          query: query,
+        }.compact
+
+        _get("/ssl-certificate/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/passivetotal/clients/tag.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  module Client
+    class Tag < Base
+      #
+      # Retrieve the tags of an artifact or artifacts.
+      # http://api.passivetotal.org/api/docs/#api-Tag_Artifact-GetV2ArtifactTag
+      #
+      # @param [String] artifact the artifact id or ids to list
+      #
+      # @return [Hash]
+      #
+      def get(artifact)
+        params = {
+          artifact: artifact,
+        }.compact
+
+        _get("/artifact/tag", params) { |json| json }
+      end
+
+      #
+      # Remove a set of tags from an artifact or artifacts.
+      # http://api.passivetotal.org/api/docs/#api-Tag_Artifact-DeleteV2ArtifactTag
+      #
+      # @param [String] artifact the artifact id or ids to update
+      # @param [Array<String>] tags the tags or tag to delete (list or str)
+      #
+      # @return [Hash]
+      #
+      def delete(artifact, tags)
+        params = {
+          artifact: artifact,
+          tags: tags,
+        }.compact
+
+        _delete("/artifact/tag", params) { |json| json }
+      end
+
+      #
+      # Set the tags of an artifact or artifacts.
+      # http://api.passivetotal.org/api/docs/#api-Tag_Artifact-PutV2ArtifactTag
+      #
+      # @param [String] artifact the artifact id or ids to update
+      # @param [Array<String>] tags the tags or tag to set (list or str)
+      #
+      # @return [Hash]
+      #
+      def set(artifact, tags)
+        params = {
+          artifact: artifact,
+          tags: tags,
+        }.compact
+
+        _put("/artifact/tag", params) { |json| json }
+      end
+
+      #
+      # Add tags to an artifact or artifacts.
+      # http://api.passivetotal.org/api/docs/#api-Tag_Artifact-PostV2ArtifactTag
+      #
+      # @param [String] artifact the artifact id or ids to update
+      # @param [Array<String>] tags the tags or tag to add (list or str)
+      #
+      # @return [Hash]
+      #
+      def update(artifact, tags)
+        params = {
+          artifact: artifact,
+          tags: tags,
+        }.compact
+
+        _post("/artifact/tag", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/passivetotal/clients/tracker.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  module Client
+    class Tracker < Base
+      #
+      # Retrieves hosts that employ user tracking mechanisms served from another given host.
+      # http://api.passivetotal.org/api/docs/#api-Trackers-GetV2TrackersSearch
+      #
+      # @param [String] query host from which trackers originate
+      # @param [String] type type of trackers to retrieve; a type other than the offically supported ones may be supplied
+      #
+      # @return [Hash]
+      #
+      def search(query:, type:)
+        params = {
+          query: query,
+          type: type,
+        }.compact
+
+        _get("/trackers/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/passivetotal/clients/whois.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  module Client
+    class WHOIS < Base
+      #
+      # Retrieves the WHOIS data for the specified query
+      # http://api.passivetotal.org/api/docs/#api-WHOIS-GetV2Whois
+      #
+      # @param [String] query the domain being queried
+      # @param [String, nil] compact_record whether to compress the results
+      # @param [String, nil] history whether to return historical results
+      #
+      # @return [Hash]
+      #
+      def get(query, compact_record: nil, history: nil)
+        params = {
+          query: query,
+          compact_record: compact_record,
+          history: history,
+        }.compact
+
+        _get("/whois", params) { |json| json }
+      end
+
+      #
+      # Search WHOIS data for a keyword.
+      # http://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisSearchKeyword
+      #
+      # @param [String] query being queried
+      #
+      # @return [Hash]
+      #
+      def keyword(query)
+        params = {
+          query: query,
+        }.compact
+
+        _get("/whois/search/keyword", params) { |json| json }
+      end
+
+      #
+      # Searches WHOIS data by field and query.
+      # http://api.passivetotal.org/api/docs/#api-WHOIS-GetV2WhoisSearch
+      #
+      # @param [String] query the value of the field being queried
+      # @param [String] field the field to query
+      #
+      # @return [Hash]
+      #
+      def search(query:, field:)
+        params = {
+          query: query,
+          field: field,
+        }.compact
+
+        _get("/whois/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/passivetotal/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PassiveTotal
+  VERSION = "0.1.0"
+end

data/lib/passivetotalx.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "passivetotal"

data/passivetotalx.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "passivetotal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "passivetotalx"
+  spec.version       = PassiveTotal::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "PassiveTotal API wrapper for Ruby"
+  spec.description   = "PassiveTotal API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/passivetotalx"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+end