zeusclient 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c9b1fe09cdda854fc306b53d850844882fcfb8c
-  data.tar.gz: 67609f973c1bb564d651d09e684e5cd02e423389
+  metadata.gz: d04cab72b6da4d93b3b969a696b13fa304c4d7c9
+  data.tar.gz: 14a16ea6fba4e7f91168f48ea34b1e83bf041d10
 SHA512:
-  metadata.gz: 3ebb415c828ccb35f9146ba6d85b15893538fabcaed53f44c61f91b480a90f66d2909f4e06274b4b833267842e3a36c01d0e1b3f86d7a57ad9ccdd21332b2eaf
-  data.tar.gz: 8a291264fc2236aa6fd0968135518621d9f1e38d00e9fac8301988f5ae80903ca7b1211c7d0527776a7ffdceabaa3bf3eb0c5d4a9579d7f5adc0099c9285941b
+  metadata.gz: 9759a9c03cc1c73b5e5e20644af98eda593bd1e99b0e1817972c76a41244f007159a38ccc2f222bbfbf5db272f07107886da3cf0c3616aa3c9bfc62a8ba35282
+  data.tar.gz: 11775b0f901a4782e9d58203db59a1677041069126e092122eca804bbbbb6d19b06a1b8db0d8f4834dbf1b3e819bb80200be96c7fd355ea9fa8822a112e06644

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+script:
+  - "bundle exec rspec"
+  - "bundle exec rubocop"

data/Gemfile

@@ -14,5 +14,6 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in zeus.gemspec
+# Specify your gem's dependencies in zeusclient.gemspec
+
 gemspec

data/Gemfile.lock

@@ -1,28 +1,52 @@
 PATH
   remote: .
   specs:
-    zeusclient (0.1.3)
-      json
-      rest-client
+    zeusclient (0.3.0)
+      rest-client (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    domain_name (0.5.24)
+    ast (2.3.0)
+    diff-lcs (1.2.5)
+    domain_name (0.5.20161021)
       unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
-    json (1.8.2)
-    mime-types (2.6.1)
-    netrc (0.10.3)
+    mime-types (2.99.3)
+    netrc (0.11.0)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
     rake (10.4.2)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    rubocop (0.45.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.1.1)
     yard (0.8.7.6)
 
 PLATFORMS
@@ -31,5 +55,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.8)
   rake (~> 10.0)
+  rspec (~> 3.0.0)
+  rubocop (~> 0.45.0)
   yard (~> 0.8.0)
   zeusclient!
+
+BUNDLED WITH
+   1.13.3

data/README.md

@@ -1,6 +1,6 @@
-# Ruby Zeus Client [![license](https://img.shields.io/hexpm/l/plug.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+# Ruby Zeus Client [![license](https://img.shields.io/hexpm/l/plug.svg)](http://www.apache.org/licenses/LICENSE-2.0) [![Build Status](https://travis-ci.org/CiscoZeus/ruby-zeusclient.svg)](https://travis-ci.org/CiscoZeus/ruby-zeusclient)
 
-![Alt text](/icons/zeus-logo.png?raw=true "Zeus Logo")
+![Alt text](https://github.com/CiscoZeus/ruby-zeusclient/blob/master/icons/zeus-logo.png?raw=true "Zeus Logo")
 
 Ruby client for [Cisco Zeus](http://www.ciscozeus.io/). This allows us to send and recieve data to and from Zeus.
 
@@ -25,27 +25,48 @@ Or install it yourself as:
 ```ruby
 require 'zeus/api_client'
 zeus_client = Zeus::APIClient.new({
-    :access_token => "your_token_here"
+    :access_token => "your_token_here",
+    :endpoint => "zeus_endpoint_here"
 })
 ```
 
 List All Metrics
+
 ```ruby
-result = zeus_client.list_metrics()
+result = zeus_client.list_metrics(
+  # optional parameters
+  {
+    regex: "metric.name*" # regex for filtering metrics names
+    from_date: "2016-06-12", # YYYY-MM-DD
+    to_date: "2017-12-20", # YYYY-MM-DD
+    aggregator_function: "sum", # Aggregator function to be applied to the metric values.
+                                # Available options. count, min, max, sum, mean, mode, median
+    group_interval: "100m",     # Interval for grouping, when applying aggregations via the aggregator_function parameter.
+                                # The aggregator_function parameter must be specific for this parameter to work.
+                                # Examples: 1000s, 100m, 10h, 1d , 1w. Use 's' for seconds, 'm' for minutes, 'h' for hours,
+                                # 'd' for days and 'w' for weeks.
+    filter_condition: "column1 > 0", # Filters to be applied to metric values.
+                                     # Examples: "column1 > 0", "column1 > 50 AND column2 = 10".
+    offset: 100,
+    limit: 10
+  }
+)
 p result.code      # 200
 p result.success?  # true
 p result.data      # => {}
 ```
 
 Get Metric
+
 ```ruby
-result = zeus_client.get_metrics()
+result = zeus_client.get_metrics( # same optional arguments as list_metrics)
 p result.code      # 200
 p result.success?  # true
 p result.data      # => {}
 ```
 
 Push Metric
+
 ```ruby
 result = zeus_client.send_metrics([{point: {value: 1, ...}}, ...])
 p result.code      # 200
@@ -54,6 +75,7 @@ p result.data      # => {}
 ```
 
 Delete metric
+
 ```ruby
 result = zeus_client.delete_metrics()
 p result.code      # 200
@@ -62,14 +84,27 @@ p result.data      # => {}
 ```
 
 Get logs
+
 ```ruby
-result = zeus_client.get_logs("log_name_here")
+result = zeus_client.get_logs(
+  "log_name_here",
+  #optional parameters
+  {
+    attribute_name: "cpu", # name of the attribute within the log to be searched
+    pattern: "memory.*", # a pattern for name filtering
+    from_date: "2016-06-12", # YYYY-MM-DD
+    to_date: "2017-12-20", # YYYY-MM-DD
+    offset: 200,
+    limit: 10
+  }
+)
 p result.code      # 200
 p result.success?  # true
 p result.data      # => {}
 ```
 
 Push logs
+
 ```ruby
 result = zeus_client.send_logs([{},{}, ...])
 p result.code      # 200
@@ -77,6 +112,90 @@ p result.success?  # true
 p result.data      # => {}
 ```
 
+Get alerts
+
+```ruby
+result = zeus_client.get_alerts()
+p result.code      # 200
+p result.success?  # true
+p result.data      # => {}
+```
+
+Create alert
+
+```ruby
+result = zeus_client.create_alert(
+  {
+    alert_name: "name of the alert",
+    username: "username associated with alert",
+    alert_expression: "cpu.value > 80", # expression to match alert against
+    # optional params
+    alerts_type: "metrics", # Either metric or log
+    alert_severity: "S1", # severity of the alert, S1-S5
+    metric_name: "name of the metrics associated with the alert",
+    emails: "email@provider.com", # email to be notified when alert triggers
+    status: "active", # either active or disabled
+    frequency: 60, # frequency for alert to be checked
+  }
+)
+p result.code      # 201
+p result.success?  # true
+p result.data      # => {}
+```
+
+Modify alert
+
+```ruby
+result = zeus_client.modify_alert(
+  alert_id,
+  {
+    # parameter you wish to modify
+    alert_name: "name of the alert",
+    username: "username associated with alert",
+    alert_expression: "cpu.value > 80", # expression to match alert against
+    alerts_type: "metric", # Either metric or log
+    alert_severity: "S1", # severity of the alert, S1-S5
+    metric_name: "name of the metrics associated with the alert",
+    emails: "email@provider.com", # email to be notified when alert triggers
+    status: "active", # either active or disabled
+    frequency: 60, # frequency for alert to be checked
+  }
+)
+p result.code      # 200
+p result.success?  # true
+p result.data      # => {}
+```
+
+Delete alert
+
+```ruby
+result = zeus_client.delete_alert(alert_id)
+p result.code      # 204
+p result.success?  # true
+p result.data      # => {}
+```
+
+Get triggered alerts
+
+```ruby
+result = zeus_client.triggered_alerts()
+p result.code      # 200
+p result.success?  # true
+p result.data      # => {}
+Get triggered alerts
+```
+
+Get triggered alerts in the last 24 hours
+
+```ruby
+result = zeus_client.triggered_alerts_last_24_hours()
+p result.code      # 200
+p result.success?  # true
+p result.data      # => {}
+```
+
+For more details, refer to [this documentation](http://www.rubydoc.info/github/CiscoZeus/ruby-zeusclient/)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -12,5 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'

data/bin/console

@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "bundler/setup"
-require "zeus/api_client"
+require 'bundler/setup'
+require 'zeus/api_client'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -24,5 +24,5 @@ require "zeus/api_client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/zeus/api_client/alerts_interface.rb

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+# Copyright 2016 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'zeus/api_client/rest_interface'
+require 'zeus/api_client/result'
+
+module Zeus
+  # Interface for dealing with alerts api calls
+  module AlertsInterface
+    include RestInterface
+
+    # create alert
+    # @param [Hash]  alert_data must contain:
+    #   @param [String]  alert_name name of the alert
+    #   @param [String]  username account username
+    #   @param [String]  token account token
+    #   @param [String]  alerts_type alert type, metrics or logs
+    #   @param [String]  alert_expression expression to evaluate the alert
+    #   @param [String]  alert_severity severity level of the alert
+    #   @param [String]  metric_name <TODO add description>
+    #   @param [String]  emails recipients to receive notifications
+    #   @param [String]  status if the alerts is enabled or not
+    #   @param [Integer] frequency <TODO add description>
+    # @return [Zeus::APIClient::Result]
+
+    def create_alert(alert_data)
+      alert_data[:token] = @access_token
+      response = post("/alerts/#{@access_token}", alert_data)
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # modify alert
+    # @param [Integer] alert_id id of the alert to be modified
+    # @param [Hash]  alert_data must contain:
+    #   @param [String]  alert_name name of the alert
+    #   @param [String]  username account username
+    #   @param [String]  token account token
+    #   @param [String]  alert_expression expression to evaluate the alert
+    #   Optional params:
+    #   @param [String]  alerts_type alert type, metrics or logs
+    #   @param [String]  alert_severity severity level of the alert
+    #   @param [String]  metric_name <TODO add description>
+    #   @param [String]  emails recipients to receive notifications
+    #   @param [String]  status if the alerts is enabled or not
+    #   @param [Integer] frequency <TODO add description>
+    # @return [Zeus::APIClient::Result]
+
+    def modify_alert(alert_id, alert_data)
+      alert_data[:token] = @access_token
+      response = put("/alerts/#{@access_token}/#{alert_id}", alert_data)
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # get alerts
+    # @param [String] metric Name of metric that alerts are associated with
+    # @return [Zeus::APIClient::Result]
+
+    def get_alerts(metric = nil)
+      params = { metric: metric }
+      begin
+        response = get("/alerts/#{@access_token}", params)
+        Result.new(response)
+      rescue => e
+        Result.new(e.response)
+      end
+    end
+
+    # get alert
+    # @param [Integer] alert_id id of alert to be retrieved
+    # @return [Zeus::APIClient::Result]
+
+    def get_alert(alert_id)
+      response = get("/alerts/#{@access_token}/#{alert_id}")
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # delete alert
+    # @param [Integer] alert_id id of alert to be deleted
+    # @return [Zeus::APIClient::Result]
+
+    def delete_alert(alert_id)
+      response = delete("/alerts/#{@access_token}/#{alert_id}")
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # enable alerts
+    # @param [Array[Integer]] alert_id_list list of alert ids to be enabled
+    # @return [Zeus::APIClient::Result]
+
+    def enable_alerts(alert_id_array)
+      params = { id: alert_id_array }
+      begin
+        response = post("/alerts/#{@access_token}/enable", params)
+        Result.new(response)
+      rescue => e
+        Result.new(e.response)
+      end
+    end
+
+    # disable alerts
+    # @param [Array[Integer]] alert_id_list list of alert ids to be disabled
+    # @return [Zeus::APIClient::Result]
+
+    def disable_alerts(alert_id_array)
+      params = { id: alert_id_array }
+      begin
+        response = post("/alerts/#{@access_token}/disable", params)
+        Result.new(response)
+      rescue => e
+        Result.new(e.response)
+      end
+    end
+  end
+end

data/lib/zeus/api_client/logs_interface.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+# Copyright 2016 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'zeus/api_client/rest_interface'
+require 'zeus/api_client/result'
+
+module Zeus
+  # Interface for dealing with logs api calls
+  module LogsInterface
+    include RestInterface
+    # send logs
+    # @param [String] name a log name
+    # @param [Array] logs a list of hash objects
+    # @return [Zeus::APIClient::Result]
+    def send_logs(name, logs)
+      params = { logs: logs }
+      begin
+        response = post("/logs/#{@access_token}/#{name}/", params)
+        Result.new(response)
+      rescue => e
+        Result.new(e.response)
+      end
+    end
+
+    # get logs
+    # @param [String] name a log name
+    # @param [Hash]  options can contain:
+    #   @param [String] attribute_name Name of the attribute within
+    #                                     the log to be searched.
+    #   @param [String] pattern a factor for filtering by name
+    #   @param [String] from_date a factor for filtering by start timestamp
+    #   @param [String] to_date a factor for filtering by end timestamp
+    #   @param [Integer] offset a factor for filtering by metrics name
+    #   @param [Integer] limit a maximum number of returning values
+    # @return [Zeus::APIClient::Result]
+    def get_logs(name, options = {})
+      options[:log_name] = name
+      response = get("/logs/#{@access_token}", options)
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+  end
+end

data/lib/zeus/api_client/metrics_interface.rb

@@ -0,0 +1,85 @@
+# coding: utf-8
+
+# Copyright 2016 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'zeus/api_client/rest_interface'
+require 'zeus/api_client/result'
+
+module Zeus
+  # Interface for dealing with metrics api calls
+  module MetricsInterface
+    include RestInterface
+    # Get metrics list
+    # @param [Hash]  options can contain:
+    #   @param [String] regex a factor for filtering by metrics name.
+    #                   eg: metric.name, metric.name*, metric.name.* etc.
+    #   @param [String] from_date a factor for filtering by start timestamp
+    #   @param [String] to_date a factor for filtering by end timestamp
+    #   @param [String] aggregator an aggregation methods
+    #   @param [String] group_interval grouping values by time interval.
+    #                   For example, 1000s, 100m, 10h, 1d , 1w
+    #   @param [String] filter_condition a factor for filtering by metrics name
+    #   @param [String] limit a maximum number of returning values
+    # @return [Zeus::APIClient::Result]
+    def list_metrics(options = {})
+      response = get("/metrics/#{@access_token}/_names/", options)
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # Send metrics list
+    # @param [String] name a name of metrics.
+    #                 For example, metric.name, metric.name*, metric.name.* etc.
+    # @param [Array] metrics a list of hash objects
+    # @return [Zeus::APIClient::Result]
+    def send_metrics(name, metrics)
+      params = { metrics: metrics }
+      begin
+        response = post("/metrics/#{@access_token}/#{name}/", params)
+        Result.new(response)
+      rescue => e
+        Result.new(e.response)
+      end
+    end
+
+    # Get metrics
+    # @param [Hash]  options can contain:
+    #   @param [String] regex a factor for filtering by metrics name
+    #   @param [String] from_date a factor for filtering by start timestamp
+    #   @param [String] to_date a factor for filtering by end timestamp
+    #   @param [String] aggregator an aggregation methods
+    #   @param [String] group_interval grouping values by time interval.
+    #                   For example, 1000s, 100m, 10h, 1d , 1w
+    #   @param [String] filter_condition filters to be applied to metric values.
+    #                   eg: "column1 > 0", "column1 > 50 AND column2 = 10"
+    #   @param [Integer] limit a maximum number of returning values
+    # @return [Zeus::APIClient::Result]
+    def get_metrics(options = {})
+      response = get("/metrics/#{@access_token}/_values/", options)
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # delete metrics
+    # @param [String] name a target metrics name
+    # @return [Zeus::APIClient::Result]
+    def delete_metrics(name)
+      response = delete("/metrics/#{@access_token}/#{name}/")
+      Result.new(response)
+    end
+  end
+end

data/lib/zeus/api_client/rest_interface.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+# Copyright 2016 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rest-client'
+
+# Wrapper around rest-client
+module RestInterface
+  private
+
+  def get(path, params = {})
+    RestClient.get "#{@endpoint}#{path}", params: params
+  end
+
+  def post(path, data = {})
+    RestClient.post "#{@endpoint}#{path}", data.to_json,
+                    content_type: :json, accept: :json
+  end
+
+  def put(path, params = {})
+    RestClient.put "#{@endpoint}#{path}", params: params
+  end
+
+  def delete(path = {})
+    RestClient.delete "#{@endpoint}#{path}"
+  end
+end

data/lib/zeus/api_client/result.rb

@@ -15,41 +15,36 @@
 require 'json'
 
 module Zeus
-  class APIClient
-    # Wrapper for a response of REST API
-    class Result
-
-      # constructor for Result class
-      def initialize(response)
-        @response = response
-      end
-
-      # request is successed?
-      def success?
-        @response.code == 200 || @response.code == 201
-      end
+  # Wrapper to interface with return values from the api
+  class Result
+    # constructor for Result class
+    def initialize(response)
+      @response = response
+    end
 
-      # request is error?
-      def error?
-        !self.success?
-      end
+    # request is successed?
+    def success?
+      @response.code == 200 || @response.code == 201
+    end
 
-      # response code
-      def code
-        @response.code
-      end
+    # request is error?
+    def error?
+      !success?
+    end
 
-      # response header
-      def header
-        @response.headers
-      end
+    # response code
+    def code
+      @response.code
+    end
 
-      # response body
-      def data
-        JSON.parse(@response)
-      end
+    # response header
+    def header
+      @response.headers
+    end
 
+    # response body
+    def data
+      JSON.parse(@response)
     end
   end
 end
-

data/lib/zeus/api_client/trigalerts_interface.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+# Copyright 2016 Cisco Systems, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'zeus/api_client/rest_interface'
+require 'zeus/api_client/result'
+
+module Zeus
+  # Interface for dealing with triggered alerts api calls
+  module TrigalertsInterface
+    include RestInterface
+
+    # get triggered alerts
+    # @return [Zeus::APIClient::Result]
+
+    def triggered_alerts
+      response = get("/trigalerts/#{@access_token}")
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+
+    # get triggered alerts in last 24 hours
+    # @return [Zeus::APIClient::Result]
+
+    def triggered_alerts_last_24_hours
+      response = get("/trigalerts/#{@access_token}/last24")
+      Result.new(response)
+    rescue => e
+      Result.new(e.response)
+    end
+  end
+end

data/lib/zeus/api_client/version.rb

@@ -15,6 +15,6 @@
 module Zeus
   class APIClient
     # package version number
-    VERSION = "0.1.3"
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/zeus/api_client.rb

@@ -12,179 +12,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'rest-client'
-require 'zeus/api_client/result'
-require 'zeus/api_client/version'
+require 'zeus/api_client/alerts_interface'
+require 'zeus/api_client/metrics_interface'
+require 'zeus/api_client/logs_interface'
+require 'zeus/api_client/trigalerts_interface'
 
 module Zeus
-
   # API Client for Zeus Service
   class APIClient
+    include AlertsInterface, MetricsInterface,
+            LogsInterface, TrigalertsInterface
 
     # constructor for Zeus::APIClient
     # @param       [Hash] opts the options to create z Zeus::APIClient instance
     # @option opts [String] :access_token The tokens for Zeus Service
     # @option opts [String] :endpoint The base url for API endpoint
-    def initialize(opts={})
+    def initialize(opts = {})
       @access_token = opts[:access_token]
-      @endpoint = opts[:endpoint] || "http://api.ciscozeus.io"
-    end
-
-    # Get metrics list
-    # @param [String] regex a factor for filtering by metrics name
-    #   [optional]
-    #   [Examples] metric.name, metric.name*, metric.name.* etc.
-    # @param [String] from_date a factor for filtering by start timestamp
-    #   [optional]
-    # @param [String] to_date a factor for filtering by end timestamp
-    #   [optional]
-    # @param [String] aggregator an aggregation methods
-    #   [optional]
-    # @param [String] group_interval grouping values by time interval
-    #   [optional]
-    #   [Examples] 1000s, 100m, 10h, 1d , 1w. Use 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days and 'w' for weeks.
-    # @param [String] filter_condition a factor for filtering by metrics name
-    #   [optional]
-    # @param [String] limit a maximum number of returning values
-    #   [optional]
-    # @return [Zeus::APIClient::Result]
-    def list_metrics(regex=nil, from_date=nil, to_date=nil, aggregator=nil, group_interval=nil, filter_condition=nil, limit=nil)
-      params = {}
-      params.merge!(metric_name: regex)                 if regex
-      params.merge!(from: from_date)                    if from_date
-      params.merge!(to: to_date)                        if to_date
-      params.merge!(aggregator_function: aggregator)    if aggregator
-      params.merge!(group_interval: group_interval)     if group_interval
-      params.merge!(filter_condition: filter_condition) if filter_condition
-      params.merge!(limit: limit)                       if limit
-      begin
-        response = get("/metrics/#{@access_token}/_names/", params)
-        Result.new(response)
-      rescue => e
-        Result.new(e.response)
-      end
-    end
-
-    # Send metrics list
-    # @param [String] name a name of metrics
-    #   [Examples] metric.name, metric.name*, metric.name.* etc.
-    # @param [Array] metrics a list of hash objects
-    # @return [Zeus::APIClient::Result]
-    def send_metrics(name, metrics)
-      params = {metrics: metrics}
-      begin
-        response = post("/metrics/#{@access_token}/#{name}/", params)
-        Result.new(response)
-      rescue => e
-        Result.new(e.response)
-      end
-    end
-
-    # Get metrics
-    # @param [String] regex a factor for filtering by metrics name
-    #   [optional]
-    # @param [String] from_date a factor for filtering by start timestamp
-    #   [optional]
-    # @param [String] to_date a factor for filtering by end timestamp
-    #   [optional]
-    # @param [String] aggregator an aggregation methods
-    #   [optional]
-    # @param [String] group_interval grouping values by time interval
-    #   [optional]
-    #   [Examples] 1000s, 100m, 10h, 1d , 1w. Use 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days and 'w' for weeks.
-    # @param [String] filter_condition filters to be applied to metric values
-    #   [optional]
-    #   [Examples] "column1 > 0", "column1 > 50 AND column2 = 10".
-    # @param [Integer] limit a maximum number of returning values
-    #   [optional]
-    # @return [Zeus::APIClient::Result]
-    def get_metrics(regex=nil, from_date=nil, to_date=nil, aggregator=nil, group_interval=nil, filter_condition=nil, limit=nil)
-      params = {}
-      params.merge!(metric_name: regex)                 if regex
-      params.merge!(from: from_date)                    if from_date
-      params.merge!(to: to_date)                        if to_date
-      params.merge!(aggregator_function: aggregator)    if aggregator
-      params.merge!(group_interval: group_interval)     if group_interval
-      params.merge!(filter_condition: filter_condition) if filter_condition
-      params.merge!(limit: limit)                       if limit
-      begin
-        response = get("/metrics/#{@access_token}/_values/", params)
-        Result.new(response)
-      rescue => e
-        Result.new(e.response)
-      end
-    end
-
-    # delete metrics
-    # @param [String] name a target metrics name
-    # @return [Zeus::APIClient::Result]
-    def delete_metrics(name)
-      response = delete("/metrics/#{@access_token}/#{name}/")
-      Result.new(response)
-    end
-
-    # send logs
-    # @param [String] name a log name
-    # @param [Array] logs a list of hash objects
-    # @return [Zeus::APIClient::Result]
-    def send_logs(name, logs)
-      params = {logs:logs}
-      begin
-        response = post("/logs/#{@access_token}/#{name}/", params)
-        Result.new(response)
-      rescue => e
-        Result.new(e.response)
-      end
+      # makes sure its using https
+      uri_parts = URI.split(opts[:endpoint])
+      uri_parts[0] = 'https://'
+      @endpoint = uri_parts.join
     end
-
-    # get logs
-    # @param [String] name a log name
-    # @param [String] attribute_name Name of the attribute within the log to be searched.
-    #   [optional]
-    #   [Examples] if the submitted log has the format {"key1": "value1", "key2": "value2", "timestamp": 1430268064} then the value of this field can be "key1" or "key2"
-    # @param [String] pattern a factor for fitering by name
-    #   [optional]
-    # @param [String] from_date a factor for filtering by start timestamp
-    #   [optional]
-    # @param [String] to_date a factor for filtering by end timestamp
-    #   [optional]
-    # @param [Integer] offset a factor for filtering by metrics name
-    #   [optional]
-    # @param [Integer] limit a maximum number of returning values
-    #   [optional]
-    # @return [Zeus::APIClient::Result]
-    def get_logs(name, attribute_name=nil, pattern=nil, from_date=nil, to_date=nil, offset=nil, limit=nil)
-      params = {log_name: name}  # required fields
-      params.merge!(attribute_name: attribute_name) if attribute_name
-      params.merge!(pattern: pattern) if pattern
-      params.merge!(from: from_date)  if from_date
-      params.merge!(to: to_date)      if to_date
-      params.merge!(offset: offset)   if offset
-      params.merge!(limit: limit)     if limit
-      begin
-        response = get("/logs/#{@access_token}", params)
-        Result.new(response)
-      rescue => e
-        Result.new(e.response)
-      end
-    end
-
-    private
-    def get(path, params={})
-      RestClient.get "#{@endpoint}#{path}", {params: params}
-    end
-
-    def post(path, data={})
-      RestClient.post "#{@endpoint}#{path}", data.to_json, :content_type => :json, :accept => :json
-    end
-
-    def put(path, data={})
-      RestClient.put "#{@endpoint}#{path}", data.to_json, :content_type => :json, :accept => :json
-    end
-
-    def delete(path={})
-      RestClient.delete "#{@endpoint}#{path}"
-    end
-
   end
 end

data/zeusclient.gemspec

@@ -16,31 +16,36 @@
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'zeus/api_client'
+require 'zeus/api_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "zeusclient"
+  spec.name          = 'zeusclient'
   spec.version       = Zeus::APIClient::VERSION
-  spec.authors       = ["Komei Shimamura"]
-  spec.email         = ["komei.t.f@gmail.com"]
+  spec.authors       = ['Cisco Zeus']
+  spec.email         = ['info@ciscozeus.io']
 
   if spec.respond_to?(:metadata)
     # spec.metadata['allowed_push_host'] = 'http://mygemserver.com'
   end
 
-  spec.summary       = %q{Ruby Client for Cisco Zeus}
-  spec.description   = %q{Client for Cisco Zeus. This allows users to send and receive data to and from Cisco Zeus.}
-  spec.homepage      = "https://github.com/CiscoZeus/ruby-zeusclient"
-  spec.license       = "Apache 2.0"
+  spec.summary       = 'Ruby Client for Cisco Zeus'
+  spec.description   = 'Client for Cisco Zeus. This allows users to send'\
+                        'and receive data to and from Cisco Zeus.'
+  spec.homepage      = 'https://github.com/CiscoZeus/ruby-zeusclient'
+  spec.license       = 'Apache 2.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|icons)/}) }
-  spec.bindir        = "exe"
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject { |f|
+      f.match(%r{^(test|spec|features|icons)/})
+    }
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "json"
-  spec.add_dependency "rest-client"
-  spec.add_development_dependency "bundler", "~> 1.8"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "yard", "~> 0.8.0"
+  spec.add_runtime_dependency 'rest-client', '~> 1.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'yard', '~> 0.8.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45.0'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: zeusclient
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
-- Komei Shimamura
+- Cisco Zeus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2016-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.8'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -80,15 +80,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
-description: Client for Cisco Zeus. This allows users to send and receive data to
-  and from Cisco Zeus.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+description: Client for Cisco Zeus. This allows users to sendand receive data to and
+  from Cisco Zeus.
 email:
-- komei.t.f@gmail.com
+- info@ciscozeus.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -97,7 +112,12 @@ files:
 - bin/console
 - bin/setup
 - lib/zeus/api_client.rb
+- lib/zeus/api_client/alerts_interface.rb
+- lib/zeus/api_client/logs_interface.rb
+- lib/zeus/api_client/metrics_interface.rb
+- lib/zeus/api_client/rest_interface.rb
 - lib/zeus/api_client/result.rb
+- lib/zeus/api_client/trigalerts_interface.rb
 - lib/zeus/api_client/version.rb
 - zeusclient.gemspec
 homepage: https://github.com/CiscoZeus/ruby-zeusclient
@@ -120,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Client for Cisco Zeus