wd_sinatra 0.2.5 → 0.2.6

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 # Weasel Diesel Sinatra Changelog
 
+## 0.2.6
+
+* Added a few basic disabled settings for newrelic and airbrake.
+
 ## 0.2.5
 
-* added suport for `ENV['DONT_LOAD_MODELS']` to avoid loading models.
+* added support for `ENV['DONT_LOAD_MODELS']` to avoid loading models.
 
 ## 0.2.4
 

data/README.md

@@ -49,6 +49,16 @@ like the most.
 The console mode is like the server mode but without the server only
 concerns such as the sinatra routes config and Rack middleware.
 
+If your users also want `script/console`, add the file, chmod +x it and
+use the following code:
+
+```bash
+#!/bin/bash
+# Run bin/console for those who like the old Rails way.
+abspath=$(cd ${0%/*} && echo $PWD/${0##*/})
+$abspath/../../bin/console
+```
+
 ### Documentation generation
 
     $ rake doc:services
@@ -205,7 +215,6 @@ app by trying to generate a new app named the same as your old app.
 The generator will detect conflicts and let you pick an action (diff,
 overwrite, ignore...)
 
-
 ## Contributing
 
 1. Fork it

data/lib/wd_sinatra/version.rb

@@ -1,5 +1,5 @@
 module WD
   module Sinatra
-    VERSION = "0.2.5"
+    VERSION = "0.2.6"
   end
 end

data/templates/Gemfile

@@ -5,7 +5,7 @@ gem "sinatra", "1.3.2"
 # service DSL
 gem "weasel_diesel"
 gem "wd_sinatra"
-
+# gem 'wd_newrelic_rpm', :require => 'newrelic_rpm'
 
 if RUBY_VERSION =~ /1.8/
   gem 'backports', '2.3.0'

data/templates/config/airbrake.yml

@@ -0,0 +1,16 @@
+common: &default_settings
+  api_key: 'replace me'
+  params_filters:
+  - password
+  host: 'api.airbrake.io'
+  enabled: false
+
+development:
+  <<: *default_settings
+
+test:
+  <<: *default_settings
+
+production:
+  <<: *default_settings
+  enabled: true

data/templates/config/middleware.rb

@@ -0,0 +1,16 @@
+if defined?(NewRelic)
+  if RACK_ENV == 'development'
+    require 'new_relic/rack/developer_mode'
+    use NewRelic::Rack::DeveloperMode
+  end
+  if NewRelic::Control.instance.agent_enabled?
+    LOGGER.info "New Relic monitoring enabled App name: '#{NewRelic::Control.instance['app_name']}', Mode: '#{NewRelic::Control.instance.app}'"
+  end
+end
+
+# Use this middleware with AR to avoid threading issues.
+# require 'active_record'
+# use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+use Airbrake::Rack if defined?(Airbrake)
+use Rack::ContentLength

data/templates/lib/app.rb

@@ -3,3 +3,22 @@
 #
 # Here you want to load your dependencies and maybe set your
 # datastore.
+
+
+############### AIRBRAKE ###############
+airbrake_config_file = File.join(WDSinatra::AppLoader.root_path, 'config', 'airbrake.yml')
+if File.exist?(airbrake_config_file)
+  airbrake_config = YAML.load_file(airbrake_config_file)[RACK_ENV]
+  if airbrake_config && airbrake_config['enabled']
+    require 'airbrake'
+    Airbrake.configure do |config|
+      config.api_key = airbrake_config['api_key']
+      (airbrake_config['params_filters'] - config.params_filters).each do |param| 
+        config.params_filters << param
+      end
+      config.environment_name = RACK_ENV
+      config.host = airbrake_config['host'] if airbrake_config['host']
+      config.logger = LOGGER
+    end
+  end
+end

data/templates/lib/hooks.rb

@@ -85,3 +85,7 @@ end
 
 Sinatra::Helpers.send(:include, WDSinatraHooks)
 WeaselDiesel::RequestHandler.send(:include, WDSinatraHooks)
+
+# NEW RELIC HOOKS
+# uncomment if you want to use newrelic (you also need the wd_newrelic_rpm gem)
+# require 'newrelic_instrumentation'

