seer-rb 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74e195941b3642297ccac3ca04b9ba165286db6f
+  data.tar.gz: 5e6db0e02a5e50914c29e78bbfab9e909af0ed27
+SHA512:
+  metadata.gz: 91eba63a80bb0e2b6fcf4654359b356ab085c519be6241bf5a5dd89a787c066752e0a610a8d19ec31f7dea03e8124c97f4232f5c5594518f06ba11c4b3909525
+  data.tar.gz: 6d8de23a8cd6f69658d9b35e821b25821a22fc3c46ed296671f09c443eb9215ef0bbfbc90a27e756a7d9c71b40ae48204bf5c94da568e3c59c6f27824dfacf22

data/README.md

@@ -0,0 +1,61 @@
+# seer-rb
+
+Ruby SDK for SEER API
+
+## Example
+
+### Host query
+
+#### Register with API token
+
+```ruby
+seer = Seer::Hosts.new(token: api_token, host: api_host)
+```
+
+#### Get host information by IP
+
+```ruby
+host = seer.ip(ip)
+```
+
+#### Get host information by custom search syntax
+
+```ruby
+host = seer.search(query, return_field)
+```
+
+#### Get hosts by port
+
+```ruby
+hosts = seer.port(port)
+```
+
+### Domain query
+
+#### Register with API token
+
+```ruby
+seer = Seer::DNS.new(token: api_token, host: api_host)
+```
+
+#### Get type A record by IP
+
+```ruby
+seer.ip(ip)
+```
+
+#### Get type A record by domain
+
+```ruby
+seer.domain(domain)
+```
+
+## Installation
+
+```
+gem install seer-rb
+```
+
+```
+gem "seer-rb"
+```

data/lib/environment.rb

@@ -0,0 +1,12 @@
+# Standard libs
+require 'json'
+
+# Third party libs
+require 'rest-client'
+
+# Custom libs
+require 'seer/dns'
+require 'seer/hosts'
+require 'seer/org'
+require 'seer/status'
+require 'seer/version'

data/lib/seer.rb

@@ -0,0 +1,22 @@
+require 'environment'
+
+# SEER API Wrapper
+# @author ztz <ztz@ztz.me>
+# @version 0.1
+module Seer
+  # Send request to SEER API
+  # @param url [String] Request url
+  # @param body [String] Request body
+  # @param header [Hash] Request hash
+  # @return [Hash]
+  def request(url, body, header)
+    response = RestClient.post(
+      url,
+      JSON.dump(body),
+      header
+    )
+    JSON.load response
+  end
+
+  module_function :request
+end

data/lib/seer/dns.rb

@@ -0,0 +1,35 @@
+module Seer
+  # DNS API controller
+  class DNS
+    # Initialize a DNS object
+    # @param token [string] API token
+    # @param version [string] API version you want use (defaut 1)
+    # @param host [string] API host
+    def initialize(token: '', version: '1', host: '')
+      @host = host + '/dns'
+      @header = {
+        content_type: 'application/json',
+        accept: "application/seer+json;version=#{version}",
+        x_seer_token: token
+      }
+    end
+
+    # Get ip from domain
+    # @param domain [string]
+    # @return [Hash] Result
+    def domain(domain)
+      body = { domain: domain }
+      url = @host + '/domain'
+      Seer.request(url, body, @header)
+    end
+
+    # Get domain by ip
+    # @param ip [String]
+    # @return [Hash] Result
+    def ip(ip)
+      body = { ip: ip }
+      url = @host + '/ip'
+      Seer.request(url, body, @header)
+    end
+  end
+end

data/lib/seer/hosts.rb

