atsd 1.0.1

data/lib/atsd/errors/api_error.rb

@@ -0,0 +1,11 @@
+require 'atsd/errors/error'
+
+module ATSD
+  class APIError < Error
+    attr_reader :status
+
+    def initialize(env)
+      @status = env.status
+    end
+  end
+end

data/lib/atsd/errors/error.rb

@@ -0,0 +1,3 @@
+module ATSD
+  class Error < StandardError; end
+end

data/lib/atsd/middleware/errors_handler.rb

@@ -0,0 +1,88 @@
+require 'atsd/errors/api_error'
+
+module ATSD
+  # Faraday Middleware
+  module Middleware
+    # Middleware to raise error on request fail and possibly catch error message from API.
+    class ErrorsHandlerMiddleware < Faraday::Response::Middleware
+      # HTTP status codes with messages generated by
+      #
+      # ```bash
+      #   curl -s www.iana.org/assignments/http-status-codes/http-status-codes-1.csv | \
+      #   ruby -ne 'm = /^(\d{3}),(?!Unassigned|\(Unused\))([^,]+)/.match($_) and \
+      #   puts "#{m[1]} => \x27#{m[2].strip}\x27,"'
+      # ```
+      HTTP_STATUS_CODES = {
+          100 => 'Continue',
+          101 => 'Switching Protocols',
+          102 => 'Processing',
+          200 => 'OK',
+          201 => 'Created',
+          202 => 'Accepted',
+          203 => 'Non-Authoritative Information',
+          204 => 'No Content',
+          205 => 'Reset Content',
+          206 => 'Partial Content',
+          207 => 'Multi-Status',
+          208 => 'Already Reported',
+          226 => 'IM Used',
+          300 => 'Multiple Choices',
+          301 => 'Moved Permanently',
+          302 => 'Found',
+          303 => 'See Other',
+          304 => 'Not Modified',
+          305 => 'Use Proxy',
+          307 => 'Temporary Redirect',
+          308 => 'Permanent Redirect',
+          400 => 'Bad Request',
+          401 => 'Unauthorized',
+          402 => 'Payment Required',
+          403 => 'Forbidden',
+          404 => 'Not Found',
+          405 => 'Method Not Allowed',
+          406 => 'Not Acceptable',
+          407 => 'Proxy Authentication Required',
+          408 => 'Request Timeout',
+          409 => 'Conflict',
+          410 => 'Gone',
+          411 => 'Length Required',
+          412 => 'Precondition Failed',
+          413 => 'Payload Too Large',
+          414 => 'URI Too Long',
+          415 => 'Unsupported Media Type',
+          416 => 'Range Not Satisfiable',
+          417 => 'Expectation Failed',
+          421 => 'Misdirected Request',
+          422 => 'Unprocessable Entity',
+          423 => 'Locked',
+          424 => 'Failed Dependency',
+          426 => 'Upgrade Required',
+          428 => 'Precondition Required',
+          429 => 'Too Many Requests',
+          431 => 'Request Header Fields Too Large',
+          500 => 'Internal Server Error',
+          501 => 'Not Implemented',
+          502 => 'Bad Gateway',
+          503 => 'Service Unavailable',
+          504 => 'Gateway Timeout',
+          505 => 'HTTP Version Not Supported',
+          506 => 'Variant Also Negotiates',
+          507 => 'Insufficient Storage',
+          508 => 'Loop Detected',
+          510 => 'Not Extended',
+          511 => 'Network Authentication Required',
+      }
+
+      def call(environment)
+        @app.call(environment).on_complete do |env|
+          unless env.success?
+            message = env.body['error'] || HTTP_STATUS_CODES[env.status]
+            fail APIError.new(env), message
+          end
+        end
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware :errors_handler => ATSD::Middleware::ErrorsHandlerMiddleware

data/lib/atsd/models/alert.rb

@@ -0,0 +1,7 @@
+require 'atsd/models/base_model'
+
+module ATSD
+  class Alert < BaseModel
+  end
+end
+

data/lib/atsd/models/alert_history.rb

@@ -0,0 +1,7 @@
+require 'atsd/models/base_model'
+
+module ATSD
+  class AlertHistory < BaseModel
+  end
+end
+

data/lib/atsd/models/base_model.rb

@@ -0,0 +1,23 @@
+module ATSD
+  # Base class for all models
+  # @abstract
+  class BaseModel < ::Hash
+    include ::Hashie::Extensions::MethodAccess
+    include ::Hashie::Extensions::MergeInitializer
+    include Utils::UnderscoreKeys
+
+    # Converts model to hash usable for API
+    #
+    # @return [Hash]
+    def to_request_hash
+      hash = {}
+      keys.each do |k|
+        new_key = k.to_s.camelize(:lower)
+        new_key = new_key.to_sym if k.is_a? Symbol
+        hash[new_key] = self[k]
+      end
+      hash
+    end
+  end
+end
+

data/lib/atsd/models/entity.rb

