appoptics_apm 4.0.2

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -0,0 +1,222 @@
+# AppOpticsAPM Initializer (for the appoptics_apm gem)
+# https://www.appoptics.com/
+#
+# More information on instrumenting Ruby applications can be found here:
+# https://docs.appoptics.com/kb/apm_tracing/ruby/
+
+if defined?(AppOpticsAPM::Config)
+
+  #
+  # Turn tracing on or off
+  #
+  # By default tracing is set to 'always', the other option is 'never'.
+  # 'always' means that sampling will be done according to the current
+  # sampling rate. 'never' means that there is no sampling.
+  #
+  AppOpticsAPM::Config[:tracing_mode] = :always
+
+  #
+  # Verbose output of instrumentation initialization
+  #
+  # AppOpticsAPM::Config[:verbose] = <%= @verbose %>
+  #
+
+  #
+  # Logging of incoming HTTP query args
+  #
+  # This optionally disables the logging of incoming URL request
+  # query args.
+  #
+  # This flag is global and currently only affects the Rack
+  # instrumentation which reports incoming request URLs and
+  # query args by default.
+  AppOpticsAPM::Config[:include_remote_url_params] = true
+
+  #
+  # Logging of outgoing HTTP query args
+  #
+  # This optionally disables the logging of query args of outgoing
+  # HTTP clients such as Net::HTTP, excon, typhoeus and others.
+  #
+  # This flag is global to all HTTP client instrumentation.
+  #
+  # To configure this on a per instrumentation basis, set this
+  # option to true and instead disable the instrumentation specific
+  # option <tt>log_args</tt>:
+  #
+  #   AppOpticsAPM::Config[:nethttp][:log_args] = false
+  #   AppOpticsAPM::Config[:excon][:log_args] = false
+  #   AppOpticsAPM::Config[:typhoeus][:log_args] = true
+  #
+  AppOpticsAPM::Config[:include_url_query_params] = true
+
+  #
+  # Sanitize SQL Statements
+  #
+  # The AppOpticsAPM Ruby client has the ability to sanitize query literals
+  # from SQL statements.  By default this is enabled.  Disable to
+  # collect and report query literals to AppOpticsAPM.
+  #
+  # AppOpticsAPM::Config[:sanitize_sql] = true
+  #
+
+  # Do Not Trace
+  # These two values allow you to configure specific URL patterns to
+  # never be traced.  By default, this is set to common static file
+  # extensions but you may want to customize this list for your needs.
+  #
+  # dnt_regexp and dnt_opts is passed to Regexp.new to create
+  # a regular expression object.  That is then used to match against
+  # the incoming request path.
+  #
+  # The path string originates from the rack layer and is retrieved
+  # as follows:
+  #
+  #   req = ::Rack::Request.new(env)
+  #   path = URI.unescape(req.path)
+  #
+  # Usage:
+  #   AppOpticsAPM::Config[:dnt_regexp] = "lobster$"
+  #   AppOpticsAPM::Config[:dnt_opts]   = Regexp::IGNORECASE
+  #
+  # This will ignore all requests that end with the string lobster
+  # regardless of case
+  #
+  # Requests with positive matches (non nil) will not be traced.
+  # See lib/appoptics_apm/util.rb: AppOpticsAPM::Util.static_asset?
+  #
+  # AppOpticsAPM::Config[:dnt_regexp] = "\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$"
+  # AppOpticsAPM::Config[:dnt_opts]   = Regexp::IGNORECASE
+
+  #
+  # Blacklist urls
+  #
+  # This configuration is used by outbound calls. If the call
+  # goes to a blacklisted url then we won't add any
+  # tracing information to the headers.
+  #
+  # The list has to an array of strings, even if only one url is blacklisted
+  #
+  # Example: AppOpticsAPM::Config[:blacklist] = ['google.com']
+  #
+  # AppOpticsAPM::Config[:blacklist]
+  #
+
+  #
+  # Rails Exception Logging
+  #
+  # In Rails, raised exceptions with rescue handlers via
+  # <tt>rescue_from</tt> are not reported to the AppOptics
+  # dashboard by default.  Setting this value to true will
+  # report all raised exception regardless.
+  #
+  # AppOpticsAPM::Config[:report_rescued_errors] = false
+  #
+
+  #
+  # Bunny Controller and Action
+  #
+  # The bunny (Rabbitmq) instrumentation can optionally report
+  # Controller and Action values to allow filtering of bunny
+  # message handling in # the UI.  Use of Controller and Action
+  # for filters is temporary until the UI is updated with
+  # additional filters.
+  #
+  # These values identify which properties of
+  # Bunny::MessageProperties to report as Controller
+  # and Action.  The defaults are to report :app_id (as
+  # Controller) and :type (as Action).  If these values
+  # are not specified in the publish, then nothing
+  # will be reported here.
+  #
+  # AppOpticsAPM::Config[:bunnyconsumer][:controller] = :app_id
+  # AppOpticsAPM::Config[:bunnyconsumer][:action] = :type
+  #
+
+  #
+  # Resque Argument logging
+  #
+  # Set to true to enable Resque argument logging (Default: false)
+  #
+  # AppOpticsAPM::Config[:resqueworker][:log_args] = false
+  # AppOpticsAPM::Config[:resqueclient[:log_args] = false
+  #
+
+  #
+  # Enabling/Disabling Instrumentation
+  #
+  # If you're having trouble with one of the instrumentation libraries, they
+  # can be individually disabled here by setting the :enabled
+  # value to false:
+  #
+  # AppOpticsAPM::Config[:action_controller][:enabled] = true
+  # AppOpticsAPM::Config[:action_controller_api][:enabled] = true
+  # AppOpticsAPM::Config[:action_view][:enabled] = true
+  # AppOpticsAPM::Config[:active_record][:enabled] = true
+  # AppOpticsAPM::Config[:bunnyclient][:enabled] = true
+  # AppOpticsAPM::Config[:bunnyconsumer][:enabled] = true
+  # AppOpticsAPM::Config[:cassandra][:enabled] = true
+  # AppOpticsAPM::Config[:curb][:enabled] = true
+  # AppOpticsAPM::Config[:dalli][:enabled] = true
+  # AppOpticsAPM::Config[:delayed_jobclient][:enabled] = true
+  # AppOpticsAPM::Config[:delayed_jobworker][:enabled] = true
+  # AppOpticsAPM::Config[:em_http_request][:enabled] = true
+  # AppOpticsAPM::Config[:excon][:enabled] = true
+  # AppOpticsAPM::Config[:faraday][:enabled] = true
+  # AppOpticsAPM::Config[:grape][:enabled] = true
+  # AppOpticsAPM::Config[:httpclient][:enabled] = true
+  # AppOpticsAPM::Config[:memcache][:enabled] = true
+  # AppOpticsAPM::Config[:memcached][:enabled] = true
+  # AppOpticsAPM::Config[:mongo][:enabled] = true
+  # AppOpticsAPM::Config[:moped][:enabled] = true
+  # AppOpticsAPM::Config[:nethttp][:enabled] = true
+  # AppOpticsAPM::Config[:redis][:enabled] = true
+  # AppOpticsAPM::Config[:resqueclient][:enabled] = true
+  # AppOpticsAPM::Config[:resqueworker][:enabled] = true
+  # AppOpticsAPM::Config[:rest_client][:enabled] = true
+  # AppOpticsAPM::Config[:sequel][:enabled] = true
+  # AppOpticsAPM::Config[:sidekiqclient][:enabled] = true
+  # AppOpticsAPM::Config[:sidekiqworker][:enabled] = true
+  # AppOpticsAPM::Config[:typhoeus][:enabled] = true
+  #
+
+  #
+  # Enabling/Disabling Backtrace Collection
+  #
+  # Instrumentation can optionally collect backtraces as they collect
+  # performance metrics.  Note that this has a negative impact on
+  # performance but can be useful when trying to locate the source of
+  # a certain call or operation.
+  #
+  # AppOpticsAPM::Config[:action_controller][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:action_controller_api][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:action_view][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:active_record][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:bunnyclient][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:bunnyconsumer][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:cassandra][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:curb][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:dalli][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:delayed_jobworker][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:excon][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:faraday][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:grape][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:httpclient][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:memcache][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:memcached][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:mongo][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:moped][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:nethttp][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:rack][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:redis][:collect_backtraces] = false
+  # AppOpticsAPM::Config[:resqueclient][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:resqueworker][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:rest_client][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:sequel][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:sidekiqclient][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:sidekiqworker][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:typhoeus][:collect_backtraces] = false
+  #
+end

