cloud-logger 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rest-client", ">= 1.6.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "> 2.3.0"
+  gem "bundler", "> 1.0.0"
+  gem "jeweler", ">= 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Mitchell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= cloud-logger
+
+Description goes here.
+
+== Contributing to cloud-logger
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Ryan Mitchell. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cloud-logger"
+  gem.homepage = "http://github.com/ryan-mitchell/cloud-logger"
+  gem.license = "MIT"
+  gem.summary = "Simple Ruby interface to cloud logging services such as Loggly and Papertrail" 
+  gem.description ="A simple Ruby interface to the APIs of various cloud logging services" 
+  gem.email = "mitchellryanj@gmail.com"
+  gem.authors = ["Ryan Mitchell"]
+  gem.version = "0.0.1"
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cloud-logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/cloud-logger.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cloud-logger"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Mitchell"]
+  s.date = "2011-09-21"
+  s.description = "A simple Ruby interface to the APIs of various cloud logging services"
+  s.email = "mitchellryanj@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "cloud-logger.gemspec",
+    "lib/base.rb",
+    "lib/cloud-logger.rb",
+    "lib/event.rb",
+    "lib/loggly.rb",
+    "lib/papertrail.rb",
+    "spec/loggly_spec.rb",
+    "spec/papertrail_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/ryan-mitchell/cloud-logger"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Simple Ruby interface to cloud logging services such as Loggly and Papertrail"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6.3"])
+      s.add_development_dependency(%q<rspec>, ["> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 1.6.3"])
+      s.add_dependency(%q<rspec>, ["> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 1.6.3"])
+    s.add_dependency(%q<rspec>, ["> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["> 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/base.rb

@@ -0,0 +1,5 @@
+module CloudLogger
+
+  class Base
+  end
+end   

data/lib/cloud-logger.rb

@@ -0,0 +1,5 @@
+require 'rest_client'
+require 'base'
+require 'event'
+require 'loggly'
+require 'papertrail'

data/lib/event.rb

@@ -0,0 +1,14 @@
+require 'date'
+
+module CloudLogger
+
+  class Event
+
+    attr_accessor :timestamp, :text
+
+    def initialize(text, timestamp)
+      @text = text
+      @timestamp = DateTime.parse(timestamp)
+    end
+  end
+end

data/lib/loggly.rb

@@ -0,0 +1,30 @@
+module CloudLogger
+  
+  class Loggly
+
+    # a json object with a data property which is an array with zero or more elements
+    #ResponseMatcher = /\{\s*"data": \[\s*(\{.*?\})*\s*\]/m
+
+    def initialize(options)
+      @subdomain = options[:subdomain]
+      @user = options[:user]
+      @pass = options[:pass]
+      @key = options[:key]
+      @ec2 = options[:ec2] ||= false
+    end
+
+    def log(log_data)
+      ec2flag = @ec2 ? 'ec2.' : ''
+      RestClient.post("https://#{ec2flag}logs.loggly.com/inputs/#{@key}", log_data)
+    end
+
+    def search(query)
+      raw_response = RestClient.get("https://#{@user}:#{@pass}@#{@subdomain}.loggly.com/api/search", {:params => {:q => query}})
+      result = JSON.parse(raw_response)['data'].map do |log_entry|
+        CloudLogger::Event.new(log_entry['text'], log_entry['timestamp'])
+      end 
+      yield result if block_given?
+      result
+    end
+  end
+end

data/lib/papertrail.rb

@@ -0,0 +1,23 @@
+module CloudLogger
+
+  class Papertrail
+
+    def initialize(options)
+      @user = options[:user]
+      @pass = options[:pass]
+    end
+
+    def log(message)
+      raise "sending logs is not supported for the Papertrail driver"
+    end
+
+    def search(query)
+      raw_response = RestClient.get("https://#{@user}:#{@pass}@papertrailapp.com/api/vi/events/search.json", {:params => {:q => query}})
+      result = JSON.parse(raw_response)['events'].map do |log_entry|
+        CloudLogger::Event.new(log_entry['message'], log_entry['received_at'])
+      end 
+      yield result if block_given?
+      result
+    end
+  end
+end

data/spec/loggly_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe CloudLogger::Loggly do
+
+  before(:all) do
+    @test_subdomain = 'example'
+    @test_user = 'user'
+    @test_pass = 'pass'
+    @test_key = '123456'
+    @loggly = CloudLogger::Loggly.new(
+      :subdomain => @test_subdomain, 
+      :user => @test_user, 
+      :pass => @test_pass, 
+      :key => @test_key
+    )
+  end
+
+  describe "#search" do
+
+    before(:each) do
+      RestClient.stub!(:get)
+      Kernel.stub!(:print)
+      @test_response = JSON.generate({ :data => [ { :timestamp => "2011-09-21T18:48:55.151Z", :text => "Test Data" } ] })
+
+    end
+
+    it "should generate an appropriate RestClient GET" do
+
+      search_string = "search string"
+      RestClient.should_receive(:get).with(
+        "https://#{@test_user}:#{@test_pass}@#{@test_subdomain}.loggly.com/api/search", 
+        {:params => {:q => search_string}}
+      ).and_return(@test_response)
+      @loggly.search(search_string)
+    end
+
+    it "should convert the returned text to a CloudLogger::Event" do
+      RestClient.should_receive(:get).and_return(@test_response)
+      @loggly.search("Test Data") do |data|
+        data.first.should be_instance_of CloudLogger::Event
+        data.first.text.should == "Test Data"
+      end
+    end
+
+    it "should execute the callback if one is provided" do
+
+      Kernel.should_receive(:print).with an_instance_of Array 
+      RestClient.should_receive(:get).and_return(@test_response)
+
+      @loggly.search('anything') do |data|
+        Kernel.print data
+        data.first.should be_instance_of CloudLogger::Event
+      end
+    end
+
+    it "should return the response if no callback is provided" do
+
+      RestClient.should_receive(:get).and_return(@test_response)
+      @loggly.search('anything').should_not be_nil
+    end
+  end
+
+  describe "#log" do
+    
+    before(:each) do
+      RestClient.stub!(:post)
+    end
+
+    it "should generate an appropriate RestClient POST with a raw payload" do
+
+      log_string = "this is a test log"
+      RestClient.should_receive(:post).with(
+        "https://logs.loggly.com/inputs/%s" % @test_key,
+        log_string
+      )
+
+      @loggly.log(log_string)
+    end
+
+    it "should generate an appropriate RestClient POST with parameters" do
+
+      log_parameters = { :time => 123456, :type => 'foo', :logger => 'bar' }
+      RestClient.should_receive(:post).with(
+        "https://logs.loggly.com/inputs/%s" % @test_key,
+        log_parameters
+      )
+
+      @loggly.log(log_parameters)
+    end
+
+    it "should use the EC2 host if the EC2 flag is set" do
+
+      log_string = "this is a test log"
+      ec2logger = CloudLogger::Loggly.new(
+        :subdomain => @test_subdomain, 
+        :user => @test_user, 
+        :pass => @test_pass, 
+        :key => @test_key,
+        :ec2 => true
+      )
+      RestClient.should_receive(:post).with(
+        "https://ec2.logs.loggly.com/inputs/%s" % @test_key,
+        log_string
+      )
+
+      ec2logger.log(log_string)
+    end
+  end
+end

data/spec/papertrail_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe CloudLogger::Papertrail do
+
+  before(:all) do
+    @test_user = 'user'
+    @test_pass = 'pass'
+    @logger = CloudLogger::Papertrail.new(
+      :user => @test_user, 
+      :pass => @test_pass, 
+    )
+  end
+
+  describe "#search" do
+
+    before(:each) do
+      RestClient.stub!(:get)
+      Kernel.stub!(:print)
+      @test_response = JSON.generate({ :events => [ { :received_at => "2011-09-21T18:48:55.15-07:00", :message => "Test Data" } ] })
+
+    end
+
+    it "should generate an appropriate RestClient GET" do
+
+      search_string = "search string"
+      RestClient.should_receive(:get).with(
+        "https://#{@test_user}:#{@test_pass}@papertrailapp.com/api/vi/events/search.json", 
+        {:params => {:q => search_string}}
+      ).and_return(@test_response)
+      @logger.search(search_string)
+    end
+
+    it "should convert the returned text to a CloudLogger::Event" do
+      RestClient.should_receive(:get).and_return(@test_response)
+      @logger.search("Test Data") do |data|
+        data.first.should be_instance_of CloudLogger::Event
+        data.first.text.should == "Test Data"
+      end
+    end
+
+    it "should execute the callback if one is provided" do
+
+      Kernel.should_receive(:print).with an_instance_of Array 
+      RestClient.should_receive(:get).and_return(@test_response)
+
+      @logger.search('anything') do |data|
+        Kernel.print data
+        data.first.should be_instance_of CloudLogger::Event
+      end
+    end
+
+    it "should return the response if no callback is provided" do
+
+      RestClient.should_receive(:get).and_return(@test_response)
+      @logger.search('anything').should_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'cloud-logger'
+require 'json'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: cloud-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &25526720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *25526720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &25526240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *25526240
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &25525640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *25525640
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &25525140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *25525140
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &25524620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *25524620
+description: A simple Ruby interface to the APIs of various cloud logging services
+email: mitchellryanj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- cloud-logger.gemspec
+- lib/base.rb
+- lib/cloud-logger.rb
+- lib/event.rb
+- lib/loggly.rb
+- lib/papertrail.rb
+- spec/loggly_spec.rb
+- spec/papertrail_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ryan-mitchell/cloud-logger
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 196934442856709586
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple Ruby interface to cloud logging services such as Loggly and Papertrail
+test_files: []