@@ -0,0 +1,7 @@
+require 'atsd/models/base_model'
+
+module ATSD
+  class Entity < BaseModel
+  end
+end
+

data/lib/atsd/models/entity_group.rb

@@ -0,0 +1,8 @@
+require 'atsd/models/base_model'
+require 'atsd/models/entity'
+
+module ATSD
+  class EntityGroup < BaseModel
+  end
+end
+

data/lib/atsd/models/metric.rb

@@ -0,0 +1,7 @@
+require 'atsd/models/base_model'
+
+module ATSD
+  class Metric < BaseModel
+  end
+end
+

data/lib/atsd/models/property.rb

@@ -0,0 +1,11 @@
+require 'atsd/models/base_model'
+
+module ATSD
+  # Property model
+  #
+  # @note Please use `property[:key]` instead of `property.key` to access
+  #   `key` attribute due to implementation details (`#key` is a Hash method).
+  class Property < BaseModel
+  end
+end
+

data/lib/atsd/models/series.rb

@@ -0,0 +1,8 @@
+require 'atsd/models/base_model'
+
+module ATSD
+  # Time Series model
+  class Series < BaseModel
+  end
+end
+

data/lib/atsd/queries/alerts_history_query.rb

@@ -0,0 +1,31 @@
+require 'atsd/queries/base_query'
+
+module ATSD
+  # Class for building and executing Alerts History Query
+  # @see https://axibase.com/atsd/api/#alerts:-history-query
+  class AlertsHistoryQuery < BaseQuery
+    TO_MILLISECONDS_LAMBDA = ->(v) do
+      case v
+        when Time
+          v.to_i * 1_000
+        else
+          v.to_i
+      end
+    end
+
+    coerce_key :end_time, TO_MILLISECONDS_LAMBDA
+    coerce_key :start_time, TO_MILLISECONDS_LAMBDA
+
+    # @return [Array<AlertHistory>]
+    def result
+      super
+    end
+
+    # @return (see #result)
+    def execute
+      result = @client.alerts_history_query to_request_hash
+      @result = result.map { |json| AlertHistory.new json }
+    end
+  end
+end
+

data/lib/atsd/queries/alerts_query.rb

@@ -0,0 +1,31 @@
+require 'atsd/queries/base_query'
+
+module ATSD
+  # Class for building and executing Alerts Query
+  # @see https://axibase.com/atsd/api/#alerts:-query
+  class AlertsQuery < BaseQuery
+    # `severity` levels
+    module Severity
+      UNDEFINED = 0
+      UNKNOWN = 1
+      NORMAL = 2
+      WARNING = 3
+      MINOR = 4
+      MAJOR = 5
+      CRITICAL = 6
+      FATAL = 7
+    end
+
+    # @return [Array<Alert>]
+    def result
+      super
+    end
+
+    # @return (see #result)
+    def execute
+      result = @client.alerts_query to_request_hash
+      @result = result.map { |json| Alert.new json }
+    end
+  end
+end
+

data/lib/atsd/queries/base_query.rb

@@ -0,0 +1,40 @@
+module ATSD
+  # Base class for API query builders
+  # @abstract
+  class BaseQuery < ::Hashie::Clash
+    include ::Hashie::Extensions::Coercion
+
+    # @return [Client]
+    attr_reader :client
+
+    # @param [Client] client
+    def initialize(client)
+      @client = client
+    end
+
+    # Build request parameters hash
+    # @return [Hash]
+    def to_request_hash
+      Utils::CamelizeKeys.camelize_keys(self)
+    end
+
+    # Execute query on client
+    # @return (see #result)
+    # @raise [APIError]
+    def execute
+      raise NotImplementedError
+    end
+
+    # Result of query execution.
+    #
+    # @return [Object]
+    # @raise [APIError]
+    def result
+      @result ||= execute
+    end
+
+    protected
+
+    attr_writer :result
+  end
+end

data/lib/atsd/queries/properties_query.rb

@@ -0,0 +1,31 @@
+require 'atsd/queries/base_query'
+
+module ATSD
+  # Class for building and executing Properties Query
+  # @see https://axibase.com/atsd/api/#properties:-query
+  class PropertiesQuery < BaseQuery
+    TO_MILLISECONDS_LAMBDA = ->(v) do
+      case v
+        when Time
+          v.to_i * 1_000
+        else
+          v.to_i
+      end
+    end
+
+    coerce_key :end_time, TO_MILLISECONDS_LAMBDA
+    coerce_key :start_time, TO_MILLISECONDS_LAMBDA
+
+    # @return [Array<Property>]
+    def result
+      super
+    end
+
+    # @return (see #result)
+    def execute
+      result = @client.properties_query to_request_hash
+      @result = result.map { |json| Property.new json }
+    end
+  end
+end
+

data/lib/atsd/queries/series_query.rb

