lita-timing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96f734b887a989426e7d3bfda449f1e050b164eb
+  data.tar.gz: 60797820ff5fb0aa13053a4da02a3bfdca2ef182
+SHA512:
+  metadata.gz: 70952579da7d3d7ed7a09e90c495d8bf873517800269876894e92bfff7ada11ab3dc28e0115fc0d2c23905bd868e38db6567d882992e8e918abcc9181f0f5026
+  data.tar.gz: f054f0913f9cb4b957bc90801a8b2d30de070a11160d5e035ec5d0b52a2be4c8f91808448f4bda6d64601700d57519e51228b66e19bb5e6c12a8126f8d809b63

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 James Healy
+
+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,56 @@
+# lita-timing
+
+A small collection of utility classes that make it easier to work with time, recurring
+events and rate limits in lita.
+
+## Installation
+
+Add this gem to your lita installation by including the following line in your Gemfile:
+
+    gem "lita-timing"
+
+## Usage
+
+This gem is not a lita handler or plugin in its own right, but it is easily used
+by other lita plugins.
+
+### Rate Limits
+
+lita comes with an "every" helper that executes a block of code at fixed
+intervals. However the interval is only stored in memory, which means
+long intervals will often be reset if the lita process restarts (like
+during a deploy).
+
+For handlers that want to execute code at fixed intervals, the RateLimit
+class can be used in conjunction with the built in every() helper:
+
+    one_minute = 60
+    one_week = 60 + 60 + 24 + 7
+    every(one_minute) do
+      RateLimit.new("interval-name", redis).once_every(one_week) do
+        # weekly code in here
+      end
+    end
+
+### Sliding Windows
+
+Sometimes a handler wants to periodically execute a block of code with a start
+and end time, and ensure that every minute of the day is handled by one of the
+executions. The text-book use case is polling an external API for updates within
+a time range.
+
+The SlidingWindow class can help. For best results, use it in conjunction with the 
+built in every() helper.
+
+Redis is used to persist the end of the last window that executed and ensure the
+block doesn't execute again until that window is passed.
+
+    window = SlidingWindow.new("my-sliding-window", redis)
+    every(one_minute) do
+      window.advance(duration_minutes: 30) do |window_start, window_end|
+        puts "#{window_start} -> #{window_end}"
+      end
+    end
+
+Call this as often as you like, and the block passed to advance() will
+only execute if it's been 30 minutes since the last time it executed.

data/lib/lita-timing.rb

@@ -0,0 +1,2 @@
+require 'lita/timing/rate_limit'
+require 'lita/timing/sliding_window'

data/lib/lita/timing/rate_limit.rb

@@ -0,0 +1,22 @@
+module Lita
+  module Timing
+    class RateLimit
+      def initialize(name, redis)
+        @name, @redis = name, redis
+      end
+
+      def once_every(seconds, &block)
+        if last_time.nil? || last_time + seconds < Time.now
+          yield
+          @redis.set(@name, Time.now.to_i)
+        end
+      end
+
+      def last_time
+        value = @redis.get(@name)
+        value ? Time.at(value.to_i).utc : nil
+      end
+
+    end
+  end
+end

data/lib/lita/timing/sliding_window.rb

@@ -0,0 +1,41 @@
+module Lita
+  module Timing
+    class SlidingWindow
+      def initialize(name, redis)
+        @name, @redis = name, redis
+
+        initialise_last_time_if_not_set
+      end
+
+      def advance(duration_minutes: 30, buffer_minutes: 0, &block)
+        start_time = Time.now - mins_to_seconds(duration_minutes) - mins_to_seconds(buffer_minutes)
+        advance_to = start_time + mins_to_seconds(duration_minutes)
+
+        return unless start_time > last_time
+
+        yield last_time, advance_to 
+
+        @redis.set(@name, advance_to.to_i)
+      end
+
+      private
+
+      def mins_to_seconds(mins)
+        mins * 60
+      end
+
+      def last_time
+        Time.at(@redis.get(@name).to_i)
+      end
+
+      def initialise_last_time_if_not_set
+        @redis.setnx(@name, two_weeks_ago.to_i)
+      end
+
+      def two_weeks_ago
+        ::Time.now - (60 * 60 * 24 * 14)
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: lita-timing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-12 00:00:00.000000000 Z
+dependencies:
+- !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: '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: pry
+  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: rdoc
+  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: Provides utilities that help with repeating tasks and rate limits
+email:
+- james.healy@theconversation.edu.au
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- MIT-LICENSE
+files:
+- MIT-LICENSE
+- README.md
+- lib/lita-timing.rb
+- lib/lita/timing/rate_limit.rb
+- lib/lita/timing/sliding_window.rb
+homepage: http://github.com/yob/lita-timing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Utilities for time related tasks in lita
+test_files: []