papertrail-cli 0.6.1 → 0.7.0

data/Gemfile

@@ -1,3 +1,5 @@
 source :rubygems
 
+gem 'rake', '0.8.7'
+
 gemspec

data/README.md

@@ -4,40 +4,48 @@ Small standalone [binary] to retrieve, search, and tail recent app
 server log and system syslog messages from [Papertrail].
 
 Supports optional Boolean search queries and polling for new events
-(like "tail -f").  Example:
+(like "tail -f"). Example:
 
     papertrail -f "(www OR db) (nginx OR pgsql) -accepted"
 
 Output is line-buffered so it can be fed into a pipe, like for grep.
+See below for colorization setup.
 
 The [SearchClient] class can be used by other apps to perform one-off
 API searches or follow (tail) events matching a given query. Interface
 may change.
 
 
-## Quickstart
+## Quick Start
 
     $ [sudo] gem install papertrail-cli
-    $ echo "username: your@account.com\npassword: yourpass" > ~/.papertrail.yml
+    $ echo "token: 123456789012345678901234567890ab" > ~/.papertrail.yml
     $ papertrail
 
+Retrieve token from Papertrail [Account Settings].
+
 
 ## Installation
 
-Install the gem ([RubyGems]), which includes a binary called "papertrail":
+Install the gem (details on [RubyGems]), which includes a binary called 
+"papertrail":
 
-   $ [sudo] gem install papertrail-cli
+    $ [sudo] gem install papertrail-cli
 
 
 ## Configuration
 
-Create ~/.papertrail.yml containing your credentials, or specify the
+Create ~/.papertrail.yml containing your API token, or specify the
 path to that file with -c. Example (from
 examples/papertrail.yml.example):
-    username: your@account.com
-    password: yourpassword
+
+    token: 123456789012345678901234567890ab
+
+Retrieve token from Papertrail [Account Settings]. For compatibility with 
+older config files, `username` and `password` keys are also supported.
 
 You may want to alias "trail" to "papertrail", like:
+
     echo "alias trail=papertrail" >> ~/.bashrc
 
 
@@ -62,10 +70,27 @@ You may want to alias "trail" to "papertrail", like:
     More: http://papertrailapp.com/
 
 
-## Colorize
+## Colors
+
+Pipe through [colortail] or [MultiTail]. We recommend colortail:
+
+    $ sudo gem install colortail
+
+Save [colortailrc] as `~/.colortailrc` and edit it to enable:
+
+    $ papertrail -f -d 5 | colortail -g papertrail
+
+### Shorthand
+
+If you're using bash, create a function that accepts arguments, then 
+invoke `pt` with optional search operators:
+
+    $ function pt() { papertrail -f -d 5 $_ | colortail -g papertrail }
+    $ pt 1.2.3 Failure
+
+Add the function line to your `~/.bashrc`.
 
-Pipe through [MultiTail] or [colortail]. For example:
-    $ papertrail | multitail -c -j
+### Advanced
 
 For complete control, pipe through anything capable of inserting ANSI
 control characters. Here's an example that colorizes 3 fields separately
@@ -98,7 +123,9 @@ to your enhancement.
 [binary]: https://github.com/papertrail/papertrail-cli/blob/master/bin/papertrail
 [Papertrail]: http://papertrailapp.com/
 [SearchClient]: https://github.com/papertrail/papertrail-cli/blob/master/lib/papertrail/search_client.rb
+[Account Settings]: https://papertrailapp.com/account
 [RubyGems]: https://rubygems.org/gems/papertrail-cli
+[colortail]: http://rubydoc.info/gems/colortail
+[colortailrc]: https://github.com/papertrail/papertrail-cli/wiki/colortailrc
 [MultiTail]: http://www.vanheusden.com/multitail/index.html
-[colortail]: http://www.codaset.com/elubow/colortail
 [escape characters]: http://en.wikipedia.org/wiki/ANSI_escape_code#Colors

data/bin/papertrail

@@ -37,7 +37,11 @@ class PapertrailSearch
       YAML.load(f)
     end
 
-    client = Papertrail::SearchClient.new(credentials['username'], credentials['password'])
+    if credentials['token']
+      client = Papertrail::SearchClient.new(:token => credentials['token'])
+    else
+      client = Papertrail::SearchClient.new(:username => credentials['username'], :password => credentials['password'])
+    end
 
     search_and_print(client)
 

data/examples/papertrail.yml.example

@@ -1,2 +1 @@
-username: your@account.com
-password: yourpassword
+token: 123456789012345678901234567890ab

data/lib/papertrail-cli.rb

@@ -1,5 +1,5 @@
 module PapertrailCli
- VERSION = "0.6.1"
+ VERSION = "0.7.0"
 end
 
 require 'papertrail/search_client'

data/lib/papertrail/search_client.rb

@@ -4,11 +4,7 @@ require 'always_verify_ssl_certificates'
 
 module Papertrail
   class SearchClient
-    attr_accessor :username, :password, :conn
-
-    def initialize(username, password)
-      @username = username
-      @password = password
+    def initialize(options)
 
       ssl_options = { :verify => OpenSSL::SSL::VERIFY_PEER }
 
@@ -21,7 +17,11 @@ module Papertrail
       end
 
       @conn = Faraday::Connection.new(:url => 'https://papertrailapp.com', :ssl => ssl_options) do |builder|
-        builder.basic_auth(@username, @password)
+        if options[:username] && options[:password]
+          builder.basic_auth(options[:username], options[:password])
+        else
+          builder.headers['X-Papertrail-Token'] = options[:token]
+        end
 
         builder.adapter  Faraday.default_adapter
         builder.response :yajl

data/papertrail-cli.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'papertrail-cli'
-  s.version           = '0.6.1'
-  s.date              = '2011-06-02'
+  s.version           = '0.7.0'
+  s.date              = '2011-10-28'
   s.rubyforge_project = 'papertrail-cli'
 
   ## Make sure your summary is short. The description may be as long

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: papertrail-cli
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Papertrail
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 -07:00
+date: 2011-10-28 00:00:00 -07:00
 default_executable: papertrail
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: yajl-ruby
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -36,11 +33,9 @@ dependencies:
   name: faraday
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 0
         - 5
@@ -52,11 +47,9 @@ dependencies:
   name: always_verify_ssl_certificates
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -89,27 +82,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: papertrail-cli
-rubygems_version: 1.4.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 2
 summary: Command-line client for Papertrail hosted log management service.