graylogapi 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e18820f8c12cdbb4ee2ca5abbbae9cf243602a1
-  data.tar.gz: a3f0359c7e296e882ada520d468b5d545330df68
+  metadata.gz: 683d85c513cb5ae61865a46e6df25f4c32059b4c
+  data.tar.gz: f26183d5c0741ed649760e09412d1fca673b3563
 SHA512:
-  metadata.gz: 9c158262bfbe63f1dd4cc625cf9a06b430c7e09b14501774cce47cc38c9920398aa519ff9c7e50a3b3f2ecd8954fe42cd4309ca5dbc2a4a542b5461e47aaad48
-  data.tar.gz: 35abed6db071d0d21ef7095d6d34569bf3a119b9bbf584b4239ad4bed580440a2f3398db1274d58a024a1ba885d1c0f96269c4a55651c8b34b11cb5b0b6dd1a8
+  metadata.gz: 5678337ae29a5d47027778b9a330730649725b95cbc75b475b35299e8cfda2edca90fb803136626f4cbf7ae0d5f4cada4b85544474db88c140d35af9dd7192e6
+  data.tar.gz: 860e06d3ffb7822c1d1b2bf32be4d571612b4a69cf57eba518753740c4c7b929f4568499f63b9f6f351737d9dc6f9c7424d7eb245eeee047773a97eafabad4de

data/README.md