@@ -0,0 +1,150 @@
+require 'atsd/queries/base_query'
+
+module ATSD
+  # Class for building and executing Series Query
+  # @see https://axibase.com/atsd/api/#series:-query
+  class SeriesQuery < BaseQuery
+
+    # @!method type(type)
+    #   specifies source for underlying data
+    #   @param [String] type see {Type} for possible values
+    #   @return [self]
+
+    # `type` parameter possible values
+    module Type
+      HISTORY = 'HISTORY' # default
+      FORECAST = 'FORECAST'
+      FORECAST_DEVIATION = 'FORECAST_DEVIATION'
+    end
+
+    # `join.type` parameter possible values
+    module JoinType
+      COUNT = 'COUNT'
+      MIN = 'MIN'
+      MAX = 'MAX'
+      AVG = 'AVG'
+      SUM = 'SUM'
+      PERCENTILE_999 = 'PERCENTILE_999'
+      PERCENTILE_995 = 'PERCENTILE_995'
+      PERCENTILE_99 = 'PERCENTILE_99'
+      PERCENTILE_95 = 'PERCENTILE_95'
+      PERCENTILE_90 = 'PERCENTILE_90'
+      PERCENTILE_75 = 'PERCENTILE_75'
+      PERCENTILE_50 = 'PERCENTILE_50'
+      STANDARD_DEVIATION = 'STANDARD_DEVIATION'
+    end
+
+    # `join.interpolate` parameter possible values
+    module JoinInterpolate
+      STEP = 'STEP' # default
+      NONE = 'NONE'
+      LINEAR = 'LINEAR'
+    end
+
+    # `aggregate.type` parameter possible values
+    module AggregateType
+      DETAIL = 'DETAIL'
+      COUNT = 'COUNT'
+      MIN = 'MIN'
+      MAX = 'MAX'
+      AVG = 'AVG'
+      SUM = 'SUM'
+      PERCENTILE_999 = 'PERCENTILE_999'
+      PERCENTILE_995 = 'PERCENTILE_995'
+      PERCENTILE_99 = 'PERCENTILE_99'
+      PERCENTILE_95 = 'PERCENTILE_95'
+      PERCENTILE_90 = 'PERCENTILE_90'
+      PERCENTILE_75 = 'PERCENTILE_75'
+      PERCENTILE_50 = 'PERCENTILE_50'
+      STANDARD_DEVIATION = 'STANDARD_DEVIATION'
+      FIRST = 'FIRST'
+      LAST = 'LAST'
+      DELTA = 'DELTA'
+      WAVG = 'WAVG'
+      WTAVG = 'WTAVG'
+      THRESHOLD_COUNT = 'THRESHOLD_COUNT'
+      THRESHOLD_DURATION = 'THRESHOLD_DURATION'
+      THRESHOLD_PERCENT = 'THRESHOLD_PERCENT'
+    end
+
+    # `aggregate.interpolate` parameter possible values
+    module AggregateInterpolate
+      STEP = 'STEP'
+      NONE = 'NONE'
+      LINEAR = 'LINEAR'
+    end
+
+    # interval's unit possible values
+    module Interval
+      MILLISECOND = 'MILLISECOND'
+      SECOND = 'SECOND'
+      MINUTE = 'MINUTE'
+      HOUR = 'HOUR'
+      DAY = 'DAY'
+      WEEK = 'WEEK'
+      MONTH = 'MONTH'
+      QUARTER = 'QUARTER'
+      YEAR = 'YEAR'
+    end
+
+    TO_MILLISECONDS_LAMBDA = ->(v) do
+      case v
+        when Time
+          v.to_i * 1_000
+        else
+          v.to_i
+      end
+    end
+
+    coerce_key :end_time, TO_MILLISECONDS_LAMBDA
+    coerce_key :start_time, TO_MILLISECONDS_LAMBDA
+
+    # @return [Array<Series>]
+    def result
+      super
+    end
+
+    # Add tag to `tags` parameter
+    #
+    # @param [String] name tag name
+    # @param [String, Array<String>] values possible tag value of array of values.
+    #   `*` and `?` wildcards allowed.
+    # @return [self]
+    def tag_add(name, values)
+      self[:tags][name] = Utils.ensure_array(values)
+      self
+    end
+
+    # Executes query and sets `result` attribute.
+    #
+    # @return (see #result)
+    def execute
+      result = @client.series_query to_request_hash
+      @result = result.map { |series_json| Series.new series_json }
+    end
+
+    # Executes multiple queries at the same time. Adds `request_id` parameter
+    # to each query if necessary. All queries will have a corresponding `series`
+    # attribute set.
+    #
+    # @param [SeriesQuery] others list of series query to execute with receiver
+    # @return [Array<Series>] all results
+    def execute_with(*others)
+      others ||= []
+      queries = [self] + others
+      queries_by_id = {}
+      if queries.count > 1
+        queries.each_with_index do |query, index|
+          query.request_id("query_#{index}") unless query.request_id
+          query.result = []
+          queries_by_id[query[:request_id]] = query
+        end
+      end
+
+      results = @client.series_query queries.map {|q| q.to_request_hash}
+      results.map! { |json| Series.new(json) }
+      results.each { |r| queries_by_id[r.request_id].result << r }
+    end
+  end
+end
+