redis_batch_push 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2701e2f46360e7407171c6cb152dd502d37682ad
+  data.tar.gz: 71b1be2e98815ac081f61fe07cb408c9b67bf033
+SHA512:
+  metadata.gz: a2d5454c0786d58f4226d4670c9ce4175566eea390a0ab2000ddd45ed9ba39f7819b2a0930db1cd0f44374ae916b80a115eb8750c0928d0fffa7d7e06a8108e0
+  data.tar.gz: 3ca481a1d263523c864f4e185815e9c309c6cfffbdeaf650701c969c9be18e626c598105ccdb7768eb828fc2b81124e3493b5f6771c74a327417ef2ffb4c4ba4

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.rbenv-gemsets
+.ruby-versions

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.16.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 manoelifpb@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 redis_batch_push.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    redis_batch_push (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mock_redis (0.18.0)
+    rake (10.5.0)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mock_redis (~> 0.18)
+  rake (~> 10.0)
+  redis (~> 4.0)
+  redis_batch_push!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Manoel Quirino Neto
+
+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,96 @@
+# RedisBatchPush
+
+This gem provide a simple way to:
+
+1. watch a data in a redis queue
+2. cache this data (buffer)
+3. process this buffered data by time
+
+## Motivation
+
+Sometimes you have a webserver that expect some data to come, and you have to save this data in a database. But this webserver receive a lot of requests per second, and saving in database is very expensive.
+
+example:
+
+your server receives:
+
+```
+POST /view -d '{id: 1}'
+POST /view -d '{id: 1}'
+POST /view -d '{id: 2}'
+POST /view -d '{id: 1}'
+POST /view -d '{id: 3}'
+```
+
+and for each post you should do
+
+```
+model = Table.find(id)
+model.view += 1
+model.save
+```
+
+with this gem you can reduce your data to make one incr by once
+
+```
+# in post
+redis.lpush queue, view
+
+# in other work
+runner = RedisBatchPush::Runner.new(redis_client, queue, max_size, max_interval_sec)
+runner.run do |views|
+  views_by_id = views.inject({}) do |memo, item|
+    memo[item["id"]] ||= 0
+    memo[item["id"]] += 1
+  end
+
+  # Now you have to make 3 incr, 1 by id
+  print views_by_id
+
+  # {
+  #   "1" => 3,
+  #   "2" => 1,
+  #   "3" => 1,
+  # }
+end
+
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_batch_push'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_batch_push
+
+## Usage
+
+See examples
+
+## 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/manoelneto/redis_batch_push. 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 RedisBatchPush project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/manoelneto/redis_batch_push/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_batch_push"
+
+# 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/examples/consumer.rb

@@ -0,0 +1,18 @@
+require "redis_batch_push"
+require "redis"
+
+queue = "redis_batch_push::example_queue"
+# localhost
+redis = Redis.new
+max_interval_sec = 30
+max_size = 20
+
+t = Time.now
+
+runner = RedisBatchPush::Runner.new(redis, queue, max_size, max_interval_sec)
+runner.run do |data|
+  p 'data will be an array'
+  p "got some data #{data.size} #{data}"
+  p "ellapsed time #{Time.now - t}"
+  t = Time.now
+end

data/examples/producer.rb

@@ -0,0 +1,20 @@
+require "redis_batch_push"
+require "securerandom"
+require "redis"
+
+queue = "redis_batch_push::example_queue"
+# localhost
+redis = Redis.new
+
+
+loop do
+  data = SecureRandom.hex
+  p "pushing #{data}"
+  redis.lpush(queue, data)
+
+  # if you want to see data printed by size
+  sleep 0.1
+
+  # if you want to see data printed by ellapsed time
+  sleep 1
+end

data/lib/redis_batch_push.rb

@@ -0,0 +1,28 @@
+require "redis_batch_push/version"
+require "redis_batch_push/monitor"
+require "redis_batch_push/getter"
+require "redis_batch_push/processor"
+
+module RedisBatchPush
+
+  class Runner
+    def initialize redis_client, queue, max_size=nil, max_interval_sec=nil
+      @redis_client = redis_client
+      @queue = queue
+      @max_size = max_size
+      @max_interval_sec = max_interval_sec
+    end
+
+    def run &block
+      getter = Getter.new(@redis_client, @queue)
+      blk = Proc.new do |data|
+        yield data
+        getter.clear_backup
+      end
+      processor = Processor.new(blk, @max_size, @max_interval_sec)
+      monitor = Monitor.new(getter, processor)
+      monitor.run
+    end
+  end
+
+end

data/lib/redis_batch_push/getter.rb

@@ -0,0 +1,38 @@
+require 'securerandom'
+
+module RedisBatchPush
+
+  class Getter
+    attr_reader :backup_queue
+
+    def initialize redis_client, queue
+      @redis_client = redis_client
+      @queue = queue
+      @backup_queue = "#{@queue}:backup:#{SecureRandom.hex}"
+    end
+
+    def get_next_item
+      @redis_client.brpoplpush(
+        @queue,
+        @backup_queue,
+        {
+          timeout: 5
+        }
+      )
+    end
+
+    def clear_backup
+      @redis_client.del(@backup_queue)
+    end
+
+    def restore_backups
+      @redis_client.keys("#{@queue}:backup:*").each do |bkp_queue|
+        loop do
+          break unless @redis_client.rpoplpush(bkp_queue, @queue)
+        end
+        @redis_client.del(bkp_queue)
+      end
+    end
+  end
+
+end

data/lib/redis_batch_push/monitor.rb

@@ -0,0 +1,21 @@
+module RedisBatchPush
+
+  class Monitor
+    def initialize getter, processor
+      @getter = getter
+      @processor = processor
+    end
+
+    def run
+      @getter.restore_backups
+
+      loop do
+        if item = @getter.get_next_item
+          @processor.process item
+        else
+          @processor.tick
+        end
+      end
+    end
+  end
+end

data/lib/redis_batch_push/processor.rb

@@ -0,0 +1,47 @@
+module RedisBatchPush
+
+  class Processor
+    def initialize block, max_size=nil, max_interval_sec=nil
+      @max_size = max_size
+      @max_interval_sec = max_interval_sec
+      validate!
+      @block = block
+
+      initialize_buffer
+    end
+
+    def initialize_buffer
+      @buffer = []
+      @buffer_start_time = Time.now
+    end
+
+    def validate!
+      if @max_size.nil? && @max_interval_sec.nil?
+        raise "You must inform max_size or max_interval_sec"
+      end
+    end
+
+    def process_current_time
+      Time.now
+    end
+
+    def must_send
+      by_buffer_size = @max_size && @buffer.size >= @max_size
+      by_interval_passed = @max_interval_sec && process_current_time - @buffer_start_time >= @max_interval_sec
+
+      by_buffer_size || by_interval_passed
+    end
+
+    def tick
+      if must_send && @buffer.size > 0
+        @block.call(@buffer)
+        initialize_buffer
+      end
+    end
+
+    def process item
+      @buffer << item
+      tick
+    end
+  end
+end

data/lib/redis_batch_push/version.rb

@@ -0,0 +1,3 @@
+module RedisBatchPush
+  VERSION = "0.1.0"
+end

data/redis_batch_push.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis_batch_push/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_batch_push"
+  spec.version       = RedisBatchPush::VERSION
+  spec.authors       = ["Manoel Quirino Neto"]
+  spec.email         = ["manoelifpb@gmail.com"]
+
+  spec.summary       = %q{Provides an easy way to queue some messages and push them in batches.}
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mock_redis", "~> 0.18"
+  spec.add_development_dependency "redis", "~> 4.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: redis_batch_push
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manoel Quirino Neto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-26 00:00:00.000000000 Z
+dependencies:
+- !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: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- manoelifpb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/consumer.rb
+- examples/producer.rb
+- lib/redis_batch_push.rb
+- lib/redis_batch_push/getter.rb
+- lib/redis_batch_push/monitor.rb
+- lib/redis_batch_push/processor.rb
+- lib/redis_batch_push/version.rb
+- redis_batch_push.gemspec
+homepage: 
+licenses:
+- MIT
+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.14
+signing_key: 
+specification_version: 4
+summary: Provides an easy way to queue some messages and push them in batches.
+test_files: []