napa 0.2.1 → 0.3.0

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

@@ -10,7 +10,7 @@ describe HelloApi do
   describe 'GET /hello' do
     it 'returns a hello world message' do
       get '/hello'
-      expect(last_response.body).to eq({ message: 'Hello Wonderful World, from <%= app_name.classify %>!' }.to_json)
+      expect(response_body).to eq({ message: 'Hello Wonderful World, from <%= app_name.classify %>!' }.to_json)
     end
   end
 

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

@@ -4,20 +4,33 @@ require 'webmock/rspec'
 require 'rack/test'
 require 'simplecov'
 require 'factory_girl'
+require 'napa/rspec_extensions/response_helpers'
 
-FactoryGirl.definition_file_paths = %w{./spec/factories}
+FactoryGirl.definition_file_paths = %w(./spec/factories)
 FactoryGirl.find_definitions
-SimpleCov.start
+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 Napa::RspecExtensions::ResponseHelpers
 
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction

data/lib/napa/grape_extenders.rb

@@ -6,10 +6,14 @@ module Napa
       # if AR is being used, rescue from common AR errors
       if defined?(::ActiveRecord)
         modified_class.rescue_from ::ActiveRecord::RecordNotFound do |e|
-          rack_response(Napa::JsonError.new(:record_not_found, 'record not found').to_json, 404)
+          err = Napa::JsonError.new(:record_not_found, 'record not found')
+          Napa::Logger.logger.debug Napa::Logger.response(404, {}, err)
+          rack_response(err.to_json, 404)
         end
         modified_class.rescue_from ::ActiveRecord::RecordInvalid do |e|
-          rack_response(Napa::JsonError.new(:unprocessable_entity, e.message).to_json, 422)
+          err = Napa::JsonError.new(:unprocessable_entity, e.message)
+          Napa::Logger.logger.debug Napa::Logger.response(422, {}, err)
+          rack_response(err.to_json, 422)
         end
       end
     end

data/lib/napa/grape_extensions/error_formatter.rb

@@ -7,7 +7,7 @@ if defined?(Grape)
             result = message.is_a?(Napa::JsonError) ? message : Napa::JsonError.new(:api_error, message)
 
             if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
-              result = result.merge(backtrace: backtrace)
+              result = result.to_h.merge(backtrace: backtrace)
             end
             MultiJson.dump(result)
           end

data/lib/napa/grape_extensions/grape_helpers.rb

@@ -14,7 +14,14 @@ module Napa
       Napa::JsonError.new(code, message)
     end
 
+    def permitted_params(options = {})
+      options = { include_missing: false }.merge(options)
+      declared(params, options)
+    end
+
     # extend all endpoints to include this
-    Grape::Endpoint.send :include, self
+    Grape::Endpoint.send :include, self if defined?(Grape)
+    # rails 4 controller concern
+    extend ActiveSupport::Concern if defined?(Rails)
   end
 end

data/lib/napa/logger/logger.rb

@@ -27,6 +27,16 @@ module Napa
 
         @logger
       end
+
+      def response(status, headers, body)
+        { response:
+          {
+            status:   status,
+            headers:  headers,
+            response: body
+          }
+        }
+      end
     end
   end
 end

data/lib/napa/logger/parseable.rb

@@ -0,0 +1,37 @@
+# override what is in logging gem to ALWAYS use a structured object, rather than a string
+# original version of this: https://github.com/TwP/logging/blob/master/lib/logging/layouts/parseable.rb
+module Logging
+  module Layouts
+    class Parseable < ::Logging::Layout
+
+      # Public: Take a given object and convert it into a format suitable for
+      # inclusion as a log message. The conversion allows the object to be more
+      # easily expressed in YAML or JSON form.
+      #
+      # If the object is an Exception, then this method will return a Hash
+      # containing the exception class name, message, and backtrace (if any).
+      #
+      # If the object is a string, wrap it in a hash.
+      #
+      # obj - The Object to format
+      #
+      # Returns the formatted Object.
+      #
+      def format_obj(obj)
+        case obj
+        when Exception
+          h = { class: obj.class.name,
+                message: obj.message }
+          h[:backtrace] = obj.backtrace if @backtrace && !obj.backtrace.nil?
+          h
+        when Time
+          iso8601_format(obj)
+        when String
+          { text: obj }
+        else
+          obj
+        end
+      end
+    end  # Parseable
+  end  # Layouts
+end

data/lib/napa/middleware/app_monitor.rb

@@ -6,7 +6,7 @@ module Napa
       end
 
       def call(env)
-        if ["/health", "/health.json"].include? env['REQUEST_PATH']
+        if ["/health", "/health.json"].include? env['PATH_INFO']
           [200, { 'Content-type' => 'application/json' }, [Napa::Identity.health.to_json]]
         else
           @app.call(env)

