goalkeeper 0.0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e12557dafed1d9031a7a11e69d2c4acd39665cf8
-  data.tar.gz: 87d0150ba4b4b3c6f72d6577308f3dbbb60d30b3
+  metadata.gz: 151b87201e8fbaa657d6aad6ef7aed33f8bf328a
+  data.tar.gz: 5a2b70b08cc0aa919d13cd3283300240d1895cdc
 SHA512:
-  metadata.gz: 5053c93b993f256c6b91000713ed079058a0b1179cd6ca58e0aeefb5e6ec8dd69188ba091ed8bb5e23f1dd8fdede9e72ba348e01c408a9066521da81e08c5fa0
-  data.tar.gz: 2eafd8b2593bd2f4ce935089fceb606f2ee954a412d771558ce349f5a00c56aebfe7d92f2d7d1d0036326ec13ed6862ffba10a91004dad9d0ad9d20310ddc747
+  metadata.gz: 2bb9d5d7819f6f778525ce4d1fbb638ac986f4a3644b26c306e07292396d8207adbb9499421fd33ce5f17034f03dc71c97cb3e893be537b3e761af16da1b3270
+  data.tar.gz: 55e43ca0fe7926ef24984da40b29f82af3dd8e9ff48d111b01e932e130a73dc9379ec16b59044d2802b6d1bdaf3bdbd016fde60bef2863cb0f65f8ac85c4dccd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Weir, Pharos Enterprise Intelligence LLC
+
+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/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
+task default: [:test]
+
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = "test/*_test.rb"

data/goalkeeper.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["John Weir"]
   spec.email         = ["john@smokinggun.com"]
   spec.summary       = %q{A Todo App for your application.}
-  spec.description   = %q{Goalkeeper is a system for validation that specific goals have been met by an application.}
-  spec.homepage      = ""
+  spec.description   = %q{Goalkeeper is a system for verifing if specific goals have been met by an application.}
+  spec.homepage      = "https://github.com/jweir/goalkeeper"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/goalkeeper.rb

@@ -1,17 +1,101 @@
 require "goalkeeper/version"
 require 'forwardable'
 require 'redis'
-
+require 'time' # for Time.parse
+
+# Goalkeeper provides methods to track if specific events(Goals) have been completed(met).
+#
+# It is not a complicated system and it is easy enough to roll your own.  This
+# is an extraction from a system Pharos EI has been using.
+#
+# A Goal is just a unique string. It is up to your application to
+# define any schema for the Goal's label.
+#
+# For example you might have your Goals labeled by date and company id:
+#   "job:2016-01-17:company:7"
+#
+# When a Goal is met a record is created in Redis with a timestamp, this is the only
+# persistent layer.
+#   Goalkeeper.met!("jobkey")
+#   # or
+#   Goalkeeper::Goal.new("jobkey").met!
+#
+# To check if a Goal as been met
+#   Goalkeeper::Goal.new("jobkey").met?
+#
+# Customize the redis client by setting it in your application
+#   Goalkeeper.redis = your_redis_client
+#
+# Each record has a default expiration of 24 hours, but this can be modified.
+#   Goalkeeper.expiration = number_of_seconds
+#
+# Redis keys are stored under the default namespace of "Goalkeeper:". The namespace can be configured:
+#
+#   Goalkeeper.namespace = string
+#
 class Goalkeeper
 
+  # Set the Redis client to a non default setting
+  def self.redis=(redis)
+    @redis = redis
+  end
+
+  def self.redis
+    @redis ||= Redis.new
+  end
+
   # Creates a persistent Goal market with the given label.
   def self.met!(label)
     Goal.new(label).met!
   end
 
+  # The TTL set for each met Goal record created in Redis
+  # Default is 24 hours
+  def self.expiration
+    @expiration ||= 24 * 60 * 60
+  end
+
+  # Overwrite the default expiration
+  def self.expiration=(number_of_seconds)
+    @expiration = number_of_seconds
+  end
+
+  def self.namespace
+    @namespace ||= "Goalkeeper"
+  end
+
+  def self.namespace=(ns)
+    @namespace = ns
+  end
+
+  # List is a collection of Goals to simplify tracking multiple goals.
+  #
+  # Create a new list
+  #   mylist = Goalkeeper::List.new
+  #
+  # Add Goals you want to check for completion
+  #   mylist.add("job1").add("job2")
+  #   mylist.size
+  #   #=> 2
+  #
+  # Check if all the goals are completed
+  #   mylist.met?
+  #   #=> false
+  #
+  # Get the unmet Goals
+  #   mylist.unmet
+  #   #=> [...]
+  #
+  # Get the met Goals
+  #   mylist.met
+  #   #=> [...]
+  #
+  # Iterate all Goals
+  #   myslist.each {|goal| ...}
+  #   myslist.map  {|goal| ...}
   class List
     extend Forwardable