data/ruby_setup.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+# used by run_tests_docker.sh
+# call with:
+# docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics_apm/ruby_setup.sh <ruby-version> <gemfile> <true|false>
+# docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics_apm/ruby_setup.sh 2.4.1 gemfiles/libraries.gemfile
+
+cd /code/ruby-appoptics_apm/
+
+rbenv local $1
+bundle install
+bundle update
+bundle exec rake fetch_ext_deps
+bundle exec rake clean
+bundle exec rake compile
+
+# start postgres
+service postgresql start
+
+# start redis
+service redis-server start
+
+# start memcached
+service memcached start
+
+# mysql add table for tests
+mysql -e 'create database travis_ci_test;' -h$MYSQL_HOST -p$MYSQL_ROOT_PASSWORD
+
+bundle install --gemfile $2
+
+export RVM_TEST=$1
+export BUNDLE_GEMFILE=$2
+
+# replicate stdout of tests to file in local log directory
+export TEST_RUNS_TO_FILE=true
+
+if [ "$3" == "true" ]; then
+  /bin/bash
+  # now run tests either with:
+  # bundle exec rake test TEST=test/instrumentation/curb_test.rb
+  # or
+  # bundle exec ruby -I test test/instrumentation/curb_test.rb -n test_obey_collect_backtraces_when_false
+else
+  bundle exec rake test
+fi
+
+mysql -e 'drop database travis_ci_test;' -h$MYSQL_HOST -p$MYSQL_ROOT_PASSWORD