data/templates/lib/newrelic_instrumentation.rb

@@ -0,0 +1,66 @@
+require 'new_relic/agent/instrumentation/controller_instrumentation'
+
+DependencyDetection.defer do
+  depends_on do
+    defined?(WeaselDiesel) && defined?(WeaselDiesel::RequestHandler) &&
+      WeaselDiesel::RequestHandler.method_defined?(:dispatch)
+  end
+
+  executes do
+    NewRelic::Agent.logger.debug 'Installing WeaselDiesel instrumentation'
+  end
+
+  executes do
+    ::WeaselDiesel::RequestHandler.class_eval do
+      include NewRelic::Agent::Instrumentation::WeaselDiesel
+      include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+      alias dispatch_without_newrelic dispatch
+      alias dispatch dispatch_with_newrelic
+
+      add_method_tracer :params_preprocessor_hook if self.method_defined?(:params_preprocessor_hook)
+      add_method_tracer :params_postprocessor_hook if self.method_defined?(:params_postprocessor_hook)
+      add_method_tracer :pre_dispatch_hook if self.method_defined?(:pre_dispatch_hook)
+    end
+    # Monitor the actual dispatch of each service
+    WSList.all.each do |service|
+      service.handler.class_eval do
+        add_method_tracer :service_dispatch, 'Service/Dispatch'
+      end
+    end
+  end
+end
+
+
+module NewRelic
+  module Agent
+    module Instrumentation
+      module WeaselDiesel
+        include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+        def dispatch_with_newrelic(app)
+          perform_action_with_newrelic_trace(:category => :controller,
+                                             :class_name => service.class.name,
+                                             :controller => service.class.name,
+                                             :path => "#{service.verb.upcase} #{service.url}",
+                                             :name => "#{service.verb.upcase} #{service.url}",
+                                             :params => filter_newrelic_params(app.params),
+                                             :request => app.request) do
+            dispatch_without_newrelic(app)
+          end
+        end
+
+        # filter params based the newrelic.yml entry if it exists.
+        def filter_newrelic_params(params)
+          @filters ||= NewRelic::Control.instance['filter_parameters']
+          return params if @filters.nil? || @filters.empty?
+          duped_params = params.dup
+          duped_params.each{|k,v| duped_params[k] = 'FILTERED' if @filters.include?(k) }
+          duped_params
+        end
+
+      end
+    end
+  end
+end
+
+DependencyDetection.detect!

metadata

@@ -1,61 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wd_sinatra
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.2.6
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 5
-  version: 0.2.5
 platform: ruby
-authors: 
+authors:
 - Matt Aimonetti
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-01 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: weasel_diesel
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70297591787320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: thor
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70297591787320
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70297591786900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps using the Weasel Diesel DSL
-email: 
+  prerelease: false
+  version_requirements: *70297591786900
+description: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra
+  apps using the Weasel Diesel DSL
+email:
 - mattaimonetti@gmail.com
-executables: 
+executables:
 - wd_sinatra
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -75,6 +61,7 @@ files:
 - templates/api/hello_world.rb
 - templates/bin/console
 - templates/config.ru
+- templates/config/airbrake.yml
 - templates/config/environments/default.rb
 - templates/config/environments/production.rb
 - templates/config/environments/test.rb
@@ -83,6 +70,7 @@ files:
 - templates/lib/app.rb
 - templates/lib/body_parser.rb
 - templates/lib/hooks.rb
+- templates/lib/newrelic_instrumentation.rb
 - templates/lib/tasks/doc.rake
 - templates/lib/tasks/doc_generator/bootstrap/.gitignore
 - templates/lib/tasks/doc_generator/bootstrap/LICENSE
@@ -143,39 +131,29 @@ files:
 - templates/test/integration/hello_world_test.rb
 - templates/test/test_helpers.rb
 - wd-sinatra.gemspec
-has_rdoc: true
 homepage: https://github.com/mattetti/wd_sinatra
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
-summary: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps using the Weasel Diesel DSL
+summary: Weasel-Diesel Sinatra app gem, allowing you to generate/update sinatra apps
+  using the Weasel Diesel DSL
 test_files: []
-