service_variables 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4186bf753f9a2e976662c1769dbebb5ca3c91626
+  data.tar.gz: 05d05c05bde1756f7567c6f71ce2e87e7d26ecd4
+SHA512:
+  metadata.gz: 7a8f84e85755c7f20c2e397fc3f662e2a21f2b721b4ae8d3653ee44b3c1a90680f62293508f4b5a2777a2bb8610f4826b419fae2703bb1db6d227a71266cde06
+  data.tar.gz: 38295d1ea48bf8a9379e6340ed481e9339deb9791f5ca754e384dff5859c8ff80a7d909f60d68e035be93537e22efbca460b3c5657024111d31b0f694640f5f1

data/lib/service_variables.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'redis'
+
+# Module to create service level variables stored in Redis.
+module ServiceVariables
+  class NotConfiguredError < StandardError; end
+  class InvalidValueError < StandardError; end
+
+  DEFAULT_REDIS_KEY = 'service_variables_redis_key'
+  BOOLEAN_VALUES = [true, false, 'true', 'false'].freeze
+
+  attr_writer :service_variables_redis_client, :redis_key
+
+  def configure(redis_client:, redis_key: nil)
+    @service_variables_redis_client = redis_client
+    @redis_key = redis_key
+  end
+
+  def boolean_option(name, default: nil)
+    getter_method_name = "#{name}?".to_sym
+    setter_method_name = "#{name}=".to_sym
+
+    define_singleton_method getter_method_name do
+      # Note that all values are stored in Redis as strings.
+      value = get(name)
+      value.nil? ? default : get(name) == 'true'
+    end
+
+    # Allow for `name` and `name?` accessors of boolean options.
+    singleton_class.send(:alias_method, name, getter_method_name)
+
+    define_singleton_method setter_method_name do |value|
+      raise InvalidValueError, "Value isn't `true` or `false`" unless BOOLEAN_VALUES.include?(value)
+      set(name, value.to_s)
+    end
+  end
+
+  def integer_option(name, default: nil, min: nil, max: nil)
+    define_singleton_method name do
+      get(name)&.to_i || default
+    end
+
+    define_singleton_method "#{name}=" do |value|
+      value = Integer(value) # raises ArgumentError if non integer value
+      raise InvalidValueError, "Value too small. min = #{min.to_i}" if min && min > value
+      raise InvalidValueError, "Value too large. max = #{max.to_i}" if max && max < value
+      set(name, value&.to_s)
+    end
+  end
+
+  def float_option(name, default: nil, min: nil, max: nil)
+    define_singleton_method name do
+      get(name)&.to_f || default
+    end
+
+    define_singleton_method "#{name}=" do |value|
+      value = Float(value) # raises ArgumentError if non float value
+      raise InvalidValueError, "Value too small. min = #{min.to_f}" if min && min > value
+      raise InvalidValueError, "Value too large. max = #{max.to_f}" if max && max < value
+      set(name, value&.to_s)
+    end
+  end
+
+  def string_option(name, default: nil, enum: nil)
+    define_singleton_method name do
+      get(name) || default
+    end
+
+    define_singleton_method "#{name}=" do |value|
+      raise InvalidValueError, "Only #{enum} values are allowed." if enum && !enum.include?(value)
+      set(name, value)
+    end
+  end
+
+  private
+
+  def get(key)
+    redis.hget(redis_hash_key, key)
+  end
+
+  def set(key, value)
+    if value.nil?
+      redis.hdel(redis_hash_key, key)
+    else
+      redis.hset(redis_hash_key, key, value)
+    end
+  end
+
+  def redis
+    return @service_variables_redis_client if @service_variables_redis_client.is_a?(Redis)
+    raise NotConfiguredError, 'Redis client not given.'
+  end
+
+  def redis_hash_key
+    @redis_key.nil? ? DEFAULT_REDIS_KEY : "#{DEFAULT_REDIS_KEY}:#{@redis_key}"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: service_variables
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- coinbase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+description: Wrapper for redis backed configuration variables accessible to multiple
+  servers.
+email: opensource@coinbase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/service_variables.rb
+homepage: https://github.com/coinbase/service_variables
+licenses:
+- Apache-2.0
+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.13
+signing_key: 
+specification_version: 4
+summary: Service level variables.
+test_files: []