apollo-ruby 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8109a5c40706105f9e14020da6983533eb9cbcaf562a44ca0e9707e52cfe527
+  data.tar.gz: 22672ddec88c105940dc3ffdf9c3841496a3cc56df24dbdb3ed04b7d597a2fff
+SHA512:
+  metadata.gz: 2da4e8aaedfbcc6d77687335cbb68be0af333c8f297b13cd1af6975f0e4ae84d8222c976cbc804c72b2cf8c193256b07f52fe84b1a37272d5c5382055fc15d12
+  data.tar.gz: a9498cbac9a9b8d535404de27d895299ab0ac941bb8902416253e837298246fd05770af61ab750cdc80aea11d219b40a48569f14f3e48e577ad475dfbe58a72d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Released]
+
+## [1.0.2] - 2023-04-17
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at kervinchangyu@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in apollo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rest-client"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    apollo-ruby (1.0.4)
+      json
+      rest-client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    json (2.6.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0218.1)
+    netrc (0.11.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  universal-darwin-21
+
+DEPENDENCIES
+  apollo-ruby!
+  bundler
+  rake (~> 13.0)
+  rest-client
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.11

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kervin
+
+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.en.md

@@ -0,0 +1,47 @@
+# Apollo-Ruby
+
+🚀Ruby client for ctrip/apollo (https://github.com/apolloconfig/apollo)
+
+## Installation
+
+Install the gem and add to the Rails application's Gemfile by executing:
+
+    $ bundle add apollo-ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install apollo-ruby
+
+## Usage
+
+You'll need to configure it in `config/initializers/apollo.rb`:
+
+```ruby
+Apollo.configure do |config|
+  config.appid = ENV['APOLLO_APPID']
+  config.secret = ENV['APOLLO_SECRET']
+  config.server = ENV['APOLLO_SERVER']
+end
+```
+
+Then you can get the configuration from Apollo using the following code:
+
+```ruby
+Apollo.fetch("your configuration key")
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Added some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Changelog
+
+See the [CHANGELOGS.md](./CHANGELOG.md).

data/README.md

@@ -0,0 +1,5 @@
+# Apollo-Ruby
+
+🚀Ruby client for ctrip/apollo (https://github.com/apolloconfig/apollo)
+
+[English](./README.en.md) | [简体中文](./README.zh-CN.md)

data/README.zh-CN.md

@@ -0,0 +1,47 @@
+# Apollo-Ruby
+
+🚀[携程Apollo配置管理框架](https://github.com/apolloconfig/apollo) 的Ruby客户端
+
+## 安装
+
+通过执行以下命令将gem加入Rails应用程序的Gemfile：
+
+    $ bundle add apollo-ruby
+
+如果不使用bundler管理依赖，可以通过以下命令安装gem：
+
+    $ gem install apollo-ruby
+
+## 用法
+
+你需要在`config/initializers/apollo.rb`中进行配置：
+
+```ruby
+Apollo.configure do |config|
+  config.appid = ENV['APOLLO_APPID']
+  config.secret = ENV['APOLLO_SECRET']
+  config.server = ENV['APOLLO_SERVER']
+end
+```
+
+然后便可以使用以下代码从Apollo获取配置：
+
+```ruby
+Apollo.fetch("你的配置Key")
+```
+
+## 贡献
+
+1. Fork
+2. 创建您的特性分支 (`git checkout -b my-new-feature`)
+3. 提交您的改动 (`git commit -am 'Added some feature'`)
+4. 将您的修改记录提交到远程 git 仓库 (`git push origin my-new-feature`)
+5. 然后到 github 网站的该 git 远程仓库的 my-new-feature 分支下发起 Pull Request
+
+## 许可证
+
+本项目基于MIT协议发布，更多细节请参阅 [MIT License](https://opensource.org/licenses/MIT).
+
+## 更新日志
+
+请参阅 [CHANGELOGS.md](./CHANGELOG.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/apollo/auth.rb

@@ -0,0 +1,16 @@
+require "base64"
+require "openssl"
+
+module Apollo
+  # Authorization
+  class Auth
+    class << self
+      def signature(secret, timestamp, path_with_query)
+        return if secret.nil?
+
+        sign = "#{timestamp}\n#{path_with_query}"
+        Base64.encode64(OpenSSL::HMAC.digest("sha1", secret, sign))
+      end
+    end
+  end
+end

data/lib/apollo/client.rb

@@ -0,0 +1,51 @@
+module Apollo
+  # Get configuration data from Apollo server.
+  class Client
+
+    attr_accessor :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def fetch(key, disable_cache)
+      if disable_cache
+        uncached_http_get(key)
+      else
+        cached_http_get(key)
+      end
+    end
+
+    def cached_http_get(key)
+      url = "#{configuration.server}/configfiles/json/#{configuration.appid}/#{configuration.cluster}/#{configuration.namespace}"
+      headers = build_http_headers(url)
+      code, data, _headers = HTTP.get(url, headers)
+      return unless HTTP.response_ok?(code)
+
+      configurations = Utils.safe_json_parse(data)
+      configurations[key]
+    end
+
+    def uncached_http_get(key)
+      url = "#{configuration.server}/configs/#{configuration.appid}/#{configuration.cluster}/#{configuration.namespace}"
+      headers = build_http_headers(url)
+      code, data, _headers = HTTP.get(url, headers)
+      return unless HTTP.response_ok?(code)
+
+      configurations = Utils.safe_json_parse(data)["configurations"]
+      configurations[key]
+    end
+
+    def build_http_headers(url)
+      timestamp = Time.now.utc.strftime("%s%L")
+      uri = Utils.safe_uri_parse(url)
+      path_with_query = uri.path
+      path_with_query += "?#{uri.query}" unless uri.query.nil?
+      signature = Auth.signature(configuration.secret, timestamp, path_with_query)
+      {
+        "Authorization" => "Apollo #{configuration.appid}:#{signature}",
+        "Timestamp" => timestamp
+      }
+    end
+  end
+end

data/lib/apollo/configuration.rb

@@ -0,0 +1,66 @@
+module Apollo
+  # Set Apollo application configuration.
+  class Configuration
+
+    # Cluster name of Apollo application.
+    attr_reader :cluster
+
+    # Namespace name of Apollo application.
+    attr_reader :namespace
+
+    # Apollo application ID.
+    attr_reader :appid
+
+    # Apollo application secret.
+    attr_reader :secret
+
+    # Apollo server url.
+    attr_reader :server
+
+    def initialize
+      self.cluster = "default"
+      self.namespace = "application"
+      self.appid = ENV["APOLLO_APPID"]
+      self.secret = ENV["APOLLO_SECRET"]
+      self.server = ENV["APOLLO_SERVER"]
+    end
+
+    def cluster=(value)
+      return if value.nil?
+
+      @cluster = value.to_s
+    end
+
+    alias cluster_name= cluster=
+
+    def namespace=(value)
+      return if value.nil?
+
+      @namespace = value.to_s
+    end
+
+    alias namespace_name= namespace=
+
+    def appid=(value)
+      return if value.nil?
+
+      @appid = value.to_s
+    end
+
+    alias app_id= appid=
+
+    def secret=(value)
+      return if value.nil?
+
+      @secret = value.to_s
+    end
+
+    def server=(value)
+      return if value.nil?
+
+      @server = value.to_s
+    end
+
+    alias dsn= server=
+  end
+end

data/lib/apollo/http.rb

@@ -0,0 +1,25 @@
+require "rest-client"
+
+module Apollo
+  # HTTP Client.
+  module HTTP
+    class << self
+      def response_ok?(status_code)
+        [200, 304].include?(status_code)
+      end
+
+      def get(url, headers, _opts = {})
+        response = RestClient.get(url, headers)
+        [response.code.to_i, response.body, response.raw_headers]
+      rescue StandardError => e
+        Log.logger.warn "#{e.message} => Apollo::HTTP.get('#{url}')"
+        if e.respond_to?(:response) && e.response.respond_to?(:code)
+          return e.response.code, e.response.body, e.response.raw_headers
+        end
+
+        [nil, nil, nil]
+      end
+    end
+  end
+end
+

data/lib/apollo/instance.rb

@@ -0,0 +1,29 @@
+module Apollo
+  # A copy of Apollo's base module class methods.
+  class Instance
+    # See Apollo::Client
+    attr_writer :client
+
+    # See Apollo::Configuration
+    attr_accessor :configuration
+
+    def initialize(config = nil)
+      self.configuration = config || Configuration.new
+    end
+
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      self.client = Client.new(configuration)
+      client
+    end
+
+    def fetch(key, opts = {})
+      opts[:disable_cache] = false unless opts.key?(:disable_cache)
+      client.fetch(key, opts[:disable_cache])
+    end
+  end
+end

data/lib/apollo/log.rb

@@ -0,0 +1,12 @@
+require "logger"
+
+module Apollo
+  # Log.
+  module Log
+    class << self
+      def logger
+        @logger ||= ::Logger.new($stderr)
+      end
+    end
+  end
+end

data/lib/apollo/utils.rb

@@ -0,0 +1,21 @@
+require "json"
+require "uri"
+
+module Apollo
+  # Utils.
+  module Utils
+    class << self
+      def safe_json_parse(data)
+        JSON.parse(data)
+      rescue JSON::ParserError
+        {}
+      end
+
+      def safe_uri_parse(url)
+        URI.parse(url)
+      rescue URI::InvalidURIError
+        URI.parse("")
+      end
+    end
+  end
+end

data/lib/apollo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Apollo
+  VERSION = "1.0.4"
+end

data/lib/apollo-ruby.rb

@@ -0,0 +1 @@
+require "apollo"

data/lib/apollo.rb

@@ -0,0 +1,21 @@
+require "apollo/auth"
+require "apollo/client"
+require "apollo/configuration"
+require "apollo/http"
+require "apollo/instance"
+require "apollo/log"
+require "apollo/utils"
+require "apollo/version"
+
+# A module encapsulating Apollo server API.
+module Apollo
+  class << self
+    extend Forwardable
+
+    def instance
+      @instance ||= Apollo::Instance.new
+    end
+
+    def_delegators :instance, :client=, :configuration=, :configuration, :client, :configure, :fetch
+  end
+end

data/sig/apollo.rbs

@@ -0,0 +1,4 @@
+module Apollo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: apollo-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Kervin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rest-client
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: "\U0001F680Ruby client for ctrip/apollo (https://github.com/apolloconfig/apollo)"
+email:
+- kervinchangyu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.en.md
+- README.md
+- README.zh-CN.md
+- Rakefile
+- lib/apollo-ruby.rb
+- lib/apollo.rb
+- lib/apollo/auth.rb
+- lib/apollo/client.rb
+- lib/apollo/configuration.rb
+- lib/apollo/http.rb
+- lib/apollo/instance.rb
+- lib/apollo/log.rb
+- lib/apollo/utils.rb
+- lib/apollo/version.rb
+- sig/apollo.rbs
+homepage: https://github.com/kervinchang/apollo-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: "\U0001F680Ruby client for ctrip/apollo (https://github.com/apolloconfig/apollo)"
+test_files: []