configure_semian 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d47a27158e20da560941a9b5dd4757d8dc2b03c3
+  data.tar.gz: 07eb8ca0eb264e72938a9f00f663feaaba823547
+SHA512:
+  metadata.gz: 004c300a99db4a8050948bec7a597d2ed3a180489af2407854d46ce9c0e563d17559016902f9d0787e512b32910b798f150881c526aa31c5866c4490d21d9776
+  data.tar.gz: b356ea59cf6eef8b66599bf8565f41e7a2025aff2f6d1614ccdac4681cc6bf74ee1076f4d5601b247a21ea8a5c34f9694df732d93dbac9f2d9ebf50bca21ef46

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+ruby "~> 2.4.1"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in configure_semian.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 supantha
+
+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,89 @@
+# configure_semian
+A layer to help start using semian in an easy and configurable way
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'configure_semian'
+```
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install configure_semian
+
+## Usage
+
+Provides functionality to define parameters for Semian. Additionality, provides read timeout to all HTTP calls.
+Semian parameters can be customized for each host the http call is made to, while the timeouts can be configured at path level also.
+
+Configuring Gem:
+
+Define a module in config/initializers and there define the configurations for the gem as follows:
+
+    ConfigureSemian::SemianConfiguration.configure_client{ |ob|
+      ob.app_server = (true if bulkheading to be enabled by default false otherwise)
+      ob.service_configs = (hash defining the default alongwith various host and path based configurations for the service)
+      ob.free_hosts = (array of hosts to be free from semian)
+      ob.track_exceptions = (array of exception classes to be tracked by semian)
+      ob.service_name = (name of the service using this gem, this name is prepended to the name of the host to which the http call is being made to create semian resource name)
+    }
+
+Service Configs:
+  The complete set of parameters that can be defined in service configs alongwith their default values are
+
+    quota: 0.75,
+    success_threshold: 2,
+    error_threshold: 3,
+    error_timeout: 10,
+    timeout: 10,
+    bulkhead: true if app_server is true, false otherwise
+
+The service configs hash provided during configuration can edit as many of these parameters as required. For the parameters for which no definition is provided during configuration takes the gem default value as defined above.
+    The structure of the configs hash should be as below:
+
+      {
+        default:{gem parameters to be overridden for this whole service provided as parameters-values hash},
+        hostname1: {default: {the resulting service parameters to be overridden for this host provided as parameters-values hash},
+              path1: hash with timeout as key and its value to override its hosts default read timeout value for this path}
+      }
+Example Definition:
+       Suppose during configuration service provides app_server as true and service configs as:
+
+        {
+          default: {quota: 0.5, timeout: 16},
+          'host.example.com': {
+            default: {timeout: 10, bulkhead: false},
+            '/example/index': {timeout: 20}
+          }
+        }
+
+Then, in this example parameters values in default for the service would be
+
+    {quota: 0.5, success_threshold: 2,error_threshold: 3,error_timeout: 10,timeout: 16, bulkhead: true},
+while for 'host.example.com' would be
+
+    {quota: 0.5, success_threshold: 2,error_threshold: 3,error_timeout: 10,timeout: 10, bulkhead: false}
+and for the path '/example/index', the read timeout will be 20s.
+
+Note: Only read timeout can be configures at path level, all the other parameters are same as that of its host's.
+A suggested way to define the service_configs hash would be to define a yml file, and load that file while configuring.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/configure_semian.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "configure_semian"
+
+# 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(__FILE__)

data/bin/setup

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

data/configure_semian.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "configure_semian/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "configure_semian"
+  spec.version       = ConfigureSemian::VERSION
+  spec.authors       = ["supantha"]
+  spec.email         = ["supantha.samanta@gmail.com"]
+  spec.files         = Dir["{lib}/**/*"] + ["README.md"]
+  spec.summary       = "Configure Semian"
+  spec.description   = "Semian Connector"
+  spec.homepage      = "https://github.com/elarahq/configure_semian"
+  spec.license       = "MIT"
+  spec.add_dependency "rails", ">=4.0.2"
+  spec.add_dependency "semian"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/configure_semian/engine.rb

@@ -0,0 +1,4 @@
+module ConfigureSemian
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/configure_semian/net_http.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+module Net
+  class HTTP
+
+    alias_method :old_request, :request
+    alias_method :old_post, :post
+
+    def request(req, body = nil, &block)
+      timeout = get_request_timeout_value(self.address, req.path)
+      self.read_timeout = timeout
+      old_request(req, body, &block)
+    end
+
+    def get_request_timeout_value(host, path)
+      if !ConfigureSemian::SemianConfiguration.service_configs[host.intern].nil?
+        specs = ConfigureSemian::SemianConfiguration.service_configs[host.intern][path.intern]
+        specs ||= ConfigureSemian::SemianConfiguration.service_configs[host.intern][:default]
+      end
+      specs ||= ConfigureSemian::SemianConfiguration.service_configs[:default]
+      timeout = specs[:timeout] || specs['timeout']
+      return timeout
+    end
+  end
+
+end

data/lib/configure_semian/semian_configuration.rb

@@ -0,0 +1,103 @@
+require 'semian'
+require 'semian/net_http'
+require 'active_support/core_ext/hash/indifferent_access'
+module ConfigureSemian
+  class SemianConfiguration
+    attr_accessor :host, :port, :path, :data
+
+    # Singleton Object associated with Semian Configuration that has various specifications for Semian initialization
+    class SemianParameters
+      attr_accessor :app_server, :service_configs, :free_hosts, :track_exceptions, :service_name
+
+      SEMIAN_PARAMETERS = {
+                      semian_default: {
+                        quota: 0.5,
+                        success_threshold: 2,
+                        error_threshold: 3,
+                        error_timeout: 10,
+                        timeout: 10,
+                        bulkhead: false
+                      }
+                    }
+
+      def initialize
+        @app_server = false
+        @service_configs = SEMIAN_PARAMETERS.with_indifferent_access
+        @free_hosts = []
+        @track_exceptions = []
+        @service_name = nil
+      end
+
+      # Passed true only for app server so that bulkheading is disabled in worker servers
+      def app_server=value
+        @app_server = value
+        self.service_configs[:semian_default][:bulkhead] = (value || false)
+      end
+
+      # semian options alongwith the ones defined by the service
+      def service_configs=value
+        value.with_indifferent_access
+        self.service_configs.merge!(value)
+      end
+
+      # exceptions to be tracked defined by the service 
+      def track_exceptions=value
+        self.track_exceptions |= value
+      end
+
+      # initial computations
+      def generate_specifications
+        # Define exceptions to be tracked by Semian
+        Semian::NetHTTP.exceptions |= self.track_exceptions
+        # Create the complete host,path driven semian options
+        semian_default = self.service_configs.delete(:semian_default)
+        service_default = semian_default.merge(self.service_configs.delete(:default) || {})
+        service_default.delete(:quota) if !service_default[:tickets].nil?
+        self.service_configs.each do |host, specs|
+          host_default = service_default.merge(specs.delete(:default) || {})
+          host_default.delete(:quota) if !host_default[:tickets].nil?
+          specs.each do |path, path_specs|
+            self.service_configs[host][path] = host_default.merge(path_specs || {})
+          end
+          self.service_configs[host][:default] = host_default
+        end
+        self.service_configs.merge!({semian_default: semian_default, default: service_default})
+      end
+
+    end
+
+    @@semian_parameters = SemianParameters.new
+
+    ::Semian::NetHTTP.semian_configuration = proc do |host, port|
+      if !self.free_hosts.include?(host)
+        semian_options = get_semian_parameters(host, port)
+        semian_options
+      else
+        nil
+      end
+    end
+
+    def self.get_semian_parameters(host, port)
+      resource_name = "#{self.service_name}_#{host}"
+      parameters = self.service_configs[host.intern].nil? ? self.service_configs[:default] : self.service_configs[host.intern][:default]
+      parameters.merge!({name: resource_name})
+      semian_parameters = parameters.dup
+      semian_parameters.delete(:timeout)
+      semian_parameters
+    end
+
+    def self.configure_client
+      yield(@@semian_parameters)
+      raise "Service Name not specified for Semian Configuration" if self.service_name.nil?
+      @@semian_parameters.generate_specifications
+    end
+
+    @@semian_parameters.instance_variables.each do |variable|
+      attribute = variable.to_s.delete('@')
+      self.define_singleton_method(attribute) do
+        return @@semian_parameters.instance_variable_get(variable)
+      end
+    end
+
+  end
+end

data/lib/configure_semian/version.rb

@@ -0,0 +1,3 @@
+module ConfigureSemian
+  VERSION = "0.1.1"
+end

data/lib/configure_semian.rb

@@ -0,0 +1,6 @@
+require "configure_semian/version"
+
+module ConfigureSemian
+  require 'configure_semian/semian_configuration'
+  require 'configure_semian/net_http'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: configure_semian
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- supantha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: semian
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: Semian Connector
+email:
+- supantha.samanta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- configure_semian.gemspec
+- lib/configure_semian.rb
+- lib/configure_semian/engine.rb
+- lib/configure_semian/net_http.rb
+- lib/configure_semian/semian_configuration.rb
+- lib/configure_semian/version.rb
+homepage: https://github.com/elarahq/configure_semian
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Configure Semian
+test_files: []