data/run_docker_build_gem_upload_to_packagecloud.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# to build the image:
+docker build -f Dockerfile -t buildgem .
+
+# build the gems in the image
+docker run --rm  -v `pwd`:/code/ruby-appoptics_apm buildgem bash -l -c 'cd /code/ruby-appoptics_apm && ./build_gems.sh'
+
+# save current rbenv setting and switch to 2.4.1 for the package_cloud commands
+current_ruby=`rbenv local`
+rbenv local 2.4.1
+
+# prerequisite: package_cloud tocken needs to be in ~/.packagecloud
+
+gem=`ls -dt1 appoptics_apm-[^pre]*.gem | head -1`
+
+package_cloud push AppOptics/apm-instrumentation $gem
+
+# restore ruby version
+rbenv local $current_ruby

data/run_tests_docker.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+# this runs all the tests on the current code base
+# any edits take effect immediately
+# test output is logged to log/test_runs.log
+# make sure log/ and log/test_runs.log is writeable by docker
+
+# `docker build -f Dockerfile -t ruby_appoptics .`
+# (docker-compose will build it too if missing)
+#
+# `docker-compose up -d`
+# or to rebuild ruby_appoptics
+# `docker-compose up --build -d`
+
+require 'yaml'
+travis = YAML.load_file('.travis.yml')
+
+matrix = []
+travis['rvm'].each do |rvm|
+  travis['gemfile'].each do |gemfile|
+    matrix << { "rvm" => rvm, "gemfile" => gemfile }
+  end
+end
+
+matrix = matrix - travis['matrix']['exclude']
+
+matrix.each do |args|
+  args['rvm'] = '1.9.3-p551' if args['rvm'] =~ /1.9.3/
+  `docker-compose run --rm --service-ports ruby_appoptics_apm /code/ruby-appoptics_apm/ruby_setup.sh #{args['rvm']} #{args['gemfile']}`
+end
+
+# `docker-compose down --rmi all`

data/test/benchmark/README.md

@@ -0,0 +1,65 @@
+#Micro Benchmarking
+
+Work In Progress
+
+In this folder there are samples for doing microbenchmarks. 
+
+They are in folders with names indicating which gemfile needs to be set, eg:
+```
+export BUNDLE_GEMFILE=gemfiles/libraries.gemfile
+bundle install
+```
+
+The gems used are `benchmark-ips` and `benchmark-memory` to compare performance and memory usage between different 
+versions of code.
+
+The variable `ENV['TEST_AB']` is used to define which version of code to run.
+
+**!!! It is very important to remove `ENV['TEST_AB']` before commiting code !!!**
+
+###Example of setup for benchmarking:
+
+The benchmarking code to be run:
+```
+Benchmark.ips do |x|
+  x.config(:time => 20, :warmup => 20, :iterations => 3)
+  @conn = Bunny.new(@connection_params)
+  @conn.start
+  @channel = @conn.create_channel
+  @queue = @channel.queue("ao.ruby.test")
+  @exchange = @channel.topic("ao.ruby.topic.tests", :auto_delete => true)
+  
+  x.report('bunny_pub_sampling_A') do
+    ENV['TEST_AB'] = 'A'
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+
+    dostuff(@exchange)
+  end
+  
+  x.report('bunny_pub_sampling_B') do
+    ENV['TEST_AB'] = 'B'
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+
+    dostuff(@exchange)
+  end
+  
+  x.compare!
+end
+```
+The code to be benchmarked:
+```
+ def basic_publish_with_appoptics(payload, exchange, routing_key, opts = {})
+    # If we're not tracing, just do a fast return.
+    return basic_publish_without_appoptics(payload, exchange, routing_key, opts) if !AppOpticsAPM.tracing? && ENV['TEST_AB'] == 'B'
+
+    begin
+       kvs = collect_channel_kvs
+       if exchange.respond_to?(:name)
+          kvs[:ExchangeName] = exchange.name
+       elsif exchange.respond_to?(:empty?) && !exchange.empty?
+    ...
+```

data/test/benchmark/logging_bench.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2017 SolarWinds, LLC.
+# All rights reserved.
+
+require 'benchmark/ips'
+require_relative '../minitest_helper'
+
+
+# compare logging when testing for loaded versus tracing?
+ENV['APPOPTICS_GEM_VERBOSE'] = 'false'
+
+n = 1000
+
+Benchmark.ips do |x|
+  x.config(:time => 10, :warmup => 2)
+
+  # x.report('tracing_f') do
+  #   AppOpticsAPM.loaded = false
+  #   AppOpticsAPM::Config[:tracing_mode] = 'never'
+  #   AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+  #   n.times do
+  #     AppOpticsAPM.tracing?
+  #   end
+  # end
+  # x.report('tracing_n') do
+  #   AppOpticsAPM.loaded = true
+  #   AppOpticsAPM::Config[:tracing_mode] = 'never'
+  #   AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+  #   n.times do
+  #     AppOpticsAPM.tracing?
+  #   end
+  # end
+
+  x.report('tracing_tf') do
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+    n.times do
+      AppOpticsAPM.tracing?
+    end
+  end
+  x.report('tracing_tt') do
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F01')
+    n.times do
+      AppOpticsAPM.tracing?
+      AppOpticsAPM.tracing?
+    end
+  end
+
+  x.compare!
+end
+
+

data/test/benchmark/with_libraries_gemfile/bunny_bench.rb

@@ -0,0 +1,69 @@
+# Copyright (c) 2017 SolarWinds, LLC.
+# All rights reserved.
+
+require 'benchmark/ips'
+require_relative '../../minitest_helper'
+
+
+# compare logging when testing for loaded versus tracing?
+ENV['APPOPTICS_GEM_VERBOSE'] = 'false'
+
+ENV['APPOPTICS_RABBITMQ_SERVER'] = "127.0.0.1"      unless ENV['APPOPTICS_RABBITMQ_SERVER']
+ENV['APPOPTICS_RABBITMQ_PORT'] = "5672"             unless ENV['APPOPTICS_RABBITMQ_PORT']
+ENV['APPOPTICS_RABBITMQ_USERNAME'] = "guest"        unless ENV['APPOPTICS_RABBITMQ_USERNAME']
+ENV['APPOPTICS_RABBITMQ_PASSWORD'] = "guest"        unless ENV['APPOPTICS_RABBITMQ_PASSWORD']
+ENV['APPOPTICS_RABBITMQ_VHOST'] = "/"               unless ENV['APPOPTICS_RABBITMQ_VHOST']
+
+@connection_params = {}
+@connection_params[:host]   = ENV['APPOPTICS_RABBITMQ_SERVER']
+@connection_params[:port]   = ENV['APPOPTICS_RABBITMQ_PORT']
+@connection_params[:vhost]  = ENV['APPOPTICS_RABBITMQ_VHOST']
+@connection_params[:user]   = ENV['APPOPTICS_RABBITMQ_USERNAME']
+@connection_params[:pass]   = ENV['APPOPTICS_RABBITMQ_PASSWORD']
+
+def dostuff(exchange)
+  # require 'ruby-prof'
+
+  # profile the code
+  # RubyProf.start
+
+  n = 100
+
+  n.times do
+    exchange.publish("The Tortoise and the Hare", :routing_key => @queue.name)
+  end
+
+  # result = RubyProf.stop
+  # print a flat profile to text
+  #   printer = RubyProf::FlatPrinter.new(result)
+  #   printer.print(STDOUT)
+end
+
+
+Benchmark.ips do |x|
+  x.config(:time => 20, :warmup => 20, :iterations => 3)
+  @conn = Bunny.new(@connection_params)
+  @conn.start
+  @channel = @conn.create_channel
+  @queue = @channel.queue("ao.ruby.test")
+  @exchange = @channel.topic("ao.ruby.topic.tests", :auto_delete => true)
+
+  x.report('bunny_pub_sampling_A') do
+    ENV['TEST_AB'] = 'A'
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+
+    dostuff(@exchange)
+  end
+  x.report('bunny_pub_sampling_B') do
+    ENV['TEST_AB'] = 'B'
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+
+    dostuff(@exchange)
+  end
+
+  x.compare!
+end

data/test/benchmark/with_rails5x_gemfile/action_controller5x_bench.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2017 SolarWinds, LLC.
+# All rights reserved.
+
+require 'benchmark/ips'
+require 'benchmark/memory'
+require_relative '../../minitest_helper'
+
+# compare logging when testing for loaded versus tracing?
+ENV['APPOPTICS_GEM_VERBOSE'] = 'false'
+ENV['DBTYPE'] = "postgresql" unless ENV['DBTYPE']
+
+def dostuff(uri)
+  n = 100
+  n.times do
+    Net::HTTP.get_response(uri)
+  end
+end
+
+
+Benchmark.memory do |x|
+  AppOpticsAPM::Config[:action_controller][:collect_backtraces] = false
+  # x.config(:time => 20, :warmup => 20, :iterations => 3)
+  uri = URI.parse('http://127.0.0.1:8140/hello/world')
+
+  x.report('controller_A') do
+    ENV['TEST_AB'] = 'A'
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+
+    dostuff(uri)
+  end
+  x.report('controller_B') do
+    ENV['TEST_AB'] = 'B'
+    AppOpticsAPM.loaded = true
+    AppOpticsAPM::Config[:tracing_mode] = 'always'
+    AppOpticsAPM::Context.fromString('2B7435A9FE510AE4533414D425DADF4E180D2B4E3649E60702469DB05F00')
+
+    dostuff(uri)
+  end
+
+  x.compare!
+end

data/test/frameworks/apps/grape_nested.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'grape'
+
+class Wrapper < Grape::API
+  class GrapeSimple < Grape::API
+    rescue_from :all do |e|
+      error_response({ message: "rescued from #{e.class.name}" })
+    end
+
+    get '/json_endpoint' do
+      present({ :test => true })
+    end
+
+    get "/break" do
+      raise Exception.new("This should have http status code 500!")
+    end
+
+    get "/error" do
+      error!("This is a error with 'error'!")
+    end
+
+    get "/breakstring" do
+      raise "This should have http status code 500!"
+    end
+  end
+end
+
+class GrapeNested < Grape::API
+  mount Wrapper::GrapeSimple
+end
+

data/test/frameworks/apps/grape_simple.rb

@@ -0,0 +1,80 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'grape'
+
+class GrapeSimple < Grape::API
+  rescue_from :all do |e|
+    error_response({ message: "rescued from #{e.class.name}" })
+  end
+
+  get '/index' do
+    present( )
+  end
+
+  get '/json_endpoint' do
+    present({ :test => true })
+  end
+
+  get "/break" do
+    raise Exception.new("This should have http status code 500!")
+  end
+
+  get "/error" do
+    error!("This is an error with 'error'!")
+  end
+
+  get "/breakstring" do
+    raise "This should have http status code 500!"
+  end
+
+  resource :employee_data do
+    desc "List all Employee"
+    get do
+      present({ :employee_data => "all"})
+    end
+
+    get ':id' do
+      present({ :employee_data => "Employee ##{params[:id]}"})
+    end
+
+    desc "create a new employee"
+    # This takes care of parameter validation
+    params do
+      requires :name, type: String
+      requires :address, type:String
+      requires :age, type:Integer
+    end
+    post do
+      present({ :employee_data => "Creating employee: #{params[:name]}, #{params[:address]}, #{params[:age]}"})
+    end
+
+    desc "update an employee address"
+    params do
+      requires :id, type: String
+      requires :address, type:String
+    end
+    put ':id' do
+      present({ :employee_data => "Updating employee ##{params[:id]}: #{params[:address]}"})
+    end
+
+    desc "delete an employee"
+    params do
+      requires :id, type: String
+    end
+
+    delete ':id' do
+      present({ :employee_data => "Deleting employee ##{params[:id]}"})
+    end
+
+    route_param :id do
+      resource :nested do
+        desc "try a nested route"
+        get ':child' do
+          present({ :employee_data => "Nested employee data for ##{params[:id]}: #{params[:child]}"})
+        end
+      end
+    end
+  end
+end
+