redis_dedupe 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75665204b3b1c72866624a2cb948eea5e7ec59db
+  data.tar.gz: d8472403d0a7711f7255b3662697dc58aa2131c2
+SHA512:
+  metadata.gz: 848327df6eb7833b69bc55575a0c33b5d0c82ae9d09fc3dcf2ab20cf35d6d24554fd82d23f71400e647a7e71201d480b6fd4572ee9e3168e6aa3f46921299b4c
+  data.tar.gz: 8672ea3ee0be153a2fe786d9143d23ef6e998eef2dd9501389d5dd0eb3f12df287e8f22810d3d61ca345465f14194feaf8226d993b79d0484c3e44a2b71df9bd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andy Huynh
+
+MIT License
+
+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,40 @@
+# RedisDedupe
+
+This is a weak deduper to make things like bulk email run safer. It is not a lock safe for financial/security needs because it uses a weak redis locking pattern that can have race conditions.
+
+However, imagine a bulk email job that loops over 100 users, and enqueues a background email for each user. If the job fails at iteration 50, a retry would enqueue all the users again and many will receive dupes. This would continue multiple times as the parent job continued to rerun. By marking that a subjob has been enqueued, we can let that isolated job handle its own failures, and the batch enqueue job can run multiple times without re-enqueueing the same subjobs. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_dedupe'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_dedupe
+
+## Usage
+
+```ruby
+comment_id = 42
+dedupe = RedisDedupe::Set.new($redis, "comment:42:notification")
+
+users.each do |user|
+  dedupe.check(user.id) do
+    send_email_to(user, comment_id)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redis_dedupe/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+

data/lib/redis_dedupe.rb

@@ -0,0 +1,64 @@
+require 'redis_dedupe/version'
+
+module RedisDedupe
+  class<<self
+    attr_accessor :client
+  end
+
+  class Set
+    SEVEN_DAYS = 7 * 24 * 60 * 60
+
+    attr_reader :key, :expires_in
+
+    def initialize(redis, key, expires_in = Time.now + SEVEN_DAYS)
+      @redis      = redis
+      @key        = key
+      @expires_in = expires_in
+    end
+
+    def check(member)
+      results = redis.pipelined do
+        redis.sadd(key, member)
+        redis.expire(key, expires_in)
+      end
+
+      if results[0]
+        yield
+      end
+    end
+
+    def finish
+      redis.del(key)
+    end
+
+    private
+
+    def redis
+      @redis
+    end
+  end
+
+  module Helpers
+    private
+
+    def dedupe
+      @dedupe ||= RedisDedupe::Set.new(RedisDedupe.client, [dedupe_namespace, dedupe_id].join(':'))
+    end
+
+    # Implement in class, should return an integer or string:
+    #
+    # Ex.
+    #
+    #   def dedupe_id
+    #     @announcement.id # => 42
+    #   end
+    #
+    def dedupe_id
+      raise NotImplementedError
+    end
+
+    def dedupe_namespace
+      self.class.name
+    end
+  end
+end

data/lib/redis_dedupe/version.rb

@@ -0,0 +1,3 @@
+module RedisDedupe
+  VERSION = "0.0.2"
+end

data/redis_dedupe.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_dedupe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_dedupe"
+  spec.version       = RedisDedupe::VERSION
+  spec.authors       = ["Andy Huynh"]
+  spec.email         = ["andy4thehuynh@gmail.com"]
+  spec.summary       = %q{ A weak deduper to make things like bulk email run safer. }
+  spec.description   = %q{ This is a weak deduper to make things like bulk email run safer. It is not a lock safe for financial/security needs because it uses a weak redis locking pattern that can have race conditions. However, imagine a bulk email job that loops over 100 users, and enqueues a background email for each user. If the job fails at iteration 50, a retry would enqueue all the users again and many will receive dupes. This would continue multiple times as the parent job continued to rerun. By marking that a subjob has been enqueued, we can let that isolated job handle its own failures, and the batch enqueue job can run multiple times without re-enqueueing the same subjobs. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "mock_redis"
+end

data/spec/redis_dedupe_spec.rb

@@ -0,0 +1,56 @@
+require 'redis_dedupe'
+require 'mock_redis'
+require 'spec_helper'
+
+describe RedisDedupe::Set do
+  it "is initialized with a redis client and key" do
+    dedupe = RedisDedupe::Set.new(:redis, :key)
+    expect(dedupe.key).to eq(:key)
+  end
+
+  it "defaults expires_in to 7 days" do
+    dedupe = RedisDedupe::Set.new(:redis, :key)
+    expect(dedupe.expires_in.to_i).to eq((Time.now + (7*24*60*60)).to_i)
+  end
+
+  it "optionally receives an expires_in time" do
+    dedupe = RedisDedupe::Set.new(:redis, :key, (Time.now + (7*24*60)).to_i)
+    expect(dedupe.expires_in.to_i).to eq((Time.now + (7*24*60)).to_i)
+  end
+end
+
+describe RedisDedupe::Set, "#check" do
+  it "prevents a block from yielding multiple times for the same member" do
+    dedupe1 = RedisDedupe::Set.new(MockRedis.new, 'spec_key:1')
+    dedupe2 = RedisDedupe::Set.new(MockRedis.new, 'spec_key:2')
+
+    @results = []
+
+    dedupe1.check('1') { @results << 'A' }
+    dedupe1.check('1') { @results << 'B' }
+    dedupe2.check('1') { @results << 'C' }
+
+    expect(@results).to eq(['A', 'C'])
+  end
+
+  it "sets the set to expire so it cleans up if the process never completes" do
+    redis  = MockRedis.new
+    dedupe = RedisDedupe::Set.new(redis, 'spec_key:1', 10)
+
+    dedupe.check('1') {  }
+
+    expect(redis.ttl 'spec_key:1').to be_within(1).of(10)
+  end
+end
+
+describe RedisDedupe::Set, "#finish" do
+  it "removes the set to free up memory" do
+    redis  = MockRedis.new
+    dedupe = RedisDedupe::Set.new(redis, 'spec_key:1')
+
+    dedupe.check('1') {  }
+    dedupe.finish
+
+    expect(redis.exists 'spec_key:1').to be(false)
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: redis_dedupe
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andy Huynh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: 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'
+description: " This is a weak deduper to make things like bulk email run safer. It
+  is not a lock safe for financial/security needs because it uses a weak redis locking
+  pattern that can have race conditions. However, imagine a bulk email job that loops
+  over 100 users, and enqueues a background email for each user. If the job fails
+  at iteration 50, a retry would enqueue all the users again and many will receive
+  dupes. This would continue multiple times as the parent job continued to rerun.
+  By marking that a subjob has been enqueued, we can let that isolated job handle
+  its own failures, and the batch enqueue job can run multiple times without re-enqueueing
+  the same subjobs. "
+email:
+- andy4thehuynh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_dedupe.rb
+- lib/redis_dedupe/version.rb
+- redis_dedupe.gemspec
+- spec/redis_dedupe_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A weak deduper to make things like bulk email run safer.
+test_files: []
+has_rdoc: