dont_repeat_for 1.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6a2223e610c2c4a6359c0aee70254bb04960a4f
+  data.tar.gz: 652200549e9120537b7130961fe302b73b08d94e
+SHA512:
+  metadata.gz: fe2dededa9102667c038ef3c6fa44aa49b0d3cacbd54ef9898f1a4171d002e10a620cfc5d3dcfa05aad89398a44d136556e4dbcacf0250b8eff3c9f120f93834
+  data.tar.gz: d1410275b765fb7e55780f194ec3554074c852ca5ae2801c95084ad130ed331157a9e0667e07a068c5d8fbbd80d84d31293294a6c9fe4d0590012b65f1280609

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/.idea
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+ - "2.1.0"
+ - "2.2.3"
+script: 'bundle exec rake'
+notifications:
+  email:
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at najibkaake@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jay El-Kaake
+
+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,81 @@
+# Don't Repeat For Gem
+
+Runs a block only once in the given time frame and lets you make sure it doesn't repeat more than the times you specify per time block. 
+
+Uses redis to know if we've run the block before.
+
+### Why?
+Sometimes you don't want to flood your logs with repeated messages, or you want to make sure notifications are not send multiple times to your messaging groups.
+
+**Table of Contents**
+* [Installation](#installation)
+* [Usage](#usage)
+* [Other Things](#Other_Things)
+
+# Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'dont_repeat_for'
+```
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install dont_repeat_for
+
+### Requirements
+Requires `redis` to be available and installed. That's what it will use for memory.
+
+
+# Usage
+```ruby
+  ##
+  # @param time [Integer] The amount of seconds that we don't want to repeat the process for
+  # @param key [String]  A unique key to identify the process that we don't want to repeat for the given time
+  def initialize(time, key)
+```
+
+### Example 1: Global Key
+
+```ruby
+20.times do
+  DontRepeatFor.new("Everyone/Test", 1.second) { puts "This message will only be displayed once every 1 second."; }
+end
+sleep(1.second)
+DontRepeatFor.new("Everyone/Test", 1.second) { puts "This message will only be displayed once every 1 second."; }
+
+# Output:
+# This message will only be displayed once every 1 second.
+# This message will only be displayed once every 1 second.
+```
+
+### Example 2: User Key
+
+```ruby
+user1 = User.new(id: -1)
+user2 = User.new(id: -2)
+20.times do
+  DontRepeatFor.new("User-#{user1.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user1.id}."; }
+  DontRepeatFor.new("User-#{user2.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user2.id}."; }
+end
+sleep(1.second)
+DontRepeatFor.new("User-#{user1.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user1.id}."; }
+DontRepeatFor.new("User-#{user2.id}/Test", 1.second) { puts "This message will only be displayed once every 1 second for user #{user2.id}."; }
+
+# Output:
+# This message will only be displayed once every 1 second for user -1.
+# This message will only be displayed once every 1 second for user -2.
+# This message will only be displayed once every 1 second for user -1.
+# This message will only be displayed once every 1 second for user -2.
+```
+
+# Other Things
+### Roadmap
+* Make this system compatible with memory-baseds storage and other data storage systems.
+
+### Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/jayelkaake/dont_repeat_for.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+### License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activemodel_flags"
+
+# 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

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/dont_repeat_for.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dont_repeat_for/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dont_repeat_for"
+  spec.version       = DontRepeatFor::VERSION
+  spec.authors       = ["Jay El-Kaake"]
+  spec.email         = ["najibkaake@gmail.com"]
+
+  spec.summary       = %q{Adds beautifully readable true/false flags to user and account active models (like devise).}
+  spec.description   = %q{This gem adds the ability for models to have an unlimited number of custom flags \
+                        that are stored within one database column cell instead of several columns.}
+  spec.homepage      = "https://www.github.com/jayelkaake/dont_repeat_for"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rails", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "temping", "~> 3.3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.4'
+  spec.add_development_dependency "sqlite3", '~> 1.3.11'
+
+end

data/lib/dont_repeat_for/version.rb

@@ -0,0 +1,3 @@
+class DontRepeatFor
+    VERSION = '1.0.0.0'
+end

data/lib/dont_repeat_for.rb

@@ -0,0 +1,56 @@
+require "dont_repeat_for/version"
+
+##
+# Runs a block only once in the given time frame
+# Uses redis to know if we've run the block before.
+# Example 1:
+# ```ruby
+#   20.times do
+#     DontRepeatFor.new("test_dont_repeat/test", 5.minutes) { puts "This message will only be displayed once every 5 minutes.";
+#     sleep(1.minute)
+#   end
+# ```
+#
+# @hint: You can include an ID in the key to enforce rate limiting for a specific store.
+class DontRepeatFor
+  attr_accessor :key, :time
+
+  ##
+  # @param time [Integer] The amount of seconds that we don't want to repeat the process for
+  # @param key [String]  A unique key to identify the process that we don't want to repeat for the given time
+  def initialize(time, key)
+    @key = key
+    @time = time.to_i
+
+    return nil if ran_recently?
+
+    remember_not_to_repeat!
+
+    yield
+  end
+
+  private
+
+  def remember_not_to_repeat!
+    redis.set(storage_key, true, ex: time)
+  end
+
+  def ran_recently?
+    redis.get(storage_key)
+  end
+
+  def storage_key
+    @storage_key ||= "DontRepeatFor/Keys/#{@key}"
+  end
+
+  def redis
+    return $redis if defined?($redis)
+
+    self.class.redis
+  end
+
+  def self.redis
+    @redis ||= Redis.new
+  end
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: dont_repeat_for
+version: !ruby/object:Gem::Version
+  version: 1.0.0.0
+platform: ruby
+authors:
+- Jay El-Kaake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+description: |-
+  This gem adds the ability for models to have an unlimited number of custom flags \
+                          that are stored within one database column cell instead of several columns.
+email:
+- najibkaake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dont_repeat_for.gemspec
+- lib/dont_repeat_for.rb
+- lib/dont_repeat_for/version.rb
+homepage: https://www.github.com/jayelkaake/dont_repeat_for
+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.10
+signing_key: 
+specification_version: 4
+summary: Adds beautifully readable true/false flags to user and account active models
+  (like devise).
+test_files: []