xconsul 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89aa922e83a7dc27f3170b17ee7e023a9b42eb0f
+  data.tar.gz: 231964930ec3277f1a291df99a49acc49e293812
+SHA512:
+  metadata.gz: 5a46c32b83cb54f9600fd18b9215c0573f7814c2969412e81631e51f8b3d01553961bca096d523dbb8cc97a57a57833e07b3c0d181c69f1be24aac00cea918be
+  data.tar.gz: 452b39f2ad1ac7a3dbe8a5f50a1031b93f7980b14f94ca038433ef53b25bbb202cfb6e13171a4970845499255863e17b96ee1809ec1d689d1ef9b0fb950d80df

data/.gitignore

@@ -0,0 +1,2 @@
+.rspec_status
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Style/AsciiComments:
+  Description: 'Use only ascii symbols in comments.'
+  StyleGuide: '#english-comments'
+  Enabled: false
+
+Metrics/BlockLength:
+  CountComments: false  # count full line comments?
+  Max: 100
+
+Metrics/LineLength:
+  Max: 120
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be an Integer or
+  # a Float.
+  Max: 30
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+AllCops:
+  TargetRubyVersion: 2.3.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zhchsf@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,74 @@
+# Xconsul
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xconsul`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xconsul', git: 'git@xxxx/xconsul.git', tag: 'v0.x.x'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+配置consul：
+```ruby
+# 统一配置consul，非必须（如果配置了acl此处就必须配置了，否则hosts取值会是空）
+# 注意：consul配置会影响所有在同一项目的此gem配置，所有要求必须使用同一个consul集群
+consul_config_options = {
+  url: 'consul 地址，可以不传，Diplomat Gem会使用默认localhost:8500',
+  config_options: {ssl: {version: :TLSv1_2}, headers: {"X-Consul-Token" => "xxxx"}
+}
+Xconsul.configure_consul_connection(consul_config_options)
+```
+
+使用consul动态服务：
+```ruby
+# 生成balancer，每个client gem自己维护一个balancer示例，后续都通过此示例调用
+# cache_expired_seconds 暂时强制了必须5s以上
+consul_service_options = {service_name: 'xxx', cache_expired_seconds: 60}
+balance_options = {balance_algorithm: :round_robin} # 目前内部只有一种算法，此参数可以直接不传
+balancer = Xconsul.gen_balancer(consul_service_options, balance_options)
+# 获取host，如果没有可选host会raise异常
+balancer.host
+```
+
+不使用consul，手工配置hosts，需要配置：use_fixed_hosts true & fixed_hosts:
+```ruby
+# 生成balancer，每个client gem自己维护一个balancer示例，后续都通过此示例调用
+# cache_expired_seconds 暂时强制了必须5s以上
+consul_service_options = {
+  service_name: 'xxx', cache_expired_seconds: 60,
+  use_fixed_hosts: true, fixed_hosts: ['10.10.116.249:8881', '10.10.116.249:8882']
+}
+balance_options = {balance_algorithm: :round_robin} # 目前内部只有一种算法，此参数可以直接不传
+balancer = Xconsul.gen_balancer(consul_service_options, balance_options)
+# 获取host，如果没有可选host会raise异常
+balancer.host
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/xconsul. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Xconsul project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xconsul/blob/master/CODE_OF_CONDUCT.md).

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 "xconsul"
+
+# 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/lib/xconsul.rb

@@ -0,0 +1,33 @@
+require 'diplomat'
+require "xconsul/version"
+require "xconsul/load_balancer"
+
+module Xconsul
+
+  # 通过此方法生成一个balancer，后面获取host时调用 balancer.host（'10.10.142.233:8890'）
+  # 所有Hash key请传入symbol格式
+  # consul_options [Hash]: 详细见::Xconsul::LoadBalancer内注释
+  # balance_options [Hash]: 暂时不需要传
+  #   balance_algorithm 负载均衡算法，暂时无用，只有一种算法，自动使用
+  def self.gen_balancer(consul_options, balance_options = {})
+    ::Xconsul::LoadBalancer.new(consul_options, balance_options)
+  end
+
+  # 注意：这个配置是全局行的，配置后其他gem调用consul也会生效，所以要求所有的必须使用同一个consul服务
+  # consul_options [Hash]: 示例
+  # {
+  #    url: 'consul 地址，不传Diplomat会使用默认localhost地址',
+  #    config_options: {ssl: {version: :TLSv1_2}, headers: {"X-Consul-Token" => "xxxx"}
+  # }
+  # 其他参数有需要时再加
+  def self.configure_consul_connection(consul_options)
+    return if consul_options.length.zero?
+    url = consul_options[:url]
+    config_options = consul_options[:config_options] || {}
+
+    Diplomat.configure do |config|
+      config.url = url if url
+      config.options = config_options
+    end
+  end
+end

data/lib/xconsul/consul/service.rb

@@ -0,0 +1,12 @@
+# consul service 调用封装
+module Xconsul
+  module Consul
+    class Service
+      # 返回示例: ['10.10.142.233:8890', '192.168.0.2:8901']
+      def self.hosts_with_port(service_name)
+        services = Diplomat::Service.get(service_name, :all)
+        services.map { |service| "#{service.Address}:#{service.ServicePort}" }
+      end
+    end
+  end
+end

data/lib/xconsul/load_balance/base.rb

@@ -0,0 +1,16 @@
+require_relative 'round_robin'
+module Xconsul
+  module LoadBalance
+    class Base
+      # balance_algorithm 请传sym格式
+      def self.generate(balance_algorithm)
+        case balance_algorithm
+        when :round_robin
+          return RoundRobin.new
+        else
+          raise '未支持的load balance算法'
+        end
+      end
+    end
+  end
+end

