backscatterio 1.0.0

data/docs/Hello.md

@@ -0,0 +1,9 @@
+# SwaggerClient::Hello
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/IPEnrichment.md

@@ -0,0 +1,9 @@
+# SwaggerClient::IPEnrichment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**IPEnrichmentResults**](IPEnrichmentResults.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/IPEnrichmentResults.md

@@ -0,0 +1,25 @@
+# SwaggerClient::IPEnrichmentResults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**as_name** | **String** |  | [optional] 
+**as_num** | **Integer** |  | [optional] 
+**city** | **String** |  | [optional] 
+**country_iso** | **String** |  | [optional] 
+**country_name** | **String** |  | [optional] 
+**ip** | **String** |  | [optional] 
+**ip_hex** | **String** |  | [optional] 
+**ip_version** | **Integer** |  | [optional] 
+**latitude** | **Float** |  | [optional] 
+**longitude** | **Float** |  | [optional] 
+**network** | **String** |  | [optional] 
+**network_broadcast** | **String** |  | [optional] 
+**network_hostmask** | **String** |  | [optional] 
+**network_netmask** | **String** |  | [optional] 
+**network_size** | **Integer** |  | [optional] 
+**postal_code** | **String** |  | [optional] 
+**region_iso** | **String** |  | [optional] 
+**region_name** | **String** |  | [optional] 
+
+

data/docs/NetworkEnrichment.md

@@ -0,0 +1,9 @@
+# SwaggerClient::NetworkEnrichment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**NetworkEnrichmentResults**](NetworkEnrichmentResults.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/NetworkEnrichmentResults.md

@@ -0,0 +1,10 @@
+# SwaggerClient::NetworkEnrichmentResults
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cidr** | **String** |  | [optional] 
+**network_addresses** | **Array<String>** |  | [optional] 
+**network_size** | **Integer** |  | [optional] 
+
+

data/docs/Observation.md

@@ -0,0 +1,21 @@
+# SwaggerClient::Observation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dst_port** | **String** |  | [optional] 
+**fragment_flags** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**length** | **String** |  | [optional] 
+**observed** | **String** |  | [optional] 
+**precedence** | **String** |  | [optional] 
+**protocol** | **String** |  | [optional] 
+**res** | **String** |  | [optional] 
+**src_ip** | **String** |  | [optional] 
+**src_port** | **String** |  | [optional] 
+**tcp_flags** | **String** |  | [optional] 
+**tos** | **String** |  | [optional] 
+**ttl** | **String** |  | [optional] 
+**window** | **String** |  | [optional] 
+
+

data/docs/Observations.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Observations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | [**Query**](Query.md) |  | [optional] 
+**results** | [**Results**](Results.md) |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Query.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Query
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after_time** | **String** |  | [optional] 
+**focus** | **String** |  | [optional] 
+**scope** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

data/docs/Results.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Results
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**observations** | [**Array<Observation>**](Observation.md) |  | [optional] 
+**summary** | [**Summary**](Summary.md) |  | [optional] 
+**unique** | [**Unique**](Unique.md) |  | [optional] 
+
+

data/docs/Summary.md

@@ -0,0 +1,15 @@
+# SwaggerClient::Summary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**autonomous_system_count** | **Integer** |  | [optional] 
+**has_observations** | **BOOLEAN** |  | [optional] 
+**ip_address_count** | **Array<String>** |  | [optional] 
+**network_count** | **Integer** |  | [optional] 
+**observations** | **BOOLEAN** |  | [optional] 
+**observations_count** | **Integer** |  | [optional] 
+**port_count** | **Integer** |  | [optional] 
+**protocol_count** | **Integer** |  | [optional] 
+
+

data/docs/Trends.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Trends
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | [**Query**](Query.md) |  | [optional] 
+**results** | **Object** |  | [optional] 
+**success** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Unique.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Unique
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**autonomous_systems** | **Array<String>** |  | [optional] 
+**countries** | **Array<String>** |  | [optional] 
+**ip_addresses** | **Array<String>** |  | [optional] 
+**networks** | **Array<String>** |  | [optional] 
+**ports** | **Array<String>** |  | [optional] 
+**protocols** | **Array<String>** |  | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id=""
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id=""
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note=""
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/backscatterio.rb

@@ -0,0 +1,54 @@
+=begin
+#Backscatter.io
+
+#[This is the Backscatter.io API.](https://backscatter.io/developers) 
+
+OpenAPI spec version: 1.0.0
+Contact: info@backscatter.io
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0
+
+=end
+
+# Common files
+require 'backscatterio/api_client'
+require 'backscatterio/api_error'
+require 'backscatterio/version'
+require 'backscatterio/configuration'
+
+# Models
+require 'backscatterio/models/asn_enrichment'
+require 'backscatterio/models/asn_enrichment_results'
+require 'backscatterio/models/hello'
+require 'backscatterio/models/ip_enrichment'
+require 'backscatterio/models/ip_enrichment_results'
+require 'backscatterio/models/network_enrichment'
+require 'backscatterio/models/network_enrichment_results'
+require 'backscatterio/models/observation'
+require 'backscatterio/models/observations'
+require 'backscatterio/models/query'
+require 'backscatterio/models/results'
+require 'backscatterio/models/summary'
+require 'backscatterio/models/trends'
+require 'backscatterio/models/unique'
+
+# APIs
+require 'backscatterio/api/default_api'
+
+module BackscatterIO
+  class << self
+    # Customize default settings for the SDK using block.
+    #   BackscatterIO.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/backscatterio/api/default_api.rb