-    def_delegators :@list, :size, :[]
+    def_delegators :@list, :size, :[], :each, :map
 
     def initialize
       @list = []
@@ -24,6 +108,7 @@ class Goalkeeper
       self
     end
 
+    # met? returns true if all Goals in the set have been met.
     def met?
       unmet.empty?
     end
@@ -38,61 +123,62 @@ class Goalkeeper
   end
 
   class Goal
+    # The unique label to identify this Goal
     attr_reader :label
+
+    # An optional object refrence which allows an application author to
+    # associate this goal to an object. The +ref+ is not used by Goalkeeper.
     attr_reader :ref
 
-    # +label+ is a unique string to identify this demand.
+    # the TTL value for the Redis record.  Defalts to Goalkeeper.expiration
+    attr_reader :expiration
+
+    # +label+ is a unique string to identify this Goal.
     # There is no checking if it is truly unique.
     #
     # +ref+ is an optional reference to any object.  This
     # would be used by the end user's application.
-    def initialize(label, ref: nil)
+    #
+    # +expiration+ can be set to override the gobal expiratin.
+    def initialize(label, ref: nil, expiration: Goalkeeper.expiration)
       @label = label
       @ref = ref
+      @expiration = expiration
     end
 
     def met!
-      Store.write(self.label)
+      write
       self
     end
 
     def met?
-      ! Store.read(self.label).nil?
+      ! read.nil?
     end
-  end
-
-  class Store
-    EXPIRATION = 60 * 60 * 24 # 1 day
 
-    def self.write(label)
-      nl = ns(label)
-      client.set nl, Time.now
-      client.expire nl, EXPIRATION
+    # Time the goal was completed.
+    # WARNING retuns nil if the job is not met
+    def met_at
+      if met?
+        Time.parse(read)
+      else
+        nil
+      end
     end
 
-    def self.read(label)
-      nl = ns(label)
-      client.get nl
-    end
-
-    def self.remove(label)
-      nl = ns(label)
-      client.del nl
+    # a namespaced key for the goal
+    def key
+      "#{Goalkeeper.namespace}:#{label}"
     end
 
     protected
 
-    def self.ns(label)
-      namespace + ":"+ label
+    def write
+      Goalkeeper.redis.set(self.key, Time.now)
+      Goalkeeper.redis.expire(self.key, self.expiration)
     end
 
-    def self.namespace
-      "Goalkeeper"
+    def read
+      Goalkeeper.redis.get self.key
     end
-
-    def self.client
-      @client ||= Redis.new
-    end
-
   end
 end

data/lib/goalkeeper/version.rb

@@ -1,3 +1,3 @@
 class Goalkeeper
-  VERSION = "0.0.1"
+  VERSION = "0.2"
 end

data/test/goalkeeper_test.rb

@@ -1,23 +1,33 @@
 require 'test_helper'
 
-# API
-# Goal.configure
-# Goal.met label, ttl
-# Goal::List.new
-#   .add
-#   .met
-#   .unmet
-#   .met?
-#
-#   configure
-#     redis client
-#     namespace
-#
-# Goal -> score, completed, met
-#
-# was a Goal met?
-# when was it met?
 describe Goalkeeper do
+  before do
+    Goalkeeper.redis.flushdb
+  end
+
+  describe "::redis" do
+    it "returns the Redis client" do
+      assert Goalkeeper.redis.is_a?(Redis)
+    end
+  end
+
+  describe "::namespace" do
+    it "defaults to Goalkeeper" do
+      assert_equal "Goalkeeper", Goalkeeper.namespace
+    end
+
+    it "can be user defined" do
+      ns = Goalkeeper.namespace
+
+      Goalkeeper.namespace = "NewNamespace"
+      assert_equal "NewNamespace", Goalkeeper.namespace
+      goal = Goalkeeper::Goal.new("x")
+      assert_equal "NewNamespace:x", goal.key
+
+      # reset
+      Goalkeeper.namespace = ns
+    end
+  end
 
   describe Goalkeeper::List do
     before do
