papertrail 0.8.3

data/Gemfile

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

data/README.md

@@ -0,0 +1,131 @@
+# papertrail Command-line tail & search client for Papertrail log management service
+
+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:
+
+    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.
+
+
+## Quick Start
+
+    $ [sudo] gem install papertrail-cli
+    $ echo "token: 123456789012345678901234567890ab" > ~/.papertrail.yml
+    $ papertrail
+
+Retrieve token from Papertrail [User Profile].
+
+
+## Installation
+
+Install the gem (details on [RubyGems]), which includes a binary called 
+"papertrail":
+
+    $ [sudo] gem install papertrail-cli
+
+
+## Configuration
+
+Create ~/.papertrail.yml containing your API token, or specify the
+path to that file with -c. Example (from
+examples/papertrail.yml.example):
+
+    token: 123456789012345678901234567890ab
+
+Retrieve token from Papertrail [User Profile]. 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
+
+
+## Usage & Examples
+
+    $ papertrail -h
+    papertrail - command-line tail and search for Papertrail log management service
+        -h, --help                       Show usage
+        -f, --follow                     Continue running and print new events (off)
+        -d, --delay SECONDS              Delay between refresh (3)
+        -c, --configfile PATH            Path to config (~/.papertrail.yml)
+
+    Usage: papertrail [-f] [-d seconds] [-c /path/to/papertrail.yml] [query]
+
+    Examples:
+      papertrail -f
+      papertrail something
+      papertrail 1.2.3 Failure
+      papertrail -f "(www OR db) (nginx OR pgsql) -accepted"
+      papertrail -f -d 10 "ns1 OR 'connection refused'"
+
+    More: http://papertrailapp.com/
+
+
+## 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`.
+
+### Advanced
+
+For complete control, pipe through anything capable of inserting ANSI
+control characters. Here's an example that colorizes 3 fields separately
+- the first 15 characters for the date, a word for the hostname, and a
+word for the program name:
+
+    $ papertrail | perl -pe 's/^(.{15})(.)([\S]+)(.)([\S]+)/\e[1;31;43m\1\e[0m\2\e[1;31;43m\3\e[0m\4\e[1;31;43m\5\e[0m/g'
+
+the "1;31;43" are bold (1), foreground red (31), background yellow (43),
+and can be any ANSI [escape characters].
+
+
+## Contribute
+
+Bug report:
+
+1. See whether the issue has already been reported:
+   http://github.com/papertrail/papertrail-cli/issues/
+2. If you don't find one, create an issue with a repro case.
+
+Enhancement or fix:
+
+1. Fork the project:
+   http://github.com/papertrail/papertrail-cli
+2. Make your changes with tests.
+3. Commit the changes without changing the Rakefile or other files unrelated 
+to your enhancement.
+4. Send a pull request.
+
+[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
+[User Profile]: https://papertrailapp.com/user/edit
+[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
+[escape characters]: http://en.wikipedia.org/wiki/ANSI_escape_code#Colors

data/Rakefile

@@ -0,0 +1,154 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def module_name
+  name.split('-').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{module_name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{module_name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/papertrail

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'papertrail/cli'
+
+begin
+  Papertrail::Cli.new.run
+rescue Interrupt
+  exit(0)
+end

data/examples/papertrail.yml.example

@@ -0,0 +1 @@
+token: 123456789012345678901234567890ab

data/lib/papertrail.rb

@@ -0,0 +1,5 @@
+module Papertrail
+ VERSION = "0.8.3"
+end
+
+require 'papertrail/search_client'

data/lib/papertrail/cli.rb

@@ -0,0 +1,95 @@
+require 'optparse'
+require 'yaml'
+
+require 'papertrail/connection'
+
+module Papertrail
+  class Cli
+    def run
+      options = {
+        :configfile => File.expand_path('~/.papertrail.yml'),
+        :delay  => 2,
+        :follow => false
+      }
+
+      OptionParser.new do |opts|
+        opts.banner = "papertrail - command-line tail and search for Papertrail log management service"
+
+        opts.on("-h", "--help", "Show usage") do |v|
+          puts opts
+          exit
+        end
+        opts.on("-f", "--follow", "Continue running and print new events (off)") do |v|
+          options[:follow] = true
+        end
+        opts.on("-d", "--delay SECONDS", "Delay between refresh (2)") do |v|
+          options[:delay] = v.to_i
+        end
+        opts.on("-c", "--configfile PATH", "Path to config (~/.papertrail.yml)") do |v|
+          options[:configfile] = File.expand_path(v)
+        end
+        opts.on("-s", "--system SYSTEM", "System to search") do |v|
+          options[:system] = v
+        end
+        opts.on("-g", "--group GROUP", "Group to search") do |v|
+          options[:group] = v
+        end
+
+        opts.separator usage
+      end.parse!
+
+      credentials = open(options[:configfile]) do |f|
+        YAML.load(f)
+      end
+
+      if credentials['token']
+        connection = Papertrail::Connection.new(:token => credentials['token'])
+      else
+        connection = Papertrail::Connection.new(:username => credentials['username'], :password => credentials['password'])
+      end
+
+      query_options = {}
+
+      if options[:system]
+        query_options[:system_id] = connection.find_id_for_source(options[:system])
+      end
+
+      if options[:group]
+        query_options[:group_id] = connection.find_id_for_group(options[:group])
+      end
+
+      search_query = connection.query(ARGV[0], query_options)
+
+      if options[:follow]
+        loop do
+          search_query.search.events.each do |event|
+            $stdout.puts event
+          end
+          $stdout.flush
+          sleep options[:delay]
+        end
+      else
+        search_query.search.events.each do |event|
+          $stdout.puts event
+        end
+      end
+    end
+
+    def usage
+      <<-EOF
+
+  Usage: papertrail [-f] [-d seconds] [-c /path/to/papertrail.yml] [query]
+
+  Examples:
+    papertrail -f
+    papertrail something
+    papertrail 1.2.3 Failure
+    papertrail -f "(www OR db) (nginx OR pgsql) -accepted"
+    papertrail -f -d 10 "ns1 OR 'connection refused'"
+
+  More: https://papertrailapp.com/
+
+  EOF
+    end
+  end
+end

data/lib/papertrail/connection.rb

@@ -0,0 +1,62 @@
+require 'faraday'
+require 'openssl'
+require 'faraday_stack'
+
+require 'papertrail/search_query'
+
+module Papertrail
+  class Connection
+    extend Forwardable
+
+    attr_reader :connection
+
+    def_delegators :@connection, :get, :put, :post
+
+    def initialize(options)
+      ssl_options = { :verify => OpenSSL::SSL::VERIFY_PEER }
+
+      # Make Ubuntu OpenSSL work
+      #
+      # From: https://bugs.launchpad.net/ubuntu/+source/openssl/+bug/396818
+      # "[OpenSSL] does not presume to select a set of CAs by default."
+      if File.file?('/etc/ssl/certs/ca-certificates.crt')
+        ssl_options[:ca_file] = '/etc/ssl/certs/ca-certificates.crt'
+      end
+
+      @connection = Faraday::Connection.new(:url => 'https://papertrailapp.com', :ssl => ssl_options) do |builder|
+        builder.adapter Faraday.default_adapter
+        builder.use     FaradayStack::ResponseJSON
+      end.tap do |conn|
+        if options[:username] && options[:password]
+          conn.basic_auth(options[:username], options[:password])
+        else
+          conn.headers['X-Papertrail-Token'] = options[:token]
+        end
+      end
+    end
+
+    def find_id_for_source(name)
+      response = @connection.get('/api/v1/systems.json')
+
+      response.body.each do |source|
+        return source['id'] if source['name'] =~ /#{Regexp.escape(name)}/i
+      end
+
+      return nil
+    end
+
+    def find_id_for_group(name)
+      response = @connection.get('/api/v1/groups.json')
+
+      response.body.each do |group|
+        return group['id'] if group['name'] =~ /#{Regexp.escape(name)}/i
+      end
+
+      return nil
+    end
+
+    def query(query = nil, options = {})
+      Papertrail::SearchQuery.new(self, query, options)
+    end
+  end
+end

data/lib/papertrail/event.rb

@@ -0,0 +1,15 @@
+require 'time'
+
+module Papertrail
+  class Event
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def to_s
+      "#{Time.parse(data['received_at']).strftime('%b %e %X')} #{data['hostname']} #{data['program']}: #{data['message']}"
+    end
+  end
+end

data/lib/papertrail/search_query.rb

@@ -0,0 +1,23 @@
+require 'papertrail/search_result'
+
+module Papertrail
+  class SearchQuery
+    def initialize(connection, query = nil, options = {})
+      @connection = connection
+      @query      = query
+      @options    = options
+    end
+
+    def search
+      response = @connection.get('/api/v1/events/search.json') do |r|
+        r.params = @options.dup
+
+        r.params[:q]      = @query  if @query
+        r.params[:min_id] = @max_id if @max_id
+      end
+
+      @max_id = response.body['max_id']
+      Papertrail::SearchResult.new(response.body)
+    end
+  end
+end

data/lib/papertrail/search_result.rb

@@ -0,0 +1,23 @@
+require 'papertrail/event'
+
+module Papertrail
+  class SearchResult
+    attr_reader :data, :events
+
+    def initialize(data)
+      @data = data
+
+      @events = @data['events'].collect do |event|
+        Papertrail::Event.new(event)
+      end
+    end
+
+    def max_id
+      @data['max_id']
+    end
+
+    def min_id
+      @data['min_id']
+    end
+  end
+end

data/papertrail.gemspec

@@ -0,0 +1,83 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'papertrail'
+  s.version           = '0.8.3'
+  s.date              = '2012-02-11'
+  s.rubyforge_project = 'papertrail'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Command-line client for Papertrail hosted log management service."
+  s.description = "Command-line client for Papertrail hosted log management service. Tails and searches app server logs and system syslog. Supports Boolean search and works with grep and pipe output (Unix)."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ['Papertrail']
+  s.email    = 'troy@sevenscale.com'
+  s.homepage = 'http://github.com/papertrail/papertrail-cli'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+#  s.require_paths << 'ext'
+#  s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["papertrail"]
+  s.default_executable = 'papertrail'
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+#  s.extra_rdoc_files = %w[README LICENSE]
+  s.extra_rdoc_files = []
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('yajl-ruby')
+  s.add_dependency('faraday', [ '~> 0.6' ])
+  s.add_dependency('faraday-stack', [ '~> 0.1' ])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #  s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    README.md
+    Rakefile
+    bin/papertrail
+    examples/papertrail.yml.example
+    lib/papertrail.rb
+    lib/papertrail/cli.rb
+    lib/papertrail/connection.rb
+    lib/papertrail/event.rb
+    lib/papertrail/search_query.rb
+    lib/papertrail/search_result.rb
+    papertrail.gemspec
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: papertrail
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 3
+  version: 0.8.3
+platform: ruby
+authors: 
+- Papertrail
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-11 00:00:00 -08:00
+default_executable: papertrail
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: faraday-stack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id003
+description: Command-line client for Papertrail hosted log management service. Tails and searches app server logs and system syslog. Supports Boolean search and works with grep and pipe output (Unix).
+email: troy@sevenscale.com
+executables: 
+- papertrail
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.md
+- Rakefile
+- bin/papertrail
+- examples/papertrail.yml.example
+- lib/papertrail.rb
+- lib/papertrail/cli.rb
+- lib/papertrail/connection.rb
+- lib/papertrail/event.rb
+- lib/papertrail/search_query.rb
+- lib/papertrail/search_result.rb
+- papertrail.gemspec
+has_rdoc: true
+homepage: http://github.com/papertrail/papertrail-cli
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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"
+requirements: []
+
+rubyforge_project: papertrail
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Command-line client for Papertrail hosted log management service.
+test_files: []
+