@@ -0,0 +1,349 @@
+=begin
+#Backscatter.io
+
+#[This is the Backscatter.io API.](https://backscatter.io/developers) 
+
+OpenAPI spec version: 1.0.0
+Contact: info@backscatter.io
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.0
+
+=end
+
+require 'uri'
+
+module BackscatterIO
+  class Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # enriches asn
+    # returns enrichment data for an ASN
+    # @param query 
+    # @param [Hash] opts the optional parameters
+    # @return [ASNEnrichment]
+    def enrich_asn(query, opts = {})
+      data, _status_code, _headers = enrich_asn_with_http_info(query, opts)
+      data
+    end
+
+    # enriches asn
+    # returns enrichment data for an ASN
+    # @param query 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ASNEnrichment, Fixnum, Hash)>] ASNEnrichment data, response status code and response headers
+    def enrich_asn_with_http_info(query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Api.enrich_asn ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling Api.enrich_asn"
+      end
+      # resource path
+      local_var_path = '/enrichment/asn'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ASNEnrichment')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Api#enrich_asn\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # enriches ip
+    # returns enrichment data for an ip
+    # @param query 
+    # @param [Hash] opts the optional parameters
+    # @return [IPEnrichment]
+    def enrich_ip(query, opts = {})
+      data, _status_code, _headers = enrich_ip_with_http_info(query, opts)
+      data
+    end
+
+    # enriches ip
+    # returns enrichment data for an ip
+    # @param query 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IPEnrichment, Fixnum, Hash)>] IPEnrichment data, response status code and response headers
+    def enrich_ip_with_http_info(query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Api.enrich_ip ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling Api.enrich_ip"
+      end
+      # resource path
+      local_var_path = '/enrichment/ip'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'IPEnrichment')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Api#enrich_ip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # enriches network
+    # returns enrichment data for a network
+    # @param query 
+    # @param [Hash] opts the optional parameters
+    # @return [NetworkEnrichment]
+    def enrich_network(query, opts = {})
+      data, _status_code, _headers = enrich_network_with_http_info(query, opts)
+      data
+    end
+
+    # enriches network
+    # returns enrichment data for a network
+    # @param query 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NetworkEnrichment, Fixnum, Hash)>] NetworkEnrichment data, response status code and response headers
+    def enrich_network_with_http_info(query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Api.enrich_network ...'
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling Api.enrich_network"
+      end
+      # resource path
+      local_var_path = '/enrichment/network'
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'NetworkEnrichment')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Api#enrich_network\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # authenticate to the service
+    # @param [Hash] opts the optional parameters
+    # @return [Hello]
+    def hello(opts = {})
+      data, _status_code, _headers = hello_with_http_info(opts)
+      data
+    end
+
+    # authenticate to the service
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hello, Fixnum, Hash)>] Hello data, response status code and response headers
+    def hello_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Api.hello ...'
+      end
+      # resource path
+      local_var_path = '/hello'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Hello')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Api#hello\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # fetches observations for a given ip address
+    # @param query_type query type ip, network, asn, port, country
+    # @param query ip address, cidr block, asn, port, or country
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :scope timeframe to search over, e.g., 1d, 7d
+    # @return [Observations]
+    def observations(query_type, query, opts = {})
+      data, _status_code, _headers = observations_with_http_info(query_type, query, opts)
+      data
+    end
+
+    # fetches observations for a given ip address
+    # @param query_type query type ip, network, asn, port, country
+    # @param query ip address, cidr block, asn, port, or country
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :scope timeframe to search over, e.g., 1d, 7d
+    # @return [Array<(Observations, Fixnum, Hash)>] Observations data, response status code and response headers
+    def observations_with_http_info(query_type, query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Api.observations ...'
+      end
+      # verify the required parameter 'query_type' is set
+      if @api_client.config.client_side_validation && query_type.nil?
+        fail ArgumentError, "Missing the required parameter 'query_type' when calling Api.observations"
+      end
+      # verify the required parameter 'query' is set
+      if @api_client.config.client_side_validation && query.nil?
+        fail ArgumentError, "Missing the required parameter 'query' when calling Api.observations"
+      end
+      # resource path
+      local_var_path = '/observations/{queryType}'.sub('{' + 'queryType' + '}', query_type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+      query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Observations')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Api#observations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Top N items
+    # A listing of the top N items observered over the query scope
+    # @param trend_type which item type you want to perform a trend over
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :scope timeframe to search over, e.g., 1d, 7d
+    # @return [Trends]
+    def trends(trend_type, opts = {})
+      data, _status_code, _headers = trends_with_http_info(trend_type, opts)
+      data
+    end
+
+    # Top N items
+    # A listing of the top N items observered over the query scope
+    # @param trend_type which item type you want to perform a trend over
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :scope timeframe to search over, e.g., 1d, 7d
+    # @return [Array<(Trends, Fixnum, Hash)>] Trends data, response status code and response headers
+    def trends_with_http_info(trend_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Api.trends ...'
+      end
+      # verify the required parameter 'trend_type' is set
+      if @api_client.config.client_side_validation && trend_type.nil?
+        fail ArgumentError, "Missing the required parameter 'trend_type' when calling Api.trends"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['ip', 'network', 'asn', 'port', 'country'].include?(trend_type)
+        fail ArgumentError, "invalid value for 'trend_type', must be one of ip, network, asn, port, country"
+      end
+      # resource path
+      local_var_path = '/trends/popular/{trendType}'.sub('{' + 'trendType' + '}', trend_type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Trends')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Api#trends\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end