graylogapi 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9be5fd32aab8bdf033a166ea8f8a2bbcbc37d922
-  data.tar.gz: 4b1c4e462cbe2ef62b37c3d8c260eac5563f1eb7
+  metadata.gz: d11f3ff96af6158de0d004545af1fd99f2fd6b23
+  data.tar.gz: 77936ef677d557d8237fc3cba8f074127afc8765
 SHA512:
-  metadata.gz: 6a1f053a8900febc23289bce905b860b411b3ae8239cd14d5621236a5434f7b1e3bceb6c3a743636c20e181626a96571991cc64c218194fe8ff5f9235bc3a13e
-  data.tar.gz: 594d5f6b37bae202ec9b79d668c991badc2473bbebbddd1b2a3f01275857f90eee243081bfd17bedb3100f08b00579e0322fca3b5441db516162436fdc3fcda7
+  metadata.gz: f7f0b8293f39e8e5076041c2767acd5c4b6287c482335ea6c46dfa81bdb3825f0550fa06805661fd5bb563a6823fa8ad5a81b92a0c1d91f39e6d109bf2a34b99
+  data.tar.gz: 558faa1e0cb74d393b4aa79d12294bd9f0f5e4b7f8e3efa933bcb23914d146f9bd2da0f9f9cc596edf65d7333189d148449f1180107f78b79e4b0f510b99e0cf

data/README.md