data/lib/xconsul/load_balance/round_robin.rb

@@ -0,0 +1,22 @@
+# 轮训调度算法
+# 最简单策略，调用计数器每调用一次+1，调用数 % hosts数，根据mod值取host
+# 计算器暂时不做线程安全处理，1 不需要完全这么精确，并发发同一host多个也无所谓，2 减少代码锁
+module Xconsul
+  module LoadBalance
+    class RoundRobin
+      # attr_accessor :hosts # ['192.168.0.1:8909']
+      attr_accessor :counter # Integer
+
+      def initialize
+        @counter = 0
+      end
+
+      # hosts ['192.168.0.1:8909', '192.168.0.2:8901']
+      def select(hosts)
+        idx = @counter % hosts.size
+        @counter += 1
+        hosts[idx]
+      end
+    end
+  end
+end

data/lib/xconsul/load_balancer.rb

@@ -0,0 +1,69 @@
+# 负责load balance算法调用封装
+require_relative 'load_balance/base'
+require_relative 'consul/service'
+
+module Xconsul
+  # balancer = Xconsul::LoadBalancer.new({}); balancer.host
+  class LoadBalancer
+    DEFAULT_CACHE_EXPIRED_SECONDS = 30
+
+    attr_accessor :consul_service_name # consul service 名称
+    attr_accessor :latest_hosts # 最近一次获取的hosts
+    attr_accessor :last_timestamp # 上次获取hosts的时间戳
+    attr_accessor :cache_expired_seconds # hosts缓存有效期，每隔一定时间从consul获取最新list，不传使用默认值
+    attr_accessor :load_balance_processor # load balancer
+
+    # consul_options
+    #   service_name（必填）: consul服务的名称
+    #   cache_expired_seconds（可选）：hosts缓存有效期，每隔一定时间从consul获取最新list，不传使用默认值
+    #   use_fixed_hosts（可选，默认false）: 为true使用固定hosts，主要用于dev环境，或者暂时不使用consul
+    #   fixed_hosts（可选）: 手工配置的hosts列表，当use_fixed_hosts 为true时必须传入，格式为['10.10.142.233:8890', 'xxx']
+    # balance_options [Hash]:
+    #   balance_algorithm 负载均衡算法，暂时无用，只有一种算法，自动使用
+    def initialize(consul_options, balance_options = {})
+      @consul_service_name = consul_options[:service_name]
+      @cache_expired_seconds = consul_options[:cache_expired_seconds].to_i
+      @cache_expired_seconds = DEFAULT_CACHE_EXPIRED_SECONDS if @cache_expired_seconds <= 5
+
+      balance_algorithm = :round_robin
+      @load_balance_processor = generate_load_balance_processor(balance_algorithm)
+
+      if consul_options[:use_fixed_hosts] == true
+        @latest_hosts = consul_options[:fixed_hosts]
+        @last_timestamp = Time.now.to_i + 315360000 # 设置一个未来10年的时间戳，cache不过期
+      else
+        @latest_hosts = []
+      end
+    end
+
+    # 获取一个host with port，示例：'10.10.142.233:8890'
+    def host
+      hosts = hosts_with_cache
+      raise "consul_service:#{consul_service_name} 无可用hosts" if hosts.length.zero?
+      @load_balance_processor.select(hosts)
+    end
+
+    private
+
+      def generate_load_balance_processor(balance_algorithm)
+        ::Xconsul::LoadBalance::Base.generate(balance_algorithm)
+      end
+
+      # 带cache的hosts
+      # 如果没有过期，并且hosts不为空，则返回上次结果，否则重新查consul
+      def hosts_with_cache
+        if not_expired?
+          return latest_hosts unless latest_hosts.length.zero?
+        end
+        @latest_hosts = Xconsul::Consul::Service.hosts_with_port(consul_service_name)
+        @last_timestamp = Time.now.to_i
+        @latest_hosts
+      end
+
+      # 判断是否在有效期内
+      def not_expired?
+        return false unless last_timestamp
+        (last_timestamp + cache_expired_seconds) >= Time.now.to_i
+      end
+  end
+end

data/lib/xconsul/version.rb

@@ -0,0 +1,3 @@
+module Xconsul
+  VERSION = "0.2.0"
+end

data/xconsul.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xconsul/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xconsul"
+  spec.version       = Xconsul::VERSION
+  spec.authors       = ["zhchsf"]
+  spec.email         = ["zhchsf@gmail.com"]
+
+  spec.summary       = %q{consul 获取hosts + 负载均衡}
+  spec.description   = %q{通过consul服务获取指定服务hosts，并且使用简单的负载均衡策略，返回一个host:port}
+  spec.homepage      = "https://github.com/zhchsf/xconsul"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'diplomat', '~> 2.2.5'
+
+  spec.add_development_dependency "bundler", "> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'timecop'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: xconsul
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- zhchsf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 通过consul服务获取指定服务hosts，并且使用简单的负载均衡策略，返回一个host:port
+email:
+- zhchsf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xconsul.rb
+- lib/xconsul/consul/service.rb
+- lib/xconsul/load_balance/base.rb
+- lib/xconsul/load_balance/round_robin.rb
+- lib/xconsul/load_balancer.rb
+- lib/xconsul/version.rb
+- xconsul.gemspec
+homepage: https://github.com/zhchsf/xconsul
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.10
+signing_key: 
+specification_version: 4
+summary: consul 获取hosts + 负载均衡
+test_files: []