notificate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 439b7d13b42b1e8ba4fa48fdf5e992d90ec15304
+  data.tar.gz: 7b54968bd0af5a57c847ad8802ba1abf84c81e59
+SHA512:
+  metadata.gz: 417b1f76de6b9d664aedee54354399a8bb97c59edbb8bc9e01df7c373ca0cbbd62777e3ba7a4fd5e62f6b735c0469c94954fb5fb2c74641b1765e32cf3c18fea
+  data.tar.gz: 0b6a918889b6f9d7bb8b41a77a3821fb9a832c144935446df10a08df667dab6d9f33ae020f6e8dc9d51f41456d91cc9d034069286d4adfcd99d978de37d7d54b

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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  watch(%r|^test/(.*)\/?(.*)_test\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 James Newton <james@Zaphyous.com>
+
+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 @@
+# Howell::Rails
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'howell-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install howell-rails
+
+## 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 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = true
+end
+
+task :default => :test

data/lib/notificate-rails/configuration.rb

@@ -0,0 +1,7 @@
+module Notificate::Rails::Configuration
+  attr_reader :options
+
+  def configure(opts = {})
+    @options = Notificate::ObjectifiedHash.new(opts)
+  end
+end

data/lib/notificate-rails/controller.rb

@@ -0,0 +1,34 @@
+module Notificate::Rails::Controller
+  def self.included(klass)
+    klass.extend ControllerMethods
+  end
+
+  def rails_data
+    {
+      environment: ::Notificate::Rails.options.environment,
+      root:        ::Notificate::Rails.options.project_root
+    }
+  end
+
+  def notify_notificate(exception)
+    ::Notificate::ExceptionCatcher.notify(exception, rails_data)
+  end
+
+  def _notificate_around_filter
+    begin
+      yield
+    rescue Object => error
+      handler = error.respond_to?(:original_exception) ? error.original_exception : error
+
+      notify_notificate(error) unless handler_for_rescue(handler)
+
+      raise
+    end
+  end
+
+  module ControllerMethods
+    def enable_notificate_notifications(options = {})
+      prepend_around_filter :_notificate_around_filter, options
+    end
+  end
+end

data/lib/notificate-rails/rack.rb

@@ -0,0 +1,28 @@
+module Notificate::Rails
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @env = env
+
+      begin
+        result = @app.call(env)
+      rescue ::Exception => ex
+        @env['notificate.notified'] = ::Notificate::ExceptionCatcher.notify(ex, rack_data)
+
+        raise ex
+      end
+
+      result
+    end
+
+    def rack_data
+      {
+        environment: ::Notificate::Rails.options.environment,
+        root:        ::Notificate::Rails.options.project_root
+      }
+    end
+  end
+end

data/lib/notificate-rails/railtie.rb

@@ -0,0 +1,20 @@
+class Notificate::Rails::Railtie < Rails::Railtie
+  initializer 'notificate.configure_rails_initialization' do |app|
+    Notificate::Rails.configure(
+      environment:  Rails.env.to_s,
+      project_root: Rails.root.to_s
+    )
+
+    if app.respond_to?(:config) and app.config.respond_to?(:middleware)
+      require 'notificate-rails/rack'
+
+      if defined?(ActionDispatch::DebugExceptions)
+        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Notificate::Rails::Rack
+      elsif defined?(ActionDispatch::ShowExceptions)
+        app.config.middleware.insert_after ActionDispatch::ShowExceptions, Notificate::Rails::Rack
+      else
+        app.config.middleware.insert 0, Notificate::Rails::Rack
+      end
+    end
+  end
+end

data/lib/notificate-rails/version.rb

@@ -0,0 +1,5 @@
+module Notificate
+  module Rails
+    VERSION = '0.0.1'
+  end
+end

data/lib/notificate.rb

@@ -0,0 +1,31 @@
+module Notificate; end
+
+require 'json'
+require 'httparty'
+require 'notificate-rails/version'
+require 'notificate/objectified_hash'
+require 'notificate/configuration'
+require 'notificate/notice'
+require 'notificate/exception_catcher'
+
+module Notificate
+  extend Configuration
+
+  def self.notice(message)
+    payload = { body: { payload: { message: message } }.to_json }
+
+    Notice.new(payload, :application)
+  end
+end
+
+if defined?(Rails)
+  require 'notificate-rails/configuration'
+  require 'notificate-rails/railtie'
+  require 'notificate-rails/controller'
+
+  module Notificate::Rails
+    extend Configuration
+
+    include Controller
+  end
+end

data/lib/notificate/configuration.rb

@@ -0,0 +1,14 @@
+module Notificate::Configuration
+  attr_reader :options
+
+  def configure(opts = {})
+    opts[:protocol] ||= :https
+    opts[:port]     ||= 80
+
+    @options = Notificate::ObjectifiedHash.new(opts)
+  end
+
+  def request_path
+    "#{options.protocol}://#{options.hostname}:#{options.port}/#{options.endpoint}#{options.params}"
+  end
+end

data/lib/notificate/exception_catcher.rb

@@ -0,0 +1,7 @@
+module Notificate::ExceptionCatcher
+  def self.notify(exception, data)
+    payload = { body: { payload: { exception: exception.to_s, data: data } }.to_json }
+
+    ::Notificate::Notice.new(payload, :exception)
+  end
+end

data/lib/notificate/notice.rb

@@ -0,0 +1,22 @@
+class Notificate::Notice
+  include ::HTTParty
+
+  def initialize(message, message_type)
+    @defaults = { headers: { 'Content-Type' => 'application/json'} }
+
+    case message_type
+    when :application
+      app_notice(message)
+    when :exception
+      exception_notice(message)
+    end
+  end
+
+  def app_notice(payload)
+    self.class.post(Notificate.request_path, payload.merge(@defaults))
+  end
+
+  def exception_notice(payload)
+    self.class.post(Notificate.request_path, payload.merge(@defaults))
+  end
+end

data/lib/notificate/objectified_hash.rb

@@ -0,0 +1,14 @@
+class Notificate::ObjectifiedHash
+  def initialize(hash)
+    @data = hash.inject({}) do |data, (key, value)|
+      value = self.new(value) if value.is_a? Hash
+
+      data[key.to_s] = value
+      data
+    end
+  end
+
+  def method_missing(key)
+    @data.key?(key.to_s) ? @data[key.to_s] : nil
+  end
+end

data/notificate.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notificate-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'notificate'
+  spec.version       = Notificate::Rails::VERSION
+  spec.authors       = ['James Newton']
+  spec.email         = ['james@Zaphyous.com']
+  spec.description   = %q{Send notices to howell throughout rails applications}
+  spec.summary       = %q{Send notices to howell throughout rails applications}
+  spec.homepage      = 'https://github.com/zaphyous/notificate'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-colorize'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rails'
+end

data/test/lib/notificate-rails/configuration_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class NotificateRailsConfigurationTest < MiniTest::Unit::TestCase
+  def setup
+    Notificate::Rails.configure(
+      environment: 'production',
+      project_root: File.expand_path(File.dirname(__FILE__) + '../../../'),
+    )
+  end
+
+  def test_environment
+    assert_equal Notificate::Rails.options.environment, 'production'
+  end
+
+  def test_project_root
+    assert_equal Notificate::Rails.options.project_root, File.expand_path(File.dirname(__FILE__) + '../../..')
+  end
+end

data/test/lib/notificate/configuration_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class NotificateConfigurationTest < MiniTest::Unit::TestCase
+  def setup
+    notificate_config
+  end
+
+  def test_hostname
+    assert_equal Notificate.options.hostname, 'example.com'
+  end
+
+  def test_endpoint
+    assert_equal Notificate.options.endpoint, 'app_notices'
+  end
+
+  def test_params
+    assert_equal Notificate.options.params, '?channel=zaphyous'
+  end
+
+  def test_port
+    assert_equal Notificate.options.port, 1234
+  end
+
+  def test_request_path
+    assert_equal Notificate.request_path, 'http://example.com:1234/app_notices?channel=zaphyous'
+  end
+end

data/test/lib/notificate/notice_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+# TODO:
+# * Add a test to check the content of what is being sent in a notice
+class NotificateNoticeTest < MiniTest::Unit::TestCase
+  def setup
+    notificate_config
+
+    @stub_notice = stub_request(:post, Notificate.request_path)
+  end
+
+  def test_notices_going_to_endpoint
+    Notificate.notice 'Testing'
+
+    assert_requested @stub_notice
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'minitest-colorize'
+require 'webmock/minitest'
+require 'rails'
+require 'notificate'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+def notificate_config(opts = {})
+  Notificate.configure(
+    protocol: opts[:protocol] || 'http',
+    hostname: opts[:hostname] || 'example.com',
+    endpoint: opts[:endpoint] || 'app_notices',
+    params:   opts[:params]   || '?channel=zaphyous',
+    port:     opts[:port]     || 1234
+  )
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: notificate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Newton
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ4wDAYDVQQDDAVqYW1l
+  czEYMBYGCgmSJomT8ixkARkWCFphcGh5b3VzMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTEzMDQwNTIxMzEzOVoXDTE0MDQwNTIxMzEzOVowPzEOMAwGA1UEAwwFamFt
+  ZXMxGDAWBgoJkiaJk/IsZAEZFghaYXBoeW91czETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOh7OtTl+UmXxZh2pbmv
+  J6ed/K2X5XtZvxQBEaEMtnfmgHcWbQY6akcAO68Kau4/jLbkq6yolAzMG48WEnj1
+  SrL28103hyZAhLcBTPLkGgark3GsK6TFsuoStBMAmA1y8aToBSKSP+eksjGMj7LJ
+  AfRKNfBokbXttjcaM1iqwYEXsLiJ4DHUDV4fWEEqCtDq8T9UKniDzDDRnLiiv4W8
+  KTyx7ZXvfwFRUJdNLjafnyVFFscru4eYAxKIBRJ890EBNMwIQwwc6i7p1xCpBILw
+  gQNSk2bNbL9QS3qaF0mmFduQpS3yi5zSfm+b/BMTmVhdRpJl5L3V2mJSK57JIaES
+  zN0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFKf6
+  AvzYWNq1vKs1A98HazUOXGebMB0GA1UdEQQWMBSBEmphbWVzQFphcGh5b3VzLmNv
+  bTAdBgNVHRIEFjAUgRJqYW1lc0BaYXBoeW91cy5jb20wDQYJKoZIhvcNAQEFBQAD
+  ggEBACo8Gb2O/KyIccN1X0vShC6PMzpo7IdyVs+naFqU3de8+vazLUxLHgi8yqg5
+  Ue4FdR++juHJCCAPJghrYi0/RlNR7+ZVhgM9/MFO283DaYyHW1+CRXp7KKlbcyUS
+  +2iqTVsjDNu4RCpjDZd0p7iqGk11+tpaWpnEvgCCGjnhox/Mmu2tjpxYP4z3RpDZ
+  IPJIx8Whh1iM5GGR2jt7O6PY7sYUBv5v85T0RTNY1xTUIwzZy1sjLMqgcZBlFF/8
+  IdasO+EybhhmNT32weebimCM21ychbBqkWzJGPlIfqgvmOMbQc/TwQcwkYPgoX6l
+  QdB79NrQet5m6RR7qA5joVvZhZA=
+  -----END CERTIFICATE-----
+date: 2013-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send notices to howell throughout rails applications
+email:
+- james@Zaphyous.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/notificate-rails/configuration.rb
+- lib/notificate-rails/controller.rb
+- lib/notificate-rails/rack.rb
+- lib/notificate-rails/railtie.rb
+- lib/notificate-rails/version.rb
+- lib/notificate.rb
+- lib/notificate/configuration.rb
+- lib/notificate/exception_catcher.rb
+- lib/notificate/notice.rb
+- lib/notificate/objectified_hash.rb
+- notificate.gemspec
+- test/lib/notificate-rails/configuration_test.rb
+- test/lib/notificate/configuration_test.rb
+- test/lib/notificate/notice_test.rb
+- test/test_helper.rb
+homepage: https://github.com/zaphyous/notificate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Send notices to howell throughout rails applications
+test_files:
+- test/lib/notificate-rails/configuration_test.rb
+- test/lib/notificate/configuration_test.rb
+- test/lib/notificate/notice_test.rb
+- test/test_helper.rb