hawatel_tlb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f55182a59c4798296a0a990bd9395d5f551cef41
+  data.tar.gz: 6d0c51e51a1eefcf66bd00b136d032d64bba85a7
+SHA512:
+  metadata.gz: 18fcca9f92f324ff62ac4de08a6845388b94fe10bc4a65fb9f2595dd6ad6c54329144e9368ca18e98d6b8fb1e91fff8a232ace75d40a389f3b3eaa2d9722b02c
+  data.tar.gz: b6f30dffc784a7cd7df5ee8fb8a387c3d11d371b2079e9d7bd6e978a18df0f6dfbecf4c0ff98d0f9b4fb0ebdd77032a72783b234e63ea41bd99f07b027aca835

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/.idea/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hawatel/hawatel_tlb. This project is intended to be a safe, welcoming space for collaboration, and contributors.
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```sh
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/hawatel_tlb
+   # Navigate to the newly cloned directory
+   cd hawatel_tlb
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/hawatel/hawatel_tlb
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout master
+   git pull upstream master
+   ```
+
+3. Create a new topic branch (off of `master`) to contain your feature, change,
+   or fix.
+
+   **IMPORTANT**: Making changes in `master` is discouraged. You should always
+   keep your local `master` in sync with upstream `master` and make your
+   changes in topic branches.
+
+   ```sh
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Keep your commit messages organized,
+   with a short description in the first line and more detailed information on
+   the following lines. Feel free to use Git's
+   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Make sure all the tests are still passing.
+
+   ```sh
+   rspec spec
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```sh
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
+    with a clear title and description.
+
+8. If you haven't updated your pull request for a while, you should consider
+   rebasing on master and resolving any conflicts.
+
+   **IMPORTANT**: _Never ever_ merge upstream `master` into your branches. You
+   should always `git rebase` on `master` to bring your changes up to date when
+   necessary.
+
+   ```sh
+   git checkout master
+   git pull upstream master
+   git checkout <your-topic-branch>
+   git rebase master
+   ```
+
+Thank you for your contributions!

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hawatel_tlb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Iwaniuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Hawatel_tlb
+
+Hawatel_tlb is a ruby version of load balancer which the purpose is to dynamic return selected address IP/hostname based on specified algorithm. Depend on settings gem have built features like regularly monitoring status backend nodes, response time, calculating fastest node based on history, flapping detection and more. Currently, supported algorithms are round robin, dynamic ration, fastest, ratio and weighted.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hawatel_tlb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hawatel_tlb
+
+
+## Available algorithms
+|Name|Description|
+|---|---|
+|dynamicratio| Dynamic load balancing algorithm based on dynamic ratio weights. Weight for each node is setting up by following formula: 100 - (respond_time / sum_respond_time) * 100 |
+|fastest|Algorithm based on history statistics about respond time and 'online' states (flapping detection). Return host with fastest responds time.|
+|ratio|Static load balancing algorithm based on ratio weights
+|roundrobin|Standard [Round-robin](https://en.wikipedia.org/wiki/Round-robin_scheduling) algorithm with fail node and flapping detection|
+|weighted|Algorithm based on specified by user weight, return currently available host with highest metric.  |
+
+## Example Usage
+
+###### Create client 
+``` ruby
+client = HawatelTlb::Client.new
+```
+
+###### Add hosts to group
+``` ruby
+client.add({:host => 'api.example.com', :port => 80, :weight => 0, :state => 'enable'})
+client.add({:host => 'api.example2.com', :port => 80, :weight => 0, :state => 'enable'})
+client.add({:host => 'api.example3.com', :port => 80, :weight => 0, :state => 'enable'})
+```
+
+###### Set  algorithm
+``` ruby
+client.configure({:mode => 'fastest'})
+```
+
+###### Call API request 
+``` ruby
+p client.node
+{:host=>"example2.com", :port=>80}
+
+Net::HTTP.get(client.node[:host], '/q=seach_example')
+```
+
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hawatel_tlb"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hawatel_tlb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hawatel_tlb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hawatel_tlb"
+  spec.version       = HawatelTlb::VERSION
+  spec.authors       = ['Daniel Iwaniuk', 'Przemyslaw Mantaj']
+  spec.email         = ['daniel.iwaniuk@hawatel.com', 'przemyslaw.mantaj@hawatel.com']
+
+  spec.summary       = "Ruby gem for failover detection and balancing hosts group"
+  spec.description   = %q{Hawatel_tlb is a ruby version load balancing which the purpose is to dynamic return selected address IP/domainame based on specified algorithm}
+  spec.homepage      = "http://github.com/hawatel/hawatel_tlb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/hawatel_tlb.rb

@@ -0,0 +1,4 @@
+require 'hawatel_tlb/version'
+require 'hawatel_tlb/client'
+
+

data/lib/hawatel_tlb/client.rb

@@ -0,0 +1,207 @@
+require 'hawatel_tlb/watchdog'
+require 'hawatel_tlb/mode'
+require 'ostruct'
+
+module HawatelTlb
+  class Client
+    include HawatelTlb::WatchDog
+
+    attr_reader :group, :mode, :interval
+
+    WORKING_MODE    = {
+        'dynamicratio' => Mode::DynamicRatio,
+        'roundrobin' => Mode::RoundRobin,
+        'fastest' => Mode::Fastest,
+        'ratio' => Mode::Ratio,
+        'weighted' => Mode::Weighted
+    }
+    DEFAULT_STATE     = 'enable'
+    DEFAULT_PORT      = 80
+    DEFAULT_WEIGHT    = 1
+    DEFAULT_TIMEOUT   = 5
+    DEFAULT_INTERVAL  = 5
+
+    def initialize
+      @group    = Array.new
+      @interval = DEFAULT_INTERVAL
+      watchdog_thread()
+    end
+
+    # Add host to TLB group
+    #
+    # @param args [Hash]
+    # @option args [String]  :host hostname or ip address
+    # @option args [Integer] :port port number
+    # @option args [Integer] :timeout default 5s.
+    # @option args [String]  :state Available options: enable(default), disable.
+    # @option args [Integer] :wight priority of host, higher value is equal lower priority
+    # @example
+    #   client.add({:value => 'example'})
+    #
+    #
+    # @return [Integer]
+    def add(args)
+      host    = args[:host]
+      port    = args[:port]    || DEFAULT_PORT
+      weight  = args[:weight]  || DEFAULT_WEIGHT
+      timeout = args[:timeout] || DEFAULT_TIMEOUT
+      state   = args[:state]   || DEFAULT_STATE
+
+      status = validate_host_settings({:host => host, :port => port, :weight => weight, :timeout => timeout,
+                                       :state => state})
+      if status == 'success'
+        host_cfg = OpenStruct.new(:id => host_id.to_i, :host => host, :port => port, :weight => weight,
+                                  :timeout => timeout, :state => state, :status => {:time => 0, :state => 'offline',
+                                                                                    :respond_time => 0})
+        @group.push(host_cfg)
+      end
+      @mode.refresh(@group) if @mode
+      return status
+    end
+
+   # Delete host from TLB group
+   #
+   # @param id [Integer] host id
+   # @example
+   #   client.del(2)
+   #
+   # @return [String]
+    def del(id)
+      if id.is_a?(Fixnum)
+        if @group[id-1]
+          @group.delete(id-1)
+          @mode.refresh(@group) if @mode
+          return 'host successful deleted'
+        else
+          return 'invalid host id'
+        end
+      else
+        'invalid value'
+      end
+    end
+
+
+    # Return hosts list
+    #
+    # @example
+    #   client.add({:host => 'example.com', :port => '80', weight => '5'})
+    #   client.list
+    #
+    # @return [Array<String>]
+    def list
+      return @group
+    end
+
+    # Set settings for group
+    #
+    # @param args [Hash]
+    # @option args [String] :mode  failover, roundrobin
+    # @example
+    #   client.configure({:mode => 'roundrobin'})
+    #
+    # @return [Integer]
+    def configure(args)
+      if @group[0]
+        watcher if @group[0].status[:time] == 0
+      end
+
+      mode = args[:mode] || 'roundrobin'
+      @interval if args[:interval]
+      return 'invalid mode' if !WORKING_MODE.key?(mode)
+      if @mode
+        @mode.destroy if @mode.respond_to?(:destroy)
+        @mode = nil
+      else
+        @mode = nil
+      end
+      @mode = WORKING_MODE[mode].new(@group)
+    end
+
+
+    # Description
+    #
+    # @param args [Hash]
+    # @option args [String] :value description
+    # @example
+    #   counte({:value => 'example'})
+    #
+    #
+    # @return [Integer]
+    def node
+      return @mode.node if @mode
+      false
+    end
+
+    # Description
+    #
+    # @param args [Hash]
+    # @option args [String] :value description
+    # @example
+    #   counte({:value => 'example'})
+    #
+    #
+    # @return [Integer]
+    def status
+      @group.each do |node|
+      end
+    end
+
+    private
+
+    # start watcher, thread responsible for online monitoring
+    def watchdog_thread
+      @thr = Thread.new {
+        while(true)
+          watcher
+          sleep(@interval)
+        end
+      }
+      rescue
+        false
+    end
+
+    # Validate host settings
+    def validate_host_settings(args)
+      msg = ''
+      msg << 'host with the same configuration already exists in the group, ' if !validate_list?(args)
+      msg << 'incorrect host name or ip address, ' if !(valid_v4?(args[:host]) || valid_domain?(args[:host]))
+      msg << 'incorrect port number, ' if !valid_port?(args[:port])
+      msg << 'incorrect weight value, ' if !args[:weight].is_a?(Fixnum)
+      msg << 'incorrect timeout value, ' if !args[:timeout].is_a?(Fixnum)
+      msg.empty? ? 'success' : msg
+    end
+
+    # Check if specified host, with the same port dosen't already exist in group
+    def validate_list?(args)
+      @group.each do |item|
+        return false if item[:host] == args[:host] && item[:port] == args[:port]
+      end
+      return true
+    end
+
+    # validate ipv4
+    def valid_v4?(addr)
+      if /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/ =~ addr
+        return $~.captures.all? {|i| i.to_i < 256}
+      end
+    end
+
+    # Validate domainname
+    def valid_domain?(host)
+      true if /([a-z]|[0-9])*\.[a-z]{2,5}$/ =~ host
+    end
+
+    # Validate port
+    def valid_port?(port)
+      if port.is_a?(Fixnum)
+        true if port <= 65535 && port > 0
+      end
+    end
+
+    # Generate host id
+    def host_id
+      return @group.length + 1
+    end
+
+  end
+end