whenauser 0.4.4 → 0.5.0

data/README.md

@@ -22,14 +22,15 @@ In your Gemfile:
 You should create two incoming channels (event streams) in WhenAUser, and configure their tokens in `config/whenauser.rb` (the available options are explained below). You may want to create additional channels to use in other environments, eg for staging.
 
     token 'CHANNEL_TOKEN'          # default channel (for user-centric events)
-    middleware :pageviews          # automatically generate events for pageviews
+    middleware :pageviews          # automatically generate events for requests/pageviews
     middleware :exceptions do      # automatically generate events for exceptions
       token 'ERROR_CHANNEL_TOKEN'  # separate channel for error-centric events
     end
     
-###As general-purpose Rack middleware, without Rails
+###As general-purpose Rack middleware, with or without Rails
 
-    config.middleware.use 'WhenAUser::Rack',       :token => 'CHANNEL_TOKEN_'
+    config.middleware.insert 0, 'WhenAUser::Rack', :token => 'CHANNEL_TOKEN'
+    config.middleware.insert_after 'WhenAUser::Rack', 'WhenAUser::Pageviews'
     config.middleware.use 'WhenAUser::Exceptions', :token => 'ERROR_CHANNEL_TOKEN'
 
 Using girl_friday for asynchronous communication and persistence
@@ -39,15 +40,20 @@ By default this gem sends a batch of events to the WhenAUser service synchronous
 
     queue WhenAUser::GirlFridayQueue
 
-You can also pass options to girl_friday. To avoid losing events when your app server instances restart, you can tell girl_friday to use Redis:
+Using the GirlFridayQueue also ensures that events are not lost should the WhenAUser service be temporarily unavailable.
 
-    queue WhenAUser::GirlFridayQueue, 
-      :store => GirlFriday::Store::Redis, :store_config => { :host => 'hostname', :port => 12345 }
+You can also pass options to girl_friday. To avoid losing events when your app server instances restart, you can tell girl_friday to use Redis. In order to use the Redis backend, you must use the [connection_pool](https://github.com/mperham/connection_pool) gem to share a set of Redis connections with other threads and the GirlFriday queue. If you are not already using Redis in your application, add
+
+    gem 'connection_pool'
+    gem 'redis'
 
-If you already have a Redis connection pool, you can tell girl_friday to use it:
+to your Gemfile, and add something like this to `config/whenauser.rb`:
 
+    require 'connection_pool'
+    
+    redis_pool = ConnectionPool.new(:size => 5, :timeout => 5) { ::Redis.new }
     queue WhenAUser::GirlFridayQueue, 
-      :store => GirlFriday::Store::Redis, :store_config => { :pool => $redis }
+      :store => GirlFriday::Store::Redis, :store_config => { :pool => redis_pool }
 
 See the [girl_friday wiki](https://github.com/mperham/girl_friday/wiki) for more information on how to use girl_friday.
 

data/lib/whenauser/girl_friday_queue.rb

@@ -8,7 +8,17 @@ module WhenAUser
   
     def initialize
       super(:whenauser, {:size => 1}.merge(WhenAUser.queue_options)) do |msg|
-        WhenAUser.post_payload_to_token msg[:payload], WhenAUser.token
+        retries = 0
+        begin
+          WhenAUser.post_payload_to_token msg[:payload], WhenAUser.token
+        rescue Exception => e
+          if (retries += 1) % 6 == 5
+            WhenAUser.logger.warn "WhenAUser having trouble sending events; #{retries} attempts so far."
+          end
+          sleep [5, retries].max
+          retry
+        end
+        WhenAUser.logger.warn "WhenAUser resuming service after #{retries} retries." unless retries == 0
       end
     end
 

data/lib/whenauser/version.rb

@@ -1,3 +1,3 @@
 module WhenAUser
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

data/lib/whenauser.rb

@@ -6,10 +6,11 @@ require 'whenauser/girl_friday_queue'
 require 'whenauser/memory_queue'
 require 'net/http'
 require 'uri'
+require 'logger'
 require 'active_support/core_ext/module/attribute_accessors'
 
 module WhenAUser
-  mattr_accessor :endpoint, :filter_parameters, :buffer, :token, :webhook_url, :queue, :queue_options
+  mattr_accessor :filter_parameters, :buffer, :token, :webhook_url, :queue, :queue_options, :logger
 
   def self.default_ignored_crawlers
     %w(Baidu Gigabot Googlebot libwww-perl lwp-trivial msnbot SiteUptime Slurp WordPress ZIBB ZyBorg Yandex Jyxobot Huaweisymantecspider ApptusBot)
@@ -45,6 +46,7 @@ module WhenAUser
   class Rack
     def initialize(app, options={})
       @app = app
+      WhenAUser.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
       WhenAUser.webhook_url = options[:webhook_url] || 'http://www.whenauser.com/events/'
       WhenAUser.buffer = []
       WhenAUser.filter_parameters = defined?(Rails) ? Rails.application.config.filter_parameters : []

metadata

@@ -1,71 +1,72 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: whenauser
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 4
-  version: 0.4.4
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - David Anderson
 - Chris Weis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-02 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: actionpack
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: girl_friday
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: girl_friday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 10
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.10.0
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 description: Rack middleware for connecting to WhenAUser
-email: 
+email:
 - david@alpinegizmo.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -79,35 +80,28 @@ files:
 - lib/whenauser/railtie.rb
 - lib/whenauser/version.rb
 - whenauser.gemspec
-has_rdoc: true
 homepage: https://github.com/tractionlabs/whenauser
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rack middleware for connecting to WhenAUser
 test_files: []
-