whoopsy 0.1.0 → 0.1.2

data/README.md

@@ -1,6 +1,10 @@
 # Whoopsy
 
-Whoppsy provides an awesome CLI Interface to Whoops Logger (http://www.whoopsapp.com/whoops-logger/).
+[![Build Status](https://secure.travis-ci.org/jongillies/whoopsy.png?branch=master)](https://github.com/jongillies/whoopsy)
+[![Gem Version](https://badge.fury.io/rb/whoopsy.png)](https://badge.fury.io/rb/whoopsy)
+[![Dependency Status](https://gemnasium.com/jongillies/whoopsy.png)](https://gemnasium.com/jongillies/whoopsy)
+
+Whoppsy provides an CLI Interface to Whoops Logger (http://www.whoopsapp.com/whoops-logger/).
 
 Consult the whoopsy_logger gem http://www.whoopsapp.com/whoops-logger/) for more detailed information.  This Gem is a simple wrapper for that library.
 
@@ -67,8 +71,27 @@ You must specify the additional required paramters to send a message to the whoo
 Here is an example command line:
 
 ```bash
-whoopsy --host whoops.example.com --port 80 --event-type "warning" --service "my script" --environment "development" --message "working ok today" --event-group-identifier "group7"
+whoopsy --host whoops.example.com --port 80 --event-type "warning" --service "my script" \
+--environment "development" --message "working ok today" --event-group-identifier "group7"
 ```
+
+## Version History
+
+* 0.1.2
+    * Renamed internall Logger class to Log to avoid naming conflict with Logger::Logger
+    * Sent WhoopsLooger a "logger" object to get back status, will set log level to DEBUG if --debug is passed
+    * Noticed that if you setup a "Notification Subscription" on your WhoopsServer and you don't have email configured, you get an internal server error and the message will be lost.
+* 0.1.1
+    * Supressed warnings for config files missing
+    * Noticed --details was not really working because it needs to be a data structure?
+    * Added CI information to the README.MD
+* 0.1.0
+    * Initial release.
+
+## MongoDB Tips
+
+1. mongo whoops --eval "db.dropDatabase()"
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/whoopsy

@@ -2,4 +2,4 @@
 
 require 'whoopsy'
 
-Whoopsy::Logger.new(ARGV)
+Whoopsy::Log.new(ARGV)

data/bin/whoopsy.rb

@@ -2,4 +2,4 @@
 
 require 'whoopsy'
 
-Whoopsy::Logger.new(ARGV)
+Whoopsy::Log.new(ARGV)

data/lib/whoopsy.rb

@@ -2,15 +2,19 @@ require 'whoopsy/version'
 require 'whoopsy/config'
 require 'trollop'
 require 'whoops_logger'
+require 'crack'
+require 'logger'
 
 module Whoopsy
 
   REQUIRED_ARGS = [:host, :port, :event_type, :service, :environment, :event_group_identifier]
 
-  class Logger
+  class Log
 
     def initialize(args={})
 
+      @debug
+
       opts = Trollop::options(args) do
 
         banner "#{Whoopsy::VERSION_BANNER}\n\n#{Whoopsy::HELP_TEXT}"
@@ -34,17 +38,32 @@ module Whoopsy
         opt :environment, 'development', type: String
         opt :message, 'String to Show in Whoops Event List', type: String
         opt :event_group_identifier, 'String used to assign related events to a group', type: String
-        opt :details, 'A string, hash, or array of arbitrary data', type: String
+        opt :details, 'A JSON string, or @filename which contains JSON', type: String
 
       end
 
+      @debug = opts[:debug_given] == true
+
       @config = Whoopsy::Config.new
 
       # Set the @config attributes based on the opts hash
       Whoopsy::CONFIG_OPTIONS.each do |option|
+        next if option == :details
         eval("@config.#{option} = \"#{opts[option]}\"") if opts["#{option}_given".to_sym]
       end
 
+      if opts[:details_given]
+        if opts[:details].to_s.start_with? '@'
+          @config.details = Crack::JSON.parse(File.open(opts[:details].to_s[1..-1], 'r').read)
+        else
+          @config.details = Crack::JSON.parse(opts[:details])
+        end
+      end
+
+      if @config.details == false
+        @config.details = "{\"error\":\"unable to parse JSON data from #{opts[:details]}\"}"
+      end
+
       check_required_args
 
       send_message
@@ -54,17 +73,27 @@ module Whoopsy
 
     def send_message
 
+
       WhoopsLogger.config.set(@config.config_hash)
 
-      WhoopsLogger.log('default::basic', {
-          event_type: @config.event_type,
-          service: @config.service,
-          environment: @config.environment,
-          message: @config.message,
-          event_group_identifier: @config.message,
-          details: @config.details
-      })
+      log = Logger.new(STDOUT)
+      @debug ? log.level = Logger::DEBUG : log.level = Logger::INFO
+
+      WhoopsLogger.config.logger = log
 
+      begin
+        WhoopsLogger.log('default::basic', {
+            event_type: @config.event_type,
+            service: @config.service,
+            environment: @config.environment,
+            message: @config.message,
+            event_group_identifier: @config.message,
+            details: @config.details
+        })
+
+      rescue SocketError => e
+        log.fatal "#{e.message}. Is it the correct hostname?"
+      end
     end
 
     def check_required_args

data/lib/whoopsy/config.rb

@@ -66,7 +66,7 @@ module Whoopsy
       begin
         @config.merge! YAML::load_file(file_name)
       rescue Errno::ENOENT
-        $stderr.puts "WARNING: #{file_name} does not exist"
+        ; # No problem here, but catch this specific error
       end
     end
 

data/lib/whoopsy/version.rb

@@ -1,5 +1,5 @@
 module Whoopsy
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
   AUTHORS = ['Jon Gillies']
   EMAIL = %w(supercoder@gmail.com)
   DESCRIPTION = %q{Log to Whoops Logger in your scripts'}

data/spec/cli_spec.rb

@@ -6,27 +6,64 @@ require 'yaml'
 describe 'Different Command Line Options' do
 
   it 'should fail with no options' do
-    expect { Whoopsy::Logger.new({}) }.to raise_error
+    expect { Whoopsy::Log.new({}) }.to raise_error
   end
 
   it 'should succeed with required arguments' do
     args = "--event-type 'warning' --service 'my script' --environment 'development' --message 'working ok today' --event-group-identifier 'whats this'"
-    expect { Whoopsy::Logger.new(args.shellsplit) }.not_to raise_error
+    expect { Whoopsy::Log.new(args.shellsplit) }.not_to raise_error
   end
 
   it 'should fail missing --environment' do
     args = "--event-type 'warning' --service 'my script' --message 'working ok today' --event-group-identifier 'whats this'"
-    expect { Whoopsy::Logger.new(args.shellsplit) }.to raise_error
+    expect { Whoopsy::Log.new(args.shellsplit) }.to raise_error
   end
 
   it 'should spit out help' do
     args = '--help'
-    expect { Whoopsy::Logger.new(args.shellsplit) }.to raise_error
+    expect { Whoopsy::Log.new(args.shellsplit) }.to raise_error
   end
 
   it 'should spit out version' do
     args = '--version'
-    expect { Whoopsy::Logger.new(args.shellsplit) }.to raise_error
+    expect { Whoopsy::Log.new(args.shellsplit) }.to raise_error
   end
 
-end
+end
+
+#describe 'Handling --details' do
+#
+#  it 'should parse --details from the command line' do
+#
+#    details = { first_name: 'Scooby', last_name: 'Doo', age: 7, friends: %w(Fred Daphne Velma Shaggy) }
+#
+#    args = "--event-type \"warning\" --service \"my script\" --environment \"development\" --message \"working ok today\" --event-group-identifier \"whats this\" --details \"#{details.to_json}\""
+#
+#    expect { Whoopsy::Log.new(args.shellsplit)}.not_to raise_error
+#  end
+#
+#  #it 'should parse --details from a file' do
+#  #
+#  #  file = 'spec/data/good.json'
+#  #  args = "--event-type \"warning\" --service \"my script\" --environment \"development\" --message \"working ok today\" --event-group-identifier \"whats this\" --details @#{file}"
+#  #
+#  #  expect { Whoopsy::Log.new(args.shellsplit)}.not_to raise_error
+#  #end
+#  #
+#  #it 'should fail if --details cannot be cracked' do
+#  #
+#  #  file = 'spec/data/bad.json'
+#  #  args = "--event-type \"warning\" --service \"my script\" --environment \"development\" --message \"working ok today\" --event-group-identifier \"whats this\" --details @#{file}"
+#  #
+#  #  expect { Whoopsy::Log.new(args.shellsplit)}.not_to raise_error
+#  #end
+#  #
+#  #it 'should fail if --details file is empty' do
+#  #
+#  #  file = 'spec/data/empty.json'
+#  #  args = "--event-type \"warning\" --service \"my script\" --environment \"development\" --message \"working ok today\" --event-group-identifier \"whats this\" --details @#{file}"
+#  #
+#  #  expect { Whoopsy::Log.new(args.shellsplit)}.not_to raise_error
+#  #end
+#
+#end

data/spec/data/bad.json

@@ -0,0 +1,12 @@
+
+    {
+        "ipAddress":"10.16.100.109",
+        "fqdn":"0050563fe4f5.devapollogrp.edu",
+        "id":1
+    },
+
+        "ipAddress":"10.16.100.193",
+        "fqdn":"0050563fc8d5.devapollogrp.edu",
+        "id":2
+    }
+]

data/spec/data/good.json

@@ -0,0 +1,12 @@
+[
+    {
+        "ipAddress": "10.16.100.109",
+        "fqdn": "0050563fe4f5.devapollogrp.edu",
+        "id": 1
+    },
+    {
+        "ipAddress": "10.16.100.193",
+        "fqdn": "0050563fc8d5.devapollogrp.edu",
+        "id": 2
+    }
+]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whoopsy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2013-08-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Log to Whoops Logger in your scripts'
 email:
 - supercoder@gmail.com
@@ -92,6 +124,9 @@ files:
 - lib/whoopsy/version.rb
 - lib/whoopsy.rb
 - spec/cli_spec.rb
+- spec/data/bad.json
+- spec/data/empty.json
+- spec/data/good.json
 - spec/spec_helper.rb
 - README.md
 - LICENSE.txt