@@ -25,7 +35,7 @@ describe Goalkeeper do
     end
 
     describe "#add" do
-      it "create a Goal" do
+      it "creates a Goal" do
         @goals.add("a:1")
         assert_equal 1, @goals.size
         assert_equal "a:1", @goals[0].label
@@ -42,61 +52,94 @@ describe Goalkeeper do
       end
     end
 
-    describe "#met" do
-      it "returns all Goals which have been met"
-    end
+    describe "with goals" do
+      before do
+        @goals.add("x").add("y")
+      end
 
-    describe "#unmet" do
-      it "returns all Goals which have not been met"
-    end
+      describe "#met" do
+        it "returns all Goals which have been met" do
+          assert @goals.met.empty?
+          @goals[0].met!
+          assert_equal ["x"], @goals.met.map(&:label)
+          @goals[1].met!
+          assert_equal ["x","y"], @goals.met.map(&:label)
+        end
+      end
 
-    describe "#met?" do
-      it "is true when all Goals have been met"
-    end
-  end
+      describe "#unmet" do
+        it "returns all Goals which have not been met" do
+          assert_equal ["x","y"], @goals.unmet.map(&:label)
+          @goals[0].met!
+          assert_equal ["y"], @goals.unmet.map(&:label)
+          @goals[1].met!
+          assert @goals.unmet.empty?
+        end
+      end
 
-  describe "met!" do
-    it "should create a Goal for the given label" do
-      assert Goalkeeper.met!("x:1")
+      describe "#met?" do
+        it "is true when all Goals have been met" do
+          assert ! @goals.met?
+          @goals.each(&:met!)
+          assert @goals.met?
+        end
+      end
     end
-
-    it "has a default ttl expiration"
-    it "takes an optional at: timestamp" 
-    it "takes an optional ttl for expiration" 
   end
 
-  describe "namespace" do
-  end
+  describe Goalkeeper::Goal do
+    before do
+      @goal = Goalkeeper::Goal.new("b")
+    end
 
-  describe "configuation" do
-    # allow setting the redis client
-  end
-end
+    it "has a label" do
+      assert_equal "b", @goal.label
+    end
 
-describe "Integration" do
-  before do
-    puts "fix this!"
-    Redis.new.flushdb
-  end
+    it "has a namespaced key" do
+      assert_equal "Goalkeeper:b", @goal.key
+    end
 
-  it "works like this" do
-    Goalkeeper.met! "x"
+    it "is met? if the label has a Redis record" do
+      assert ! @goal.met?
+      Goalkeeper.redis.set @goal.key, Time.now
+      assert @goal.met?
+    end
 
-    d = Goalkeeper::List
-      .new
-      .add("x")
-      .add("y")
+    describe "met_at" do
+      it "is nil if the Goal is not met" do
+        assert_equal nil, @goal.met_at
+      end
 
-    assert_equal false, d.met?
+      it "is the timestamp that the Goal was met" do
+        @t = Time.parse(Time.now.to_s)
+        @goal.met!
+        assert_equal @t, @goal.met_at
+      end
+    end
 
-    assert_equal ["y"], d.unmet.map(&:label)
-    assert_equal ["x"], d.met.map(&:label)
+    describe "#met!" do
+      it "creates a Redis record" do
+        assert Goalkeeper.redis.get(@goal.key).nil?
+        @goal.met!
+        assert ! Goalkeeper.redis.get(@goal.key).nil?
+      end
 
-    Goalkeeper.met! "y"
+      it "has a default ttl expiration" do
+        @goal.met!
+        assert_equal @goal.expiration, Goalkeeper.redis.ttl(@goal.key) 
+      end
+    end
 
-    assert_equal true, d.met?
+    describe "#expiration" do
+      it "has a default of 24 hours" do
+        assert_equal 24 * 60 * 60, @goal.expiration
+      end
 
-    assert_equal ["x","y"], d.met.map(&:label)
+      it "can be set at initialization" do
+        g = Goalkeeper::Goal.new("x", expiration: 60)
+        assert_equal 60, g.expiration
+      end
+    end
   end
 end
