egg-notifier 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@egg-notifier"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.12 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+gemspec
+gem 'rake'
+gem 'rspec'
+gem 'fakeweb'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 mikegee
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Egg::Notifier
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-egg-notifier', :require => 'egg-notifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-egg-notifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/egg-notifier.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/egg-notifier/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "egg-notifier"
+  gem.version       = Egg::Notifier::VERSION
+
+  gem.authors       = ["mikegee"]
+  gem.email         = ["gee.24@osu.edu"]
+  gem.homepage      = "https://github.com/ASCTech/ruby-egg-notifier"
+  gem.summary       = %q{A Ruby library to send events to Egg}
+  gem.description   = %q{This simple Ruby library notifies Egg of events via an HTTP POST.}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'json'
+end

data/lib/egg-notifier.rb

@@ -0,0 +1,12 @@
+require "net/http"
+require "json"
+require "time"
+
+# The gemspec uses the full path of the version file, and 1.8 requires
+# it twice if the path is different. So we expand_path here, too.
+require File.expand_path('../egg-notifier/version', __FILE__)
+
+require "egg-notifier/configuration"
+require "egg-notifier/egg"
+require "egg-notifier/egg/notifier"
+require "egg-notifier/egg/exceptions"

data/lib/egg-notifier/configuration.rb

@@ -0,0 +1,10 @@
+class Egg
+  class << self
+    attr_accessor :api_key, :raise_on_failure
+    attr_reader   :url
+
+    def url=(url)
+      @url = URI(url)
+    end
+  end
+end

data/lib/egg-notifier/egg.rb

@@ -0,0 +1,5 @@
+class Egg
+  def self.notify(*args)
+    Notifier.new(*args).execute!
+  end
+end

data/lib/egg-notifier/egg/exceptions.rb

@@ -0,0 +1,8 @@
+class Egg
+  class APIKeyNotDefined < RuntimeError; end
+  class UrlNotDefined    < RuntimeError; end
+
+  class Notifier
+    class HTTPFailure    < RuntimeError; end
+  end
+end

data/lib/egg-notifier/egg/notifier.rb

@@ -0,0 +1,60 @@
+class Egg
+  class Notifier
+
+    require 'net/https'
+
+    attr_accessor :event_name, :timestamp
+
+    def initialize(event_name, timestamp=Time.now)
+      @event_name = event_name
+
+      timestamp = Time.parse(timestamp.to_s) unless timestamp.respond_to?(:utc)
+      @timestamp = timestamp.utc.iso8601
+    end
+
+    def execute!
+      raise APIKeyNotDefined unless Egg.api_key
+      raise UrlNotDefined    unless Egg.url
+
+      response = self.class.http.post(url.path, params.to_json, headers)
+
+      if Egg.raise_on_failure and !response.kind_of?(Net::HTTPSuccess)
+        if response
+          raise HTTPFailure.new("#{response.code}: #{response.body}")
+        else
+          raise HTTPFailure.new("nil HTTP response, that's odd.")
+        end
+      end
+
+      response
+    end
+
+
+    private
+
+    def self.http
+      return @http if @http
+
+      @http = Net::HTTP.new(url.host, url.port)
+      @http.use_ssl = true if url.scheme == 'https'
+      @http
+    end
+
+    def self.url
+      Egg.url
+    end
+
+    def url
+      Egg.url
+    end
+
+    def params
+      {:name => @event_name, :timestamp => @timestamp}
+    end
+
+    def headers
+      {'Content-type' => 'application/json', 'X-API-Key' => Egg.api_key}
+    end
+
+  end
+end

data/lib/egg-notifier/version.rb

@@ -0,0 +1,5 @@
+class Egg
+  class Notifier
+    VERSION = "0.0.2"
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Egg, 'configuration' do
+  subject { Egg } # not Egg.new
+
+  describe 'setting the URL' do
+    let(:url) { 'http://egg.example.com/events' }
+    before { subject.url = url }
+
+    its(:url)         { should eq(URI(url)) }
+    its('url.scheme') { should eq('http') }
+    its('url.host')   { should eq('egg.example.com') }
+    its('url.port')   { should eq(80) }
+    its('url.path')   { should eq('/events') }
+  end
+
+  describe 'setting the API key' do
+    let(:api_key) { '1234567890abcdef' }
+    before { subject.api_key = api_key }
+    its(:api_key) { should eq(api_key) }
+  end
+end

