baywatch 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjE3ZTliNWY5Y2MxZTk2NTNiODg0NGIzYzJhODU5YmM3ZmNiZDUyNQ==
+  data.tar.gz: !binary |-
+    ZDhhMjI1ZjFhNzYzMDZiOGJjYmM4NzBlM2IyOGNlNGFjZjcxNzM0YQ==
+SHA512:
+  metadata.gz: !binary |-
+    OGU5ZWEzZjgyNDMwNzFhZjAzNmQzYjRhZTczMTY5ZDY2ZWYwMjE5YjU0ZDk4
+    YmEwNDkxMmVlYzg5ZmJjZGY3Y2JhMTY5NjIwNmNiYWQ3MWIxNDhkNDY5MTEx
+    ZTA4MDVlOGU3M2ZiZTBiMDc2NDU2ZDA5MjY0MzM4MGE1NmQwMTk=
+  data.tar.gz: !binary |-
+    MzQwZmE2NDc0NDM2NmM4NTYwNWRiZmE2ZjQxYzM5NmRlOWM2YzM2MjgzODcw
+    OGNkMTY0Yjc1ZmY4MDFiOGFjYzQzNjkyZjgxNDQwMDZmNDcyNmQ2YWRlNGNk
+    YjgzMTc2OWZjZjRmNTQwYmU3YzY4Y2IxYjI3NWFhZGIxZGI1YjQ=

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/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in baywatch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thiago Dantas
+
+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,103 @@
+[![Build Status](https://travis-ci.org/tdantas/baywatch.svg)](https://travis-ci.org/tdantas/baywatch)
+
+# Baywatch
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'baywatch'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Declarative way to error handling inside controller
+
+````
+
+  class UsersController < ApplicationController
+    include Baywatch::Rescue
+
+    # By default will handle([ Errno::ECONNREFUSED, Errno::ECONNRESET ])
+    service_down do |on|      
+      on.index do
+        flash[:error] = "Sorry, the service is not working properly"
+      end
+      on.create do 
+        flash[:error] = "Sorry, we cannot save right now"
+        flash.keep(:error)
+        redirect root_url
+      end
+    end
+    
+    def index
+      @users = UserRemoteService.all
+    end
+    
+    def create
+      UserRemoteService.create(params[:user])
+    end
+    
+  end
+  
+````
+
+Using #only to use the same behavior to many actions.
+
+
+````
+
+  class UserController < ApplicationController
+    include Baywatch::Rescue
+
+    service_down do |on|      
+      on.only :index, :create do
+        flash[:error] = "Sorry, the service is not working properly"
+        redirect_to root_url
+      end
+    end
+    
+    def index
+      @users = UserRemoteService.all
+    end
+    
+    def create
+      UserRemoteService.create(params[:user])
+    end
+    
+  end
+  
+````
+
+
+### TODO
+
+##### Handle Contextual Exception
+ 
+ ```
+  service_down do |on|
+  
+    on.edit(ActiveRecord::RecordNotFound)
+      flash[:error] = "Not Found"
+      redirect_to root_url
+    end
+    
+    on.edit(Base::WhateverException)
+      flash[:error] = "Whatever Message Here"
+      MailAdministrator.send(:fail")
+      redirect_to root_url
+    end
+  end
+ ```
+ 
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Cover with tests
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`) 
+6. Create new Pull Request

data/Rakefile

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

data/baywatch.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'baywatch/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "baywatch"
+  gem.version       = Baywatch::VERSION
+  gem.authors       = ["Thiago Dantas"]
+  gem.email         = ["thiago.teixeira.dantas@gmail.com"]
+  gem.description   = %q{Baywatch your code}
+  gem.summary       = %q{Baywatch rescue}
+  gem.homepage      = ""
+
+  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_development_dependency "rspec", '~> 2.14.1'
+  gem.add_development_dependency "mocha", '~> 1.0.0'
+  gem.add_development_dependency "actionpack"
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'pry', '~> 0.9.12.6'
+  gem.add_development_dependency 'activemodel'
+
+end

data/lib/baywatch.rb

@@ -0,0 +1,6 @@
+require "baywatch/version"
+
+module Baywatch
+  autoload :Config, 'baywatch/config'
+  autoload :Rescue, 'baywatch/rescue'
+end

data/lib/baywatch/config.rb

@@ -0,0 +1,31 @@
+module Baywatch
+  
+  class Config
+    attr_accessor :configurations
+    
+    def initialize
+      @configurations = {}
+    end
+
+    def include?(action)
+      @configurations.keys.include?(action.to_sym)
+    end
+
+    def [](val)
+      @configurations[val.to_sym]
+    end
+
+    def only(*args, &block)
+      args.each do |action|
+        @configurations[action.to_sym] = block
+      end 
+    end
+
+    def method_missing(method, *args, &block)
+      raise "You should pass one Block #{method}" if block.nil?
+      @configurations[method.to_sym] = block
+    end
+
+  end
+
+end

data/lib/baywatch/rescue.rb

@@ -0,0 +1,55 @@
+module Baywatch
+
+  module Rescue
+    
+    DEFAULT_EXCEPTIONS = [ Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::ECONNRESET ]
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def service_down(*exceptions, &block)
+        on = Baywatch::Config.new
+        block.call(on)
+        exceptions_appended = exceptions.unshift(*DEFAULT_EXCEPTIONS)
+        define_rescues(exceptions_appended, on)
+      end
+        
+      private
+
+      def define_rescues(exceptions, configuration)
+          define_baywatch_requested_action
+          define_baywatch(configuration)
+          register_rescue_from(exceptions)
+        end
+        
+      def define_baywatch_requested_action
+        self.class_eval do 
+          def baywatch_requested_action
+            request.filtered_parameters["action"]
+          end
+        end
+      end
+        
+      def define_baywatch(configuration)
+        self.class_eval do
+          define_method :baywatch do |exception|
+            raise exception unless configuration.include? baywatch_requested_action
+            block =  configuration[baywatch_requested_action]
+            self.instance_eval &block
+          end
+        end
+      end
+
+        def register_rescue_from(exceptions)
+          self.class_eval do 
+            self.rescue_from *exceptions, :with => :baywatch
+          end
+        end
+
+      end #classMethods
+
+  end
+end

data/lib/baywatch/version.rb

@@ -0,0 +1,3 @@
+module Baywatch
+  VERSION = "0.0.2"
+end

data/spec/baywatch_controller_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+
+describe BaywatchController, type: :controller do
+
+  context "Service Down Interface" do 
+    it "pass Baywatch::Config as block parameter" do 
+      WhateverController = Class.new(ActionController::Base) do
+        include Baywatch::Rescue 
+      end
+
+      WhateverController.service_down do |on|
+        expect(on).to be_kind_of(Baywatch::Config)
+      end
+    end
+
+    it "register baywatch method to instance" do
+      expect(controller).to respond_to(:baywatch) 
+    end
+  end  
+
+  context "Service Unavailable Exceptions" do 
+
+    it "doesn't capture unregistered exception" do 
+      controller.stub(:index) do
+        raise "WHATEVER EXCEPTION"
+      end
+
+      expect{ get :index }.to raise_error
+    end
+
+    it "does not capture exception for not registered action" do 
+      controller.stub(:edit) do
+        raise "WHATEVER EXCEPTION"
+      end
+
+      expect{ get :edit }.to raise_error("WHATEVER EXCEPTION")
+    end
+
+    it "captures explicit exception registered" do 
+      controller.stub(:timeout) do
+        raise BaywatchController::TimeoutException
+      end
+
+      get :timeout
+      response.should redirect_to("/baywatch_service_down_rescued")
+    end
+  end
+end

data/spec/beaches_controller_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe BeachesController, type: :controller do
+
+  it "captures Errno::ECONNRESET " do
+      controller.stub(:long_beach) do
+        raise Errno::ECONNRESET.new
+      end
+
+      get :long_beach
+      response.should redirect_to("/baywatch_service_down_rescued")
+  end
+
+  it "captures Errno::ECONNREFUSED " do
+      controller.stub(:venice) do
+        raise Errno::ECONNREFUSED.new
+      end
+
+      get :venice
+      response.should redirect_to("/baywatch_service_down_rescued")
+  end
+
+	it "captures Errno::ETIMEDOUT" do
+		controller.stub(:costa_da_caparica) do
+			raise Errno::ETIMEDOUT.new
+		end
+
+		get :costa_da_caparica
+		response.should redirect_to("/baywatch_service_down_rescued")
+	end
+
+  it "captures Errno::ECONNRESET" do
+    exception = Errno::ECONNRESET.new
+    controller.stub(:sunset) do
+      raise exception
+    end
+
+    expect{ get :sunset }.to raise_error(exception)
+  end
+
+end

data/spec/fixtures/app.rb

@@ -0,0 +1,34 @@
+require 'active_model'
+require 'active_support/all'
+require 'action_controller'
+require 'action_dispatch'
+
+module Rails
+  class App
+
+    def env_config; {} end
+    
+    def routes
+      return @routes if defined?(@routes)
+      @routes = ActionDispatch::Routing::RouteSet.new
+      @routes.draw do
+        
+        get "/baywatch" => "baywatch#index"
+        get "/timeout" => "baywatch#timeout"
+        get "/edit" => "baywatch#edit"
+
+        get "/long_beach" => "beaches#long_beach"
+        get "/venice" => "beaches#venice"
+        get "/sunset" => "beaches#sunset"
+    		get "/costa_da_caparica" => "beaches#costa_da_caparica" 
+		 end
+   
+      @routes
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+  
+end

data/spec/fixtures/controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  def render(*attributes); end
+end
+
+require_relative './controllers/baywatch'
+require_relative './controllers/beaches'

data/spec/fixtures/controllers/baywatch.rb

@@ -0,0 +1,31 @@
+class BaywatchController < ApplicationController
+  include Baywatch::Rescue
+
+  class TimeoutException < StandardError; end
+
+  service_down(BaywatchController::TimeoutException) do |on|
+    
+    on.index do |e|
+      redirect_to "/baywatch_service_down_rescued"
+    end
+
+    on.timeout do |e|
+      redirect_to "/baywatch_service_down_rescued"
+    end
+
+  end
+
+
+  def index
+    redirect_to "/baywatch_index"
+  end
+
+  def timeout
+    redirect_to "/baywatch_timeout"
+  end
+
+  def edit
+    redirect_to "/baywatch_edit"
+  end
+
+end

data/spec/fixtures/controllers/beaches.rb

@@ -0,0 +1,26 @@
+class BeachesController < ApplicationController
+  include Baywatch::Rescue
+ 
+  service_down do |on|
+    on.only :venice, :long_beach, :costa_da_caparica do 
+      redirect_to "/baywatch_service_down_rescued"
+    end
+  end
+
+  def long_beach
+    redirect_to "beaches_venice"
+  end
+
+  def venice
+    redirect_to "beaches_venice"
+  end
+
+  def sunset
+    redirect_to "beaches_venice"
+  end
+
+	def costa_da_caparica
+		redirect_to "beaches_costa_da_caparica"
+	end
+	
+end

data/spec/service_down_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Baywatch do 
+
+  context "Service Down Interface" do 
+    before(:each) do 
+      @controller = Class.new(ActionController::Base) do
+                      include Baywatch::Rescue
+                      service_down do |on| on.action {} end
+                  end
+    end
+
+    it "pass Baywatch::Config as block parameter" do 
+      @controller.service_down do |on|
+        expect(on).to be_kind_of(Baywatch::Config)
+      end
+    end
+
+    it "register baywatch method to instance" do
+      expect(@controller.new).to respond_to(:baywatch) 
+    end
+
+    it "pass Baywatch::Config as block parameter" do
+       @controller.service_down do |on|
+        expect{ on.create }.to raise_error
+      end
+    end
+
+  end
+end  

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'baywatch'
+
+require 'fixtures/app'
+require 'fixtures/controller'
+require 'rspec/rails'

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: baywatch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Thiago Dantas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: rspec-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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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: Baywatch your code
+email:
+- thiago.teixeira.dantas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- baywatch.gemspec
+- lib/baywatch.rb
+- lib/baywatch/config.rb
+- lib/baywatch/rescue.rb
+- lib/baywatch/version.rb
+- spec/baywatch_controller_spec.rb
+- spec/beaches_controller_spec.rb
+- spec/fixtures/app.rb
+- spec/fixtures/controller.rb
+- spec/fixtures/controllers/baywatch.rb
+- spec/fixtures/controllers/beaches.rb
+- spec/service_down_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Baywatch rescue
+test_files:
+- spec/baywatch_controller_spec.rb
+- spec/beaches_controller_spec.rb
+- spec/fixtures/app.rb
+- spec/fixtures/controller.rb
+- spec/fixtures/controllers/baywatch.rb
+- spec/fixtures/controllers/beaches.rb
+- spec/service_down_spec.rb
+- spec/spec_helper.rb