-

data/test/support/redis_instance.rb

@@ -0,0 +1,136 @@
+# RedisInstance is copied from
+# https://github.com/resque/resque-scheduler/blob/master/test/support/redis_instance.rb
+# released under an MIT license
+# modifications have been made
+require 'socket'
+require 'timeout'
+require 'fileutils'
+
+class RedisInstance
+  class << self
+    @running = false
+    @port = nil
+    @pid = nil
+    @waiting = false
+
+    def run_if_needed!
+      run! unless @running
+    end
+
+    def run!
+      ensure_redis_server_present!
+      ensure_pid_directory
+      start_redis_server
+      post_boot_waiting_and_such
+
+      @running = true
+      client
+    end
+
+    def stop!
+      $stdout.puts "Sending TERM to Redis (#{pid})..." if $stdout.tty?
+      Process.kill('TERM', pid)
+
+      @port = nil
+      @running = false
+      @pid = nil
+    end
+
+    def client
+      Redis.new(
+        hostname: '127.0.0.1', port: port, thread_safe: true
+      )
+    end
+
+    private
+
+    def post_boot_waiting_and_such
+      wait_for_pid
+      puts "Booted isolated Redis on #{port} with PID #{pid}."
+
+      wait_for_redis_boot
+
+      # Ensure we tear down Redis on Ctrl+C / test failure.
+      at_exit { stop! }
+    end
+
+    def ensure_redis_server_present!
+      unless system('redis-server -v')
+        fail "** can't find `redis-server` in your path"
+      end
+    end
+
+    def wait_for_redis_boot
+      Timeout.timeout(10) do
+        loop do
+          begin
+            break if client.ping == "PONG" 
+          rescue Redis::CannotConnectError
+            @waiting = true
+          end
+        end
+        @waiting = false
+      end
+    end
+
+    def ensure_pid_directory
+      FileUtils.mkdir_p(File.dirname(pid_file))
+    end
+
+    def start_redis_server
+      IO.popen('redis-server -', 'w+') do |server|
+        server.write(config)
+        server.close_write
+      end
+    end
+
+    def pid
+      @pid ||= File.read(pid_file).to_i
+    end
+
+    def wait_for_pid
+      Timeout.timeout(10) do
+        loop { break if File.exist?(pid_file) }
+      end
+    end
+
+    def port
+      @port ||= random_port
+    end
+
+    def pid_file
+      '/tmp/redis-scheduler-test.pid'
+    end
+
+    def config
+      <<-EOF
+        daemonize yes
+        pidfile #{pid_file}
+        port #{port}
+      EOF
+    end
+
+    # Returns a random port in the upper (10000-65535) range.
+    def random_port
+      ports = (10_000..65_535).to_a
+
+      loop do
+        port = ports[rand(ports.size)]
+        return port if port_available?('127.0.0.1', port)
+      end
+    end
+
+    def port_available?(ip, port, seconds = 1)
+      Timeout.timeout(seconds) do
+        begin
+          TCPSocket.new(ip, port).close
+          false
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          true
+        end
+      end
+    rescue Timeout::Error
+      true
+    end
+  end
+end

data/test/test_helper.rb

@@ -3,3 +3,9 @@ require 'minitest/autorun'
 require 'minitest/pride'
 
 require './lib/goalkeeper'
+
+require './test/support/redis_instance'
+
+# Start up Redis on a random port
+Goalkeeper.redis = RedisInstance.run!
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goalkeeper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.2'
 platform: ruby
 authors:
 - John Weir
@@ -52,8 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Goalkeeper is a system for validation that specific goals have been met
-  by an application.
+description: Goalkeeper is a system for verifing if specific goals have been met by
+  an application.
 email:
 - john@smokinggun.com
 executables: []
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -69,8 +70,9 @@ files:
 - lib/goalkeeper.rb
 - lib/goalkeeper/version.rb
 - test/goalkeeper_test.rb
+- test/support/redis_instance.rb
 - test/test_helper.rb
-homepage: ''
+homepage: https://github.com/jweir/goalkeeper
 licenses:
 - MIT
 metadata: {}
@@ -96,4 +98,5 @@ specification_version: 4
 summary: A Todo App for your application.
 test_files:
 - test/goalkeeper_test.rb
+- test/support/redis_instance.rb
 - test/test_helper.rb