redis_batch_push 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 2701e2f46360e7407171c6cb152dd502d37682ad
4
+ data.tar.gz: 71b1be2e98815ac081f61fe07cb408c9b67bf033
5
+ SHA512:
6
+ metadata.gz: a2d5454c0786d58f4226d4670c9ce4175566eea390a0ab2000ddd45ed9ba39f7819b2a0930db1cd0f44374ae916b80a115eb8750c0928d0fffa7d7e06a8108e0
7
+ data.tar.gz: 3ca481a1d263523c864f4e185815e9c309c6cfffbdeaf650701c969c9be18e626c598105ccdb7768eb828fc2b81124e3493b5f6771c74a327417ef2ffb4c4ba4
@@ -0,0 +1,13 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+ .rbenv-gemsets
13
+ .ruby-versions
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1 @@
1
+ 2.4.3
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2.2
5
+ before_install: gem install bundler -v 1.16.0
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at manoelifpb@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in redis_batch_push.gemspec
6
+ gemspec
@@ -0,0 +1,39 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ redis_batch_push (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.3)
10
+ mock_redis (0.18.0)
11
+ rake (10.5.0)
12
+ redis (4.0.1)
13
+ rspec (3.7.0)
14
+ rspec-core (~> 3.7.0)
15
+ rspec-expectations (~> 3.7.0)
16
+ rspec-mocks (~> 3.7.0)
17
+ rspec-core (3.7.1)
18
+ rspec-support (~> 3.7.0)
19
+ rspec-expectations (3.7.0)
20
+ diff-lcs (>= 1.2.0, < 2.0)
21
+ rspec-support (~> 3.7.0)
22
+ rspec-mocks (3.7.0)
23
+ diff-lcs (>= 1.2.0, < 2.0)
24
+ rspec-support (~> 3.7.0)
25
+ rspec-support (3.7.1)
26
+
27
+ PLATFORMS
28
+ ruby
29
+
30
+ DEPENDENCIES
31
+ bundler (~> 1.16)
32
+ mock_redis (~> 0.18)
33
+ rake (~> 10.0)
34
+ redis (~> 4.0)
35
+ redis_batch_push!
36
+ rspec (~> 3.0)
37
+
38
+ BUNDLED WITH
39
+ 1.16.3
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Manoel Quirino Neto
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,96 @@
1
+ # RedisBatchPush
2
+
3
+ This gem provide a simple way to:
4
+
5
+ 1. watch a data in a redis queue
6
+ 2. cache this data (buffer)
7
+ 3. process this buffered data by time
8
+
9
+ ## Motivation
10
+
11
+ 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.
12
+
13
+ example:
14
+
15
+ your server receives:
16
+
17
+ ```
18
+ POST /view -d '{id: 1}'
19
+ POST /view -d '{id: 1}'
20
+ POST /view -d '{id: 2}'
21
+ POST /view -d '{id: 1}'
22
+ POST /view -d '{id: 3}'
23
+ ```
24
+
25
+ and for each post you should do
26
+
27
+ ```
28
+ model = Table.find(id)
29
+ model.view += 1
30
+ model.save
31
+ ```
32
+
33
+ with this gem you can reduce your data to make one incr by once
34
+
35
+ ```
36
+ # in post
37
+ redis.lpush queue, view
38
+
39
+ # in other work
40
+ runner = RedisBatchPush::Runner.new(redis_client, queue, max_size, max_interval_sec)
41
+ runner.run do |views|
42
+ views_by_id = views.inject({}) do |memo, item|
43
+ memo[item["id"]] ||= 0
44
+ memo[item["id"]] += 1
45
+ end
46
+
47
+ # Now you have to make 3 incr, 1 by id
48
+ print views_by_id
49
+
50
+ # {
51
+ # "1" => 3,
52
+ # "2" => 1,
53
+ # "3" => 1,
54
+ # }
55
+ end
56
+
57
+ ```
58
+
59
+
60
+ ## Installation
61
+
62
+ Add this line to your application's Gemfile:
63
+
64
+ ```ruby
65
+ gem 'redis_batch_push'
66
+ ```
67
+
68
+ And then execute:
69
+
70
+ $ bundle
71
+
72
+ Or install it yourself as:
73
+
74
+ $ gem install redis_batch_push
75
+
76
+ ## Usage
77
+
78
+ See examples
79
+
80
+ ## Development
81
+
82
+ 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.
83
+
84
+ 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).
85
+
86
+ ## Contributing
87
+
88
+ 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.
89
+
90
+ ## License
91
+
92
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
93
+
94
+ ## Code of Conduct
95
+
96
+ 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).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "redis_batch_push"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,18 @@
1
+ require "redis_batch_push"
2
+ require "redis"
3
+
4
+ queue = "redis_batch_push::example_queue"
5
+ # localhost
6
+ redis = Redis.new
7
+ max_interval_sec = 30
8
+ max_size = 20
9
+
10
+ t = Time.now
11
+
12
+ runner = RedisBatchPush::Runner.new(redis, queue, max_size, max_interval_sec)
13
+ runner.run do |data|
14
+ p 'data will be an array'
15
+ p "got some data #{data.size} #{data}"
16
+ p "ellapsed time #{Time.now - t}"
17
+ t = Time.now
18
+ end
@@ -0,0 +1,20 @@
1
+ require "redis_batch_push"
2
+ require "securerandom"
3
+ require "redis"
4
+
5
+ queue = "redis_batch_push::example_queue"
6
+ # localhost
7
+ redis = Redis.new
8
+
9
+
10
+ loop do
11
+ data = SecureRandom.hex
12
+ p "pushing #{data}"
13
+ redis.lpush(queue, data)
14
+
15
+ # if you want to see data printed by size
16
+ sleep 0.1
17
+
18
+ # if you want to see data printed by ellapsed time
19
+ sleep 1
20
+ end
@@ -0,0 +1,28 @@
1
+ require "redis_batch_push/version"
2
+ require "redis_batch_push/monitor"
3
+ require "redis_batch_push/getter"
4
+ require "redis_batch_push/processor"
5
+
6
+ module RedisBatchPush
7
+
8
+ class Runner
9
+ def initialize redis_client, queue, max_size=nil, max_interval_sec=nil
10
+ @redis_client = redis_client
11
+ @queue = queue
12
+ @max_size = max_size
13
+ @max_interval_sec = max_interval_sec
14
+ end
15
+
16
+ def run &block
17
+ getter = Getter.new(@redis_client, @queue)
18
+ blk = Proc.new do |data|
19
+ yield data
20
+ getter.clear_backup
21
+ end
22
+ processor = Processor.new(blk, @max_size, @max_interval_sec)
23
+ monitor = Monitor.new(getter, processor)
24
+ monitor.run
25
+ end
26
+ end
27
+
28
+ end
@@ -0,0 +1,38 @@
1
+ require 'securerandom'
2
+
3
+ module RedisBatchPush
4
+
5
+ class Getter
6
+ attr_reader :backup_queue
7
+
8
+ def initialize redis_client, queue
9
+ @redis_client = redis_client
10
+ @queue = queue
11
+ @backup_queue = "#{@queue}:backup:#{SecureRandom.hex}"
12
+ end
13
+
14
+ def get_next_item
15
+ @redis_client.brpoplpush(
16
+ @queue,
17
+ @backup_queue,
18
+ {
19
+ timeout: 5
20
+ }
21
+ )
22
+ end
23
+
24
+ def clear_backup
25
+ @redis_client.del(@backup_queue)
26
+ end
27
+
28
+ def restore_backups
29
+ @redis_client.keys("#{@queue}:backup:*").each do |bkp_queue|
30
+ loop do
31
+ break unless @redis_client.rpoplpush(bkp_queue, @queue)
32
+ end
33
+ @redis_client.del(bkp_queue)
34
+ end
35
+ end
36
+ end
37
+
38
+ end
@@ -0,0 +1,21 @@
1
+ module RedisBatchPush
2
+
3
+ class Monitor
4
+ def initialize getter, processor
5
+ @getter = getter
6
+ @processor = processor
7
+ end
8
+
9
+ def run
10
+ @getter.restore_backups
11
+
12
+ loop do
13
+ if item = @getter.get_next_item
14
+ @processor.process item
15
+ else
16
+ @processor.tick
17
+ end
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,47 @@
1
+ module RedisBatchPush
2
+
3
+ class Processor
4
+ def initialize block, max_size=nil, max_interval_sec=nil
5
+ @max_size = max_size
6
+ @max_interval_sec = max_interval_sec
7
+ validate!
8
+ @block = block
9
+
10
+ initialize_buffer
11
+ end
12
+
13
+ def initialize_buffer
14
+ @buffer = []
15
+ @buffer_start_time = Time.now
16
+ end
17
+
18
+ def validate!
19
+ if @max_size.nil? && @max_interval_sec.nil?
20
+ raise "You must inform max_size or max_interval_sec"
21
+ end
22
+ end
23
+
24
+ def process_current_time
25
+ Time.now
26
+ end
27
+
28
+ def must_send
29
+ by_buffer_size = @max_size && @buffer.size >= @max_size
30
+ by_interval_passed = @max_interval_sec && process_current_time - @buffer_start_time >= @max_interval_sec
31
+
32
+ by_buffer_size || by_interval_passed
33
+ end
34
+
35
+ def tick
36
+ if must_send && @buffer.size > 0
37
+ @block.call(@buffer)
38
+ initialize_buffer
39
+ end
40
+ end
41
+
42
+ def process item
43
+ @buffer << item
44
+ tick
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,3 @@
1
+ module RedisBatchPush
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,27 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "redis_batch_push/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "redis_batch_push"
8
+ spec.version = RedisBatchPush::VERSION
9
+ spec.authors = ["Manoel Quirino Neto"]
10
+ spec.email = ["manoelifpb@gmail.com"]
11
+
12
+ spec.summary = %q{Provides an easy way to queue some messages and push them in batches.}
13
+ spec.license = "MIT"
14
+
15
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
16
+ f.match(%r{^(test|spec|features)/})
17
+ end
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.16"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec", "~> 3.0"
25
+ spec.add_development_dependency "mock_redis", "~> 0.18"
26
+ spec.add_development_dependency "redis", "~> 4.0"
27
+ end
metadata ADDED
@@ -0,0 +1,134 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: redis_batch_push
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Manoel Quirino Neto
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-07-26 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: mock_redis
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.18'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.18'
69
+ - !ruby/object:Gem::Dependency
70
+ name: redis
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '4.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '4.0'
83
+ description:
84
+ email:
85
+ - manoelifpb@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".ruby-version"
93
+ - ".travis.yml"
94
+ - CODE_OF_CONDUCT.md
95
+ - Gemfile
96
+ - Gemfile.lock
97
+ - LICENSE.txt
98
+ - README.md
99
+ - Rakefile
100
+ - bin/console
101
+ - bin/setup
102
+ - examples/consumer.rb
103
+ - examples/producer.rb
104
+ - lib/redis_batch_push.rb
105
+ - lib/redis_batch_push/getter.rb
106
+ - lib/redis_batch_push/monitor.rb
107
+ - lib/redis_batch_push/processor.rb
108
+ - lib/redis_batch_push/version.rb
109
+ - redis_batch_push.gemspec
110
+ homepage:
111
+ licenses:
112
+ - MIT
113
+ metadata: {}
114
+ post_install_message:
115
+ rdoc_options: []
116
+ require_paths:
117
+ - lib
118
+ required_ruby_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ required_rubygems_version: !ruby/object:Gem::Requirement
124
+ requirements:
125
+ - - ">="
126
+ - !ruby/object:Gem::Version
127
+ version: '0'
128
+ requirements: []
129
+ rubyforge_project:
130
+ rubygems_version: 2.6.14
131
+ signing_key:
132
+ specification_version: 4
133
+ summary: Provides an easy way to queue some messages and push them in batches.
134
+ test_files: []