opendistro 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 464adecef8a65b39b82d4c0e566b81fe6106120109772a7a6ec64be44931472e
+  data.tar.gz: bf5f38e38ff4f02320ec641b55dff8c5e6d82fd0d7a0963dc9581f71795cfce9
+SHA512:
+  metadata.gz: 915168ca8d9f9eca5719bc96063e1172b536d0277ff759c9b50b5b85d9887da449ea3e2466929a179cc88b535fc2c1712fcb661affcbe14376a567346f1ef70e
+  data.tar.gz: 9a51b7daff70aa7028d3ac79a60b20dc568b45350c9b5d34e09a7d15c82f9d00d7e061e488c0931581a17200072b2ba9696ce9b8145cc94a68de1a3b33440811

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## CHANGELOG
+
+### Newer releases
+
+Please see: https://github.com/psyreactor/opendistro/releases
+
+### 1.0.0 (20/08/2020)
+- Add user endpoints (users, user, create_user, edit_user, delete_user)
+- Add Documentation site
+- Add Github actions
+- Add Coverall support

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2020 Lucas Mariani <marianilucas@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,160 @@
+# Opendistro
+
+[![Build Status](https://img.shields.io/github/workflow/status/psyreactor/opendistro/CI/master)](https://github.com/psyreactor/opendistro/actions?query=workflow%3ARuby)
+[![Inline docs](https://inch-ci.org/github/psyreactor/opendistro.svg?branch=master)](https://inch-ci.org/github/psyreactor/opendistro)
+[![Coverage Status](https://coveralls.io/repos/github/psyreactor/opendistro/badge.svg)](https://coveralls.io/github/psyreactor/opendistro)
+[![Gem version](https://img.shields.io/gem/v/opendistro.svg)](https://rubygems.org/gems/opendistro)
+[![License](https://img.shields.io/badge/license-BSD-red.svg)](https://github.com/psyreactor/opendistro/blob/master/LICENSE.txt)
+
+[website](https://psyreactor.github.io/opendistro/) |
+[documentation](https://www.rubydoc.info/gems/opendistro/frames) 
+
+A Ruby wrapper around the Opendistro API.
+
+This library will strive to achieve reliable coverage of the Opendistro API. Please submit an issue if you find a bug and feel free to submit a pull request to contribute fixes or new features.
+
+Initial versions of this gem to not achieve 100% coverage of the Opendistro API. Each release will include more and more endpoint support until there is 100% coverage.
+
+The layout and the code in this library is inspired by https://github.com/NARKOZ/gitlab. NARKOZ does a fantastic job of keeping code simple and achieving API feature parity.
+
+## Installation
+
+Install it from rubygems:
+
+```sh
+gem install opendistro
+```
+
+Or add to a Gemfile:
+
+```ruby
+gem 'opendistro'
+# gem 'opendistro', github: 'psyreactor/opendistro'
+```
+
+Mac OS users can install using Homebrew (may not be the latest version):
+
+```sh
+brew install opendistro-gem
+```
+
+## Usage
+
+Configuration example:
+
+```ruby
+Opendistro.configure do |config|
+  config.endpoint       = 'https://example.net:9200' 
+  config.username       = 'useradmin'
+  config.password       = 'secretpassword'
+  # Optional
+  # config.user_agent   = 'Custom User Agent'
+  # config.verify_ssl   = false
+  # config.ca_cert      = '/etc/pki/ca_cert/ca.crt'
+end
+```
+
+Usage examples:
+
+```ruby
+# set an API endpoint
+Opendistro.endpoint = 'https://example.net:9200'
+# => "https://example.net:9200"
+
+# set a user user
+Opendistro.username = 'useradmin'
+# => "useradmin"
+
+# set a user password
+Opendistro.password  = 'secretpassword'
+# => "secretpassword"
+
+# configure a proxy server
+Opendistro.http_proxy('proxyhost', 8888)
+# proxy server with basic auth
+Opendistro.http_proxy('proxyhost', 8888, 'proxyuser', 'strongpasswordhere')
+# set timeout for responses
+ENV['OPENDISTRO_API_HTTPARTY_OPTIONS'] = '{read_timeout: 60}'
+
+# list users
+Opendistro.users()
+# #<Opendistro::ObjectifiedHash:46080 {hash: {"logstash"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["logstash"], "attributes"=>{}, "description"=>"Demo logstash user", "opendistro_security_roles"=>[], "static"=>false}, "snapshotrestore"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["snapshotrestore"], "attributes"=>{}, "description"=>"Demo snapshotrestore user", "opendistro_security_roles"=>[], "static"=>false}, "admin"=>{"hash"=>"", "reserved"=>true, "hidden"=>false, "backend_roles"=>["admin"], "attributes"=>{}, "description"=>"Demo admin user", "opendistro_security_roles"=>[], "static"=>false}, "kibanaserver"=>{"hash"=>"", "reserved"=>true, "hidden"=>false, "backend_roles"=>[], "attributes"=>{}, "description"=>"Demo kibanaserver user", "opendistro_security_roles"=>[], "static"=>false}, "kibanaro"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["kibanauser", "readall"], "attributes"=>{"attribute1"=>"value1", "attribute2"=>"value2", "attribute3"=>"value3"}, "description"=>"Demo kibanaro user", "opendistro_security_roles"=>[], "static"=>false}, "readall"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["readall"], "attributes"=>{}, "description"=>"Demo readall user", "opendistro_security_roles"=>[], "static"=>false}}}
+
+# initialize a new client with custom headers
+od = Opendistro.client(
+  endpoint: 'https://example.com:9200',
+  username: 'useradmin',
+  password: 'secretpassword',
+  httparty: {
+    headers: { 'Cookie' => 'opendistro_canary=true' }
+  }
+)
+
+# get a users
+user = od.users
+#<Opendistro::ObjectifiedHash:46080 {hash: {"logstash"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["logstash"], "attributes"=>{}, "description"=>"Demo logstash user", "opendistro_security_roles"=>[], "static"=>false}, "snapshotrestore"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["snapshotrestore"], "attributes"=>{}, "description"=>"Demo snapshotrestore user", "opendistro_security_roles"=>[], "static"=>false}, "admin"=>{"hash"=>"", "reserved"=>true, "hidden"=>false, "backend_roles"=>["admin"], "attributes"=>{}, "description"=>"Demo admin user", "opendistro_security_roles"=>[], "static"=>false}, "kibanaserver"=>{"hash"=>"", "reserved"=>true, "hidden"=>false, "backend_roles"=>[], "attributes"=>{}, "description"=>"Demo kibanaserver user", "opendistro_security_roles"=>[], "static"=>false}, "kibanaro"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["kibanauser", "readall"], "attributes"=>{"attribute1"=>"value1", "attribute2"=>"value2", "attribute3"=>"value3"}, "description"=>"Demo kibanaro user", "opendistro_security_roles"=>[], "static"=>false}, "readall"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["readall"], "attributes"=>{}, "description"=>"Demo readall user", "opendistro_security_roles"=>[], "static"=>false}}}
+
+# get a user's 
+user = od.user('logstash')
+
+# get user description
+user.description
+# => 'logstash demo user'
+
+```
+
+
+## Development
+
+### With a dockerized Opendistro instance
+
+```shell
+docker-compose up -d opendistro # Will start the Opendistro instance in the background (approx. 3 minutes)
+```
+
+After a while, your Opendistro instance will be accessible on http://localhost:9200.
+
+Once you have set your new password admin, you can login with the admin user.
+
+Once you have your token, set the variables to the correct values in the `docker.env` file.
+
+Then, launch the tool:
+
+```shell
+docker-compose run app
+```
+
+```ruby
+Opendistro.users
+=> #<Opendistro::ObjectifiedHash:46080 {hash: {"logstash"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["logstash"], "attributes"=>{}, "description"=>"Demo logstash user", "opendistro_security_roles"=>[], "static"=>false}, "snapshotrestore"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["snapshotrestore"], "attributes"=>{}, "description"=>"Demo snapshotrestore user", "opendistro_security_roles"=>[], "static"=>false}, "admin"=>{"hash"=>"", "reserved"=>true, "hidden"=>false, "backend_roles"=>["admin"], "attributes"=>{}, "description"=>"Demo admin user", "opendistro_security_roles"=>[], "static"=>false}, "kibanaserver"=>{"hash"=>"", "reserved"=>true, "hidden"=>false, "backend_roles"=>[], "attributes"=>{}, "description"=>"Demo kibanaserver user", "opendistro_security_roles"=>[], "static"=>false}, "kibanaro"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["kibanauser", "readall"], "attributes"=>{"attribute1"=>"value1", "attribute2"=>"value2", "attribute3"=>"value3"}, "description"=>"Demo kibanaro user", "opendistro_security_roles"=>[], "static"=>false}, "readall"=>{"hash"=>"", "reserved"=>false, "hidden"=>false, "backend_roles"=>["readall"], "attributes"=>{}, "description"=>"Demo readall user", "opendistro_security_roles"=>[], "static"=>false}}}
+
+```
+To launch the specs:
+
+```shell
+docker-compose run app rake spec
+```
+
+### With an external Opendistro instance
+
+First, set the variables to the correct values in the `docker.env` file.
+
+Then, launch the tool:
+
+```shell
+docker-compose run app
+```
+
+```ruby
+Opendistro.users
+```
+
+To launch the specs,
+
+```shell
+docker-compose run app rake spec
+```
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/lib/opendistro.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'opendistro/version'
+require 'opendistro/objectified_hash'
+require 'opendistro/configuration'
+require 'opendistro/error'
+require 'opendistro/file_response'
+require 'opendistro/request'
+require 'opendistro/api'
+require 'opendistro/client'
+
+module Opendistro
+  extend Configuration
+
+  # Alias for Opendistro::Client.new
+  #
+  # @return [Opendistro::Client]
+  def self.client(options = {})
+    Opendistro::Client.new(options)
+  end
+
+  # Delegate to Opendistro::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Opendistro::Client
+  def self.respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
+  end
+
+  # Delegate to HTTParty.http_proxy
+  def self.http_proxy(address = nil, port = nil, username = nil, password = nil)
+    Opendistro::Request.http_proxy(address, port, username, password)
+  end
+
+  # Returns an unsorted array of available client methods.
+  #
+  # @return [Array<Symbol>]
+  def self.actions
+    hidden =
+      /endpoint|username|password|user_agent|ca_cert|verify_ssl|get|post|put|\Adelete\z|validate\z|request_defaults|httparty/
+    (Opendistro::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+  end
+end

data/lib/opendistro/api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Opendistro
+  # @private
+  class API < Request
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options = {})
+      options = Opendistro.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
+      self.class.headers 'User-Agent' => user_agent
+    end
+  end
+end

data/lib/opendistro/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Opendistro
+  # Wrapper for the Opendistro REST API.
+  class Client < API
+    Dir[File.expand_path('client/*.rb', __dir__)].each { |f| require f }
+
+    # Please keep in alphabetical order
+    include Users
+
+    # Text representation of the client, masking private token.
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+      inspected.sub! @password, only_show_last_four_chars(@password) if @password
+      inspected
+    end
+
+    # Utility method for URL encoding of a string.
+    # Copied from https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB/Util.html
+    #
+    # @return [String]
+    def url_encode(url)
+      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString, Style/FormatStringToken
+    end
+
+    def only_show_last_four_chars(password)
+      "#{'*' * (password.size - 4)}#{password[-4..-1]}"
+    end
+  end
+end

data/lib/opendistro/client/users.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+class Opendistro::Client
+  # Defines methods related to users.
+  # @see https://opendistro.github.io/for-elasticsearch-docs/docs/security/access-control/api/#users
+  module Users
+    # Gets a list of users.
+    #
+    # @example
+    #   Opendistro.users
+    #
+    # @return [Opendistro::ObjectifiedHash]
+    def users
+      get('/_opendistro/_security/api/internalusers/')
+    end
+
+    # Gets information about a user.
+    # Will return information about an authorized user if no user passed.
+    #
+    # @example
+    #   Opendistro.user
+    #   Opendistro.user('kibanero')
+    #
+    # @param  [String] name The name of a user.
+    # @return [Opendistro::ObjectifiedHash]
+    def user(username = nil)
+      username.nil? ? get('/_opendistro/_security/api/account') : get("/_opendistro/_security/api/internalusers/#{username}")
+    end
+
+    # Creates a new user.
+    # Requires authentication from an admin account.
+    #
+    # @example
+    #   Opendistro.create_user('joe','secret', { attribute1: ...})
+    #   or
+    #   Opendistro.create_user('joe','secret', { description: 'user for test' })
+    #
+    # @param  [String] username(required) The username of a user.
+    # @param  [String] password(required) The password of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Opendistro::ObjectifiedHash] Information about created user.
+    def create_user(username, password, options = {})
+      raise ArgumentError, 'Missing required parameters' unless username || password
+
+      put("/_opendistro/_security/api/internalusers/#{username}", body: { password: password }.merge!(options))
+    end
+
+    # Updates a user.
+    #
+    # @example
+    #   Opendistro.edit_user('admin', [{ 'op' => 'replace', 'path': '/description', 'value': 'new description' }])
+    #
+    # @param  [Integer] id The ID of a user.
+    # @param  [Hash] options A customizable set of options.
+    # @return [Opendistro::ObjectifiedHash] Information about created user.
+    def edit_user(username, options = {})
+      patch("/_opendistro/_security/api/internalusers/#{username}", body: options.to_json)
+    end
+
+    # Deletes a user.
+    #
+    # @example
+    #   Opendistro.delete_user(1)
+    #
+    # @param [String] username The username of a user.
+    # @return [Opendistro::ObjectifiedHash] Information about deleted user.
+    def delete_user(username)
+      delete("/_opendistro/_security/api/internalusers/#{username}")
+    end
+  end
+end

data/lib/opendistro/configuration.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Opendistro
+  # Defines constants and methods related to configuration.
+  module Configuration
+    # An array of valid keys in the options hash when configuring a Opendistro::API.
+    VALID_OPTIONS_KEYS = %i[endpoint username password ca_cert httparty user_agent verify_ssl].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "Opendistro Ruby Gem #{Opendistro::VERSION}"
+    DEFAULT_VERIFY_SSL = true
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.endpoint       = ENV['OPENDISTRO_API_ENDPOINT']
+      self.username       = ENV['OPENDISTRO_API_USER']
+      self.password       = ENV['OPENDISTRO_API_PASSWORD']
+      self.ca_cert        = ENV['OPENDISTRO_API_CA_CERT_PATH']
+      self.httparty       = get_httparty_config(ENV['OPENDISTRO_API_HTTPARTY_OPTIONS'])
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.verify_ssl     = ENV['OPENDISTRO_API_VERIFY_SSL'] || DEFAULT_VERIFY_SSL
+    end
+
+    private
+
+    # Allows HTTParty config to be specified in ENV using YAML hash.
+    def get_httparty_config(options)
+      return if options.nil?
+
+      httparty = Opendistro::CLI::Helpers.yaml_load(options)
+      raise ArgumentError, 'HTTParty config should be a Hash.' unless httparty.is_a? Hash
+
+      Opendistro::CLI::Helpers.symbolize_keys httparty
+    end
+  end
+end

data/lib/opendistro/error.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Opendistro
+  module Error
+    # Custom error class for rescuing from all Opendistro errors.
+    class Error < StandardError; end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error; end
+
+    # Custom error class for rescuing from HTTP response errors.
+    class ResponseError < Error
+      POSSIBLE_MESSAGE_KEYS = %i[message error_description error].freeze
+
+      def initialize(response)
+        @response = response
+        super(build_error_message)
+      end
+
+      # Status code returned in the HTTP response.
+      #
+      # @return [Integer]
+      def response_status
+        @response.code
+      end
+
+      # Body content returned in the HTTP response
+      #
+      # @return [String]
+      def response_message
+        @response.parsed_response.message
+      end
+
+      # Additional error context returned by some API endpoints
+      #
+      # @return [String]
+      def error_code
+        if @response.respond_to?(:error_code)
+          @response.error_code
+        else
+          ''
+        end
+      end
+
+      private
+
+      # Human friendly message.
+      #
+      # @return [String]
+      def build_error_message
+        parsed_response = classified_response
+        message = check_error_keys(parsed_response)
+        "Server responded with code #{@response.code}, message: " \
+        "#{handle_message(message)}. " \
+        "Request URI: #{@response.request.base_uri}#{@response.request.path}"
+      end
+
+      # Error keys vary across the API, find the first key that the parsed_response
+      # object responds to and return that, otherwise return the original.
+      def check_error_keys(resp)
+        key = POSSIBLE_MESSAGE_KEYS.find { |k| resp.respond_to?(k) }
+        key ? resp.send(key) : resp
+      end
+
+      # Parse the body based on the classification of the body content type
+      #
+      # @return parsed response
+      def classified_response
+        if @response.respond_to?('headers')
+          @response.headers['content-type'] == 'text/plain' ? { message: @response.to_s } : @response.parsed_response
+        else
+          @response.parsed_response
+        end
+      rescue Opendistro::Error::Parsing
+        # Return stringified response when receiving a
+        # parsing error to avoid obfuscation of the
+        # api error.
+        #
+        # note: The Opendistro API does not always return valid
+        # JSON when there are errors.
+        @response.to_s
+      end
+
+      # Handle error response message in case of nested hashes
+      def handle_message(message)
+        case message
+        when Opendistro::ObjectifiedHash
+          message.to_h.sort.map do |key, val|
+            "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : [val].flatten).join(' ')}"
+          end.join(', ')
+        when Array
+          message.join(' ')
+        else
+          message
+        end
+      end
+    end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 406.
+    class NotAcceptable < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 429.
+    class TooManyRequests < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < ResponseError; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < ResponseError; end
+
+    # HTTP status codes mapped to error classes.
+    STATUS_MAPPINGS = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      405 => MethodNotAllowed,
+      406 => NotAcceptable,
+      409 => Conflict,
+      422 => Unprocessable,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable
+    }.freeze
+  end
+end

data/lib/opendistro/file_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Opendistro
+  # Wrapper class of file response.
+  class FileResponse
+    HEADER_CONTENT_DISPOSITION = 'Content-Disposition'
+
+    attr_reader :filename
+
+    def initialize(file)
+      @file = file
+    end
+
+    # @return [bool] Always false
+    def empty?
+      false
+    end
+
+    # @return [Hash] A hash consisting of filename and io object
+    def to_hash
+      { filename: @filename, data: @file }
+    end
+    alias to_h to_hash
+
+    # @return [String] Formatted string with the class name, object id and filename.
+    def inspect
+      "#<#{self.class}:#{object_id} {filename: #{filename.inspect}}>"
+    end
+
+    def method_missing(name, *args, &block)
+      if @file.respond_to?(name)
+        @file.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || @file.respond_to?(method_name, include_private)
+    end
+
+    # Parse filename from the 'Content Disposition' header.
+    def parse_headers!(headers)
+      @filename = headers[HEADER_CONTENT_DISPOSITION].split('filename=')[1]
+      @filename = @filename[1...-1] if @filename[0] == '"' # Unquote filenames
+    end
+  end
+end

data/lib/opendistro/objectified_hash.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Opendistro
+  # Converts hashes to the objects.
+  class ObjectifiedHash
+    # Creates a new ObjectifiedHash object.
+    def initialize(hash)
+      @hash = hash
+      @data = hash.each_with_object({}) do |(key, value), data|
+        value = self.class.new(value) if value.is_a? Hash
+        value = value.map { |v| v.is_a?(Hash) ? self.class.new(v) : v } if value.is_a? Array
+        data[key.to_s] = value
+      end
+    end
+
+    # @return [Hash] The original hash.
+    def to_hash
+      hash
+    end
+    alias to_h to_hash
+
+    # @return [String] Formatted string with the class name, object id and original hash.
+    def inspect
+      "#<#{self.class}:#{object_id} {hash: #{hash.inspect}}"
+    end
+
+    def [](key)
+      data[key]
+    end
+
+    private
+
+    attr_reader :hash, :data
+
+    # Respond to messages for which `self.data` has a key
+    def method_missing(method_name, *args, &block)
+      if data.key?(method_name.to_s)
+        data[method_name.to_s]
+      elsif data.respond_to?(method_name)
+        warn 'WARNING: Please convert ObjectifiedHash object to hash before calling Hash methods on it.'
+        data.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+    end
+  end
+end

data/lib/opendistro/request.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+module Opendistro
+  # @private
+  class Request
+    include HTTParty
+    format :json
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json'
+    parser(proc { |body, _| parse(body) })
+
+    attr_accessor :username, :password, :verify_ssl, :ca_cert, :endpoint
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
+
+      if body.is_a? Hash
+        ObjectifiedHash.new body
+      elsif body.is_a? Array
+        PaginatedResponse.new(body.collect! { |e| ObjectifiedHash.new(e) })
+      elsif body
+        true
+      elsif !body
+        false
+      elsif body.nil?
+        false
+      else
+        raise Error::Parsing, "Couldn't parse a response body"
+      end
+    end
+
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      response ? JSON.load(response) : {}
+    rescue JSON::ParserError
+      raise Error::Parsing, 'The response is not a valid JSON'
+    end
+
+    %w[get post put delete patch].each do |method|
+      define_method method do |path, options = {}|
+        params = options.dup
+
+        httparty_config(params)
+
+        params[:headers] ||= {}
+        params[:headers].merge!(authorization_header)
+
+        params[:ssl_ca_file] = @ca_cert unless @ca_cert.nil?
+        params[:verify] = @verify_ssl unless @verify_ssl
+        params[:body] = params[:body].to_json if params[:body].is_a? Hash
+
+        validate self.class.send(method, @endpoint + path, params)
+      end
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      error_klass = Error::STATUS_MAPPINGS[response.code]
+      raise error_klass, response if error_klass
+
+      parsed = response.parsed_response
+      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
+      parsed
+    end
+
+    # Sets a base_uri and default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def request_defaults
+      raise Error::MissingCredentials, 'Please set an endpoint to API' unless @endpoint
+    end
+
+    private
+
+    # Returns an Authorization header hash
+    #
+    # @raise [Error::MissingCredentials] if private_token and auth_token are not set.
+    def authorization_header
+      raise Error::MissingCredentials, 'Please provide a private_token or auth_token for user' if @username.nil? || @password.nil?
+
+      auth = Base64.encode64("#{@username}:#{@password}")
+      { 'Authorization' => "Basic #{auth}" }
+    end
+
+    # Set HTTParty configuration
+    # @see https://github.com/jnunemaker/httparty
+    def httparty_config(options)
+      options.merge!(httparty) if httparty
+    end
+  end
+end

data/lib/opendistro/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Opendistro
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: opendistro
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Mariani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client and CLI for Opendistro API
+email:
+- marianilucas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/opendistro.rb
+- lib/opendistro/api.rb
+- lib/opendistro/client.rb
+- lib/opendistro/client/users.rb
+- lib/opendistro/configuration.rb
+- lib/opendistro/error.rb
+- lib/opendistro/file_response.rb
+- lib/opendistro/objectified_hash.rb
+- lib/opendistro/request.rb
+- lib/opendistro/version.rb
+homepage: https://github.com/psyreactor/opendistro
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper and CLI for the Opendistro API
+test_files: []