redis-claim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ea44be69ee8f4352ec769076707c7a1e20409b233807a9aa4f71d14c12409d4
+  data.tar.gz: 64f294742923175f78e01574a696e7075d319dfee9e04f46113f247783f50146
+SHA512:
+  metadata.gz: 5099e24651cc53685f86775385843f81e4c96a14e60287f034f77ec4ea80c538ca4a6c1b01bd1b5e710cc549d0a88f51e113ad66fb92737be8c58b2039e67b02
+  data.tar.gz: 4d08a439ed46bee33b40961dd9a0f69ec357be5c648820e3d1bcf13f6ba5f3634cf3308d969971f6523740a304250a0b1847b118e6dcc0e4abe48511264f609f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start if ENV["COVERAGE"]

data/.travis.yml

@@ -0,0 +1,32 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+services:
+  - redis-server
+
+rvm:
+  - 2.5.1
+
+before_install:
+  - gem update --system
+  - gem install bundler
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+install:
+  - bin/setup
+
+script:
+  - COVERAGE=true bundle exec rspec
+  - gem build redis-claim
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+deploy:
+  provider: rubygems
+  api_key: "$RUBY_GEMS_API_KEY"
+  on:
+    tags: true

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.0]
+### Added
+- Implemented functionality to verify that db claimed by current app, claim it or raise error
+- Parameter to ignore redis connectivity errors
+
+[Unreleased]: https://github.com/matic-insurance/redis-claim/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/matic-insurance/redis-claim/compare/master...0.1.0

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 volodymyr.m@matic.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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redis-claim.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    redis-claim (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.2.0)
+    rake (10.5.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  redis (~> 4.1)
+  redis-claim!
+  rspec (~> 3.0)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Volodymyr Mykhailyk
+
+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,85 @@
+# Redis::Claim
+
+[![Build Status](https://travis-ci.org/matic-insurance/redis-claim.svg?branch=master)](https://travis-ci.org/matic-insurance/redis-claim)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/489ff6577678a8d2a868/test_coverage)](https://codeclimate.com/github/matic-insurance/redis-claim/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/489ff6577678a8d2a868/maintainability)](https://codeclimate.com/github/matic-insurance/redis-claim/maintainability)
+
+Prevent conflicts of several apps using same Redis database or namespace. 
+Allows to check if db is already taken and claim ownership of the db.
+
+Common use case for the gem is microservices that share single physical redis instance. 
+In such case it is common problem to make an error in redis url, or namespace. 
+When passing redis url to the app it is very to make mistake in redis database number.   
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-claim'
+```
+
+## Usage
+
+Assuming you have redis you want to claim
+```ruby
+REDIS = Redis.new(url: "redis://redis-instance.aws.com:6379/12")
+```
+
+On the start of your application execute following code. 
+
+```ruby
+Redis::Claim.verify do |config|
+  # Your redis instance you want to claim
+  config.redis = REDIS      
+  # Application name to detect any other service that claimed db  
+  config.app_name = 'my cool application'
+end
+```
+
+An `Redis::Claim::Error` will be raised in case of configuration or claim error 
+
+**NOTE** For rails you can add this code to custom initializer `redis_claim.rb` in `app/config/initializers`
+
+## Behaviour
+
+Redis Claim has following execution steps
+
+1. Executed only once on start of the application. 
+1. Sets lock key if it does not exist with `setnx` command
+1. Reads lock key if it exists
+1. Compare existing lock key is the same as `app_name`
+
+**IMPORTANT** Redis claim will not detect db conflict if another application/service is not using it
+
+## Configuration options
+
+When executing `Redis::Claim.verify` - passed block will receive configuraiton object with following properties: 
+
+| Parameter               | Format  | Required | Description                                                                                         |
+|-------------------------|---------|----------|-----------------------------------------------------------------------------------------------------|
+| redis                   | Object  | true     | Initialized Redis. Work with any object as long as it responds to `get` and `setnx` methods         |
+| app_name                | String  | true     | Name of your application. Should be uniuq for every microservice.                                   |
+| ignore_connection_error | Boolean | false    | Do not raise exception when cannot connect to Redis. Default: **false**                             |
+| lock_key                | String  | false    | Name of the redis key where lock identifier will be recorded. Default: **'redis-claim:app'**        |
+
+## Development
+
+1. [Install Redis](https://redis.io//download)
+1. Run `bin/setup` to install dependencies
+1. Run tests `rspec`
+1. Add new test
+1. Add new code
+1. Go to step 3
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/matic-insurance/redis-claim. 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 Redis::Claim project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matic-insurance/redis-claim/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 "redis/claim"
+
+# 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/redis/claim.rb

@@ -0,0 +1,13 @@
+require "redis/claim/version"
+require "redis/claim/configuration"
+require "redis/claim/actions"
+require "redis/claim/errors"
+
+class Redis
+  class Claim
+    def self.verify(&configurator)
+      config = Redis::Claim::Configuration.new.tap(&configurator)
+      Redis::Claim::Actions.claim_db!(config)
+    end
+  end
+end

data/lib/redis/claim/actions.rb

@@ -0,0 +1,65 @@
+class Redis
+  class Claim
+    class Actions
+      extend Forwardable
+
+      attr_reader :config
+
+      delegate redis: :config, app_name: :config, lock_key: :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def self.claim_db!(config)
+        actions = self.new(config)
+        actions.verify_config!
+        actions.claim_db!
+      end
+
+      def verify_config!
+        check_config_values!
+        check_redis_functionality!
+
+        true
+      end
+
+      def claim_db!
+        current_lock = get_db_lock
+        if app_name == current_lock
+          true
+        else
+          raise Redis::Claim::DbAlreadyClaimed, "database already claimed by #{current_lock}"
+        end
+      end
+
+      protected
+
+      def check_config_values!
+        return raise_configuration_error('app name is missing') unless app_name
+        return raise_configuration_error('redis is missing') unless redis
+
+        true
+      end
+
+      def check_redis_functionality!
+        return raise_configuration_error('redis should respond to get') unless redis.respond_to?(:get)
+        return raise_configuration_error('redis should respond to setnx') unless redis.respond_to?(:setnx)
+
+        true
+      end
+
+      def get_db_lock
+        return app_name if redis.setnx(lock_key, app_name)
+        redis.get(lock_key)
+      rescue => e
+        return app_name if config.ignore_connection_error
+        raise e
+      end
+
+      def raise_configuration_error(message)
+        raise Redis::Claim::InvalidConfiguration, message
+      end
+    end
+  end
+end

data/lib/redis/claim/configuration.rb

@@ -0,0 +1,16 @@
+class Redis
+  class Claim
+    class Configuration
+      LOCK_KEY_NAME = "redis-claim:app"
+      # Required attributes
+      attr_accessor :redis, :app_name
+      # Optional attributes
+      attr_accessor :ignore_connection_error, :lock_key
+
+      def initialize
+        self.lock_key = LOCK_KEY_NAME
+        self.ignore_connection_error = false
+      end
+    end
+  end
+end

data/lib/redis/claim/errors.rb

@@ -0,0 +1,7 @@
+class Redis
+  class Claim
+    class Error < StandardError; end
+    class InvalidConfiguration < Error; end
+    class DbAlreadyClaimed < Error; end
+  end
+end

data/lib/redis/claim/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  class Claim
+    VERSION = "0.1.0"
+  end
+end

data/redis-claim.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis/claim/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-claim"
+  spec.version       = Redis::Claim::VERSION
+  spec.authors       = ["Volodymyr Mykhailyk"]
+  spec.email         = ["volodymyr.mykhailyk@gmail.com"]
+
+  spec.summary       = %q{Gem to Claim ownership of Redis database/namespace}
+  spec.description   = %q{Prevent conflicts of several apps using same redis database or namespace.
+                          Allows to check if db is already taken and claim ownership of the db}
+  spec.homepage      = "https://github.com/matic-insurance/redis-claim"
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/matic-insurance/redis-claim"
+    spec.metadata["changelog_uri"] = "https://github.com/matic-insurance/redis-claim/blob/master/CHANGELOG.md"
+  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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "redis", "~> 4.1"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: redis-claim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodymyr Mykhailyk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: |-
+  Prevent conflicts of several apps using same redis database or namespace.
+                            Allows to check if db is already taken and claim ownership of the db
+email:
+- volodymyr.mykhailyk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis/claim.rb
+- lib/redis/claim/actions.rb
+- lib/redis/claim/configuration.rb
+- lib/redis/claim/errors.rb
+- lib/redis/claim/version.rb
+- redis-claim.gemspec
+homepage: https://github.com/matic-insurance/redis-claim
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+  homepage_uri: https://github.com/matic-insurance/redis-claim
+  source_code_uri: https://github.com/matic-insurance/redis-claim
+  changelog_uri: https://github.com/matic-insurance/redis-claim/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Gem to Claim ownership of Redis database/namespace
+test_files: []