data/lib/napa/middleware/database_stats.rb

@@ -0,0 +1,15 @@
+module Napa
+  class Middleware
+    class DatabaseStats
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        require 'napa/active_record_extensions/notifications_subscriber'
+        status, headers, body = @app.call(env)
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/napa/middleware/logger.rb

@@ -34,13 +34,14 @@ module Napa
           end
 
           request_data = {
-            method:           env['REQUEST_METHOD'],
-            path:             env['PATH_INFO'],
-            query:            env['QUERY_STRING'],
+            method:           request.request_method,
+            path:             request.path_info,
+            query:            request.query_string,
             host:             Napa::Identity.hostname,
             pid:              Napa::Identity.pid,
             revision:         Napa::Identity.revision,
-            params:           params
+            params:           params,
+            remote_ip:        request.ip
           }
           request_data[:user_id] = current_user.try(:id) if defined?(current_user)
           { request: request_data }
@@ -54,13 +55,7 @@ module Napa
             response_body = body.inspect
           end
 
-          { response:
-            {
-              status:   status,
-              headers:  headers,
-              response: response_body
-            }
-          }
+          Napa::Logger.response(status, headers, response_body)
         end
     end
   end

data/lib/napa/middleware/request_stats.rb

@@ -6,7 +6,7 @@ module Napa
       end
 
       def normalize_path(path)
-        case 
+        case
           when path == '/'
             'root'
           else
@@ -26,14 +26,16 @@ module Napa
 
         # Calculate total response time
         response_time = (stop - start) * 1000
-        
+
         request = Rack::Request.new(env)
         path = normalize_path(request.path_info)
-        Thread.current[:stats_context] = "#{Napa::Identity.name}.http.#{request.request_method.downcase}.#{path}".gsub('/', '.')
 
         # Emit stats to StatsD
-        Napa::Stats.emitter.increment(Thread.current[:stats_context] + '.requests')
-        Napa::Stats.emitter.timing(Thread.current[:stats_context] + '.response_time', response_time)
+        Napa::Stats.emitter.increment('request_count')
+        Napa::Stats.emitter.timing('response_time', response_time)
+        Napa::Stats.emitter.increment("path.#{Napa::Stats.path_to_key(request.request_method, path)}.request_count")
+        Napa::Stats.emitter.timing("path.#{Napa::Stats.path_to_key(request.request_method, path)}.response_time", response_time)
+
         # Return the results
         [status, headers, body]
       end

data/lib/napa/output_formatters/include_nil.rb

@@ -0,0 +1,16 @@
+# include this in your representer, and you will always return all defined keys (even if their value is nil)
+module Napa
+  module Representable
+    module IncludeNil
+      def self.included base
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def property(name, options={}, &block)
+          super(name, options.merge(render_nil: true), &block)
+        end
+      end
+    end
+  end
+end

data/lib/napa/{grape_extensions → output_formatters}/representer.rb

@@ -5,8 +5,8 @@ require 'roar/representer/feature/coercion'
 module Napa
   class Representer < Roar::Decorator
     include Roar::Representer::JSON
-    include Representable::Coercion
+    include ::Representable::Coercion
 
     property :object_type, getter: lambda { |*| self.class.name.underscore }
   end
-end
+end

data/lib/napa/rspec_extensions/response_helpers.rb

@@ -0,0 +1,17 @@
+module Napa
+  module RspecExtensions
+    module ResponseHelpers
+      def parsed_response
+        Hashie::Mash.new(JSON.parse(last_response.body))
+      end
+
+      def response_code
+        last_response.status
+      end
+
+      def response_body
+        last_response.body
+      end
+    end
+  end
+end

data/lib/napa/stats.rb

@@ -14,10 +14,30 @@ module Napa
 
           # Create a new StatsD emitter with the service name as the namespace
           # Defaults to localhost port 8125 if env vars are nil
-          @emitter = Statsd.new(ENV['STATSD_HOST'], ENV['STATSD_PORT']).tap { |sd| sd.namespace = Napa::Identity.name }
+          @emitter = Statsd.new(ENV['STATSD_HOST'], ENV['STATSD_PORT']).tap { |sd| sd.namespace = namespace }
         end
         @emitter
       end
+
+      def namespace
+        environment = ENV['RACK_ENV'] || 'development'
+
+        if ENV['STATSD_API_KEY'].present?
+          "#{ENV['STATSD_API_KEY']}.#{Napa::Identity.name}.#{environment}"
+        else
+          "#{Napa::Identity.name}.#{environment}"
+        end
+      end
+
+      def path_to_key(method, path)
+        # split the path on forward slash
+        # remove any elements that are empty
+        # replace any number strings with _
+        # join all parts with a .
+        # prepend with the method
+        # downcase the whole thing
+        "#{method}.#{path.split(/\//).reject{|p| p.empty?}.collect{|p| p.gsub(/\d+/,'_')}.join('.')}".downcase
+      end
     end
   end
 end

