once 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8172b01a3e28f6aaa417166e71b88c7172596863
+  data.tar.gz: 0ea53bf46f8db4fde91bccfecc8d070fb8a1df1b
+SHA512:
+  metadata.gz: 88f0716b9fe70077e28bece1c4225a75becc08d0931ddcc768e12b401ddabcbe9355c24f4ce947c6b3bc86f30a8912ff078d12508b33041ea1a2fcb6caf9b3ce
+  data.tar.gz: 84235be3a2ad656371f0a430e5f0531ef5d7b9f3c5bec50ce0b93cf7d1fe57443134852635adc1f335bd14c78555d813f399f86254c1d57961e9472747034349

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Reverb.com, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,51 @@
+# Once
+
+Executes a block of code only once within a specified timeframe. Uses Redis to ensure uniqueness.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'once'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install once
+
+## Usage
+
+First, connect to redis:
+
+    Once.redis = Redis.new(...)
+
+If you don't specify the redis connection, we will assume the presence of a $redis global
+
+Now, use Once to wrap a call that you want done uniquely
+
+    Once.do(name: "sending_email", params: { email: "foo@bar.com" }, within: 1.hour) do
+      # executes once
+    end
+
+The combination of the name and params makes the check unique. So typically it would be the
+command you're executing, plus the params to that command
+
+## Notes
+
+This does not implement an atomic lock, nor does it take into account
+distributed locks across a cluster. This is more of a simple "probably
+guarantee uniqueness" implementation used to guard against things happening
+multiple times within minutes/hours/days, not milliseconds.
+
+See: [redlock](https://github.com/antirez/redlock-rb) for an example of distributed locking.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/once.rb

@@ -0,0 +1,48 @@
+require "once/version"
+require 'digest'
+
+# Usage:
+#
+# 1. Connect to redis:
+#    Once.redis = Redis.new(...)
+#
+# If you don't specify the redis connection, we will assume the presence of a $redis global
+#
+# 2. Use to wrap a call that you want done uniquely
+#   Once.do(name: "sending_email", params: { email: "foo@bar.com" }, within: 1.hour) do
+#     .. stuff that should happen only once ..
+#   end
+#
+# The combination of the name and params makes the check unique. So typically it would be the 
+# command you're executing, plus the params to that command
+module Once
+  DEFAULT_TIME = 3600 # seconds
+
+  class << self
+    def redis
+      @redis || $redis
+    end
+
+    def redis=(redis)
+      @redis = redis
+    end
+
+    # Checks the given params to see if this is a unique string
+    # If we've seen it within the expiry period (default: 1.hour),
+    # then we will not execute the block
+    #
+    # name: The name of the check, used as a namespace
+    # params: The params that will control whether or not the body executes
+    def do(name:, params:, within: DEFAULT_TIME, &block)
+      hash = Digest::MD5.hexdigest(params.inspect)
+      redis_key = "uniquecheck:#{name}:#{hash}"
+
+      unless redis.exists(redis_key)
+        block.call
+      end
+
+      redis.set(redis_key, true)
+      redis.expire(redis_key, within)
+    end
+  end
+end

data/lib/once/version.rb

@@ -0,0 +1,3 @@
+module Once
+  VERSION = "0.0.1"
+end

data/once.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'once/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "once"
+  spec.version       = Once::VERSION
+  spec.authors       = ["Yan Pritzker"]
+  spec.email         = ["yan@reverb.com"]
+  spec.description   = %q{Uses Redis to guarantee uniqueness for executing a particular command}
+  spec.summary       = %q{Execute commands only once within a specified period of time}
+  spec.homepage      = "https://github.com/reverbdotcom/once"
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakeredis"
+  spec.add_development_dependency "timecop"
+end

data/spec/once_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'once'
+require 'fakeredis/rspec'
+require 'timecop'
+
+describe Once do
+  before do
+    Once.redis = Redis.new
+  end
+
+  let(:thing_to_execute)  { double(execute: nil) }
+  let(:params) {{foo: "bar"}}
+
+  it "executes the given command" do
+    described_class.do(name: "mycheck", params: params) do
+      thing_to_execute.execute
+    end
+
+    thing_to_execute.should have_received(:execute).once
+  end
+
+  it "executes when called from within different namespaces" do
+    described_class.do(name: "mycheck1", params: params) do
+      thing_to_execute.execute
+    end
+    described_class.do(name: "mycheck2", params: params) do
+      thing_to_execute.execute
+    end
+
+    thing_to_execute.should have_received(:execute).twice
+  end
+
+  it "executes when given different params" do
+    described_class.do(name: "mycheck", params: {foo: "bar"}) do
+      thing_to_execute.execute
+    end
+    described_class.do(name: "mycheck", params: {baz: "quux"}) do
+      thing_to_execute.execute
+    end
+
+    thing_to_execute.should have_received(:execute).twice
+  end
+
+  it "does not execute twice within a period of time" do
+    2.times do
+      described_class.do(name: "mycheck", params: params) do
+        thing_to_execute.execute
+      end
+    end
+
+    thing_to_execute.should have_received(:execute).once
+  end
+
+  it "treats different groups of params independently" do
+    # Prevents a bug where we overwrite the uniqueness key
+    # when we were doing a get(key) == hash check instead of
+    # using the hash as part of the unique identifier
+
+    2.times do
+      described_class.do(name: "mycheck", params: {foo: "bar"}) do
+        thing_to_execute.execute
+      end
+      described_class.do(name: "mycheck", params: {baz: "quux"}) do
+        thing_to_execute.execute
+      end
+      described_class.do(name: "mycheck", params: {foo: "bar"}) do
+        thing_to_execute.execute
+      end
+    end
+
+    thing_to_execute.should have_received(:execute).twice
+  end
+
+  it "executes again after the time period passes" do
+    described_class.do(name: "mycheck", within: 60, params: params) do
+      thing_to_execute.execute
+    end
+
+    Timecop.travel(DateTime.now + 61) do
+      described_class.do(name: "mycheck", within: 60, params: params) do
+        thing_to_execute.execute
+      end
+    end
+
+    thing_to_execute.should have_received(:execute).twice
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: once
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yan Pritzker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: fakeredis
+  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'
+description: Uses Redis to guarantee uniqueness for executing a particular command
+email:
+- yan@reverb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/once.rb
+- lib/once/version.rb
+- once.gemspec
+- spec/once_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/reverbdotcom/once
+licenses:
+- Apache License, Version 2.0
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Execute commands only once within a specified period of time
+test_files:
+- spec/once_spec.rb
+- spec/spec_helper.rb