flume 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a38d4970d9c2883c1ae6611901fb8cb19df0d71
-  data.tar.gz: 482ef5efbe2401d919f95f8e4780ef8f6111fa74
+  metadata.gz: ddf2433162e288204e46cbae028ba2c1f359138d
+  data.tar.gz: 91969dc4cdfe5231def129d64df04c362b2ccc1f
 SHA512:
-  metadata.gz: e1ff7e21fecf1eaf1747ad89bdc63747b425f88b549d5c0549bf4162e49fb3ab989f5b3aeef4f8472c952caa3c34e23d0cc273ec5cb315e3b973be9d768d05d8
-  data.tar.gz: b172999e740555a080e73c80f0e90de64ae3365b95d5c14588f8790b3575b28e06e1ea4b06f8c36e4ea36f9e287480aed6ec7c809b91b4de132615c0f60a45f6
+  metadata.gz: 570916b46514d89aa96d46731e76801fc2dbd4ca39d0ded639c33c32dc969a7133fd4a89f9f410dbc2bbec8b32c7fa10db659671fa982e5e248bfd37fa1d4de4
+  data.tar.gz: f6e32fc33cdbb8b262cf9e412431b7cca23a51205360b4a2ea346318c201efaef35cfec3a417b8050769164cc4b79a552403ed68e938ecd782cb1fd80f650389

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - jruby-19mode
+  - rbx-2
+  - ruby-head
+  - jruby-head
+notifications:
+  recipients:
+    - tech@printreleaf.com

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Casey O'Hara
+Copyright (c) 2014 PrintReleaf
 
 MIT License
 

data/README.md

@@ -1,6 +1,113 @@
-# Flume
+# Flume [![Build Status](https://travis-ci.org/PrintReleaf/flume.png?branch=master)](https://travis-ci.org/PrintReleaf/flume)
+
+An unfancy Redis logger for Ruby.
+
+Works great with Rails, auto-truncates logs at a configurable size, and has a dead-simple CLI for tailing.
+
+### Usage:
+
+**Rails**:
+
+```ruby
+# config/application.rb
+# or config/environments/{development|production|etc}.rb
+
+config.logger = Flume.logger
+
+# Or, with options:
+
+config.logger = Flume.logger do |logger|
+  logger.redis = Redis.new
+  logger.list  = "#{Rails.env}:log"
+  logger.cap   = 2 ** 16
+end
+```
+
+**Plain Old Ruby**:
+
+```ruby
+redis  = Redis.new
+logger = Flume.logger redis: redis, list: 'myapp:log'
+logger.write("my message")
+
+# Alternatively, it can be configured with a block:
+
+logger = Flume.logger do |config|
+  config.redis = Redis.new
+  config.list  = 'myapp:log'
+end
+
+# Or in combination:
+
+logger = Flume.logger list: 'myapp:log' do |config|
+  config.redis { Redis.new }
+end
+```
+
+### Options:
+
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Description</th>
+      <th>Default</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>:redis</td>
+      <td>Redis instance to use</td>
+      <td>Redis.new</td>
+    </tr>
+
+    <tr>
+      <td>:list</td>
+      <td>Redis list to write to</td>
+      <td>'flume:log'</td>
+    </tr>
+
+    <tr>
+      <td>:cap</td>
+      <td>Truncation size</td>
+      <td>2 ** 16</td>
+    </tr>
+
+    <tr>
+      <td>:step</td>
+      <td>Truncation step</td>
+      <td>0</td>
+    </tr>
+
+    <tr>
+      <td>:cycle</td>
+      <td>Truncation cyle</td>
+      <td>2 ** 8</td>
+    </tr>
+  </tbody>
+</table>
+
+
+### CLI:
+
+```bash
+$ flume tail <LIST>
+$ flume tail myapp:log
+$ flume tail myapp:log -f
+$ flume tail myapp:log -n 1000
+```
+
+To specify which Redis:
+
+```bash
+$ REDIS_URL=redis://12.34.56.78:9101 flume tail myapp:log
+```
+
+
+### Why log to Redis?
+
+Redis is cheap, ubiquitous, and centralized in most deployments, making it a great log target for tiny-to-small webapps. Also, its [PubSub](http://redis.io/topics/pubsub) feature is perfect for tailing a list-based log.
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -16,14 +123,18 @@ Or install it yourself as:
 
     $ gem install flume
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/flume/fork )
+1. Fork it ( https://github.com/PrintReleaf/flume/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+Shout out to @ahoward for [Ledis](https://github.com/ahoward/ledis). Flume started as a fork and owes its simplicity to Ledis's K.I.S.S approach.
+
+## License
+
+MIT
+

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
 
+task :test do
+  sh "rspec spec"
+end
+
+task :default => :test
+

data/lib/flume/cli.rb

@@ -5,7 +5,6 @@ module Flume
     option :f, :type => :boolean, :default => false
     option :number, :type => :numeric, :default => 80, :aliases => :n
     def tail(list)
-      puts options
       logger = Flume.logger :list => list
       puts logger.tail(options[:number])
 
@@ -17,5 +16,10 @@ module Flume
       end
     end
 
+    desc "version", "show Flume version and quit"
+    def version
+      puts "Flume #{Flume::VERSION}"
+    end
+
   end
 end

data/lib/flume/log_device.rb

@@ -12,19 +12,17 @@ module Flume
       @config = OpenStruct.new(options)
       block.call(@config) if block
 
-      @redis = @config[:redis] || proc { Redis.new }
-      @cap   = @config[:cap]   || (2 ** 16)
-      @step  = @config[:step]  || 0
-      @cycle = @config[:cycle] || (2 ** 8)
-      @list  = @config[:list]  || 'flume:log'
+      @redis = @config.redis || proc { Redis.new }
+      @cap   = @config.cap   || (2 ** 16)
+      @step  = @config.step  || 0
+      @cycle = @config.cycle || (2 ** 8)
+      @list  = @config.list  || 'flume:log'
     end
 
-
     def channel
       "flume:#{list}"
     end
 
-
     def write(message)
       begin
         redis.lpush(list, message)
@@ -43,17 +41,14 @@ module Flume
       self.step = (step + 1) % cycle
     end
 
-
     def close
       redis.quit rescue nil
     end
 
-
     def tail(n = 80)
       redis.lrange(list, 0, n - 1).reverse
     end
 
-
     def tailf(&block)
       begin
         redis.subscribe(channel) do |on|
@@ -68,16 +63,13 @@ module Flume
       end
     end
 
-
     def truncate(n)
       redis.ltrim(list, 0, n - 1)
     end
 
-
     def size
       redis.llen(list)
     end
-
   end
 end
 

data/lib/flume/version.rb

@@ -1,3 +1,3 @@
 module Flume
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flume
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Casey O'Hara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md