@@ -29,11 +29,34 @@ Ruby gem for working with [Graylog](https://www.graylog.org/) via the [Graylog R
 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.
 
-### get Input by id
 
-    graylogapi = Graylog.new('http://localhost:9000/api', 'username', 'password')
+
+### Authorization
+
+#### user and password
+
+```
+graylogapi = GraylogAPI.new(base_url: 'http://localhost:9000/api', user: 'username', pass: 'password')
+```
+
+#### token
+
+```
+graylogapi = GraylogAPI.new(base_url: 'http://localhost:9000/api', token: 'token')
+```
+
+
+
+### Examples
+
+#### get Input by id
+
+    graylogapi = GraylogAPI.new(base_url: 'http://localhost:9000/api', user: 'username', pass: 'password')
+    
     graylogapi.system.inputs.by_id('5947d3840b5712166af25009')
 
+You can find more examples [here](./examples/)
+
 ## Supported methods
 
 * **Alerts**: Manage stream alerts for all streams
@@ -69,7 +92,10 @@ For example, you can find *Inputs* in *System/Inputs* in the UI and you can find
   * node_by_id — Infromation about a node.
 * **System/IndexSets**: Index sets
   * all — Get a list of all index sets.
+  * default — Get default index set.
   * create(params) — Create index set.
+  * update(params) — Update index set.
+  * make_default(id) — Set default index set.
   * by_id(id) — Get index set by id.
   * delete(id) — Delete index set.
 * **System/Inputs**: Message inputs
@@ -78,6 +104,16 @@ For example, you can find *Inputs* in *System/Inputs* in the UI and you can find
   * create(params) — Launch input on this node.
   * update(params) — Update input on this node.
   * delete(id) — Terminate input on this node.
+* **System/Inputs/Types**: Message input types of this node.
+  * node — Get all available input types of this node.
+  * all — Get informatino about all input types.
+  * by_type(type) — Get information about a single input type.
+  * name_to_type(name) — Convert name of type to type.
+* **Users**: User accounts.
+  * tokens(username) — Retrieves the list of access tokens for a user.
+  * create_token(username, name) — Generate a new access token for a user.
+  * delete_token(username, name) — Removes a token for a user.
+
 
 ## Copyright
 

data/lib/graylogapi/client/response.rb

@@ -37,11 +37,7 @@ class GraylogAPI
         if body.nil? || body.empty?
           {}
         else
-          begin
-            JSON.parse(body)
-          rescue
-            body
-          end
+          JSON.parse(body)
         end
       end
     end

data/lib/graylogapi/client.rb

@@ -18,11 +18,16 @@ class GraylogAPI
     # Initializes a new Client object
     #
     # @param options [Hash]
+    #   * :base_url [String] Endpoint of graylog API
+    #   * :user [String] Username
+    #   * :pass [String] Password
+    #   * :token [String] Token
+    #   * :read_timeout [Integer] Read timeout of http request in seconds (60 default)
+    #   * :open_timeout [Integer] Open timeout of http request in secods (60 default)
     # @return [GraylogAPI::Client]
     def initialize(options = {})
       @options = options
-      uri = URI.parse(options[:base_url])
-      @http = Net::HTTP.new(uri.host, uri.port)
+      @http = http_client(URI.parse(options[:base_url]), options)
     end
 
     # Make request to the API
@@ -30,21 +35,33 @@ class GraylogAPI
     # @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 = request(method, path, params)
-      request.basic_auth(options[:user], options[:pass])
+    # @return [GraylogAPI::Client::Response]
+    def request(method, path, params = {})
+      request = make_request(method, path, params)
       request.add_field('Content-Type', 'application/json')
+      request.basic_auth(username, password)
       response = @http.request(request)
 
       Response.new(response)
-    rescue
-      response
     end
 
     private
 
-    def request(method, path, params = {})
+    def http_client(uri, options)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      http.read_timeout = options[:read_timeout].nil? ? 60 : options[:read_timeout]
+      http.open_timeout = options[:open_timeout].nil? ? 60 : options[:open_timeout]
+
+      http
+    end
+
+    def make_request(method, path, params = {})
       case method
       when :get, :delete
         full_path = [options[:base_url] + path, URI.encode_www_form(params)]
@@ -55,5 +72,13 @@ class GraylogAPI
         req
       end
     end
+
+    def username
+      options[:token].nil? ? options[:user] : options[:token]
+    end
+
+    def password
+      options[:token].nil? ? options[:pass] : 'token'
+    end
   end
 end

data/lib/graylogapi/dashboards.rb

@@ -10,14 +10,14 @@ class GraylogAPI
     # @param params [Hash]
     # @return [GraylogAPI::Client::Response]
     def create(params)
-      @client.json_request(:post, '/dashboards', params)
+      @client.request(:post, '/dashboards', params)
     end
 
     # get list of all dashboards
     #
     # @return [GraylogAPI::Client::Response]
     def all
-      @client.json_request(:get, '/dashboards')
+      @client.request(:get, '/dashboards')
     end
 
     # get dashboard by id
@@ -25,7 +25,7 @@ class GraylogAPI
     # @param id [Integer] id of a dashboard
     # @return [GraylogAPI::Client::Response]
     def by_id(id)
-      @client.json_request(:get, "/dashboards/#{id}")
+      @client.request(:get, "/dashboards/#{id}")
     end
 
     # update dashboard
@@ -34,7 +34,7 @@ class GraylogAPI
     # @param params [Hash]
     # @return [GraylogAPI::Client::Response]
     def update(id, params)
-      @client.json_request(:put, "/dashboards/#{id}", params)
+      @client.request(:put, "/dashboards/#{id}", params)
     end
 
     # delete dashboard
@@ -42,7 +42,7 @@ class GraylogAPI
     # @param id [Integer] id of a dashboard
     # @return [GraylogAPI::Client::Response]
     def delete(id)
-      @client.json_request(:delete, "/dashboards/#{id}")
+      @client.request(:delete, "/dashboards/#{id}")
     end
   end
 end

data/lib/graylogapi/static_fields.rb

@@ -11,7 +11,7 @@ class GraylogAPI
     # @param params [Hash] hash with key and value of new static field
     # @return [GraylogAPI::Client::Response]
     def create(input_id, params)
-      @client.json_request(:post, "/system/inputs/#{input_id}/staticfields", params)
+      @client.request(:post, "/system/inputs/#{input_id}/staticfields", params)
     end
 
     # delete key of an input
@@ -20,7 +20,7 @@ class GraylogAPI
     # @param key [String] key of static field
     # @return [GraylogAPI::Client::Response]
     def delete(input_id, key)
-      @client.json_request(:delete, "/system/inputs/#{input_id}/staticfields/#{key}")
+      @client.request(:delete, "/system/inputs/#{input_id}/staticfields/#{key}")
     end
   end
 end

data/lib/graylogapi/streams.rb

@@ -6,39 +6,39 @@ class GraylogAPI
     end
 
     def all
-      @client.json_request(:get, '/streams')
+      @client.request(:get, '/streams')
     end
 
     def create(params = {})
-      @client.json_request(:post, '/streams', params)
+      @client.request(:post, '/streams', params)
     end
 
     def enabled
-      @client.json_request(:get, '/streams/enabled')
+      @client.request(:get, '/streams/enabled')
     end
 
     def by_id(id)
-      @client.json_request(:get, "/streams/#{id}")
+      @client.request(:get, "/streams/#{id}")
     end
 
     def update(id, params = {})
-      @client.json_request(:put, "/streams/#{id}", params)
+      @client.request(:put, "/streams/#{id}", params)
     end
 
     def delete(id, params = {})
-      @client.json_request(:delete, "/streams/#{id}", params)
+      @client.request(:delete, "/streams/#{id}", params)
     end
 
     def clone(id, params = {})
-      @client.json_request(:post, "/streams/#{id}/clone", params)
+      @client.request(:post, "/streams/#{id}/clone", params)
     end
 
     def pause(id)
-      @client.json_request(:post, "/streams/#{id}/pause")
+      @client.request(:post, "/streams/#{id}/pause")
     end
 
     def resume(id)
-      @client.json_request(:post, "/streams/#{id}/resume")
+      @client.request(:post, "/streams/#{id}/resume")
     end
   end
 end

data/lib/graylogapi/system/cluster.rb

@@ -7,15 +7,15 @@ class GraylogAPI
       end
 
       def node
-        @client.json_request(:get, '/system/cluster/node')
+        @client.request(:get, '/system/cluster/node')
       end
 
       def nodes
-        @client.json_request(:get, '/system/cluster/nodes')
+        @client.request(:get, '/system/cluster/nodes')
       end
 
       def node_by_id(id)
-        @client.json_request(:get, "/system/cluster/nodes/#{id}")
+        @client.request(:get, "/system/cluster/nodes/#{id}")
       end
     end
   end

data/lib/graylogapi/system/index_sets.rb

@@ -6,28 +6,59 @@ class GraylogAPI
         @client = client
       end
 
+      # Get a list of all index sets.
+      #
+      # @return [GraylogAPI::Client::Response]
       def all
-        @client.json_request(:get, '/system/indices/index_sets')
+        @client.request(:get, '/system/indices/index_sets')
       end
 
+      # Get default index set.
+      #
+      # @return [Hash]
+      def default
+        all['index_sets'].find { |i| i['default'] == true }
+      end
+
+      # Create index set.
+      #
+      # @param params [Hash] title, description, etc.
+      # @return [GraylogAPI::Client::Response]
       def create(params)
-        @client.json_request(:post, '/system/indices/index_sets', params)
+        @client.request(:post, '/system/indices/index_sets', params)
       end
 
+      # Get index set by id.
+      #
+      # @param id [String]
+      # @return [GraylogAPI::Client::Response]
       def by_id(id)
-        @client.json_request(:get, "/system/indices/index_sets/#{id}")
+        @client.request(:get, "/system/indices/index_sets/#{id}")
       end
 
+      # Delete index set.
+      #
+      # @param id [String]
+      # @return [GraylogAPI::Client::Response]
       def delete(id)
-        @client.json_request(:delete, "/system/indices/index_sets/#{id}")
+        @client.request(:delete, "/system/indices/index_sets/#{id}")
       end
 
+      # Set default index set.
+      #
+      # @param id [String]
+      # @return [GraylogAPI::Client::Response]
       def make_default(id)
-        @client.json_request(:put, "/system/indices/index_sets/#{id}/default")
+        @client.request(:put, "/system/indices/index_sets/#{id}/default")
       end
 
+      # Update index set.
+      #
+      # @param id [String]
+      # @param params [Hash]
+      # @return [GraylogAPI::Client::Response]
       def update(id, params)
-        @client.json_request(:put, "/system/indices/index_sets/#{id}", params)
+        @client.request(:put, "/system/indices/index_sets/#{id}", params)
       end
     end
   end

data/lib/graylogapi/system/inputs/types.rb

@@ -0,0 +1,40 @@
+class GraylogAPI
+  class System
+    class Inputs
+      # class for getting info about input types
+      class Types
+        def initialize(client)
+          @client = client
+        end
+
+        # get input types of current node
+        #
+        # @return [GraylogAPI::Client::Response]
+        def node
+          @client.request(:get, '/system/inputs/types')
+        end
+
+        # get all input types
+        #
+        # @return [GraylogAPI::Client::Response]
+        def all
+          @client.request(:get, '/system/inputs/types/all')
+        end
+
+        # get info about input type
+        #
+        # @return [GraylogAPI::Client::Response]
+        def by_type(type)
+          @client.request(:get, "/system/inputs/types/#{type}")
+        end
+
+        # convert type name to type
+        #
+        # @return [String]
+        def name_to_type(name)
+          all.body.find { |_, type| type['name'].casecmp(name).zero? }.first
+        end
+      end
+    end
+  end
+end

data/lib/graylogapi/system/inputs.rb

@@ -1,3 +1,5 @@
+require 'graylogapi/system/inputs/types'
+
 class GraylogAPI
   class System
     # class for manage inputs
@@ -8,40 +10,68 @@ class GraylogAPI
 
       # get all inputs
       #
-      # @return [Struct]
+      # @return [GraylogAPI::Client::Response]
       def all
-        @client.json_request(:get, '/system/inputs')
+        @client.request(:get, '/system/inputs')
       end
 
       # get input by input id
       #
-      # @return [Struct]
+      # @return [GraylogAPI::Client::Response]
       def by_id(id)
-        @client.json_request(:get, "/system/inputs/#{id}")
+        @client.request(:get, "/system/inputs/#{id}")
       end
 
       # create input
       #
       # @param params [Hash]
-      # @return [Struct]
+      # @return [GraylogAPI::Client::Response]
       def create(params = {})
-        @client.json_request(:post, '/system/inputs', params)
+        @client.request(:post, '/system/inputs', parse(params))
       end
 
       # update input
       #
       # @param params [Hash]
-      # @return [Struct]
+      # @return [GraylogAPI::Client::Response]
       def update(id, params = {})
-        @client.json_request(:put, "/system/inputs/#{id}", params)
+        @client.request(:put, "/system/inputs/#{id}", parse(params))
       end
 
       # delete input
       #
       # @param params [Hash]
-      # @return [Struct]
-      def delete(id, params = {})
-        @client.json_request(:delete, "/system/inputs/#{id}", params)
+      # @return [GraylogAPI::Client::Response]
+      def delete(id)
+        @client.request(:delete, "/system/inputs/#{id}")
+      end
+
+      # object for get information about input types
+      #
+      # @return [GraylogAPI::System::Inputs::Types]
+      def types
+        @types ||= Types.new(@client)
+      end
+
+      private
+
+      # parase params
+      #
+      # @return [Hash]
+      def parse(params)
+        params = type_name_to_type(params) if params.key? :type_name
+
+        params
+      end
+
+      # convert type name to type
+      #
+      # @return [Hash]
+      def type_name_to_type(params)
+        type = types.name_to_type(params[:type_name])
+        params[:type] = type
+        params.delete(:type_name)
+        params
       end
     end
   end

data/lib/graylogapi/system.rb

@@ -10,15 +10,15 @@ class GraylogAPI
     end
 
     def overview
-      @client.json_request(:get, '/system')
+      @client.request(:get, '/system')
     end
 
     def jvm
-      @client.json_request(:get, '/system/jvm')
+      @client.request(:get, '/system/jvm')
     end
 
     def thread_dump
-      @client.json_request(:get, '/system/threaddump')
+      @client.request(:get, '/system/threaddump')
     end
 
     # object for manage System/Inputs

data/lib/graylogapi/users.rb

@@ -0,0 +1,23 @@
+class GraylogAPI
+  # class for manage users
+  class Users
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieves the list of access tokens for a user
+    def tokens(username)
+      @client.request(:get, "/users/#{username}/tokens")
+    end
+
+    # Generate a new access token for a user
+    def create_token(username, name)
+      @client.request(:post, "/users/#{username}/tokens/#{name}", {})
+    end
+
+    # Removes a token for a user
+    def delete_token(username, name)
+      @client.request(:delete, "/users/#{username}/tokens/#{name}")
+    end
+  end
+end

data/lib/graylogapi/version.rb

@@ -1,3 +1,3 @@
 class GraylogAPI
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/lib/graylogapi.rb

@@ -1,13 +1,14 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require 'graylogapi/version'
 require 'graylogapi/alerts'
 require 'graylogapi/client'
 require 'graylogapi/dashboards'
 require 'graylogapi/static_fields'
 require 'graylogapi/streams'
 require 'graylogapi/system'
+require 'graylogapi/users'
+require 'graylogapi/version'
 
 # class for work with graylog api
 class GraylogAPI
@@ -46,4 +47,9 @@ class GraylogAPI
   def static_fields
     @static_fields ||= StaticFields.new(@client)
   end
+
+  # @return [GraylogAPI::Users]
+  def users
+    @users ||= Users.new(@client)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graylogapi
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrey Aleksandrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies: []
 description: Allows you to work with graylog api from ruby
 email:
@@ -31,6 +31,8 @@ files:
 - lib/graylogapi/system/cluster.rb
 - lib/graylogapi/system/index_sets.rb
 - lib/graylogapi/system/inputs.rb
+- lib/graylogapi/system/inputs/types.rb
+- lib/graylogapi/users.rb
 - lib/graylogapi/version.rb
 homepage: https://github.com/postgred/graylogapi
 licenses: