trusty 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b77b80ef65c070c5a9495fe84266637f79d3f0f6
-  data.tar.gz: 404bce742414fee7241f75997c52e9e577254d2c
+  metadata.gz: f19690f72d7d3b49ee371125c130f005e1a7b347
+  data.tar.gz: 525c37e879aa8a171a2d5ba213db391206091f79
 SHA512:
-  metadata.gz: 8bdebec526788514c3503e985037e13813e74a1f1e811b4bd1433c496dacedffa6d7c6d9a0eced42e8d2c17639ed6c7de7a10038ecf3fc707dec2f6e1c48f605
-  data.tar.gz: 6db733cc52d5da507261dd29c69a9b0a35ce881052cf3fac3ef379adf58fa399b26ffdbf46114d2a1b20d7edbea960af3fd43c195b3daf9189e8274b0a35a4bb
+  metadata.gz: 6e1fdf638e05d39b2783c2fabdfc6fb669a197e032bff5f2e8d6a91f372846bc7f16fbb5a05ec9b361ce177be0358085f5a54d1890715657b291644365fe04ee
+  data.tar.gz: 0aaf8265f6ce15530213afb547a544638b63ac31340df3310c570ddef4ae663e84bff0764f8586ee5c96a4fad694d44d7e7d987c8de8d8bc5ca758a6473c9514

data/README.md

