napa 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2718b1367fa6291f248a6355cbd7805307d605ef
-  data.tar.gz: 66b0551ef54b97b7d73d5bcbd1521254f35df2b9
+  metadata.gz: 0eeeb8e92f9f844abe34b2a0545655227c5d493f
+  data.tar.gz: 2d38e5b45cab67654e24388746a3c46eb168739c
 SHA512:
-  metadata.gz: 8270a158da3bcc9fb032ff5f32efaef70c470d43580cdd11e37e77c812e2e29ee55a3ff4300c2652df3e4b96d0cd2c6f7763e43684f9d528546555f0b519ab3c
-  data.tar.gz: 33596208d45629e9fc4498c28cb3d5d25a2802a26ebec8ca1c19a4e44c10639ede89909e4298c7efa787fc927c9aaeed88415b048c2e916fe1ec45cb6b66bac0
+  metadata.gz: ac876295c7e2f01d861766a12efe01302ae3b0bf816773cc34e2a99a41fd6698821b5fc86db54f1247383cae5e3656ffe56a472f8c44bae7c3c56ccf385a4ff0
+  data.tar.gz: 9bb036efa3d541e90c8aa20a3b6f088daa6d4f55d17d7acb22e7ffa4786b432aba6513974a2d0459081058b86fc5e70662ba3462a01947634dddfc53453fccb1

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 master
 ===
 
+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 Napa::FilterByHash` from generated code.
+* Fix when using IRB and napa 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 Napa console. It now takes an optional environment parameter, i.e. `napa console production`.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Darby Frey
+Copyright (c) 2013 Bellycard Inc.
 
 MIT License
 
@@ -19,4 +19,6 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+“Napa”, and the Napa logo are registered trademarks of Bellycard Inc. All rights reserved.

data/README.md

@@ -36,7 +36,7 @@ Run `napa` terminal prompt to see available features:
 ```
 Commands:
   napa console                              # Start the Napa console
-  napa generate api <api_name>              # Create a Grape API, Model and Representer
+  napa generate api <api_name>              # Create a Grape API, Model and Representer, api_name should be singular i.e. user
   napa generate migration <migration_name>  # Create a Database Migration
   napa help [COMMAND]                       # Describe available commands or one specific command
   napa new <app_name> [app_path]            # Create a scaffold for a new Napa service
@@ -94,7 +94,7 @@ The Health Check middleware will add an endpoint at `/health` that will return s
 ```
 
 ### Logger
-The *Logger* modules 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:
+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 Napa::Middleware::Logger
@@ -111,6 +111,29 @@ ActiveRecord::Base.logger = Napa::Logger.logger
 ```ruby
 Napa::Logger.logger.debug 'Some Debug Message'
 ```
+### StatsD
+There are two middlewares available to enable StatsD reporting, `RequestStats` and `DatabaseStats`. They can be enabled independently in your `config.ru` file:
+
+```
+use Napa::Middleware::RequestStats
+use Napa::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 Napa logger to see the requests in your logs.
+
+```
+Statsd.logger = Napa::Logger.logger
+```
 
 ## Bugs & Feature Requests
 Please add an issue in [Github](https://github.com/bellycard/napa/issues) if you discover a bug or have a feature request.

data/docs/quickstart.md

@@ -13,7 +13,7 @@ gem install napa
 In this example we will create a new API to manage a directory of people. Each person will have a `name`, `job_title` and `email_address`. To get started, create a new scaffold by running:
 
 ```
-napa new people_service
+napa new people-service
 ```
 
 **Note:** by default, Napa will configure itself to use Mysql. If you prefer to use Postgres, simply pass in the `-d=pg` option to the `napa new` command.
@@ -22,33 +22,33 @@ You will see the following output:
 
 ```
 Generating scaffold...
-      create  people_service
-      create  people_service/.env.test
-      create  people_service/.env
-      create  people_service/.gitignore
-      create  people_service/.rubocop.yml
-      create  people_service/.ruby-gemset
-      create  people_service/.ruby-version
-      create  people_service/Gemfile
-      create  people_service/README.md
-      create  people_service/Rakefile
-      create  people_service/app.rb
-      create  people_service/app/apis/application_api.rb
-      create  people_service/app/apis/hello_api.rb
-      create  people_service/config.ru
-      create  people_service/config/database.yml
-      create  people_service/config/initializers/active_record.rb
-      create  people_service/config/middleware/honeybadger.rb
-      create  people_service/db/schema.rb
-      create  people_service/lib/.keep
-      create  people_service/log/.gitkeep
-      create  people_service/spec/apis/hello_api_spec.rb
-      create  people_service/spec/factories/.gitkeep
-      create  people_service/spec/spec_helper.rb
+      create  people-service
+      create  people-service/.env.test
+      create  people-service/.env
+      create  people-service/.gitignore
+      create  people-service/.rubocop.yml
+      create  people-service/.ruby-gemset
+      create  people-service/.ruby-version
+      create  people-service/Gemfile
+      create  people-service/README.md
+      create  people-service/Rakefile
+      create  people-service/app.rb
+      create  people-service/app/apis/application_api.rb
+      create  people-service/app/apis/hello_api.rb
+      create  people-service/config.ru
+      create  people-service/config/database.yml
+      create  people-service/config/initializers/active_record.rb
+      create  people-service/config/middleware/honeybadger.rb
+      create  people-service/db/schema.rb
+      create  people-service/lib/.keep
+      create  people-service/log/.gitkeep
+      create  people-service/spec/apis/hello_api_spec.rb
+      create  people-service/spec/factories/.gitkeep
+      create  people-service/spec/spec_helper.rb
 Done!
 ```
 
-Now, change into the `people_service` directory and run Bundler to get all the gems you need:
+Now, change into the `people-service` directory and run Bundler to get all the gems you need:
 
 ```
 bundle install
@@ -238,6 +238,7 @@ All response from Napa include the `data` key. In this case, we see an array con
 {
   "data": [
     {
+      "object_type": "person",
       "id": 1,
       "name": "Darby Frey",
       "job_title": "Software Engineer",
@@ -287,6 +288,6 @@ So, there you have it, a new API service in minutes. It's very basic, but you ca
 
 ## Resources
 
-* [Code Example: people-service](https://github.com/darbyfrey/people_service)
+* [Code Example: people_service](https://github.com/darbyfrey/people_service)
 * [Grape](http://intridea.github.io/grape/)
 * [Roar](https://github.com/apotonick/roar)

data/lib/napa.rb

@@ -12,19 +12,23 @@ require 'napa/setup'
 require 'napa/version'
 require 'napa/logger/logger'
 require 'napa/logger/log_transaction'
+require 'napa/logger/parseable'
 require 'napa/identity'
 require 'napa/json_error'
 require 'napa/stats'
 require 'napa/active_record_extensions/filter_by_hash'
+require 'napa/active_record_extensions/stats'
 require 'napa/grape_extensions/error_formatter'
 require 'napa/grape_extensions/grape_helpers'
-require 'napa/grape_extensions/entity'
-require 'napa/grape_extensions/representer'
+require 'napa/output_formatters/entity'
+require 'napa/output_formatters/include_nil'
+require 'napa/output_formatters/representer'
 require 'napa/grape_extenders'
 require 'napa/middleware/logger'
 require 'napa/middleware/app_monitor'
 require 'napa/middleware/authentication'
 require 'napa/middleware/request_stats'
+require 'napa/middleware/database_stats'
 require 'napa/authentication'
 
 # load rake tasks if Rake installed

data/lib/napa/active_record_extensions/notifications_subscriber.rb

@@ -0,0 +1,17 @@
+if defined?(ActiveRecord)
+  ActiveSupport::Notifications.subscribe 'sql.active_record' do |name, start, finish, id, payload|
+    if payload[:sql].downcase.match(/(select|update|insert|delete)(.+)/i)
+      table, action = Napa::ActiveRecordStats.extract_sql_content(payload[:sql])
+    end
+
+    if table
+      Napa::Stats.emitter.timing(
+        "sql.query_time",
+      (finish - start) * 1000)
+
+      Napa::Stats.emitter.timing(
+        "sql.table.#{table}.#{action.downcase}.query_time",
+      (finish - start) * 1000)
+    end
+  end
+end

data/lib/napa/active_record_extensions/stats.rb

@@ -1,4 +1,4 @@
-if defined?(ActiveSupport)
+if defined?(ActiveSupport) && defined?(ActiveRecord)
   module Napa
     module ActiveRecordStats
       SQL_INSERT_DELETE_PARSER_REGEXP = /^(?<action>\w+)\s(\w+)\s\W*(?<table>\w+)/
@@ -32,19 +32,6 @@ if defined?(ActiveSupport)
         end
         [table, action]
       end
-
-      ActiveSupport::Notifications.subscribe 'sql.active_record' do |name, start, finish, id, payload|
-        if payload[:sql].match(/(select|update|insert|delete)(.+)/i)
-          table, action = extract_sql_content(payload[:sql])
-        end
-
-        if table
-          stat_context = "#{Thread.current[:stats_context] || Napa::Identity.name + '.unknown'}"
-          Napa::Stats.emitter.timing(
-            "#{stat_context}.sql.#{table}.#{action.downcase}.query_time",
-            (finish - start) * 1000)
-        end
-      end
     end
   end
 end

data/lib/napa/cli.rb

@@ -30,8 +30,8 @@ module Napa
 
       desc 'console [environment]', 'Start the Napa console'
       options aliases: 'c'
-      def console(environment = 'development' )
-        ENV['RACK_ENV'] = environment
+      def console(environment = nil)
+        ENV['RACK_ENV'] = environment || 'development'
 
         require 'racksh/init'
 
@@ -42,6 +42,9 @@ module Napa
           require "irb"
           require "irb/completion"
           interpreter = IRB
+          # IRB uses ARGV and does not expect these arguments.
+          ARGV.delete('console')
+          ARGV.delete(environment) if environment
         end
 
         Rack::Shell.init

data/lib/napa/generators/api_generator.rb

@@ -15,10 +15,14 @@ module Napa
         name.tableize
       end
 
+      def output_directory
+        '.'
+      end
+
       def api
         self.class.source_root "#{File.dirname(__FILE__)}/templates/api"
         say 'Generating api...'
-        directory '.', '.'
+        directory '.', output_directory
         say 'Done!', :green
       end
     end

data/lib/napa/generators/migration_generator.rb

@@ -15,12 +15,16 @@ module Napa
         "#{version}_#{migration_name.underscore}"
       end
 
+      def output_directory
+        './db/migrate'
+      end
+
       def migration
         self.class.source_root "#{File.dirname(__FILE__)}/templates/migration"
         say 'Generating migration...'
-        directory '.', './db/migrate'
+        directory '.', output_directory
         say 'Done!', :green
       end
     end
   end
-end
+end

data/lib/napa/generators/scaffold_generator.rb

@@ -15,9 +15,10 @@ module Napa
       def generate
         say 'Generating scaffold...'
 
-        @database_gem     = ['pg','postgres'].include?(options[:database]) ? 'pg' : 'mysql2'
-        @database_adapter = ['pg','postgres'].include?(options[:database]) ? 'postgresql' : 'mysql2'
-        @database_user    = ['pg','postgres'].include?(options[:database]) ? '' : 'root'
+        @database_gem       = ['pg','postgres'].include?(options[:database]) ? 'pg' : 'mysql2'
+        @database_adapter   = ['pg','postgres'].include?(options[:database]) ? 'postgresql' : 'mysql2'
+        @database_encoding  = ['pg','postgres'].include?(options[:database]) ? 'unicode' : 'utf8'
+        @database_user      = ['pg','postgres'].include?(options[:database]) ? '' : 'root'
 
         directory ".", (app_path || app_name)
 

data/lib/napa/generators/templates/api/app/apis/%name_tableize%_api.rb.tt

@@ -1,10 +1,10 @@
 class <%= name.classify.pluralize %>Api < Grape::API
   desc 'Get a list of <%= name.underscore.tableize %>'
   params do
-    optional :ids, type: String, desc: 'comma separated <%= name.underscore %> ids'
+    optional :ids, type: Array, desc: 'Array of <%= name.underscore %> ids'
   end
   get do
-    <%= name.underscore.tableize %> = <%= name.classify %>.filter(declared(params, include_missing: false))
+    <%= name.underscore.tableize %> = params[:ids] ? <%= name.classify %>.where(id: params[:ids]) : <%= name.classify %>.all
     represent <%= name.underscore.tableize %>, with: <%= name.classify %>Representer
   end
 
@@ -13,8 +13,7 @@ class <%= name.classify.pluralize %>Api < Grape::API
   end
 
   post do
-    <%= name.underscore %> = <%= name.classify %>.create(declared(params, include_missing: false))
-    error!(present_error(:record_invalid, <%= name.underscore %>.errors.full_messages)) unless <%= name.underscore %>.errors.empty?
+    <%= name.underscore %> = <%= name.classify %>.create!(permitted_params)
     represent <%= name.underscore %>, with: <%= name.classify %>Representer
   end
 
@@ -34,7 +33,7 @@ class <%= name.classify.pluralize %>Api < Grape::API
     put do
       # fetch <%= name.underscore %> record and update attributes.  exceptions caught in app.rb
       <%= name.underscore %> = <%= name.classify %>.find(params[:id])
-      <%= name.underscore %>.update_attributes!(declared(params, include_missing: false))
+      <%= name.underscore %>.update_attributes!(permitted_params)
       represent <%= name.underscore %>, with: <%= name.classify %>Representer
     end
   end

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

@@ -1,3 +1,2 @@
 class <%= name.classify %> < ActiveRecord::Base
-  include Napa::FilterByHash
 end

data/lib/napa/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/napa/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/napa/generators/templates/migration/%migration_filename%.rb.tt

@@ -1,4 +1,4 @@
-class <%= migration_name.classify %> < ActiveRecord::Migration
+class <%= migration_name.camelize %> < ActiveRecord::Migration
   def change
   end
 end

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

@@ -8,3 +8,5 @@ log/*
 tmp/*
 coverage
 !.keep
+.ruby-gemset
+.ruby-version

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

@@ -6,7 +6,6 @@ gem '<%= @database_gem %>'
 gem 'activerecord', '~> 4.0.0', :require => 'active_record'
 gem 'honeybadger'
 gem 'json'
-gem 'shotgun'
 gem 'napa'
 gem 'roar'
 gem 'grape-swagger'
@@ -16,7 +15,8 @@ group :development,:test do
 end
 
 group :development do
-  gem 'rubocop'
+  gem 'rubocop', require: false
+  gem 'shotgun', require: false
 end
 
 group :test do

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

@@ -15,5 +15,5 @@ Dir['./config/initializers/**/*.rb'].map { |file| require file }
 Dir['./config/middleware/**/*.rb'].map { |file| require file }
 
 # autoload app
-relative_load_paths = %w[app/apis app/representers app/models app/workers lib]
+relative_load_paths = %w(app/apis app/representers app/models app/workers lib)
 ActiveSupport::Dependencies.autoload_paths += relative_load_paths

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

@@ -6,7 +6,7 @@ require './app'
 # use Rack::Cors do
 #   allow do
 #     origins '*'
-#     resource '*', headers: :any, methods: :any
+#     resource '*', headers: :any, methods: [:get, :post, :delete, :put, :options]
 #   end
 # end
 #

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

@@ -1,4 +1,5 @@
 defaults: &defaults
+  encoding: <%= @database_encoding %>
   adapter: <%= @database_adapter %>
   host: <%%= ENV['DATABASE_HOST'] %>
   username: <%%= ENV['DATABASE_USER'] %>