data/lib/napa/version.rb

@@ -1,5 +1,5 @@
 module Napa
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 
   class Version
     class << self

data/lib/tasks/db.rake

@@ -13,6 +13,13 @@ unless defined?(Rails)
       Rake::Task["db:schema:dump"].invoke unless Napa.env.production?
     end
 
+    desc 'Rollback to a previous migration. Go back multiple steps with STEP=x'
+    task :rollback => :environment do
+      ActiveRecord::Migration.verbose = true
+      step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+      ActiveRecord::Migrator.rollback('db/migrate', step)
+    end
+
     desc "Create the database"
     task :create => :environment do
       db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Napa.env]

data/lib/tasks/git.rake

@@ -7,6 +7,9 @@ namespace :git do
 
   desc "Verify git repository is in a good state for deployment"
   task :verify do
+    raise RuntimeError, "ENV['GITHUB_REPO'] is not defined" if github_repo.nil?
+    raise RuntimeError, "ENV['GITHUB_OAUTH_TOKEN'] is not defined" if ENV['GITHUB_OAUTH_TOKEN'].nil?
+
     logger.info "Verifying git repository is in a good state"
 
     # Be sure local HEAD exists on remote

data/napa.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'grape'
   gem.add_dependency 'grape-swagger'
   gem.add_dependency 'roar'
-  gem.add_dependency 'unicorn'
   gem.add_dependency 'statsd-ruby'
   gem.add_dependency 'racksh'
 

data/spec/generators/api_generator_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'napa/generators/api_generator'
+require 'napa/cli'
+
+describe Napa::Generators::ApiGenerator do
+  let(:api_name) { 'foo' }
+  let(:test_api_directory) { 'spec/tmp' }
+
+  before do
+    described_class.any_instance.stub(:output_directory) { test_api_directory }
+    Napa::CLI::Base.new.generate("api", api_name)
+  end
+
+  after do
+    FileUtils.rm_rf(test_api_directory)
+  end
+
+  describe 'app' do
+    it 'creates an api class' do
+      expected_api_file = File.join(test_api_directory, 'app/apis/foos_api.rb')
+      api_code = File.read(expected_api_file)
+
+      expect(api_code).to match(/class FoosApi/)
+    end
+
+    it 'creates a model class' do
+      expected_model_file = File.join(test_api_directory, 'app/models/foo.rb')
+      model_code = File.read(expected_model_file)
+
+      expect(model_code).to match(/class Foo/)
+    end
+
+    it 'creates a representer class' do
+      expected_representer_file = File.join(test_api_directory, 'app/representers/foo_representer.rb')
+      representer_code = File.read(expected_representer_file)
+
+      expect(representer_code).to match(/class FooRepresenter/)
+    end
+
+    it 'representers should inherit from Napa::Representer' do
+      representer_file = File.join(test_api_directory, 'app/representers/foo_representer.rb')
+      require "./#{representer_file}"
+      expect(FooRepresenter.superclass).to be(Napa::Representer)
+    end
+  end
+
+  describe 'spec' do
+    it 'creates an api spec' do
+      expected_api_file = File.join(test_api_directory, 'spec/apis/foos_api_spec.rb')
+      api_code = File.read(expected_api_file)
+
+      expect(api_code).to match(/describe FoosApi/)
+    end
+
+    it 'creates a model spec' do
+      expected_model_file = File.join(test_api_directory, 'spec/models/foo_spec.rb')
+      model_code = File.read(expected_model_file)
+
+      expect(model_code).to match(/describe Foo/)
+    end
+  end
+
+end

data/spec/generators/migration_generator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'napa/generators/migration_generator'
+require 'napa/cli'
+
+describe Napa::Generators::MigrationGenerator do
+
+  let(:migration_name) { 'foo_bars' }
+  let(:test_migrations_directory) { 'spec/tmp' }
+
+  before do
+    described_class.any_instance.stub(:output_directory) { test_migrations_directory }
+  end
+
+  after do
+    FileUtils.rm_rf(test_migrations_directory)
+  end
+
+  it 'creates a camelized migration class' do
+    described_class.any_instance.stub(:migration_filename) { 'foo' }
+    Napa::CLI::Base.new.generate("migration", migration_name)
+    expected_migration_file = File.join(test_migrations_directory, 'foo.rb')
+    migration_code = File.read(expected_migration_file)
+    expect(migration_code).to match(/class FooBars/)
+  end
+
+
+end