@@ -152,6 +152,46 @@ class MyModel
 end
 ```
 
+### Error Handling
+
+You can include the `Trusty::Errors::Retry` module to call the `retry_block` helper method to retry a block of code. 
+This is useful when dealing with HTTP errors and such things with APIs and so on. 
+You can also easily add the retry behavior to a method with the same options you would pass to `retry_block`.
+
+```Ruby
+class MyModel
+  include Trusty::Errors::Retry
+  
+  def api_request
+    retry_block :retry => 3 do
+      # ... some API calls ...
+    end
+  end
+  
+  # add retry behavior to any method
+  def api_request2
+    # ... some API calls ...
+  end
+  retry_method :api_request2, :retry => 3
+  
+end
+```
+
+#### Exception Notification Integration
+
+If you use the "ExceptionNotification" gem, requiring `trusty/exception_notification` will automatically listen for exceptions thrown and handled from `Trusty::Errors::*`. 
+Exceptions handled by Trusty will include contextual data and the `env` data for ExceptionNotification to include in error emails.
+
+### Rails Extensions
+
+Require `trusty/rails` to register the `Trusty::Rails::Engine` and add some extensions to Rails. 
+Controller extensions are added to fix quirks such as making sure Flash messages aren't lost on redirect. 
+Error handling in Rake and ExceptionNotification are also wired up to listen to exceptions handled by Trusty (see above).
+
+### Iron.io
+
+The `Trusty::IronIo::QueueProcessor` makes it easy to pull messages off a queue.
+
 ## Contributing
 
 1. Fork it

data/lib/trusty/errors/exception_handlers.rb

@@ -0,0 +1,27 @@
+require 'active_support'
+
+module Trusty
+  module Errors
+    module ExceptionHandlers
+      
+      def try_with_data(data, &block)
+        begin
+          yield
+        rescue => exception
+          notify_exception exception, :data => data, :raise => true
+        end
+      end
+      
+      # include in classes
+      def notify_exception(exception, options = {})
+        
+        options[:env] ||= respond_to?(:request) ? request.env : respond_to?(:env) ? env : nil
+        
+        ActiveSupport::Notifications.publish("trusty.errors.notify_exception", exception, options)
+        
+        raise exception if options[:raise] == true
+      end
+      
+    end
+  end
+end

data/lib/trusty/errors/retry.rb

@@ -0,0 +1,50 @@
+require 'trusty/errors/exception_handlers'
+
+module Trusty
+  module Errors
+    module Retry
+      include ExceptionHandlers
+      
+      # retry a block of code
+      def retry_block(options = {}, &block)
+        options = {
+          :retry => 1,
+          :data => {},
+          :type => StandardError
+        }.merge(options)
+        
+        retries = case options[:retry]
+          when true
+            1
+          when Integer
+            options[:retry]
+          else
+            0
+          end
+        
+        types = [ options[:type] ].flatten.compact
+        
+        begin
+          yield
+        rescue *types => ex
+          if retries > 0
+            return self.send(__method__, options.merge(:retry => retries - 1), &block)
+          else
+            notify_exception(ex, :data => options[:data], :raise => true)
+          end
+        end
+      end
+      
+      # helper method to redefine method (a la alias_method_chain, etc)
+      def retry_method(method, options = {})
+        define_method method do |*args, &block|
+          super_method = method(:super)
+          retry_block options do
+            super_method(*args, &block)
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/trusty/errors.rb

@@ -0,0 +1,2 @@
+require 'trusty/errors/exception_handlers'
+require 'trusty/errors/retry'

data/lib/trusty/exception_notification.rb

@@ -0,0 +1,17 @@
+require 'exception_notification'
+
+module Trusty
+  module ExceptionNotification
+    
+  end
+end
+
+# register exception listener for Trusty::Errors::ExceptionHelper and Trusty::ExceptionNotification::Rake
+
+ActiveSupport::Notifications.subscribe("trusty.errors.notify_exception") do |exception, options|
+  if env = options.delete(:env)
+    ExceptionNotifier::Notifier.exception_notification(env, exception, options).deliver!
+  else
+    ExceptionNotifier::Notifier.background_exception_notification(exception, options).deliver!
+  end
+end

data/lib/trusty/iron_io/queue_processor.rb

@@ -0,0 +1,59 @@
+require 'iron_mq'
+require 'trusty/errors/exception_handlers'
+
+module Trusty
+  module IronIo
+    class QueueProcessor
+      include ::Trusty::Errors::ExceptionHandlers
+      
+      # helper method forwards to "run" instance method
+      def self.run(queue_name, *args, &block)
+        new(queue_name).run(*args, &block)
+      end
+      
+      attr_reader :queue_name, :client
+      
+      def initialize(queue_name)
+        @queue_name = queue_name
+        @client     = IronMQ::Client.new(:token => ENV['IRON_TOKEN'], :project_id => ENV['IRON_PROJECT_ID'])
+      end
+      
+      def default_options
+        { :timeout => 30, :break_if_nil => true }
+      end
+      
+      def queue
+        @queue ||= client.queue(queue_name)
+      end
+      
+      def run(options = {}, &block)
+        options = default_options.merge(options)
+        
+        queue.poll(options) do |message|#, :break_if_nil => true do |message|
+          
+          # parse body for better data formatting
+          begin
+            body = JSON.parse message.body
+          rescue JSON::ParserError => ex
+            body = message.body
+          end
+          
+          try_with_data :message_id => message.id, :body => body do
+            block.call(message, queue)
+          end
+        end
+      end
+      
+      def webhook_url
+        url_template = 'https://mq-aws-us-east-1.iron.io/1/projects/%{project_id}/queues/%{queue_name}/messages/webhook?oauth=%{token}'
+        
+        url_template % {
+          project_id: ENV['IRON_TOKEN'],
+          token: ENV['IRON_PROJECT_ID'],
+          queue_name: queue_name
+        }
+      end
+      
+    end
+  end
+end

data/lib/trusty/omniauth.rb

@@ -1,5 +1,3 @@
-module Trusty
-  module Omniauth
-    
-  end
-end
+require 'trusty/omniauth/mapping_helpers'
+require 'trusty/omniauth/model_mapper'
+require 'trusty/omniauth/provider_mapper'

data/lib/trusty/rails/controller_extensions.rb

@@ -0,0 +1,13 @@
+module Trusty
+  module Rails
+    module ControllerExtensions
+      
+      # make sure Flash messages are preserved on redirect
+      def redirect_to(*args)
+        flash.keep
+        super
+      end
+      
+    end
+  end
+end

data/lib/trusty/rails/engine.rb

@@ -0,0 +1,33 @@
+require 'trusty/rails/controller_extensions'
+
+module Trusty
+  module Rails
+    class Engine < ::Rails::Engine
+      
+      initializer "trusty.rails.initialize_views" do |app|
+        ActiveSupport.on_load :action_view do
+          # TODO: Add view extensions
+        end
+      end
+      
+      initializer "trusty.rails.initialize_controllers" do |app|
+        ActiveSupport.on_load :action_controller do
+          include ControllerExtensions
+        end
+      end
+      
+      if defined? Rake
+        initializer "trusty.rails.initialize_rake" do |app|
+          require 'trusty/rake'
+        end
+      end
+      
+      if defined? ExceptionNotification
+        initializer "trusty.rails.initialize_exception_notification" do |app|
+          require 'trusty/exception_notification'
+        end
+      end
+      
+    end
+  end
+end

data/lib/trusty/rails.rb

@@ -0,0 +1 @@
+require 'trusty/rails/engine'

data/lib/trusty/rake.rb

@@ -0,0 +1,35 @@
+require 'rake'
+require 'trusty/errors/exception_handlers'
+
+# FROM:
+# https://github.com/thoughtbot/airbrake/blob/master/lib/airbrake/rake_handler.rb
+# Patch Rake::Application to handle errors with Airbrake
+module Trusty
+  module Rake
+    include ::Trusty::Errors::ExceptionHandlers
+  
+    def self.included(base)
+      base.class_eval do
+        alias_method :display_error_message_without_email, :display_error_message
+        alias_method :display_error_message, :display_error_message_with_email
+      end
+    end
+  
+    def self.handle_exceptions!
+      Rake.application.instance_eval do
+        class << self
+          # include this module
+          include Rake
+        end
+      end
+    end
+    
+    def display_error_message_with_email(exception)
+      notify_exception(exception)
+      display_error_message_without_email(exception)
+    end
+  end
+end
+
+# wire up exception handling in Rake tasks
+Trusty::Rake.handle_exceptions!

data/lib/trusty/utilities.rb

@@ -1,5 +1,2 @@
-module Trusty
-  module Utilities
-    
-  end
-end
+require 'trusty/utilities/method_name'
+require 'trusty/utilities/method_name_extensions'

data/lib/trusty/version.rb

@@ -1,3 +1,3 @@
 module Trusty
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/trusty.rb

@@ -2,5 +2,13 @@ require "trusty/version"
 require "trusty/environment"
 require "trusty/utilities"
 
+# Optional features that need to be required manually when using this gem
+# require "trusty/errors"
+# require "trusty/exception_notification"
+# require "trusty/iron_io"
+# require "trusty/omniauth"
+# require "trusty/rails"
+# require "trusty/rake"
+
 # copy out of namespace
 ::Vars = Trusty::Environment

data/trusty.gemspec

@@ -20,9 +20,27 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "omniauth"
+  
+  # Trusty::Rails (and defined?(Rails) checks sprinkled throughout)
   spec.add_development_dependency "rails"
   
+  # Trusty::Omniauth
+  spec.add_development_dependency "omniauth"
+  
+  # Trusty::Errors::ExceptionHandlers
+  spec.add_development_dependency "active_support" # active_support/notifications
+  
+  # Trusty::ExceptionNotification
+  spec.add_development_dependency "exception_notification"
+  
+  # Trusty::Rake
+  spec.add_development_dependency "rake"
+  
+  # Trusty::IronIo::QueueProcessor
+  spec.add_development_dependency "typhoeus" # used by iron_mq
+  spec.add_development_dependency "iron_mq"
+  
+  # Trusty::Environment
   spec.add_dependency "dotenv", ">= 0.9.0"
   spec.add_dependency "hashie", ">= 2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trusty
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Joel Van Horn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !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'
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: active_support
+  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: exception_notification
+  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: 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: typhoeus
+  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: iron_mq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -109,10 +179,19 @@ files:
 - lib/trusty.rb
 - lib/trusty/environment.rb
 - lib/trusty/environment/dot_file_parser.rb
+- lib/trusty/errors.rb
+- lib/trusty/errors/exception_handlers.rb
+- lib/trusty/errors/retry.rb
+- lib/trusty/exception_notification.rb
+- lib/trusty/iron_io/queue_processor.rb
 - lib/trusty/omniauth.rb
 - lib/trusty/omniauth/mapping_helpers.rb
 - lib/trusty/omniauth/model_mapper.rb
 - lib/trusty/omniauth/provider_mapper.rb
+- lib/trusty/rails.rb
+- lib/trusty/rails/controller_extensions.rb
+- lib/trusty/rails/engine.rb
+- lib/trusty/rake.rb
 - lib/trusty/utilities.rb
 - lib/trusty/utilities/method_name.rb
 - lib/trusty/utilities/method_name_extensions.rb