service_template 0.5.0

data/lib/service_template/generators/templates/api/app/models/%name_underscore%.rb.tt

@@ -0,0 +1,2 @@
+class <%= name.classify %> < ActiveRecord::Base
+end

data/lib/service_template/generators/templates/api/app/representers/%name_underscore%_representer.rb.tt

@@ -0,0 +1,4 @@
+class <%= name.classify %>Representer < ServiceTemplate::Representer
+  property :id, type: String
+
+end

data/lib/service_template/generators/templates/api/spec/apis/%name_tableize%_api_spec.rb.tt

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+def app
+  ApplicationApi
+end
+
+describe <%= name.classify.pluralize %>Api do
+  include Rack::Test::Methods
+
+  describe 'e.g. GET, POST, PUT, etc.' do
+    it 'needs tests to be written!' do
+      pending('write tests for <%= name.classify.pluralize %>Api!')
+    end
+  end
+
+end

data/lib/service_template/generators/templates/api/spec/models/%name_underscore%_spec.rb.tt

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe <%= name.classify %> do
+
+  it 'needs tests to be written!' do
+    pending('write tests for <%= name.classify %>!')
+  end
+
+end

data/lib/service_template/generators/templates/readme/README.md.tt

@@ -0,0 +1,55 @@
+# <%= service_name %>
+
+:bow: Please put your auspicious [Travis status button](http://docs.travis-ci.com/user/status-images/) here :bow:
+
+1. [Overview](#overview)
+2. [How Does It Work](#how-does-it-work)
+3. [Endpoints](#endpoints)
+4. [Development](#development)
+5. [Extra Links](#extra-links)
+
+### Overview
+
+:bow: Tell us about your wonderful service :bow:
+
+In this section, please answer the questions, "What is this service?" or "What does this service do?"
+
+### How Does It Work
+
+Ohhh tell us, how does it function? :bow: :bow:
+
+Tell us about the __mechanics__ or __logic__ driving the service. Diagrams and pictures are :angel:
+
+### Endpoints
+
+How must we interact with your great service? :bow:
+
+Try typing `rake routes` into your console, and then paste that here.
+
+If those endpoints need to be explained in more detail, please bless us with your wisdom.
+
+### Development
+
+```
+bundle install
+
+rake db:reset
+
+rspec spec
+
+rackup
+```
+
+So wonderful, so informative! :bow:
+
+What else do we need to know so that a new developer can start contributing __within 30 minutes__?
+
+### Extra Links
+
+What a perfectly constructed service! We're so honored :bow:
+
+If your service makes heavy use of other gems or API's, imbue us with that knowledge in the form of
+
+- [Link to documentation]()
+- [etc.]()
+- [For information on how to create links in Markdown, please click here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links)

data/lib/service_template/generators/templates/readme/spec/docs/readme_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'README' do
+  it 'has been filled out' do
+    pending 'Please fill out the sections that have a :bow:'
+  end
+end

data/lib/service_template/generators/templates/scaffold/.env.development.tt

@@ -0,0 +1,9 @@
+# Uncomment when using ServiceTemplate::Middleware::Authentication
+# HEADER_PASSWORD=''
+
+SERVICE_NAME=<%= app_name %>
+
+DATABASE_USER='<%= @database_user %>'
+DATABASE_PASSWORD=''
+DATABASE_HOST=localhost
+DATABASE_NAME=<%= app_name.underscore %>_development

data/lib/service_template/generators/templates/scaffold/.env.test.tt

@@ -0,0 +1,10 @@
+# Uncomment when using ServiceTemplate::Middleware::Authentication
+# HEADER_PASSWORD=''
+
+SERVICE_NAME=<%= app_name %>
+RACK_ENV=test
+
+DATABASE_USER='<%= @database_user %>'
+DATABASE_PASSWORD=''
+DATABASE_HOST=localhost
+DATABASE_NAME=<%= app_name.underscore %>_test

data/lib/service_template/generators/templates/scaffold/.gitignore.tt

@@ -0,0 +1,13 @@
+.DS_Store
+.env
+.vagrant
+.rspec
+.env
+!.env.test
+!log/.keep
+log/*
+tmp/*
+coverage
+!.keep
+.ruby-gemset
+.ruby-version

data/lib/service_template/generators/templates/scaffold/.rubocop.yml

@@ -0,0 +1,24 @@
+Documentation:
+  Enabled: false
+
+Encoding:
+  EnforcedStyle: when_needed
+
+LineLength:
+  Max: 120
+
+# This cop checks for big numeric literals without _ between groups of digits in them.
+# ie: 100_000 vs 100000
+NumericLiterals:
+  Enabled: false
+
+# how to bubble up exceptions (raise or fail)
+SignalException:
+  EnforcedStyle: only_raise
+
+MethodLength:
+  Max: 30
+
+AllCops:
+  Exclude:
+    - db/schema.rb

data/lib/service_template/generators/templates/scaffold/.ruby-version.tt

@@ -0,0 +1 @@
+2.1.5

data/lib/service_template/generators/templates/scaffold/Gemfile.tt

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+ruby "2.1.5"
+
+gem 'rack-cors'
+gem '<%= @database_gem %>'
+gem 'activerecord', '~> 4.2.0', :require => 'active_record'
+gem 'json'
+gem 'service_template'
+gem 'roar'
+gem 'grape-swagger'
+gem 'grape-activerecord'
+
+group :development,:test do
+  gem 'pry'
+end
+
+group :development do
+  gem 'rubocop', require: false
+  gem 'shotgun', require: false
+end
+
+group :test do
+  gem 'factory_girl'
+  gem 'rspec'
+  gem 'rack-test'
+  gem 'simplecov'
+  gem 'webmock'
+  gem 'database_cleaner'
+end

data/lib/service_template/generators/templates/scaffold/README.md

@@ -0,0 +1,3 @@
+# Welcome to ServiceTemplate
+
+TODO: Add an awesome README that explains how all this stuff works!

data/lib/service_template/generators/templates/scaffold/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+require 'bundler/setup'
+require 'service_template/setup'
+require 'dotenv'
+require 'grape/activerecord/rake'
+ServiceTemplate.load_environment
+
+require './app'
+require 'json'
+
+# active record tasks
+namespace :db do
+  # Some db tasks require your app code to be loaded
+  task :environment do
+    require_relative 'app'
+  end
+end
+
+Dir.glob('./lib/tasks/*.rake').each { |r| import r }
+
+

data/lib/service_template/generators/templates/scaffold/app.rb

@@ -0,0 +1,19 @@
+# load bundler
+require 'bundler/setup'
+Bundler.setup(:default)
+require 'service_template/setup'
+Bundler.require(:default, ServiceTemplate.env.to_sym)
+require 'service_template'
+
+# load environment
+ServiceTemplate.load_environment
+
+# autoload initalizers
+Dir['./config/initializers/**/*.rb'].map { |file| require file }
+
+# load middleware configs
+Dir['./config/middleware/**/*.rb'].map { |file| require file }
+
+# autoload app
+relative_load_paths = %w(app/apis app/representers app/models app/workers lib)
+ActiveSupport::Dependencies.autoload_paths += relative_load_paths

data/lib/service_template/generators/templates/scaffold/app/apis/application_api.rb

@@ -0,0 +1,9 @@
+class ApplicationApi < Grape::API
+  format :json
+  extend ServiceTemplate::GrapeExtenders
+
+  mount HelloApi => '/'
+
+  add_swagger_documentation
+end
+

data/lib/service_template/generators/templates/scaffold/app/apis/hello_api.rb.tt

@@ -0,0 +1,10 @@
+class HelloApi < Grape::API
+
+  resource :hello do
+    desc 'Return a Hello World message'
+    get do
+      { message: 'Hello Wonderful World, from <%= app_name.classify %>!' }
+    end
+  end
+
+end

data/lib/service_template/generators/templates/scaffold/config.ru.tt

@@ -0,0 +1,21 @@
+require './app'
+
+# Experimental StatsD Emitter for ActiveRecord
+# require 'service_template/active_record_extensions/stats.rb'
+
+# use Rack::Cors do
+#   allow do
+#     origins '*'
+#     resource '*', headers: :any, methods: [:get, :post, :delete, :put, :options]
+#   end
+# end
+#
+# use Honeybadger::Rack::ErrorNotifier
+# use ServiceTemplate::Middleware::Logger
+
+use ServiceTemplate::Middleware::AppMonitor
+# Uncomment to require header passwords for all requests
+# use ServiceTemplate::Middleware::Authentication
+use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+run ApplicationApi

data/lib/service_template/generators/templates/scaffold/config/database.yml.tt

@@ -0,0 +1,19 @@
+defaults: &defaults
+  encoding: <%= @database_encoding %>
+  adapter: <%= @database_adapter %>
+  host: <%%= ENV['DATABASE_HOST'] %>
+  username: <%%= ENV['DATABASE_USER'] %>
+  password: <%%= ENV['DATABASE_PASSWORD'] %>
+  database: <%%= ENV['DATABASE_NAME'] %>
+
+production:
+  <<: *defaults
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults

data/lib/service_template/generators/templates/scaffold/config/initializers/active_record.rb

@@ -0,0 +1,5 @@
+require 'erb'
+db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[ServiceTemplate.env]
+ActiveRecord::Base.establish_connection(db)
+ActiveRecord::Base.logger = ServiceTemplate::Logger.logger if ServiceTemplate.env.development?
+ActiveRecord::Base.include_root_in_json = false

data/lib/service_template/generators/templates/scaffold/db/schema.rb

@@ -0,0 +1,11 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.

data/lib/service_template/generators/templates/scaffold/spec/apis/hello_api_spec.rb.tt

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+def app
+  ApplicationApi
+end
+
+describe HelloApi do
+  include Rack::Test::Methods
+
+  describe 'GET /hello' do
+    it 'returns a hello world message' do
+      get '/hello'
+      expect(response_body).to eq({ message: 'Hello Wonderful World, from <%= app_name.classify %>!' }.to_json)
+    end
+  end
+
+end

data/lib/service_template/generators/templates/scaffold/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'webmock/rspec'
+require 'rack/test'
+require 'simplecov'
+require 'factory_girl'
+require 'service_template/rspec_extensions/response_helpers'
+
+FactoryGirl.definition_file_paths = %w(./spec/factories)
+FactoryGirl.find_definitions
+SimpleCov.start do
+  add_filter "/spec\/.*/"
+  add_filter "/vendor\/.*/"
+end
+
+require './app'
+require 'database_cleaner'
+
+SimpleCov.start do
+  add_filter "/spec\/.*/"
+  add_filter "/vendor\/.*/"
+end
+
+# fail once the test coverage gets below an accepted amount
+# SimpleCov.minimum_coverage 90
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  config.include ServiceTemplate::RspecExtensions::ResponseHelpers
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/service_template/grape_extenders.rb

@@ -0,0 +1,30 @@
+module ServiceTemplate
+  module GrapeExtenders
+    def self.extended(modified_class)
+      # when extended, set the exceptions to handle
+
+      # if AR is being used, rescue from common AR errors
+      if defined?(::ActiveRecord)
+        modified_class.rescue_from ::ActiveRecord::RecordNotFound do |e|
+          err = ServiceTemplate::JsonError.new(:record_not_found, 'record not found')
+          ServiceTemplate::Logger.logger.debug ServiceTemplate::Logger.response(404, {}, err)
+          rack_response(err.to_json, 404)
+        end
+        modified_class.rescue_from ::ActiveRecord::RecordInvalid do |e|
+          err = ServiceTemplate::JsonError.new(:unprocessable_entity, e.message, e.record.errors.messages)
+          ServiceTemplate::Logger.logger.debug ServiceTemplate::Logger.response(422, {}, err)
+          rack_response(err.to_json, 422)
+        end
+      end
+
+      # if AASM is being used, rescue from invalid transitions
+      if defined?(::AASM)
+        modified_class.rescue_from ::AASM::InvalidTransition do |e|
+          err = ServiceTemplate::JsonError.new(:unprocessable_entity, e.message)
+          ServiceTemplate::Logger.logger.debug ServiceTemplate::Logger.response(422, {}, err)
+          rack_response(err.to_json, 422)
+        end
+      end
+    end
+  end
+end

data/lib/service_template/grape_extensions/error_formatter.rb

@@ -0,0 +1,18 @@
+if defined?(Grape)
+  module Grape
+    module ErrorFormatter
+      module Json
+        class << self
+          def call(message, backtrace, options = {}, env = nil)
+            result = message.is_a?(ServiceTemplate::JsonError) ? message : ServiceTemplate::JsonError.new(:api_error, message)
+
+            if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
+              result = result.to_h.merge(backtrace: backtrace)
+            end
+            MultiJson.dump(result)
+          end
+        end
+      end
+    end
+  end
+end