keepit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc0d1dfa47aa651e39fd114b33e6065f02809111
+  data.tar.gz: 7a7a3ce7e46f67e824435d28a3d57c794cb78a6f
+SHA512:
+  metadata.gz: 2e5844e3312176679e74388a65a30dd4ea4324fc03cd3d1c873e52d4cba9b7ee6a482cbafc2e6f24db840ae564beda3dd2fa5f59ba7745a0c9885578b51d2802
+  data.tar.gz: cb4c0ab8c1da0a147a358d62d4bfb6ce0fb5a97886115197ba5eee4faefd442fcb890fc06c458eaf3bd910387365429bcad64c94819d8d141111eba4b528e264

data/.drone.yml

@@ -0,0 +1,16 @@
+build:
+  test:
+    image: abakpress/dind-testing
+    pull: true
+    privileged: true
+    volumes:
+      - /home/data/drone/images:/images
+      - /home/data/drone/gems:/bundle
+    environment:
+      - COMPOSE_FILE_EXT=drone
+      - RUBY_IMAGE_TAG=2.2-latest
+    commands:
+      - wrapdocker docker -v
+      - fetch-images --image abakpress/ruby-app:$RUBY_IMAGE_TAG
+      - dip provision
+      - dip rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--tty
+--format progress
+--order random

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in keepit.gemspec
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+# Keepit
+
+Tools for safe interacting with external api services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keepit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keepit
+
+## Development
+
+After checking out the repo, run `dip provision` to install dependencies. Then, run `dip rspec` to run the tests.
+
+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/abak-press/keepit.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dip.yml

@@ -0,0 +1,38 @@
+version: '1'
+
+environment:
+  DOCKER_RUBY_VERSION: 2.2
+  RUBY_IMAGE_TAG: 2.2-latest
+  COMPOSE_FILE_EXT: development
+  RAILS_ENV: test
+  APRESS_GEMS_CREDENTIALS: ""
+
+compose:
+  files:
+    - docker-compose.yml
+    - docker-compose.${COMPOSE_FILE_EXT}.yml
+
+interaction:
+  sh:
+    service: app
+
+  irb:
+    service: app
+    command: irb
+
+  bundle:
+    service: app
+    command: bundle
+
+  rspec:
+    service: app
+    command: bundle exec rspec
+
+  clean:
+    service: app
+    command: rm -f Gemfile.lock
+
+provision:
+  - docker volume create --name bundler_data
+  - dip clean
+  - dip bundle install

data/docker-compose.development.yml

@@ -0,0 +1,13 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - ../:/localgems
+      - bundler-data:/bundle
+
+volumes:
+  bundler-data:
+    external:
+      name: bundler_data

data/docker-compose.drone.yml

@@ -0,0 +1,7 @@
+version: '2'
+
+services:
+  app:
+    volumes:
+      - .:/app
+      - /bundle:/bundle

data/docker-compose.yml

@@ -0,0 +1,9 @@
+version: '2'
+
+services:
+  app:
+    image: abakpress/ruby-app:$RUBY_IMAGE_TAG
+    environment:
+      - BUNDLE_PATH=/bundle/$DOCKER_RUBY_VERSION
+      - BUNDLE_CONFIG=/app/.bundle/config
+    command: bash

data/keepit.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "keepit/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "keepit"
+  spec.version = Keepit::VERSION
+  spec.authors = ["Michail Merkushin"]
+  spec.email = ["merkushin.m.s@gmail.com"]
+  spec.summary = "Classes for protection"
+  spec.homepage = "https://github.com/abak-press/keepit"
+
+  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_runtime_dependency "redis"
+  spec.add_runtime_dependency "dry-configurable"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "test-unit"
+end

data/lib/keepit.rb

@@ -0,0 +1,17 @@
+require "redis"
+require "dry/configurable"
+require "keepit/decaying"
+require "keepit/transient_store"
+require "keepit/locker"
+require "keepit/guard"
+require "keepit/version"
+
+module Keepit
+  extend Dry::Configurable
+
+  setting :redis
+
+  def self.redis
+    config.redis || ::Redis.current
+  end
+end

data/lib/keepit/decaying.rb

@@ -0,0 +1,34 @@
+module Keepit
+  # A float value which decays exponentially toward 0 over time.
+  class Decaying
+    attr_accessor :e
+    attr_accessor :p
+
+    # opts - Hash
+    #        :p - Float (0.0) The initial value
+    #        :e - Float (Math::E) Exponent base
+    #        :r - Float (Math.log(0.5) / 10) Timescale factor - defaulting to decay 50% every 10 seconds
+    def initialize(opts = {})
+      @p = opts[:p] || 0.0
+      @e = opts[:e] || Math::E
+      @r = opts[:r] || Math.log(0.5) / 10
+      @t0 = Time.now.to_i
+    end
+
+    # Add to current value
+    #
+    # d - Float value to add
+    def <<(d)
+      @p = value + d
+    end
+
+    # Returns Float the current value (adjusted for the time decay)
+    def value
+      return 0.0 unless @p > 0
+      now = Time.now.to_i
+      dt = now - @t0
+      @t0 = now
+      @p *= @e**(@r * dt)
+    end
+  end
+end

data/lib/keepit/guard.rb

@@ -0,0 +1,66 @@
+# Базовый класс защитника от ошибок при обращении к сторонним сервисам.
+#
+# Основной принцип работы:
+#
+#   Каждый сервис-клиент реализует свой класс защитника со списком возможных исключений.
+#   Если сторонний сервис возвращает определнное кол-во ошибок, которое больше некого порога,
+#   то защитник перестает давать общаться с ним на некоторое время.
+#   До преодоления порога мы сообщаем об ошибках в NewRelic и письмом проектому менеджеру.
+#   Также защитник не дает общаться с сервисом, если он находится на тех. обслуживании.
+#
+# Examples:
+#
+#   Keepit::Guard.config.error_notificator = ->(resource, error) { ErrorMailer.report(resource, error) }
+#
+#   module BarmenClient
+#     class Guard < ::Keepit::Guard
+#       config.resource = "barmen".freeze
+#       config.rescue_errors = [ActiveResource::ConnectionError]
+#     end
+#   end
+#
+#   BarmenClient::Guard.wrap { BarmenClient::Banner.find(...) }
+#
+module Keepit
+  class Guard
+    extend Dry::Configurable
+
+    setting :resource, reader: true
+    setting :rescue_errors, [StandardError], reader: true
+    setting :max_error_rate, 10, reader: true
+    setting :error_notificator, reader: true
+
+    class << self
+      def wrap
+        return nil unless fine?
+        yield
+      rescue *rescue_errors => error
+        error_rates[resource] << 1
+        error_notificator.call(resource, error)
+        nil
+      end
+
+      def reset
+        error_rates.clear
+      end
+
+      def fine?
+        !error_rate_exceeded? && !resource_locked?
+      end
+
+      private
+
+      def error_rates
+        @error_rates ||= Hash.new { |hash, key| hash[key] = ::Keepit::Decaying.new }
+      end
+
+      def error_rate_exceeded?
+        error_rates[resource].value >= (max_error_rate || DEFAULT_MAX_ERROR_RATE)
+      end
+
+      def resource_locked?
+        ::Keepit::Locker.locked?(resource, check_global: false)
+      end
+    end
+  end
+end

data/lib/keepit/locker.rb

@@ -0,0 +1,35 @@
+module Keepit
+  module Locker
+    GLOBAL = "global".freeze
+    KEY = "keepit:locks".freeze
+    EXPIRES_IN = 60
+
+    def self.lock(resources, blocking = false)
+      result = ::Keepit.redis.sadd(KEY, resources)
+      sleep(EXPIRES_IN) if blocking
+
+      result
+    end
+
+    def self.unlock(resources, blocking = false)
+      result = ::Keepit.redis.srem(KEY, resources)
+      sleep(EXPIRES_IN) if blocking
+
+      result
+    end
+
+    def self.locked?(resource, check_global: true)
+      if check_global
+        locked_resources.any? { |r| r == resource || r == GLOBAL }
+      else
+        locked_resources.any? { |r| r == resource }
+      end
+    end
+
+    def self.locked_resources
+      ::Keepit::TransientStore.fetch(:locks, expires_in: EXPIRES_IN) do
+        Array(::Keepit.redis.smembers(KEY))
+      end
+    end
+  end
+end

data/lib/keepit/transient_store.rb

@@ -0,0 +1,53 @@
+module Keepit
+  module TransientStore
+    Value = Struct.new(:value, :expired_at) do
+      def expired?
+        expired_at < Time.now.to_i
+      end
+    end
+
+    def self.clear
+      store.clear
+    end
+
+    def self.delete(key)
+      item = store.delete(key)
+      item.value if item
+    end
+
+    def self.empty?
+      store.empty?
+    end
+
+    def self.exist?(key)
+      return true if store.key?(key) && !store[key].expired?
+
+      delete(key)
+
+      false
+    end
+
+    def self.fetch(key, expires_in:, &block)
+      if exist?(key)
+        store[key].value
+      else
+        value = yield
+        write(key, value, expires_in: expires_in)
+      end
+    end
+
+    def self.read(key)
+      store[key].value if exist?(key)
+    end
+
+    def self.store
+      Thread.current[:keepit_transient_store] ||= {}
+    end
+
+    def self.write(key, value, expires_in:)
+      store[key] = Value.new(value, Time.now.to_i + expires_in.to_i)
+
+      value
+    end
+  end
+end

data/lib/keepit/version.rb

@@ -0,0 +1,3 @@
+module Keepit
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: keepit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michail Merkushin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: dry-configurable
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: mock_redis
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: test-unit
+  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: 
+email:
+- merkushin.m.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- dip.yml
+- docker-compose.development.yml
+- docker-compose.drone.yml
+- docker-compose.yml
+- keepit.gemspec
+- lib/keepit.rb
+- lib/keepit/decaying.rb
+- lib/keepit/guard.rb
+- lib/keepit/locker.rb
+- lib/keepit/transient_store.rb
+- lib/keepit/version.rb
+homepage: https://github.com/abak-press/keepit
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Classes for protection
+test_files: []