whoopsy 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,8 @@
 # Whoopsy
 
-TODO: Write a gem description
+Whoppsy provides an awesome 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.
 
 ## Installation
 
@@ -18,8 +20,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Make sure you have installed your whoops_server first! http://www.whoopsapp.com/whoops-server/
+
+Once installed the minimum options to connect to the whoops_server are:
+
+ * --host fqdn
+ * --port 80
+
+These options can be specified in a configuration file or on the command line.  The configuration files supported in order of priority are:
+
+ * /etc/whoopsy.yml
+ * $HOME/.whoopsy.yml
+ * $WHOOPSY_CONFIG (full path to file)
+
+The following connection parameters are supported:
+
+ * --host
+ * --http_open_timeout
+ * --http_read_timeout
+ * --port
+ * --protocol
+ * --proxy_host
+ * --proxy_pass
+ * --proxy_port
+ * --proxy_user
+ * --secure
+
+(These options come directly from the whoopsy_logger gem http://www.whoopsapp.com/whoops-logger/)
+
+A sample config file might look like:
+```yaml
+:host: localhost
+:port: 3000
+```
+
+Note that the command line options will override any options specified in the configuration files.
+
+You must specify the additional required paramters to send a message to the whoops_server:
+
+ * --event-type
+ * --service
+ * --environment
+ * --message
+ * --event-group-identifier
+
+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"
+```
 ## Contributing
 
 1. Fork it

data/bin/whoopsy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'whoopsy'
+
+Whoopsy::Logger.new(ARGV)

data/bin/whoopsy.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'whoopsy'
+
+Whoopsy::Logger.new(ARGV)

data/lib/whoopsy/config.rb

@@ -0,0 +1,74 @@
+require 'yaml'
+require 'logger'
+
+module Whoopsy
+  CONFIG_OPTIONS = [:host,
+                    :http_open_timeout,
+                    :http_read_timeout,
+                    :port,
+                    :protocol,
+                    :proxy_host,
+                    :proxy_pass,
+                    :proxy_port,
+                    :proxy_user,
+                    :secure,
+                    :event_type,
+                    :service,
+                    :environment,
+                    :message,
+                    :event_group_identifier,
+                    :details]
+
+  class Config
+
+    CONFIG_OPTIONS.each do |var|
+      class_eval { attr_accessor var }
+    end
+
+    def initialize
+
+      @config = {}
+
+      @file_name = 'whoopsy.yml'
+      @global_config_file = "/etc/#{@file_name}"
+      @local_config_file = "#{File.join(ENV['HOME'], ".#{@file_name}")}"
+      @environment_file = ENV['WHOOPSY_CONFIG']
+
+      # Load in order of priority
+      load_file @global_config_file
+      load_file @local_config_file
+      load_file @environment_file if @environment_file
+
+      CONFIG_OPTIONS.each do |var|
+        eval("self.#{var} = \"#{@config[var]}\"")
+      end
+
+    end
+
+    # Return a hash of config options for the whoops_logger, making sure the "type" is correct
+    def config_hash
+      h = {}
+
+      [:host, :protocol, :proxy_host, :proxy_pass, :proxy_port, :proxy_user, :secure].each do |var|
+        eval("h[:#{var}] = @#{var} unless @#{var}.empty?")
+      end
+
+      [:http_open_timeout, :http_read_timeout, :port].each do |var|
+        eval("h[:#{var}] = @#{var}.to_i if @#{var}.to_i > 0")
+      end
+
+      h
+    end
+
+    private
+
+    def load_file(file_name)
+      begin
+        @config.merge! YAML::load_file(file_name)
+      rescue Errno::ENOENT
+        $stderr.puts "WARNING: #{file_name} does not exist"
+      end
+    end
+
+  end
+end

data/lib/whoopsy/version.rb

@@ -1,3 +1,10 @@
 module Whoopsy
-  VERSION = "0.0.1"
-end
+  VERSION = '0.1.0'
+  AUTHORS = ['Jon Gillies']
+  EMAIL = %w(supercoder@gmail.com)
+  DESCRIPTION = %q{Log to Whoops Logger in your scripts'}
+  SUMMARY = %q{Awesome CLI Interface to Whoops Logger (http://www.whoopsapp.com/whoops-logger/)}
+  HOMEPAGE = 'https://github.com/jongillies/whoopsy'
+  VERSION_BANNER = "#{self.name} #{self::VERSION} #{self::SUMMARY} (c) 2013 #{self::AUTHORS.join(', ')}"
+  HELP_TEXT = "Use this program to send messages to your Whoops logger.\n\nUsage:"
+end

data/lib/whoopsy.rb

@@ -1,21 +1,80 @@
 require 'whoopsy/version'
+require 'whoopsy/config'
 require 'trollop'
-require 'shellwords'
+require 'whoops_logger'
 
 module Whoopsy
-  class GemName
-    attr_reader :cli_arg
-    def initialize(args={}, version_text='', banner_text='')
+
+  REQUIRED_ARGS = [:host, :port, :event_type, :service, :environment, :event_group_identifier]
+
+  class Logger
+
+    def initialize(args={})
+
       opts = Trollop::options(args) do
-        banner = banner_text
-        version = version_text
+
+        banner "#{Whoopsy::VERSION_BANNER}\n\n#{Whoopsy::HELP_TEXT}"
+        version Whoopsy::VERSION_BANNER
         opt :verbose, 'Verbose output.', short: 'v'
         opt :debug, 'Display additional debugging information.'
+
+        opt :host, 'Whoops Logger hostname', type: String
+        opt :http_open_timeout, 'HTTP open timeout', type: Integer
+        opt :http_read_timeout, 'HTTP read timeout', type: Integer
+        opt :port, 'Whoops Logger port', type: Integer
+        opt :protocol, 'Whoops Logger Protocol', type: String
+        opt :proxy_host, 'Proxy Host', type: String
+        opt :proxy_pass, 'Proxy Password', type: String
+        opt :proxy_port, 'Proxy Port', type: Integer
+        opt :proxy_user, 'Proxy Username', type: String
+        opt :secure, 'Secure?'
+
+        opt :event_type, 'your_event_type', type: String
+        opt :service, 'my_service_name', type: String
+        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
+
+      end
+
+      @config = Whoopsy::Config.new
+
+      # Set the @config attributes based on the opts hash
+      Whoopsy::CONFIG_OPTIONS.each do |option|
+        eval("@config.#{option} = \"#{opts[option]}\"") if opts["#{option}_given".to_sym]
       end
-      unless @cli_arg = args[0]
-        Trollop::die "ERROR: You must specify something on the command line."
+
+      check_required_args
+
+      send_message
+    end
+
+    private
+
+    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
+      })
+
+    end
+
+    def check_required_args
+      Whoopsy::REQUIRED_ARGS.each do |arg|
+        value = eval("@config.#{arg}.to_s.empty?") # This will render a string, if value nil will render ""
+        Trollop::die "Must have the following parameters: [#{Whoopsy::REQUIRED_ARGS.join(', ')}], #{arg} is missing." if value
       end
-      opts
     end
+
   end
 end
+
+

data/spec/cli_spec.rb

@@ -4,12 +4,29 @@ require 'shellwords'
 require 'yaml'
 
 describe 'Different Command Line Options' do
+
   it 'should fail with no options' do
-    expect { Whoopsy::GemName.new({}) }.to raise_error
+    expect { Whoopsy::Logger.new({}) }.to raise_error
   end
-  #
-  it 'should succeed with minimum arguments' do
-    args = 'my-argument'
-    expect { Whoopsy::GemName.new(args.shellsplit, "banner", "version") }.not_to raise_error
+
+  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
   end
-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
+  end
+
+  it 'should spit out help' do
+    args = '--help'
+    expect { Whoopsy::Logger.new(args.shellsplit) }.to raise_error
+  end
+
+  it 'should spit out version' do
+    args = '--version'
+    expect { Whoopsy::Logger.new(args.shellsplit) }.to raise_error
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whoopsy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-lint
+  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: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -43,21 +59,41 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: whoops_logger
+  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
-executables: []
+executables:
+- whoopsy
+- whoopsy.rb
 extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
 - Gemfile
+- bin/whoopsy
+- bin/whoopsy.rb
+- lib/whoopsy/config.rb
 - lib/whoopsy/version.rb
 - lib/whoopsy.rb
 - spec/cli_spec.rb
 - spec/spec_helper.rb
 - README.md
-- LICENSE
 - LICENSE.txt
 homepage: https://github.com/jongillies/whoopsy
 licenses: []

data/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2013 jongillies
-
-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.