papertrail-cli 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    papertrail-cli (0.1.0)
+      faraday
+      json
+      typhoeus
+      yajl-ruby
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.4)
+    faraday (0.5.5)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    json (1.5.1)
+    multipart-post (1.1.0)
+    rack (1.2.1)
+    typhoeus (0.2.0)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  json
+  papertrail-cli!
+  typhoeus
+  yajl-ruby

data/README.md

@@ -0,0 +1,66 @@
+# papertrail Command-line tail & search client for Papertrail log management service
+
+Ask [Papertrail] for recent log messages, optionally with a search query (the output
+can also be piped through grep). Optionally poll for new events, like tail -f.
+
+Papertrail::SearchClient class can also be used to perform one-off API searches
+or follow (tail) events matching a given query (interface may change).
+
+
+## Installation
+
+Install the gem, which includes a binary called "papertrail":
+
+    gem install papertrail-cli
+
+
+## Configuration
+
+Create ~/.papertrail.yml containing your credentials, or specify the path to 
+that file with -c. Example (from examples/papertrail.yml.example):
+    username: your@account.com
+    password: yourpassword
+
+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 (30)
+        -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/
+
+
+## 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.
+
+[Papertrail]: http://papertrailapp.com/

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,78 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'yaml'
+require 'time'
+
+require 'faraday'
+
+require 'papertrail-cli'
+
+class PapertrailSearch
+  def run
+    options = {
+      :configfile => File.expand_path('~/.papertrail.yml'),
+      :delay  => 30,
+      :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 (30)") 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.separator usage
+    end.parse!
+    
+    credentials = open(options[:configfile]) do |f|
+      YAML.load(f)
+    end
+
+    client = Papertrail::SearchClient.new(credentials['username'], credentials['password'])
+
+    search_and_print(client)
+
+    if options[:follow]
+      loop do
+        sleep options[:delay]
+        search_and_print(client)
+      end
+    end
+  end
+  
+  def search_and_print(client)
+    events = client.search(ARGV[0])
+    Papertrail::SearchClient.format_events(events) { |e| puts e } if events
+  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: http://papertrailapp.com/
+
+EOF
+  end
+end
+
+PapertrailSearch.new.run

data/examples/papertrail.yml.example

@@ -0,0 +1,2 @@
+username: your@account.com
+password: yourpassword

data/lib/papertrail-cli.rb

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

data/lib/papertrail/search_client.rb

@@ -0,0 +1,46 @@
+module Papertrail
+  class SearchClient
+    attr_accessor :username, :password, :conn
+  
+    def initialize(username, password)
+      @username = username
+      @password = password
+    
+      @conn = Faraday::Connection.new(:url => 'https://papertrailapp.com', :ssl => { :verify => true }) do |builder|
+        builder.basic_auth(@username, @password)
+
+        builder.adapter  :typhoeus
+        builder.response :yajl
+      end
+
+      @max_id_seen = {}    
+    end
+    
+    # search for all events or a specific query, defaulting to all events since
+    # last result set (call with since=0 for all).
+    def search(q = nil, since = nil)
+      response = @conn.get('/api/v1/events/search.json') do |r|
+        r.params = params_for_query(q, since)
+      end
+
+      if response.body
+        @max_id_seen[q] = response.body['max_id']
+        response.body['events']
+      end
+    end
+    
+    def params_for_query(q = nil, since = nil)
+      params = {}
+      params[:q] = q if q
+      params[:min_id] = @max_id_seen[q] if @max_id_seen[q]
+      params[:min_id] = since if since
+      params
+    end
+    
+    def self.format_events(events, &block)
+      events.each do |event|
+        yield "#{Time.parse(event['received_at']).strftime('%b %e %X')} #{event['hostname']} #{event['program']} #{event['message']}"
+      end
+    end
+  end
+end

data/papertrail-cli.gemspec

@@ -0,0 +1,81 @@
+## 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-cli'
+  s.version           = '0.1.0'
+  s.date              = '2011-02-08'
+  s.rubyforge_project = 'papertrail-cli'
+
+  ## 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 system & app logs."
+
+  ## 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'
+
+  ## 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('typhoeus')
+  s.add_dependency('yajl-ruby')
+  s.add_dependency('faraday')
+  s.add_dependency('json')
+
+  ## 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
+    Gemfile.lock
+    README.md
+    Rakefile
+    bin/papertrail
+    examples/papertrail.yml.example
+    lib/papertrail-cli.rb
+    lib/papertrail/search_client.rb
+    papertrail-cli.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,130 @@
+--- !ruby/object:Gem::Specification 
+name: papertrail-cli
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Papertrail
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 -08:00
+default_executable: papertrail
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Command-line client for Papertrail hosted log management service. Tails and searches system & app logs.
+email: troy@sevenscale.com
+executables: 
+- papertrail
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/papertrail
+- examples/papertrail.yml.example
+- lib/papertrail-cli.rb
+- lib/papertrail/search_client.rb
+- papertrail-cli.gemspec
+has_rdoc: true
+homepage: http://github.com/papertrail/papertrail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 2
+summary: Command-line client for Papertrail hosted log management service.
+test_files: []
+