forever-alone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b052ede07b7ad7b53c3e94df548f0b037fcdd6de
+  data.tar.gz: d376c64a2b1bf946d113320f2b2195bb8316491c
+SHA512:
+  metadata.gz: 494cd2f686bfdb9925d38eb84a38b9f9caf8fcd99789cb1546e9c98183c925fc189518b0ba0e2fe108b999a261c3fb16103b6f94728d3814c596d831e66af276
+  data.tar.gz: 25d7a78b4fe7eddf6d0cffa359efdd747319fcbb97b0eaa1d14f8fb29c3674750973c61886be1efc4a9a73af57e4537df18e019b5d08b66e1047e2133e5f31f7

data/.gitignore

@@ -0,0 +1,25 @@
+*.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
+.todo
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - ruby-head
+  - jruby
+  - rbx-2
+cache:
+  - apt
+  - bundler
+script:
+  - bundle exec rspec spec/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rustam Sharshenov
+
+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,60 @@
+# ForeverAlone
+[![Build Status](https://travis-ci.org/Spalmalo/forever-alone.svg)](https://travis-ci.org/Spalmalo/forever-alone)
+
+This gem uses Redis to keep a list of recent text messages. ForeverAlone calculates hex digests of message and stores them into the Redis with a given expiration period.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'forever-alone'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install forever-alone
+
+## Usage
+
+
+```ruby
+  # init ForeverAlone with default timeout(30 minutes)
+  forever_alone = ForeverAlone.new("some message")
+
+  # or with custom timeout
+  forever_alone = ForeverAlone.new("some message", 5.minutes)
+
+  # check if given message is unique
+  forever_alone.unique?
+
+  # remember this message
+  forever_alone.remember
+
+  # OR just ensure that message is unique and raise ForeverAlone::MessageIsNotUnique error otherwise
+  forever_alone.ensure
+```
+
+## Configuration
+
+Here is ForeverAlone default configuration:
+
+```ruby
+ForeverAlone.configure do |config|
+  config.digest     = Digest::MD5 # you can switch to Digest::SHA1
+  config.timeout    = 1_800       # default expiration period
+  config.namespace  = :locks      # prefix to Redis keys "locks:df49b60423903e095b80d9b4a92eb065"
+end
+```
+
+You can configure redis connection with `REDIS_URL` environment variable.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/forever-alone/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,2 @@
+require "bundler/gem_tasks"
+

data/forever-alone.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'forever-alone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "forever-alone"
+  spec.version       = ForeverAlone::VERSION
+  spec.authors       = ["Rustam Sharshenov"]
+  spec.email         = ["rustam@sharshenov.com"]
+  spec.summary       = "Ensure text uniqueness in period of time."
+  spec.description   = "This gem uses Redis to keep a list of recent text messages. ForeverAlone calculates hex digests of message and stores them into the Redis with a given expiration period."
+  spec.homepage      = "https://github.com/Spalmalo/forever-alone"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "redis", "~> 3.0", "> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.2", ">= 3.2.0"
+  spec.add_development_dependency "fakeredis", "~> 0.5.0"
+end

data/lib/forever-alone.rb

@@ -0,0 +1,31 @@
+require "digest"
+require "redis"
+require "forever-alone/errors"
+require "forever-alone/configuration"
+require "forever-alone/validator"
+require "forever-alone/version"
+
+module ForeverAlone
+  class << self
+    attr_writer :configuration
+    attr_writer :redis
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def redis
+      @redis ||= Redis.new
+    end
+
+    def new message, timeout=nil
+      Validator.new message, timeout
+    end
+
+  end
+
+end

data/lib/forever-alone/configuration.rb

@@ -0,0 +1,19 @@
+module ForeverAlone
+  class Configuration
+
+    DEFAULTS = {
+      digest:     Digest::MD5,
+      timeout:    1_800,        # 30 minutes
+      namespace:  :locks
+    }.freeze
+
+    DEFAULTS.keys.each do |key|
+      attr_writer key
+
+      define_method key do
+        instance_variable_get("@#{ key }") || DEFAULTS.fetch(key)
+      end
+    end
+
+  end
+end

data/lib/forever-alone/errors.rb

@@ -0,0 +1,3 @@
+module ForeverAlone
+  class MessageIsNotUnique < StandardError; end
+end

data/lib/forever-alone/validator.rb

@@ -0,0 +1,40 @@
+module ForeverAlone
+  class Validator
+
+    attr_reader :message, :timeout
+
+    def initialize message, timeout=nil
+      @message = message
+      @timeout = timeout || ForeverAlone.configuration.timeout
+    end
+
+    def unique?
+      ForeverAlone.redis.get(key).nil?
+    end
+
+    def remember
+      ForeverAlone.redis.setex key, timeout, 'foo'
+    end
+
+    def ensure
+      raise ForeverAlone::MessageIsNotUnique, self.inspect unless unique?
+      remember
+    end
+
+    def key
+      @key ||= generate_key
+    end
+
+    private
+
+      def generate_key
+        digest = ForeverAlone.configuration.digest.hexdigest message
+
+        [
+          ForeverAlone.configuration.namespace,
+          digest
+        ].join(':')
+      end
+
+  end
+end

data/lib/forever-alone/version.rb

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

data/lib/forever/alone.rb

@@ -0,0 +1 @@
+require "forever-alone"

data/spec/forever-alone/configuration_spec.rb

@@ -0,0 +1,48 @@
+describe ForeverAlone do
+  describe ".configuration" do
+
+    subject { described_class.configuration }
+
+    context "when custom configuration provided" do
+      before do
+        described_class.configure do |config|
+          config.digest     = Digest::SHA1
+          config.timeout    = 300
+          config.namespace  = 'custom'
+        end
+      end
+
+      after do
+        described_class.configuration = nil
+      end
+
+      it "should have proper digest" do
+        expect(subject.digest).to eq Digest::SHA1
+      end
+
+      it "should have proper timeout" do
+        expect(subject.timeout).to eq 300
+      end
+
+      it "should have proper namespace" do
+        expect(subject.namespace).to eq 'custom'
+      end
+    end
+
+    context "when no custom configuration provided" do
+
+      it "should have proper digest" do
+        expect(subject.digest).to eq Digest::MD5
+      end
+
+      it "should have proper timeout" do
+        expect(subject.timeout).to eq 1800
+      end
+
+      it "should have proper namespace" do
+        expect(subject.namespace).to eq :locks
+      end
+
+    end
+  end
+end

data/spec/forever-alone/new_spec.rb

@@ -0,0 +1,15 @@
+describe ForeverAlone do
+  describe ".new" do
+    subject { described_class.new "message", 300 }
+
+    it { is_expected.to be_a ForeverAlone::Validator }
+
+    it "should have proper message" do
+      expect(subject.message).to eq "message"
+    end
+
+    it "should have proper timeout" do
+      expect(subject.timeout).to eq 300
+    end
+  end
+end

data/spec/forever-alone/redis_spec.rb

@@ -0,0 +1,7 @@
+describe ForeverAlone do
+  describe ".redis" do
+    subject { described_class.redis }
+
+    it { is_expected.to be_a Redis }
+  end
+end

data/spec/forever-alone/validator/ensure_spec.rb

@@ -0,0 +1,30 @@
+describe ForeverAlone::Validator, "#ensure" do
+  subject { validator.ensure }
+
+  let!(:validator) { described_class.new "some message" }
+
+  before { allow(validator).to receive(:remember) }
+
+  context "when message is unique" do
+    before { allow(validator).to receive(:unique?).and_return true }
+
+    it "should raise no error" do
+      expect { subject }.not_to raise_error
+    end
+
+    it "should remember message" do
+      subject
+      expect(validator).to have_received(:remember)
+    end
+
+  end
+
+  context "when message is not unique" do
+    before { allow(validator).to receive(:unique?).and_return false }
+
+    it "should raise ForeverAlone::MessageIsNotUnique error" do
+      expect { subject }.to raise_error ForeverAlone::MessageIsNotUnique
+    end
+
+  end
+end

data/spec/forever-alone/validator/key_spec.rb

@@ -0,0 +1,17 @@
+describe ForeverAlone::Validator, "#key" do
+  subject { validator.key }
+
+  let!(:validator) { described_class.new "some message" }
+
+  context "when digest is Digest::MD5" do
+    before { allow(ForeverAlone.configuration).to receive(:digest).and_return Digest::MD5 }
+
+    it { is_expected.to eq "locks:df49b60423903e095b80d9b4a92eb065" }
+  end
+
+  context "when digest is Digest::SHA1" do
+    before { allow(ForeverAlone.configuration).to receive(:digest).and_return Digest::SHA1 }
+
+    it { is_expected.to eq "locks:af52b1a96761839824b7b4c0e6cea4b09f2b0710" }
+  end
+end

data/spec/forever-alone/validator/remember_spec.rb

@@ -0,0 +1,14 @@
+describe ForeverAlone::Validator, "#remember" do
+  subject { validator.remember }
+
+  let!(:validator) { described_class.new "some message", 10 }
+
+  before do
+    allow(validator).to receive(:key).and_return "locks:awesome"
+  end
+
+  it "should create new Redis record" do
+    subject
+    expect(ForeverAlone.redis.get("locks:awesome")).to eq "foo"
+  end
+end

data/spec/forever-alone/validator/unique_spec.rb

@@ -0,0 +1,15 @@
+describe ForeverAlone::Validator, "#unique?" do
+  subject { validator.unique? }
+
+  let!(:validator) { described_class.new "some message", 10 }
+
+  context "when message is unique for a given period" do
+    it { is_expected.to eq true }
+  end
+
+  context "when message is not unique for a given period" do
+    before { validator.remember }
+
+    it { is_expected.to eq false }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+require 'fakeredis/rspec'
+require 'forever-alone'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: forever-alone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rustam Sharshenov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: This gem uses Redis to keep a list of recent text messages. ForeverAlone
+  calculates hex digests of message and stores them into the Redis with a given expiration
+  period.
+email:
+- rustam@sharshenov.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- forever-alone.gemspec
+- lib/forever-alone.rb
+- lib/forever-alone/configuration.rb
+- lib/forever-alone/errors.rb
+- lib/forever-alone/validator.rb
+- lib/forever-alone/version.rb
+- lib/forever/alone.rb
+- spec/forever-alone/configuration_spec.rb
+- spec/forever-alone/new_spec.rb
+- spec/forever-alone/redis_spec.rb
+- spec/forever-alone/validator/ensure_spec.rb
+- spec/forever-alone/validator/key_spec.rb
+- spec/forever-alone/validator/remember_spec.rb
+- spec/forever-alone/validator/unique_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Spalmalo/forever-alone
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ensure text uniqueness in period of time.
+test_files:
+- spec/forever-alone/configuration_spec.rb
+- spec/forever-alone/new_spec.rb
+- spec/forever-alone/redis_spec.rb
+- spec/forever-alone/validator/ensure_spec.rb
+- spec/forever-alone/validator/key_spec.rb
+- spec/forever-alone/validator/remember_spec.rb
+- spec/forever-alone/validator/unique_spec.rb
+- spec/spec_helper.rb