zeusclient 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6de2b427eec1b61a32dca4dd4db821f5757bcc43
-  data.tar.gz: 3ec31374ecedd07fa548713da44306981531fe38
+  metadata.gz: 2c9b1fe09cdda854fc306b53d850844882fcfb8c
+  data.tar.gz: 67609f973c1bb564d651d09e684e5cd02e423389
 SHA512:
-  metadata.gz: 65d27734ac92912a91f689342037a4faf9528348af1e42f04bfc5e0907241ff6e6e5263f2f1d794a92819f273e382c0a738ec56fc75b18903cab97389505347c
-  data.tar.gz: 0596048bd3d412b4f861bea183d02d798be717b8f02139b9f2568b9967916d641ee6c142f079a249f01db214ff409f8e5c72eb10a4f450627a053324f753d7cb
+  metadata.gz: 3ebb415c828ccb35f9146ba6d85b15893538fabcaed53f44c61f91b480a90f66d2909f4e06274b4b833267842e3a36c01d0e1b3f86d7a57ad9ccdd21332b2eaf
+  data.tar.gz: 8a291264fc2236aa6fd0968135518621d9f1e38d00e9fac8301988f5ae80903ca7b1211c7d0527776a7ffdceabaa3bf3eb0c5d4a9579d7f5adc0099c9285941b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zeusclient (0.1.1)
+    zeusclient (0.1.3)
       json
       rest-client
 
@@ -23,6 +23,7 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.1)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
@@ -30,4 +31,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.8)
   rake (~> 10.0)
+  yard (~> 0.8.0)
   zeusclient!

data/lib/zeus/api_client.rb

@@ -18,13 +18,36 @@ require 'zeus/api_client/version'
 
 module Zeus
 
+  # API Client for Zeus Service
   class APIClient
 
+    # 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={})
       @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
@@ -35,23 +58,46 @@ module Zeus
       params.merge!(filter_condition: filter_condition) if filter_condition
       params.merge!(limit: limit)                       if limit
       begin
-        response = self.get("/metrics/#{@access_token}/_names/", params)
+        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 = self.post("/metrics/#{@access_token}/#{name}/", params)
+        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
@@ -62,50 +108,73 @@ module Zeus
       params.merge!(filter_condition: filter_condition) if filter_condition
       params.merge!(limit: limit)                       if limit
       begin
-        response = self.get("/metrics/#{@access_token}/_values/", params)
+        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 = self.delete("/metrics/#{@access_token}/#{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 = self.post("/logs/#{@access_token}/#{name}/", params)
+        response = post("/logs/#{@access_token}/#{name}/", params)
         Result.new(response)
       rescue => e
         Result.new(e.response)
       end
     end
 
-    def get_logs(name, pattern=nil, from_date=nil, to_date=nil, offset=nil, limit=nil)
+    # 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 = self.get("/logs/#{@access_token}", params)
+        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={})
-      p "#{@endpoint}#{path}"
-      p data
       RestClient.post "#{@endpoint}#{path}", data.to_json, :content_type => :json, :accept => :json
     end
 

data/lib/zeus/api_client/result.rb

@@ -16,32 +16,39 @@ 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
 
+      # request is error?
       def error?
         !self.success?
       end
 
+      # response code
       def code
         @response.code
       end
 
-      def data
-        JSON.parse(@response)
-      end
-
+      # response header
       def header
         @response.headers
       end
 
+      # response body
+      def data
+        JSON.parse(@response)
+      end
+
     end
   end
 end

data/lib/zeus/api_client/version.rb

@@ -14,6 +14,7 @@
 
 module Zeus
   class APIClient
-    VERSION = "0.1.2"
+    # package version number
+    VERSION = "0.1.3"
   end
 end

data/zeusclient.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |spec|
   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"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeusclient
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Komei Shimamura
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
 email:
@@ -111,3 +125,4 @@ signing_key:
 specification_version: 4
 summary: Ruby Client for Cisco Zeus
 test_files: []
+has_rdoc: