maidservice 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 128a62bba038a1819c442680cc1aa668dbaf8c8b
-  data.tar.gz: 83b0fd71673f68f812bfae7ff532de04d22964d3
+  metadata.gz: 0d0bb84642e3c3cfcc81f86391352c0783a5a6af
+  data.tar.gz: 456d903a1c87157fecdd4bed51da34b225b63cbd
 SHA512:
-  metadata.gz: c240ba7753d01cd08c9f9e7ad54f77d0a81185bed1ebd7acdc515a6d23801d27e331e4c74632093d0fd8ed1ad3105610d4dd65bceaf9af21f3ef14bdecec2261
-  data.tar.gz: 1979cb9133fe931de8213ddf369f96387395bc8c27d538d1fbf5b8564fecbe9fe36a5aae52d5112bb0e14c3f7af7fb8541f7f79da4f35f0674b79b94bc34edb5
+  metadata.gz: 95b89eba31a243141ad2a8d416320303e9d854d45a246b87f822c594af548f3fab264a99a8fb3d033c3cccd47797f7bc0f6b98209d35cf2db3a9d07250663b84
+  data.tar.gz: 731b5cd2250c7abfddde51a6f4af0f1ee89ce0579a967ebdaf44cab8f3d3f58ec76300a85145490630ed4dc33af1af86e3e72bbeb67f53a71c72a1582df33e05

data/README.md

@@ -2,6 +2,8 @@
 
 Distributed Page Cache Clearing using Redis pub/sub
 
+Note:  This gem has the power to remove files from your server.  Be very careful about how you use it so you don't end up force removing your root.  I'm working on adding some protections against this.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,10 +26,17 @@ Maidservice will need to be run as a daemon to listen for page expiring events.
 
 It hooks into the existing `expire_page` logic and make sure that all servers running maidservice will also expire those pages.
 
-You can also expire folders and files directly by calling
+You can also expire folders and files directly by calling.  Be very careful to pass in a full path here.  Because it will remove whatever file you give it.
 
     MaidService.clear "page/path/to/clear"
 
+If you want to configure your redis instance for maidservice
+
+    # initializers/maidservice.rb
+    Maidservice.configure do |config|
+      config.redis = Redis.new # can also be a redis url
+    end
+
 ## Contributing
 
 1. Fork it

data/TODO.md

@@ -1,5 +1,2 @@
-* File structure, basic mvp
-* Pass in your redis connection
-* build active support notification listener
-* build clean directive
 * make sure there's appropriate logging
+* tests

data/lib/maidservice.rb

@@ -1,44 +1,27 @@
-require "maidservice/version"
+require 'maidservice/configuration'
+require "maidservice/listener"
+require 'maidservice/railtie'
 require 'redis'
 
 module Maidservice
+  class << self
+    def redis
+      Maidservice.configuration.redis
+    end
 
-  def self.run
-    $0 = "cache-sweeper: Starting"
-
-    # trap signals
-    # register_signal_handlers
-
-    # Quote from the resque/worker.
-    # Fix buffering so we can `rake resque:scheduler > scheduler.log` and
-    # get output from the child in there.
-    $stdout.sync = true
-    $stderr.sync = true
-
-    redis = ::Redis.new
-
-    begin
-      redis.subscribe('pages.expire') do |on|
-        on.subscribe do |channel, subscriptions|
-          puts "Subscribed to ##{channel} (#{subscriptions} subscriptions)"
-        end
-
-        on.message do |channel, message|
-          puts "##{channel}: #{message}"
-          redis.unsubscribe if message == "exit"
-        end
+    # Publishing to redis
+    # Playing with fire here
+    def clear(full_path)
+      redis.publish('expire_page.action_controller', full_path)
+    end
 
-        on.unsubscribe do |channel, subscriptions|
-          puts "Unsubscribed from ##{channel} (#{subscriptions} subscriptions)"
-        end
+    # Delegate the active support notifications
+    def subscribe
+      ActiveSupport::Notifications.subscribe('expire_page.action_controller') do |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        Maidservice.clear(event.payload[:path])
       end
-    rescue ::Redis::BaseConnectionError => error
-      puts "#{error}, retrying in 1s"
-      sleep 1
-      retry
     end
-
-    # never gets here.
   end
 
 end

data/lib/maidservice/configuration.rb

@@ -0,0 +1,52 @@
+require 'redis-namespace'
+
+module Maidservice
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Maidservice::Configuration.new
+    end
+  end
+
+  class Configuration
+
+    # Accepts:
+    #   1. A 'hostname:port' String
+    #   2. A 'hostname:port:db' String (to select the Redis db)
+    #   3. A 'hostname:port/namespace' String (to set the Redis namespace)
+    #   4. A Redis URL String 'redis://host:port'
+    #   5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+    #      or `Redis::Namespace`.
+    def redis=(server)
+      case server
+      when String
+        if server =~ /redis\:\/\//
+          redis = Redis.connect(:url => server, :thread_safe => true)
+        else
+          server, namespace = server.split('/', 2)
+          host, port, db = server.split(':')
+          redis = Redis.new(:host => host, :port => port,
+            :thread_safe => true, :db => db)
+        end
+        namespace ||= :maidservice
+
+        @redis = Redis::Namespace.new(namespace, :redis => redis)
+      when Redis::Namespace
+        @redis = server
+      else
+        @redis = Redis::Namespace.new(:maidservice, :redis => server)
+      end
+    end
+
+    # Returns the current Redis connection. If none has been created, will
+    # create a new one.
+    def redis
+      return @redis if @redis
+      self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
+      self.redis
+    end
+  end
+end

data/lib/maidservice/listener.rb

@@ -0,0 +1,50 @@
+module Maidservice
+  module Listener
+
+    # Daemon that runs and listens
+    def self.run
+      $0 = "Maidservice: Starting"
+
+      # get output from the child in there.
+      $stdout.sync = true
+      $stderr.sync = true
+
+      redis = Maidservice.redis
+
+      begin
+
+        redis.subscribe('expire_page.action_controller') do |on|
+          on.subscribe do |channel, subscriptions|
+            puts "Subscribed to ##{channel} (#{subscriptions} subscriptions)"
+          end
+
+          on.message do |channel, message|
+            puts "##{channel}: #{message}"
+            clear_page(message)
+          end
+
+          on.unsubscribe do |channel, subscriptions|
+            puts "Unsubscribed from ##{channel} (#{subscriptions} subscriptions)"
+          end
+        end
+
+      rescue ::Redis::BaseConnectionError => error
+        puts "#{error}, retrying in 1s"
+        sleep 1
+        retry
+      end
+
+      # never gets here.
+    end
+
+    # TODO: duplicate of rails expire_page
+    def self.clear_page(full_path)
+      return unless ActionController::Base.perform_caching
+      File.delete(full_path) if File.exist?(full_path)
+      File.delete(full_path + '.gz') if File.exist?(full_path + '.gz')
+    end
+
+
+  end
+
+end

data/lib/maidservice/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module Maidservice
+  class Railtie < ::Rails::Railtie
+
+    initializer "maidservice.subscribe" do
+      Maidservice.subscribe
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+
+  end
+end

data/lib/maidservice/tasks/maidservice.rake

@@ -0,0 +1,8 @@
+namespace :maidservice do
+
+  desc "Start Maid Service"
+  task :clean => :environment do
+    Maidservice::Listener.run
+  end
+
+end

data/lib/maidservice/version.rb

@@ -1,3 +1,3 @@
 module Maidservice
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/maidservice.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Maidservice::VERSION
   spec.authors       = ["Scott Carleton"]
   spec.email         = ["scott@artsicle.com"]
-  spec.description   = %q{Distributed Page Cache Clearing using Redis pub/sub}
+  spec.description   = %q{Distributed Page Cache Clearing using Redis pub/sub and hooking into Rails page caching}
   spec.summary       = %q{Distributed Page Cache Clearing using Redis pub/sub}
   spec.homepage      = "https://github.com/ScotterC/maidservice"
   spec.license       = "MIT"
@@ -20,6 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'railties'
 
-  spec.add_dependency "redis", "3.0.5"
+  spec.add_dependency "redis-namespace", "~> 1.3"
+  spec.add_dependency "redis", "> 3"
+  spec.add_dependency "activesupport", "< 4"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems' unless defined? Gem
+require 'bundler'
+Bundler.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maidservice
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Scott Carleton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-26 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,21 +38,78 @@ dependencies:
     - - '>='
       - !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: railties
+  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: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
       - !ruby/object:Gem::Version
-        version: 3.0.5
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - <
       - !ruby/object:Gem::Version
-        version: 3.0.5
-description: Distributed Page Cache Clearing using Redis pub/sub
+        version: '4'
+description: Distributed Page Cache Clearing using Redis pub/sub and hooking into
+  Rails page caching
 email:
 - scott@artsicle.com
 executables: []
@@ -66,10 +123,13 @@ files:
 - Rakefile
 - TODO.md
 - lib/maidservice.rb
-- lib/maidservice/tasks.rb
+- lib/maidservice/configuration.rb
+- lib/maidservice/listener.rb
+- lib/maidservice/railtie.rb
+- lib/maidservice/tasks/maidservice.rake
 - lib/maidservice/version.rb
 - maidservice.gemspec
-- tasks/maidservice.rake
+- spec/spec_helper.rb
 homepage: https://github.com/ScotterC/maidservice
 licenses:
 - MIT
@@ -94,4 +154,5 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Distributed Page Cache Clearing using Redis pub/sub
-test_files: []
+test_files:
+- spec/spec_helper.rb

data/lib/maidservice/tasks.rb

@@ -1,8 +0,0 @@
-namespace :maidservice do
-
-  desc "Start Maid Service"
-  task :clean do
-    MaidService.run
-  end
-
-end

data/tasks/maidservice.rake

@@ -1,2 +0,0 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-require 'maidservice/tasks'