@@ -10,30 +10,65 @@ Ruby gem for working with [Graylog](https://www.graylog.org/) via the [Graylog R
 
 ## Installation
 
-    gem install zabbixapi
+    gem install graylogapi
+## Dependencies
+
+- net/http
+- json
+
+## Graylog documentation
+
+- [Graylog Homepage][Graylog]
+- [Graylog API docs][GraylogAPI]
+
+[Graylog]: https://www.graylog.org/
+[GraylogAPI]: http://docs.graylog.org/en/2.2/pages/configuration/rest_api.html?highlight=API
 
 ## Usage
 
 Structure of gem looks like Graylog REST Api or navigation menu in UI.
-For example, you can find **Inputs* in *System/Inputs* in the UI and you can find *Inputs* in `GraylogAPI.new(...).system.inputs` in the gem.
+For example, you can find *Inputs* in *System/Inputs* in the UI and you can find *Inputs* in `GraylogAPI.new(...).system.inputs` in the gem.
 
 ### get Input by id
 
     graylogapi = Graylog.new('http://localhost:9000/api', 'username', 'password')
     graylogapi.system.inputs.by_id('5947d3840b5712166af25009')
 
-## Dependencies
-
-* net/http
-* json
-
-## Graylog documentation
-
-* [Graylog Homepage][Graylog]
-* [Graylog API docs][GraylogAPI]
-
-[Graylog]: https://www.graylog.org/
-[GraylogAPI]: http://docs.graylog.org/en/2.2/pages/configuration/rest_api.html?highlight=API
+## Supported methods
+
+* **Alerts**: Manage stream alerts for all streams
+  * recent(params) — Get the most recent alarms of all streams.
+  * paginated(params) — Get alarms of all streams, filtered by specifying limit and offset parameters.
+  * by_id(id, params) — Get an alert by ID.
+* **Streams**: Manage streams
+  * all — Get a list of all streams.
+  * create(params) — Create a stream.
+  * enabled — Get a list of all enabled streams.
+  * by_id — Get a single stream.
+  * update(id, params) — Update a stream.
+  * delete(id) — Delete a stream.
+  * clone(id, params) — Clone a stream.
+  * pause(id) — Pause a stream.
+  * resume(id) — Resume a stream.
+* **System**: System informatino of this node.
+  * overview — Get system overview.
+  * jvm — Get JVM information.
+  * thread_dump — Get a thread dump.
+* **System/Cluster**: Node discovery
+  * node — Infromation about this node.
+  * nodes — List all active nodes in this cluster.
+  * node_by_id — Infromation about a node.
+* **System/IndexSets**: Index sets
+  * all — Get a list of all index sets.
+  * create(params) — Create index set.
+  * by_id(id) — Get index set by id.
+  * delete(id) — Delete index set.
+* **System/Inputs**: Message inputs
+  * all — Get all inputs.
+  * by_id(id, params) — Get information of a single input on this node.
+  * create(params) — Launch input on this node.
+  * update(params) — Update input on this node.
+  * delete(id) — Terminate input on this node.
 
 ## Copyright
 
@@ -42,4 +77,3 @@ Copytight (c) 2017 Andrey Aleksandrov
 See [LICENSE][] for details.
 
 [license]: LICENSE.md
-

data/lib/graylogapi/alerts.rb

@@ -6,15 +6,15 @@ class GraylogAPI
     end
 
     def recent(options = {})
-      @client.get('/streams/alerts', options)
+      @client.json_request(:get, '/streams/alerts', options)
     end
 
     def paginated(options = {})
-      @client.get('/streams/alerts/paginated', options)
+      @client.json_reuqest(:get, '/streams/alerts/paginated', options)
     end
 
     def by_id(id, options = {})
-      @client.get("/streams/alerts/#{id}", options)
+      @client.json_request(:get, "/streams/alerts/#{id}", options)
     end
   end
 end

data/lib/graylogapi/client/response.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+class GraylogAPI
+  class Client
+    # Response of a http request
+    class Response
+      attr_accessor :code, :body
+
+      # Initialize object of response
+      #
+      # @param http_response [HTTP]
+      # @return GraylogAPI::Client::Response
+      def initialize(http_response)
+        self.body = parse_body(http_response.body)
+        self.code = http_response.code.to_i
+      end
+
+      def [](key)
+        body[key]
+      end
+
+      def keys
+        body.keys
+      end
+
+      def success?
+        (200..299).cover? code
+      end
+
+      def fail?
+        (400..599).cover? code
+      end
+
+      private
+
+      def parse_body(body)
+        if body.nil? || body.empty?
+          {}
+        else
+          begin
+            JSON.parse(body)
+          rescue
+            body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/graylogapi/client.rb

@@ -1,10 +1,17 @@
 require 'net/http'
 require 'uri'
-require 'json'
+require 'graylogapi/client/response'
 
 class GraylogAPI
   # The client is the entry point to the api
   class Client
+    METHODS = {
+      delete: Net::HTTP::Delete,
+      get: Net::HTTP::Get,
+      post: Net::HTTP::Post,
+      put: Net::HTTP::Put
+    }.freeze
+
     # @return options of object [Hash]
     attr_reader :options
 
@@ -18,95 +25,35 @@ class GraylogAPI
       @http = Net::HTTP.new(uri.host, uri.port)
     end
 
-    # Make get request to url
-    #
-    # @param url [String]
-    # @param params [Hash]
-    # @return [Struct]
-    def get(url, params = {})
-      json_request(:get, url, params)
-    end
-
-    # Make post request to url
-    #
-    # @param url [String]
-    # @param params [Hash]
-    # @return [Struct]
-    def post(url, params = {})
-      json_request(:post, url, params)
-    end
-
-    # Make post request to url
+    # Make request to the API
     #
-    # @param url [String]
-    # @param params [Hash]
-    # @return [Struct]
-    def put(url, params = {})
-      json_request(:put, url, params)
-    end
-
-    # Make post request to url
-    #
-    # @param url [String]
-    # @param params [Hash]
-    # @return [Struct]
-    def delete(url, params = {})
-      json_request(:delete, url, params)
-    end
-
-    private
-
+    # @param method [Symbol] can be :get, :post, :delete, :put
+    # @param path [String] url
+    # @param params [Hash] request params
+    # @return Struct
     def json_request(method, path, params = {})
-      request = method("#{method}_request").call(path, params)
+      request = request(method, path, params)
       request.basic_auth(options[:user], options[:pass])
       request.add_field('Content-Type', 'application/json')
       response = @http.request(request)
 
-      response_struct(response)
+      Response.new(response)
     rescue
       response
     end
 
-    def response_struct(response)
-      struct = Struct.new(:code, :body)
-
-      code = response.code.to_i
-      body = parse_body(response.body)
-      struct.new(code, body)
-    end
+    private
 
-    def parse_body(body)
-      if body.nil? || body.empty?
-        {}
-      else
-        begin
-          JSON.parse(body)
-        rescue
-          body
-        end
+    def request(method, path, params = {})
+      case method
+      when :get, :delete
+        full_path = [options[:base_url] + path, URI.encode_www_form(params)]
+        METHODS[method].new(full_path.join('?'))
+      when :post, :put
+        req = METHODS[method].new(options[:base_url] + path)
+        req.body = params.to_json
+        req
       end
     end
-
-    def get_request(path, params = {})
-      full_path = [options[:base_url] + path, URI.encode_www_form(params)]
-      Net::HTTP::Get.new(full_path.join('?'))
-    end
-
-    def post_request(path, params = {})
-      req = Net::HTTP::Post.new(options[:base_url] + path)
-      req.body = params.to_json
-      req
-    end
-
-    def put_request(path, params = {})
-      req = Net::HTTP::Put.new(options[:base_url] + path)
-      req.body = params.to_json
-      req
-    end
-
-    def delete_request(path, params = {})
-      full_path = [options[:base_url] + path, URI.encode_www_form(params)]
-      Net::HTTP::Delete.new(full_path.join('?'))
-    end
   end
 end

data/lib/graylogapi/streams.rb

@@ -0,0 +1,44 @@
+class GraylogAPI
+  # class for manage streams
+  class Streams
+    def initialize(client)
+      @client = client
+    end
+
+    def all
+      @client.json_request(:get, '/streams')
+    end
+
+    def create(params = {})
+      @client.json_request(:post, '/streams', params)
+    end
+
+    def enabled
+      @client.json_request(:get, '/streams/enabled')
+    end
+
+    def by_id(id)
+      @client.json_request(:get, "/streams/#{id}")
+    end
+
+    def update(id, params = {})
+      @client.json_request(:put, "/streams/#{id}", params)
+    end
+
+    def delete(id, params = {})
+      @client.json_request(:delete, "/streams/#{id}", params)
+    end
+
+    def clone(id, params = {})
+      @client.json_request(:post, "/streams/#{id}/clone", params)
+    end
+
+    def pause(id)
+      @client.json_request(:post, "/streams/#{id}/pause")
+    end
+
+    def resume(id)
+      @client.json_request(:post, "/streams/#{id}/resume")
+    end
+  end
+end

data/lib/graylogapi/system/cluster.rb

@@ -0,0 +1,22 @@
+class GraylogAPI
+  class System
+    # class for get system information of a node
+    class Cluster
+      def initialize(client)
+        @client = client
+      end
+
+      def node
+        @client.json_request(:get, '/system/cluster/node')
+      end
+
+      def nodes
+        @client.json_request(:get, '/system/cluster/nodes')
+      end
+
+      def node_by_id(id)
+        @client.json_request(:get, "/system/cluster/nodes/#{id}")
+      end
+    end
+  end
+end

data/lib/graylogapi/system/index_sets.rb

@@ -0,0 +1,26 @@
+class GraylogAPI
+  class System
+    # class for manage System/IndexSets
+    class IndexSets
+      def initialize(client)
+        @client = client
+      end
+
+      def all
+        @client.json_request(:get, '/system/indices/index_sets')
+      end
+
+      def create(params)
+        @client.json_request(:post, '/system/indices/index_sets', params)
+      end
+
+      def by_id(id)
+        @client.json_request(:get, "/system/indices/index_sets/#{id}")
+      end
+
+      def delete(id)
+        @client.json_request(:delete, "/system/indices/index_sets/#{id}")
+      end
+    end
+  end
+end

data/lib/graylogapi/system/inputs.rb

@@ -10,14 +10,14 @@ class GraylogAPI
       #
       # @return [Struct]
       def all
-        @client.get('/system/inputs')
+        @client.json_request(:get, '/system/inputs')
       end
 
       # get input by input id
       #
       # @return [Struct]
       def by_id(id)
-        @client.get("/system/inputs/#{id}")
+        @client.json_request(:get, "/system/inputs/#{id}")
       end
 
       # create input
@@ -25,7 +25,7 @@ class GraylogAPI
       # @param params [Hash]
       # @return [Struct]
       def create(params = {})
-        @client.post('/system/inputs', params)
+        @client.json_request(:post, '/system/inputs', params)
       end
 
       # update input
@@ -33,7 +33,7 @@ class GraylogAPI
       # @param params [Hash]
       # @return [Struct]
       def update(id, params = {})
-        @client.put("/system/inputs/#{id}", params)
+        @client.json_request(:put, "/system/inputs/#{id}", params)
       end
 
       # delete input
@@ -41,7 +41,7 @@ class GraylogAPI
       # @param params [Hash]
       # @return [Struct]
       def delete(id, params = {})
-        @client.delete("/system/inputs/#{id}", params)
+        @client.json_request(:delete, "/system/inputs/#{id}", params)
       end
     end
   end

data/lib/graylogapi/system.rb

@@ -1,3 +1,5 @@
+require 'graylogapi/system/cluster'
+require 'graylogapi/system/index_sets'
 require 'graylogapi/system/inputs'
 
 class GraylogAPI
@@ -7,11 +9,31 @@ class GraylogAPI
       @client = client
     end
 
+    def overview
+      @client.json_request(:get, '/system')
+    end
+
+    def jvm
+      @client.json_request(:get, '/system/jvm')
+    end
+
+    def thread_dump
+      @client.json_request(:get, '/system/threaddump')
+    end
+
     # object for manage System/Inputs
     #
     # @return GraylogAPI::System::Inputs
     def inputs
       @inputs ||= Inputs.new(@client)
     end
+
+    def index_sets
+      @index_sets ||= IndexSets.new(@client)
+    end
+
+    def cluster
+      @cluster ||= Cluster.new(@client)
+    end
   end
 end

data/lib/graylogapi/version.rb

@@ -1,3 +1,3 @@
 class GraylogAPI
-  VERSION = '0.0.1'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/graylogapi.rb

@@ -2,8 +2,9 @@ libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 require 'graylogapi/version'
-require 'graylogapi/client'
 require 'graylogapi/alerts'
+require 'graylogapi/client'
+require 'graylogapi/streams'
 require 'graylogapi/system'
 
 # class for work with graylog api
@@ -28,4 +29,9 @@ class GraylogAPI
   def system
     @system ||= System.new(@client)
   end
+
+  # @return [GraylogAPI::Streams]
+  def streams
+    @streams ||= Streams.new(@client)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graylogapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrey Aleksandrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-19 00:00:00.000000000 Z
+date: 2017-06-27 00:00:00.000000000 Z
 dependencies: []
 description: Allows you to work with graylog api from ruby
 email:
@@ -23,7 +23,11 @@ files:
 - lib/graylogapi.rb
 - lib/graylogapi/alerts.rb
 - lib/graylogapi/client.rb
+- lib/graylogapi/client/response.rb
+- lib/graylogapi/streams.rb
 - lib/graylogapi/system.rb
+- lib/graylogapi/system/cluster.rb
+- lib/graylogapi/system/index_sets.rb
 - lib/graylogapi/system/inputs.rb
 - lib/graylogapi/version.rb
 homepage: https://github.com/postgred/graylogapi