@@ -0,0 +1,93 @@
+module Seer
+  # Hosts API controller
+  class Hosts
+    # Initialize a Hosts object
+    # @param token [string] API token
+    # @param version [string] API version you want use (defaut 1)
+    # @param host [string] API host
+    def initialize(token: '', version: '1', host: '')
+      @host = host + '/hosts'
+      @header = {
+        content_type: 'application/json',
+        accept: "application/seer+json;version=#{version}",
+        x_seer_token: token
+      }
+    end
+
+    # Get host by ip
+    # @param ip [String] IP Address
+    # @param minify [Boolean] Only return IP address (default false)
+    # @return [Hash] Result
+    def ip(ip, minify: false)
+      body = {
+        ip: ip,
+        minify: minify
+      }
+      url = @host + '/ip'
+
+      Seer.request(url, body, @header)
+    end
+
+    # Get hosts by port
+    # @param port [Fixnum] Port you want to search
+    # @param page [Fixnum] The page of results
+    # @param minify [Boolean] Only return IP address (default false)
+    # @return [Hash] Result
+    def port(port, page: 1, minify: false)
+      body = {
+        port: port,
+        page: page,
+        minify: minify
+      }
+      url = @host + '/port'
+
+      Seer.request(url, body, @header)
+    end
+
+    # Get hosts by service
+    # @param service [String] Service you want to search
+    # @param page [Fixnum] The page of results
+    # @param minify [Boolean] Only return IP address (default false)
+    # @return [Hash] Result
+    def service(service, page: 1, minify: false)
+      body = {
+        service: service,
+        page: page,
+        minify: minify
+      }
+      url = @host + '/service'
+
+      Seer.request(url, body, @header)
+    end
+
+    # Get hosts by custom search
+    # @param query [String] Custom query
+    # @param page [Fixnum] The page of results
+    # @param minify [Boolean] Only return IP address (default false)
+    # @return [Hash] Result
+    def search(query, page: 1, minify: false)
+      body = {
+        query: query,
+        page: page,
+        minify: minify
+      }
+      url = @host + '/search'
+
+      Seer.request(url, body, @header)
+    end
+
+    # Aggregations by query and field
+    # @param query [String] Custom query
+    # @param fields [String] The field you want to aggs
+    # @return [Hash] Result
+    def aggs(query, fields)
+      body = {
+        query: query,
+        fields: fields
+      }
+      url = @host + '/aggs'
+
+      Seer.request(url, body, @header)
+    end
+  end
+end

data/lib/seer/org.rb

@@ -0,0 +1,37 @@
+module Seer
+  # ORG API controller
+  class Org
+    # Initialize a Org object
+    # @param token [string]  API token
+    # @param version [string] :version ('1') API version you want use (defaut 1)
+    # @param host [string] API host (default http://seer.intra.nsfocus.com:8000/api)
+    def initialize(token: '', version: '1', host: '')
+      @host = host + '/org'
+      @header = {
+        content_type: 'application/json',
+        accept: "application/seer+json;version=#{version}",
+        x_seer_token: token
+      }
+    end
+
+    # Get organization by ip
+    # @param ip [String] IP address for search
+    # @return [Hash] Result
+    def ip(ip)
+      body = { ip: ip }
+      url = @host + '/ip'
+
+      Seer.request(url, body, @header)
+    end
+
+    # Get organization by AS number
+    # @param asn [Fixnum] AS number
+    # @return [Hash] Result
+    def asn(asn)
+      body = { asn: asn }
+      url = @host + '/asn'
+
+      Seer.request(url, body, @header)
+    end
+  end
+end

data/lib/seer/status.rb

@@ -0,0 +1,32 @@
+module Seer
+  # Status API controller
+  class Status
+    # Initialize a Status object
+    # @param token [string] API token
+    # @param version [string] :version ('1') API version you want use (defaut 1)
+    # @param host [string] API host (default http://seer.intra.nsfocus.com:8000/api)
+    def initialize(token: '', version: '1', host: '')
+      @host = host + '/status'
+      @header = {
+        content_type: 'application/json',
+        accept: "application/seer+json;version=#{version}",
+        x_seer_token: token
+      }
+    end
+
+    # Get SEER supported service
+    # @param service [String] Return all service that SEER supported
+    # @return [Hash] Result
+    def service(service)
+      body = { service: service }
+      url = @host + '/service'
+
+      response = RestClient.post(
+        url,
+        JSON.dump(body),
+        @header
+      )
+      JSON.load response
+    end
+  end
+end

data/lib/seer/version.rb

@@ -0,0 +1,20 @@
+module Seer
+  # Version
+  class Version
+    # Major version
+    MAJOR = 0
+
+    # Minor version
+    MINOR = 1
+
+    class << self
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR].compact.join('.')
+      end
+    end
+
+    # Version
+    VERSION = Version.to_s
+  end
+end

data/seer-rb.gemspec

@@ -0,0 +1,14 @@
+require File.expand_path('../lib/seer/version.rb', __FILE__)
+
+Gem::Specification.new do |s|
+  s.author = 'ztz'
+  s.summary = 'Ruby SDK for SEER API'
+  s.description = 'Ruby SDK for SEER API'
+  s.email = %w(seer@nsfocus.com)
+  s.files = Dir['README.md', 'seer-rb.gemspec', 'lib/**/*']
+  s.homepage = 'https://github.com/seer-project/seer-rb'
+  s.license = 'MIT'
+  s.name = 'seer-rb'
+  s.require_path = 'lib'
+  s.version = Seer::Version
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: seer-rb
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- ztz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-26 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SDK for SEER API
+email:
+- seer@nsfocus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/environment.rb
+- lib/seer.rb
+- lib/seer/dns.rb
+- lib/seer/hosts.rb
+- lib/seer/org.rb
+- lib/seer/status.rb
+- lib/seer/version.rb
+- seer-rb.gemspec
+homepage: https://github.com/seer-project/seer-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for SEER API
+test_files: []
+has_rdoc: