service_template 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02a8715ac1b0820f58fd3e031d1b293903eb2e7b
+  data.tar.gz: 6b83d3dd52b80b7b7abb0d3c0429f5e8537be154
+SHA512:
+  metadata.gz: 3ac128223d3b4c1e455c6e90d4d6d74969a47ab409e2b4add409713e4206fd8ee95f11762d94738d17abae2809a504a54fb1537ea64cc6cc7b54c1a1c1e29e20
+  data.tar.gz: 98a4fb6716da38f790d051dc8447798c4fcb25941901a821c40154c8f7edb5feefcba6405a11813a69df9656e5b53dd4ee39aef14fc55d7fcb5a102fd3461f4f

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+.rspec
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,23 @@
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+LineLength:
+  Max: 120
+
+NumericLiterals:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+AllCops:
+  Excludes:
+    - db/**
+    - config/**
+    - script/**

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+language: ruby
+cache:
+  - bundler
+  - apt
+rvm:
+  - ruby-2.0.0
+
+script: "bundle exec rspec spec --color"
+
+addons:
+  code_climate:
+    repo_token: 8d11efee

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+master
+===
+* [Explicitly require `filter_parameters.rb` instead of relying on `action_dispatch` autoload](https://github.com/bellycard/service_template/pull/181)
+* [Default rake task runs specs](https://github.com/bellycard/service_template/pull/176)
+* [Set ServiceTemplate.env to the environment arg we pass in the console](https://github.com/bellycard/service_template/pull/179)
+* [Add thor command to start shotgun server](https://github.com/bellycard/service_template/pull/177)
+
+0.4.1
+===
+* Added a reasons object to error responses to represent active record validation errors for individual attributes
+* Added ability to filter sensitive data from logs.
+
+0.4.0
+===
+* Added `ServiceTemplate.cache` to wrap `ActiveSupport::Cache`
+* Added README generator
+* Update the HoneyBadger scaffolding
+* Fixed a bug with ServiceTemplate::StatsDTimer where time was being reported in seconds, not milliseconds
+* Removed additional StatsD counter metric for request stats middleware
+* Added new deploy CLI with `force` and `revision` options `service_template deploy production`
+* Added deprecation warnings
+* Added initialization hook to run code when a ServiceTemplate service boots
+* Added Migration generators from Rails
+* Added rake db:seed functionality
+* Added some convenience methods to spec_helper
+
+0.3.0
+===
+* Added `rake db:rollback` to rollback migrations just like Rails
+* Fixed bug in migration generator causing constant not defined errors
+* Fixed CORS config in scaffold generator
+* Fixed logging bug in grape_extenders
+* Set UTF-8 encoding in generated database.yml
+* Removed unneeded gem dependencies (shotgun and unicorn)
+* Fixed spec_helper that gets generated to ignore spec files and gems (on CI servers)
+* Added spec response helpers `parsed_response`, `response_code` and `response_body` to make tests easier to DRY up
+* Removed #filter and `include ServiceTemplate::FilterByHash` from generated code.
+* Fix when using IRB and service_template console
+* Added IncludeNil module for Representable/Roar output
+* Template updates to include spec files for APIs
+* Removing FilterByHash in the API template
+* Fix when ErrorFormatter is passed a non-hash
+* Added more descriptive messages on git based deploy errors
+* Added RequestStats and DatabaseStats middlewares to report data to StatsD
+* All String logs are now wrapped in a hash before being written to the log file
+
+0.2.1
+===
+* Updated ServiceTemplate console. It now takes an optional environment parameter, i.e. `service_template console production`.
+* Added `c` alias for ServiceTemplate console, i.e. `service_template c` or `service_template c production`
+* Fixed a bug causing `rake db:schema:load` to fail
+* Fixed a bug affecting `rake db:create` and `rake db:drop` using Postgres
+* Fixed a bug ServiceTemplate::GrapeHelpers to bypass the representer when given an array
+
+0.2.0
+===
+* The console is now run with `service_template console`, added support for racksh
+* Scaffold generator now supports the `--database (-d)` flag
+* Scaffold generator now supports Mysql or Postgres with ActiveRecord
+* Scaffold generator now uses Roar instead of Grape Entity
+* Fixed a bug in `rake routes`
+* Fixed a bug in `rake db:reset`
+* Added StatsD instrumentation (experimental)
+* Added a CHANGELOG

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2013 Bellycard Inc.
+
+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.
+
+“ServiceTemplate”, and the ServiceTemplate logo are registered trademarks of Bellycard Inc. All rights reserved.

data/README.md

@@ -0,0 +1,217 @@
+THIS IS A FORK and different opinions of a VERY good framwork called Napa
+https://github.com/bellycard/napa
+
+Here are the main differences
++ Roar with hypermedia JSON-API default rather than a bespoke response format
++ ActiveRecord 4.2 rather than 4.0
++ Rollbar rather than Honeybadger
+
+## Installation
+
+ServiceTemplate is available as a gem, to install it run:
+
+```
+gem install service_template
+```
+
+Or, if you're using Bundler, add it to your Gemfile:
+
+```
+gem 'service_template'
+```
+
+And run:
+
+```
+$ bundle install
+```
+
+## Getting Started
+
+See the [Quickstart Guide](https://github.com/bellycard/service_template/blob/master/docs/quickstart.md) for an intro to creating a simple service with ServiceTemplate.
+
+## Usage
+
+Run `service_template` terminal prompt to see available features:
+
+```
+Commands:
+  service_template console [environment]                                                            # Start the ServiceTemplate console
+  service_template server                                                                           # Start the ServiceTemplate server
+  service_template generate api <api_name>                                                          # Create a Grape API, Model and Representer
+  service_template generate migration <migration_name> [field[:type][:index] field[:type][:index]]  # Create a Database Migration
+  service_template generate readme                                                                  # Create a formatted README
+  service_template deploy <environment>                                                             # Deploy to <environment> by setting a git tag
+  service_template help [COMMAND]                                                                   # Describe available commands or one specific command
+  service_template new <app_name> [app_path]                                                        # Create a scaffold for a new ServiceTemplate service
+  service_template version                                                                          # Shows the ServiceTemplate version number
+```
+
+
+### Console
+Similar to the Rails console, load an IRB session with your applications environment by running:
+
+```
+service_template console
+```
+
+### Deploy
+ServiceTemplate provides a CLI for deploying to a given environment by setting a git tag. This is useful for chef-based deploys where deploys are trigged when a git SHA changes.
+
+```sh
+service_template deploy production
+Are you sure you want to deploy this service? Y
+#=> <git SHA> tagged as production by danielmackey at October 09, 2014 14:41
+```
+
+If you want to skip the 'Are you sure?' prompt, pass the `--confirm` flag to set the tag automatically
+```sh
+service_template deploy production --confirm
+#=> <git SHA> tagged as production by danielmackey at October 09, 2014 14:41
+```
+
+### Rake Tasks
+
+`rake -T` will give you a list of all available rake tasks:
+
+```
+rake db:create          # Create the database
+rake db:drop            # Delete the database
+rake db:migrate         # Migrate the database through scripts in db/migrate
+rake db:reset           # Create the test database
+rake db:schema:dump     # Create a db/schema.rb file that can be portably used against any DB supported by AR
+rake db:schema:load     # Load a schema.rb file into the database
+rake db:seed            # Load the seed data from db/seeds.rb
+rake git:set_tag[tag]   # Set tag, which triggers deploy
+rake git:verify         # Verify git repository is in a good state for deployment
+rake routes             # display all routes for Grape
+```
+
+## Middlewares
+ServiceTemplate includes a number of Rack middlewares that can be enabled to add functionality to your project.
+
+### Authentication
+The Authentication middleware will add a simple header based authentication layer to all requests. This is just looking for a header of `'Password' = 'Your Password'`. The passwords are defined in the `.env` file. You can allow multiple passwords by supplying a comma separated list. For example:
+
+`HEADER_PASSWORDS='password1,password2'`
+
+If your application doesn't require authentication, you can simply remove the middleware.
+
+### Health Check
+The Health Check middleware will add an endpoint at `/health` that will return some data about your app. This was created to allow monitoring tools a standardized way to monitor multiple services. This endpoint will return a response similar to this:
+
+```
+{
+    "name": "service-name",
+    "hostname": "host-name",
+    "revision": "current-git-sha-of-app",
+    "pid": 1234,
+    "parent_pid": 1233,
+    "service_template_revision": "running-version-of-service_template"
+}
+```
+
+### Logger
+The *Logger* module is used to create a common log format across applications. The Logger is enable via a rack middleware by adding the line below to your `config.ru` file:
+
+```ruby
+use ServiceTemplate::Middleware::Logger
+```
+
+You can also enable the logger for ActiveRecord by adding the following line to an initializer:
+
+```ruby
+ActiveRecord::Base.logger = ServiceTemplate::Logger.logger
+```
+
+`ServiceTemplate::Logger.logger` returns a Singleton instance of the Logging object, so it can be passed to other libraries or called directly. For example:
+
+```ruby
+ServiceTemplate::Logger.logger.debug 'Some Debug Message'
+```
+
+### Scrubbing Logs of Sensitive Data
+
+Some requests may contain sensitive information, such as passwords or credit card numbers. In order to protect this information, they should be filtered out from logs.
+
+To do so, add the following line to an initializer:
+```ruby
+ServiceTemplate::ParamSanitizer.filter_params = [:password, :password_confirmation, :cvv, :card_number]
+```
+Note that the keys in the array above are just examples. They should be replaced with the parameters that have sensitive data in their value.
+
+Example **unfiltered** request ( ... denotes other information):
+```
+{ ... "message":{"request":{"method":"POST","path":"/example","query":"name=Test%20User%200039\u0026password=password", ... "params":{"name":"Test User 0039","password":"password"} ...}}}
+```
+
+Example **filtered** request ( ... denotes other information):
+```
+{ ... "message":{"request":{"method":"POST","path":"/example","query":"name=Test%20User%200039\u0026password=[FILTERED]", ... "params":{"name":"Test User 0039","password":"[FILTERED]"} ...}}}
+```
+
+### StatsD
+There are two middlewares available to enable StatsD reporting, `RequestStats` and `DatabaseStats`. They can be enabled independently in your `config.ru` file:
+
+```
+use ServiceTemplate::Middleware::RequestStats
+use ServiceTemplate::Middleware::DatabaseStats
+```
+
+**RequestStats** will emit information about your application's request count and response time.
+
+**DatabaseStats** will emit information from ActiveRecord about query times.
+
+##### Configuration
+
+To configure StatsD in your application you will need to supply the `STATSD_HOST` and `STATSD_PORT` in your environment. Optionally, if your StatsD host requires an api token (i.e. hostedgraphite), you can configure that with the `STATSD_API_KEY` environment variable.
+
+##### Logging
+
+If you want to see the StatsD reporting in action you can hook up the logger to the ServiceTemplate logger to see the requests in your logs.
+
+```
+Statsd.logger = ServiceTemplate::Logger.logger
+```
+
+### Caching
+
+ServiceTemplate adds a simple wrapper around `ActiveSupport::Cache` that allows you to easily access it similar to how it works in Rails. `ServiceTemplate.cache` will give you access to all of the methods available in `ActiveSupport::Cache::Store` [http://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html](). So, for example:
+
+```
+ServiceTemplate.cache.read
+ServiceTemplate.cache.write
+ServiceTemplate.cache.fetch
+...
+```
+
+By default it will use `:memory_store`, but you can override it to use any other caching strategy, like Memcache by setting the store:
+
+```
+ServiceTemplate.cache = :dalli_store
+```
+
+### Sorting
+
+ServiceTemplate has an optional module you can include in any Api called
+`ServiceTemplate::SortableApi`. To include this, add `include SortableApi` in the
+`helpers` block of the Api.
+
+`SortableApi` takes in a parameter for sort in the format of
+`field1,field2,-field3`, where `field1` and `field2` are used to sort
+ascending, and `field3` is sorted descending. For example,
+`-field4,field1` would be equivalent to `ORDER BY field4 DESC, field1'.
+
+Call `sorted_from_params(ar_relation, params[:sort])` passing in an
+`ActiveRecord::Relation` for `ar_relation`, and a comma-delimited string of field names for `params[:sort]`.
+
+## Bugs & Feature Requests
+Please add an issue in [Github](https://github.com/bellycard/service_template/issues) if you discover a bug or have a feature request.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+$LOAD_PATH.unshift 'lib', __dir__
+
+Dir.glob('./tasks/*.rake').each { |r| import r }
+require 'bundler/gem_tasks'
+require 'service_template/active_record_extensions/stats.rb'
+require 'service_template/active_record_extensions/seeder.rb'
+
+task default: :spec

data/bin/service_template

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'service_template/cli'
+
+ServiceTemplate::CLI::Base.start(ARGV)

data/lib/service_template.rb

@@ -0,0 +1,55 @@
+# require external libraries
+require 'rake'
+require 'dotenv'
+require 'logging'
+require 'octokit'
+require 'grape'
+require 'grape-entity'
+require 'json'
+
+# require internal files
+require 'service_template/setup'
+require 'service_template/version'
+require 'service_template/logger/logger'
+require 'service_template/logger/log_transaction'
+require 'service_template/logger/parseable'
+require 'service_template/identity'
+require 'service_template/json_error'
+require 'service_template/stats'
+require 'service_template/stats_d_timer'
+require 'service_template/active_record_extensions/stats'
+require 'service_template/active_record_extensions/seeder'
+require 'service_template/grape_extensions/error_formatter'
+require 'service_template/grape_extensions/grape_helpers'
+require 'service_template/output_formatters/entity'
+require 'service_template/output_formatters/include_nil'
+require 'service_template/output_formatters/json_api_representer'
+require 'service_template/grape_extenders'
+require 'service_template/middleware/logger'
+require 'service_template/middleware/app_monitor'
+require 'service_template/middleware/authentication'
+require 'service_template/middleware/request_stats'
+require 'service_template/middleware/database_stats'
+require 'service_template/authentication'
+require 'service_template/sortable_api'
+
+require 'service_template/deploy'
+require 'service_template/gem_dependency'
+
+# load rake tasks if Rake installed
+if defined?(Rake)
+  load 'tasks/deploy.rake'
+  load 'tasks/routes.rake'
+end
+
+module ServiceTemplate
+  class << self
+    def initialize
+      unless ServiceTemplate.skip_initialization
+        ServiceTemplate::Logger.logger.info ServiceTemplate::GemDependency.log_all if ServiceTemplate.env.production?
+      end
+    end
+  end
+end
+
+ServiceTemplate.initialize