data/spec/egg_notify_helper_method_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Egg, '#notify' do
+  subject { Egg } # not Egg.new
+
+  let(:event_name) { 'EventName' }
+  let(:notifier)   { stub(Egg::Notifier) }
+
+  before do
+    Egg::Notifier.should_receive(:new).with(*notification_args).and_return(notifier)
+    notifier.should_receive(:execute!).and_return(:response)
+  end
+
+  context 'not specifying a timestamp' do
+    let(:notification_args) { [event_name] }
+
+    it 'should return the response from Egg::Notifier#execute!' do
+      subject.notify(*notification_args).should eq(:response)
+    end
+  end
+
+  context 'specifying the timestamp' do
+    let(:timestamp) { Time.now - 3600 }
+    let(:notification_args) { [event_name, timestamp] }
+
+    it 'should return the same response' do
+      subject.notify(*notification_args).should eq(:response)
+    end
+  end
+end

data/spec/notifier_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Egg::Notifier do
+
+  describe '#new' do
+    describe 'the default timestamp is now' do
+      let(:timestamp) { Time.at(100000000) }
+      subject { Egg::Notifier.new('the-event-name') }
+      before { Time.should_receive(:now).and_return(timestamp) }
+      its(:timestamp) { should eq(timestamp.utc.iso8601) }
+    end
+  end
+
+  describe '#execute!' do
+    let(:api_key) { '1234567890abcdef' }
+    subject { Egg::Notifier.new('the-event-name', '2012-08-23T14:25:00Z') }
+
+    it 'should raise an exception when the API key is not defined' do
+      Egg.url = 'http://egg.example.com/events'
+      lambda { subject.execute! }.should raise_error(Egg::APIKeyNotDefined)
+    end
+
+    it 'should raise an exception when the url is not defined' do
+      Egg.api_key = api_key
+      lambda { subject.execute! }.should raise_error(Egg::UrlNotDefined)
+    end
+
+    context 'with api_key and url defined' do
+      let(:http)    { Egg::Notifier.send(:http) }
+      let(:json)    { '{"name":"the-event-name","timestamp":"2012-08-23T14:25:00Z"}' }
+      let(:headers) { {'Content-type' => 'application/json', 'X-API-Key' => api_key} }
+
+      before do
+        Egg.api_key = api_key
+        Egg.url = 'http://egg.example.com/events'
+        http.should_receive(:post).with('/events', json, headers)
+      end
+
+      it 'should work right' do
+        subject.execute!
+      end
+    end
+  end
+
+  describe '.http' do
+    let(:url)  { URI('http://egg.example.com/events') }
+    before do
+      Egg::Notifier.instance_variable_set('@http', nil)
+      Egg.url = url
+      http = Net::HTTP.new(url.host, url.port)
+      Net::HTTP.should_receive(:new).once.and_return(http)
+    end
+    it 'should only instantiate the HTTP object once' do
+      3.times { Egg::Notifier.send(:http) }
+    end
+  end
+end

data/spec/raise_on_failure_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Egg::Notifier, 'raise an exception on HTTP failure' do
+  subject { Egg::Notifier.new('some-event') }
+
+  let(:url) { 'http://egg.example.com/events' }
+
+  before do
+    Egg.url = url
+    Egg.api_key = '1234567890abcdef'
+    FakeWeb.register_uri(:post, url, :status => 406, :body => 'Rejected')
+  end
+
+  context 'raise_on_failure set to true' do
+    before { Egg.raise_on_failure = true }
+    specify do
+      lambda { subject.execute! }.should raise_error(Egg::Notifier::HTTPFailure)
+    end
+
+    it 'should include the code and body in the Error message' do
+      begin
+        subject.execute!
+      rescue Egg::Notifier::HTTPFailure => e
+        e.message.should eq("406: Rejected")
+      end
+    end
+  end
+
+  context 'raise_on_failure set to false' do
+    before { Egg.raise_on_failure = false }
+    specify do
+      lambda { subject.execute! }.should_not raise_error(Egg::Notifier::HTTPFailure)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'fake_web'
+
+require 'egg-notifier'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+
+  FakeWeb.allow_net_connect = false
+
+#  FakeWeb.register_uri(:post, 'http://egg.example.com/events', :status => 201)
+
+  config.before(:each) { Egg.instance_variable_set('@url', nil); Egg.api_key = nil }
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: egg-notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- mikegee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70167371929660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167371929660
+description: This simple Ruby library notifies Egg of events via an HTTP POST.
+email:
+- gee.24@osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- egg-notifier.gemspec
+- lib/egg-notifier.rb
+- lib/egg-notifier/configuration.rb
+- lib/egg-notifier/egg.rb
+- lib/egg-notifier/egg/exceptions.rb
+- lib/egg-notifier/egg/notifier.rb
+- lib/egg-notifier/version.rb
+- spec/configuration_spec.rb
+- spec/egg_notify_helper_method_spec.rb
+- spec/notifier_spec.rb
+- spec/raise_on_failure_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ASCTech/ruby-egg-notifier
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A Ruby library to send events to Egg
+test_files:
+- spec/configuration_spec.rb
+- spec/egg_notify_helper_method_spec.rb
+- spec/notifier_spec.rb
+- spec/raise_on_failure_spec.rb
+- spec/spec_helper.rb