visitors 0.0.7 → 0.0.8

data/README.md

@@ -8,35 +8,60 @@ Ruby-based web application. Anywhere in your app you can call…
 …to increment a counter that corresponds to the resource with an
 identifier of 1.
 
-## Usage
+## Installation
 
 First off install the gem
 
     gem install visitors
 
-Next make sure you have Redis running and the config.yml file has the
-right configuration settings to connect to your Redis instance.
+Require the visitors gem in your Rails app via your Gemfile.
+
+    gem 'visitors', '~> 0.0.2'
+
+Now add `Visitors.increment(@resource.id, :show)` to a show action in
+your application.
+
+## Configuration
+
+When `RAILS_ROOT` is defined visitors will work based upon the
+assumption your using it in combination with Rails. Make sure you have
+Redis running and that you have a config.yml file in your Rails config
+directory, similar to this:
 
     development:
       redis_namespace: visitors_development
       redis_config:
         host: localhost
 
-You can specify which settings to use with a `VISITORS_ENV` variable.
-
-Require the visitors gem in your Rails app via your Gemfile?
+    production:
+      redis_namespace: visitors_production
+      redis_config:
+        host: redis-cluster.domain.com
 
-    gem 'visitors', '~> 0.0.2'
+Without `RAILS_ROOT` visitors will use a local development connection.
+Not enough to be really useful! Here's the code that decides where to
+load the config from:
 
-Now add `Visitors.increment(@resource.id, :show)` to a show action in
-your application.
+    if defined?(RAILS_ROOT)
+      def yaml
+        @yaml ||= YAML.load_file("#{RAILS_ROOT}/config/visitors.yml")
+      end
+    else
+      def yaml
+        @yaml ||= YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
+      end
+    end
 
-Launch a Vegas-powered Sinatra web console to see who's been visiting
-your pages using `visitors web`.
+The environment will be selected using the `RAILS_ENV`, the
+`VISITORS_ENV` or default to `development`.
 
 ## Warning
 
 This code is likely to change a lot and probably shouldn't be used in
-your beautiful production app because of this. Feel free to fork and use
-the code but take bear in mind I make no committment to support,
-maintain or even acknowledge the existence of this small cluster fluck.
+your beautiful production app because of this. It's something I put
+together quickly for use in work as writing all our activity to disk was
+crippling servers.
+
+Feel free to fork and use the code but take heed, I make no committment
+to support, maintain or even acknowledge the existence of this small
+cluster fuck.

data/config.yml

@@ -9,3 +9,8 @@ development:
   redis_namespace: visitors_development
   redis_config:
     host: localhost
+
+uat:
+  redis_namespace: visitors_development
+  redis_config:
+    host: qa.touchlocal.com

data/lib/visitors/config.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 class Visitors::Config
   class MissingEnvironmentError < StandardError; end
 
@@ -31,7 +33,7 @@ class Visitors::Config
   end
 
   def env
-    ENV['VISITORS_ENV'] || 'development'
+    ENV['RAILS_ENV'] || ENV['VISITORS_ENV'] || 'development'
   end
 
   def define_methods_from_yaml

data/lib/visitors/version.rb

@@ -1,3 +1,3 @@
 module Visitors
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -2,7 +2,7 @@
 name: visitors
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - James Conroy-Finn
@@ -126,8 +126,8 @@ dependencies:
 description: Redis-backed activity storage to track visits to different parts of your Ruby web app in real-time.
 email: 
 - james@logi.cl
-executables: 
-- visitors
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
@@ -140,11 +140,9 @@ files:
 - Guardfile
 - README.md
 - Rakefile
-- bin/visitors
 - config.ru
 - config.yml
 - lib/visitors.rb
-- lib/visitors/cli.rb
 - lib/visitors/config.rb
 - lib/visitors/helpers.rb
 - lib/visitors/resource.rb

data/bin/visitors

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'visitors'
-  require 'visitors/cli'
-rescue LoadError
-  require File.expand_path('../../lib/visitors', __FILE__)
-  require File.expand_path('../../lib/visitors/cli', __FILE__)
-end
-
-Visitors::CLI.start

data/lib/visitors/cli.rb

@@ -1,15 +0,0 @@
-require 'thor'
-
-class Visitors::CLI < Thor
-  desc 'store', 'start the redis in-memory store'
-  def store
-    say "You're running in development, do it yourself!", :blue
-  end
-
-  desc 'web', 'start the web console (NOT IMPLEMENTED)'
-  def web
-    require 'vegas'
-    require File.expand_path('../../../server', __FILE__)
-    Vegas::Runner.new(Visitors::Server, 'visitors_app')
-  end
-end