loggly 0.0.0 → 0.1.0

data/.autotest

@@ -0,0 +1 @@
+require "autotest/bundler"

data/Gemfile

@@ -1,13 +1,16 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem 'rest-client', ">=1.6"
+gem 'resque', ">=1.1"
+
+gem 'json'
+
 group :development do
+  gem 'resque_unit'
   gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
+  gem "rspec"
+  gem "fakeweb"
 end

data/Gemfile.lock

@@ -1,20 +1,61 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
     git (1.2.5)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    json (1.6.1)
+    mime-types (1.17.2)
+    multi_json (1.0.3)
+    rack (1.3.5)
+    rack-protection (1.1.4)
+      rack
     rake (0.9.2)
     rcov (0.9.9)
+    redis (2.2.2)
+    redis-namespace (1.0.3)
+      redis (< 3.0.0)
+    resque (1.19.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    resque_unit (0.4.1)
+      json (>= 1.4.6)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
     shoulda (2.11.3)
+    sinatra (1.3.1)
+      rack (~> 1.3, >= 1.3.4)
+      rack-protection (~> 1.1, >= 1.1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  fakeweb
   jeweler (~> 1.6.4)
+  json
   rcov
+  resque (>= 1.1)
+  resque_unit
+  rest-client (>= 1.6)
+  rspec
   shoulda

data/README.rdoc

@@ -1,6 +1,35 @@
 = loggly
 
-Description goes here.
+It sends messages to the Loggly API. We do this using resque or without it.
+
+== INSTALL
+
+   gem install loggly
+
+== USAGE
+
+You must sublcass from Loggly and add a class method call token that return the input you get from Loggly
+
+=== For example:
+
+  class TicketLoggly < Loggly
+    def self.token
+      'token_you_get_from_loggly'
+      end
+    end
+
+
+   TicketLoggly.record("This the message")
+
+You can also pass in an optional parameter like: 
+
+   TicketLoggly.record("This is cool", Time.now.to_s)
+
+
+If you have resque installed, you can send messages using it by doing:
+
+   TicketLogglt.async_record("This will be send using resque")
+
 
 == Contributing to loggly
  

data/Rakefile

@@ -27,16 +27,16 @@ end
 Jeweler::RubygemsDotOrgTasks.new
 
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+Rake::TestTask.new(:test) do |ttestest|
+#  test.libs << 'lib' << 'spec'
+#  test.pattern = 'spec/**/*_spec.rb'
+#  test.verbose = true
 end
 
 require 'rcov/rcovtask'
 Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.libs << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
   test.verbose = true
   test.rcov_opts << '--exclude "gems/*"'
 end

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/loggly.rb

@@ -0,0 +1,96 @@
+require 'restclient'
+
+
+#
+# We use resque to send messages to loggly
+#
+
+class LogglyResque
+
+  @queue = :loggly
+
+  def self.perform(klass,message, time=nil)
+    klass.send(:send_to_loggly, message, time)
+  end
+end
+
+#
+# THIS CLASS AS AN ABSTRACT BASE CLASS TO SEND EVENTS TO LOGGLY.COM
+# events on this content are anything that happends in the app. Not an event were people to to have fun
+#
+class Loggly
+
+  #
+  # THIS IS THE ENDPOINT URL FOR LOGGLY
+  #
+  @@endpoint = 'http://logs.loggly.com/inputs/'
+
+  #
+  # Contructing a full URL. It has the endpoint + the token we generate at:
+  # https://venuedriver.loggly.com/inputs
+  #
+  def self.url
+    @@endpoint + self.token
+  end
+
+  def self.token
+    # Add the token in the subclasses.
+    # This method must return a string
+    # The idea is to have a subclass for each of the inputs that we create in loggly
+    # URL to get the token from: https://venuedriver.loggly.com/inputs
+  end
+
+
+  # Public
+  # This method sends a message to the Loggly API.
+  #
+  #
+  # BEAWARE: That Loggle.new is an abstract class and lacks the token to authenticate with loggly.
+  # You should subclass loggly and add a method named token that returns a string with the appropiate token.
+  # SEE the method token on this class to know more about it
+  #
+  # EXAMPLES
+  # USAGE: Let's say you have a class named TicketLoggly that subclasses Loggly.
+  #
+  # TicketLoggly.record("This works")
+  #
+  # You can also send a timestamp. For example:
+  #
+  # TicketLoggly.record("With a Timestamp", Time.now)
+  #
+  # Or you can get creative like:
+  #
+  # TicketLoggly.record(Event.last.attributes.to_json ,Time.now )
+
+  def self.record(message, time=nil)
+    self.send_to_loggly(message, time)
+  end
+
+  # Public
+  #
+  # This method behaves the same as record, but uses resque to send the message.
+  #
+  def self.async_record(message, time=nil)
+    begin
+      Resque.enqueue(LogglyResque, self.class, message, time)
+    rescue => e
+      puts e
+      puts "There was an error cueing loggly"
+    end
+  end
+
+
+  private
+
+  # Private
+  #  We use this method internally to send messages to loggly.
+  #  It is used by the Resque worker and by the record method.
+  def self.send_to_loggly(message, time=nil)
+    begin
+      RestClient.post(self.url, (message + " | Time : " + time.to_s))
+    rescue => e
+      puts e
+      puts "There was a problem making the HTTP call to Loggly"
+    end
+  end
+end

data/loggly.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{loggly}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ivan Acosta-Rubio"]
@@ -17,7 +17,9 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
+    ".autotest",
     ".document",
+    ".rspec",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -26,8 +28,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/loggly.rb",
     "loggly.gemspec",
-    "test/helper.rb",
-    "test/test_loggly.rb"
+    "spec/loggly_spec.rb"
   ]
   s.homepage = %q{http://github.com/ivanacostarubio/loggly}
   s.licenses = ["MIT"]
@@ -40,21 +41,39 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.6"])
+      s.add_runtime_dependency(%q<resque>, [">= 1.1"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<resque_unit>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 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"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
     else
+      s.add_dependency(%q<rest-client>, [">= 1.6"])
+      s.add_dependency(%q<resque>, [">= 1.1"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<resque_unit>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rest-client>, [">= 1.6"])
+    s.add_dependency(%q<resque>, [">= 1.1"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<resque_unit>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
   end
 end
 

data/spec/loggly_spec.rb

@@ -0,0 +1,43 @@
+require Dir.pwd + '/lib/loggly'
+
+require 'resque'
+require 'fakeweb'
+require 'rspec'
+require 'resque_unit'
+
+#Resque.inline = true
+
+class TestLoggly < Loggly
+  def self.token
+    'test'
+  end
+end
+
+ok_response = "{\"response\":\"ok\"}"
+bad_response = "There was a problem making the HTTP call to Loggly"
+
+def mock_url_with(url, response)
+  FakeWeb.register_uri(:post, url, :body => response)
+end
+
+mock_url_with("http://logs.loggly.com/inputs/test", ok_response)
+
+describe Loggly do
+
+  include ResqueUnit::Assertions
+  include Test::Unit::Assertions
+
+  it "sends the message to loggly" do
+    TestLoggly.record("This is a test").should == ok_response
+  end
+
+  it "can send an optional parameters" do
+    TestLoggly.record("Our message", Time.now.to_s).should == ok_response
+  end
+
+  it "can send the message async" do
+    TestLoggly.async_record("sk")
+    assert_queued(LogglyResque)
+  end
+
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ivan Acosta-Rubio
@@ -17,23 +17,73 @@ cert_chain: []
 date: 2011-11-19 00:00:00 -06:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: rest-client
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: resque
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: json
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: resque_unit
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
         version: "0"
-  requirement: *id001
+  requirement: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -42,12 +92,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
+  requirement: *id006
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -56,19 +106,43 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  requirement: *id003
+  requirement: *id007
 - !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
   name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: fakeweb
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
 description: " We send messages to Loggly using resque or not"
 email: ivan@bakedweb.net
 executables: []
@@ -79,7 +153,9 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files: 
+- .autotest
 - .document
+- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -88,8 +164,7 @@ files:
 - VERSION
 - lib/loggly.rb
 - loggly.gemspec
-- test/helper.rb
-- test/test_loggly.rb
+- spec/loggly_spec.rb
 has_rdoc: true
 homepage: http://github.com/ivanacostarubio/loggly
 licenses: 

data/test/helper.rb

@@ -1,18 +0,0 @@
-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 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'loggly'
-
-class Test::Unit::TestCase
-end

data/test/test_loggly.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestLoggly < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end