napa 0.2.1 → 0.3.0

data/spec/generators/scaffold_generator_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'napa/generators/scaffold_generator'
+require 'napa/cli'
+
+describe Napa::Generators::ScaffoldGenerator do
+  let(:app_name) { 'my_test_app' }
+  let(:app_path) { 'spec/my_different_directory' }
+  let(:options) { {} }
+
+  before do
+    scaffold = Napa::CLI::Base.new(args, options)
+    scaffold.invoke(:new)
+  end
+
+  after do
+    if args[1] # if app_path exists, delete dir at app_path
+      FileUtils.rm_rf(args[1])
+    else # otherwise delete dir at app_name
+      FileUtils.rm_rf(args[0])
+    end
+  end
+
+  context 'given only an app name' do
+    let(:args) { [app_name] }
+
+    it 'creates a scaffold app in a directory that mirrors the app name' do
+      args = [app_name]
+      expect(Dir).to exist(app_name)
+    end
+  end
+
+  context 'given an app name and a directory' do
+    let(:args) { [app_name, app_path] }
+
+    it 'creates a scaffold app in a directory of my choosing' do
+      expect(Dir).to exist(app_path)
+    end
+
+    it 'creates a .env file with with a development database name' do
+      expect(File).to exist("#{app_path}/.env")
+      env_file = File.read("#{app_path}/.env")
+      expect(env_file).to match(/#{app_name}_development/)
+    end
+
+    it 'creates a .env.test file with a test database name' do
+      expect(File).to exist("#{app_path}/.env.test")
+      env_test_file = File.read("#{app_path}/.env.test")
+      expect(env_test_file).to match(/#{app_name}_test/)
+    end
+
+    it 'selects mysql as the default database adapter' do
+      database_config_file = File.read("#{app_path}/config/database.yml")
+      expect(database_config_file).to match(/adapter: mysql2/)
+    end
+
+    it 'adds the mysql2 gem in the Gemfile' do
+      gemfile = File.read("#{app_path}/Gemfile")
+      expect(gemfile).to match(/gem 'mysql2'/)
+    end
+
+    it 'generates an application api' do
+      expect(File).to exist("#{app_path}/app/apis/application_api.rb")
+    end
+
+    it 'the application API inherits from Grape::API' do
+      application_api_file = File.read("#{app_path}/app/apis/application_api.rb")
+      expect(application_api_file).to match(/class ApplicationApi < Grape::API/)
+    end
+
+    it 'generates an example API and spec' do
+      expect(File).to exist("#{app_path}/app/apis/hello_api.rb")
+      expect(File).to exist("#{app_path}/spec/apis/hello_api_spec.rb")
+    end
+  end
+
+  context 'with the -d=pg option' do
+    let(:args) { [app_name, app_path] }
+    let(:options) { { :database => "pg" } }
+
+    it 'selects postres/pg as the database' do
+      database_config_file = File.read("#{app_path}/config/database.yml")
+      expect(database_config_file).to match(/adapter: postgresql/)
+    end
+
+    it 'adds the pg gem in the Gemfile' do
+      gemfile = File.read("#{app_path}/Gemfile")
+      expect(gemfile).to match(/gem 'pg'/)
+    end
+  end
+end

data/spec/grape_extensions/error_formatter_spec.rb

@@ -17,5 +17,13 @@ describe Grape::ErrorFormatter::Json do
       parsed['error']['code'].should eq('foo')
       parsed['error']['message'].should eq('bar')
     end
+
+    it 'adds the backtrace with rescue_option[:backtrace] specified' do
+      error = Grape::ErrorFormatter::Json.call('',
+                                               'backtrace',
+                                               rescue_options: {backtrace: true})
+      parsed = JSON.parse(error)
+      parsed['backtrace'].should eq('backtrace')
+    end
   end
 end

data/spec/grape_extensions/include_nil_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'napa/output_formatters/include_nil'
+require 'napa/grape_extensions/grape_helpers'
+require 'pry'
+
+describe Napa::Representable::IncludeNil do
+  class FooRepresenter < Napa::Representer
+    include Napa::Representable::IncludeNil
+    property :foo
+    property :bar
+  end
+
+  class DummyClass
+    include Napa::GrapeHelpers
+  end
+
+  it 'includes nil keys in a represented hash' do
+    input = OpenStruct.new(foo: 1, bar: nil)
+    output = DummyClass.new.represent(input, with: FooRepresenter).to_h
+    expect(output[:data]).to have_key('foo')
+    expect(output[:data]).to have_key('bar')
+  end
+end

data/spec/logger/logger_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'napa/logger/logger'
+
+describe Napa::Logger do
+  context '#response' do
+    it 'returns response in the expected format' do
+      response = Napa::Logger.response('foo', 'bar', 'baz')
+
+      expect(response[:response][:status]).to eq('foo')
+      expect(response[:response][:headers]).to eq('bar')
+      expect(response[:response][:response]).to eq('baz')
+    end
+  end
+end

data/spec/logger/parseable_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'napa/logger/parseable'
+
+describe Logging::Layouts::Parseable do
+  context '#format_obj' do
+    it 'formats text as an object' do
+      p = Logging::Layouts::Parseable.new
+      expect(p.format_obj('foobar')).to eq({ text: 'foobar' })
+    end
+
+    it 'does not reformat objects' do
+      p = Logging::Layouts::Parseable.new
+      expect(p.format_obj({ foo: :bar })).to eq({ foo: :bar })
+    end
+  end
+end

data/spec/middleware/database_stats_spec.rb

@@ -0,0 +1,64 @@
+require 'active_record'
+require 'spec_helper'
+require 'napa/active_record_extensions/stats'
+
+# Delete any prevous instantiations of the emitter and set valid statsd env vars
+Napa::Stats.emitter = nil
+ENV['STATSD_HOST'] = 'localhost'
+ENV['STATSD_PORT'] = '8125'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define(version: 1) do
+  create_table :foos do |t|
+    t.string :word
+  end
+end
+
+class Foo < ActiveRecord::Base
+end
+
+describe Napa::Middleware::DatabaseStats do
+  before do
+    # Delete any prevous instantiations of the emitter and set valid statsd env vars
+    Napa::Stats.emitter = nil
+    ENV['STATSD_HOST'] = 'localhost'
+    ENV['STATSD_PORT'] = '8125'
+
+    @foo = Foo.create(word: 'bar')
+  end
+
+  after do
+    middleware = Napa::Middleware::DatabaseStats.new(@app)
+    env = Rack::MockRequest.env_for('/test/path')
+    middleware.call(env)
+  end
+
+  it 'should send a query_time for an insert' do
+    Napa::Stats.emitter.should_receive(:timing).with('sql.query_time', an_instance_of(Float))
+    Napa::Stats.emitter.should_receive(:timing).with('sql.table.foos.insert.query_time', an_instance_of(Float))
+
+    @app = lambda { |env| [200, { 'Content-Type' => 'application/json' }, Foo.create(word: 'baz')] }
+  end
+
+  it 'should send a query_time for a select' do
+    Napa::Stats.emitter.should_receive(:timing).with('sql.query_time', an_instance_of(Float))
+    Napa::Stats.emitter.should_receive(:timing).with('sql.table.foos.select.query_time', an_instance_of(Float))
+
+    @app = lambda { |env| [200, { 'Content-Type' => 'application/json' }, Foo.first] }
+  end
+
+  it 'should send a query_time for a delete' do
+    Napa::Stats.emitter.should_receive(:timing).with('sql.query_time', an_instance_of(Float))
+    Napa::Stats.emitter.should_receive(:timing).with('sql.table.foos.delete.query_time', an_instance_of(Float))
+
+    @app = lambda { |env| [200, { 'Content-Type' => 'application/json' }, @foo.delete ] }
+  end
+
+  it 'should send a query_time for an update' do
+    Napa::Stats.emitter.should_receive(:timing).with('sql.query_time', an_instance_of(Float))
+    Napa::Stats.emitter.should_receive(:timing).with('sql.table.foos.update.query_time', an_instance_of(Float))
+
+    @app = lambda { |env| [200, { 'Content-Type' => 'application/json' }, @foo.update_attributes(word: 'baz') ] }
+  end
+end

data/spec/middleware/request_stats_spec.rb

@@ -10,7 +10,8 @@ describe Napa::Middleware::RequestStats do
   end
 
   it 'should increment api_requests counter' do
-    Napa::Stats.emitter.should_receive(:increment).with(Napa::Identity.name + ".http.get." + "test.path.requests")
+    Napa::Stats.emitter.should_receive(:increment).with('request_count')
+    Napa::Stats.emitter.should_receive(:increment).with('path.get.test.path.request_count')
     app = lambda { |env| [200, { 'Content-Type' => 'application/json' }, Array.new] }
     middleware = Napa::Middleware::RequestStats.new(app)
     env = Rack::MockRequest.env_for('/test/path')
@@ -18,10 +19,8 @@ describe Napa::Middleware::RequestStats do
   end
 
   it 'should send the api_response_time' do
-    Napa::Stats.emitter.should_receive(:timing).with(
-                                                     Napa::Identity.name + ".http.get." + "test.path.response_time", 
-                                                     an_instance_of(Float)
-                                                    )
+    Napa::Stats.emitter.should_receive(:timing).with('response_time', an_instance_of(Float))
+    Napa::Stats.emitter.should_receive(:timing).with('path.get.test.path.response_time', an_instance_of(Float))
     app = lambda { |env| [200, { 'Content-Type' => 'application/json'}, Array.new] }
     middleware = Napa::Middleware::RequestStats.new(app)
     env = Rack::MockRequest.env_for('/test/path')

data/spec/spec_helper.rb

@@ -1 +1,27 @@
 require 'napa'
+
+ENV['RACK_ENV'] = 'test'
+
+# from https://gist.github.com/adamstegman/926858
+RSpec.configure do |config|
+  config.before(:all) { silence_output }
+  config.after(:all) { enable_output }
+end
+
+# Redirects stderr and stdout to /dev/null.
+def silence_output
+  @orig_stderr = $stderr
+  @orig_stdout = $stdout
+
+  # redirect stderr and stdout to /dev/null
+  $stderr = File.new('/dev/null', 'w')
+  $stdout = File.new('/dev/null', 'w')
+end
+
+# Replace stdout and stderr so anything else is output correctly.
+def enable_output
+  $stderr = @orig_stderr
+  $stdout = @orig_stdout
+  @orig_stderr = nil
+  @orig_stdout = nil
+end

data/spec/stats_spec.rb

@@ -30,7 +30,7 @@ describe Napa::Stats do
 
   it 'the namespace of the StatsD client object should equal the service name' do
     ENV['SERVICE_NAME'] = 'my-service'
-    expect(Napa::Stats.emitter.namespace).to eq('my-service')
+    expect(Napa::Stats.emitter.namespace).to eq("my-service.test")
   end
 
   it 'should use env variables to set statsd host and port' do
@@ -39,4 +39,28 @@ describe Napa::Stats do
     expect(Napa::Stats.emitter.host).to eq('localhost')
     expect(Napa::Stats.emitter.port).to eq('9000')
   end
+
+  describe '#namespace' do
+    it 'prepends the namespace with the STATSD_API_KEY if present' do
+      ENV['STATSD_API_KEY'] = 'foo'
+      expect(Napa::Stats.namespace).to eq("#{ENV['STATSD_API_KEY']}.#{Napa::Identity.name}.test")
+    end
+
+    it 'does not include the STATSD_API_KEY if empty' do
+      ENV['STATSD_API_KEY'] = nil
+      expect(Napa::Stats.namespace).to eq("#{Napa::Identity.name}.test")
+    end
+  end
+
+  describe '#path_to_key' do
+    it 'returns the key string with ids removed and parts joined with dots' do
+      method = 'GET'
+      path = '/foo/123/bar'
+      expect(Napa::Stats.path_to_key(method, path)).to eq('get.foo._.bar')
+
+      method = 'POST'
+      path = '/foo'
+      expect(Napa::Stats.path_to_key(method, path)).to eq('post.foo')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: napa
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Darby Frey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-19 00:00:00.000000000 Z
+date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -136,20 +136,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: unicorn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +268,7 @@ files:
 - docs/quickstart.md
 - lib/napa.rb
 - lib/napa/active_record_extensions/filter_by_hash.rb
+- lib/napa/active_record_extensions/notifications_subscriber.rb
 - lib/napa/active_record_extensions/stats.rb
 - lib/napa/authentication.rb
 - lib/napa/cli.rb
@@ -292,6 +279,8 @@ files:
 - lib/napa/generators/templates/api/app/apis/%name_tableize%_api.rb.tt
 - lib/napa/generators/templates/api/app/models/%name_underscore%.rb.tt
 - lib/napa/generators/templates/api/app/representers/%name_underscore%_representer.rb.tt
+- lib/napa/generators/templates/api/spec/apis/%name_tableize%_api_spec.rb.tt
+- lib/napa/generators/templates/api/spec/models/%name_underscore%_spec.rb.tt
 - lib/napa/generators/templates/migration/%migration_filename%.rb.tt
 - lib/napa/generators/templates/scaffold/.env.test.tt
 - lib/napa/generators/templates/scaffold/.env.tt
@@ -316,18 +305,22 @@ files:
 - lib/napa/generators/templates/scaffold/spec/factories/.gitkeep
 - lib/napa/generators/templates/scaffold/spec/spec_helper.rb
 - lib/napa/grape_extenders.rb
-- lib/napa/grape_extensions/entity.rb
 - lib/napa/grape_extensions/error_formatter.rb
 - lib/napa/grape_extensions/grape_helpers.rb
-- lib/napa/grape_extensions/representer.rb
 - lib/napa/identity.rb
 - lib/napa/json_error.rb
 - lib/napa/logger/log_transaction.rb
 - lib/napa/logger/logger.rb
+- lib/napa/logger/parseable.rb
 - lib/napa/middleware/app_monitor.rb
 - lib/napa/middleware/authentication.rb
+- lib/napa/middleware/database_stats.rb
 - lib/napa/middleware/logger.rb
 - lib/napa/middleware/request_stats.rb
+- lib/napa/output_formatters/entity.rb
+- lib/napa/output_formatters/include_nil.rb
+- lib/napa/output_formatters/representer.rb
+- lib/napa/rspec_extensions/response_helpers.rb
 - lib/napa/setup.rb
 - lib/napa/stats.rb
 - lib/napa/stats_d_timer.rb
@@ -338,13 +331,19 @@ files:
 - lib/tasks/routes.rake
 - napa.gemspec
 - spec/active_record_extensions/filter_by_hash_spec.rb
-- spec/active_record_extensions/stats_spec.rb
 - spec/authentication_spec.rb
+- spec/generators/api_generator_spec.rb
+- spec/generators/migration_generator_spec.rb
+- spec/generators/scaffold_generator_spec.rb
 - spec/grape_extensions/error_formatter_spec.rb
+- spec/grape_extensions/include_nil_spec.rb
 - spec/identity_spec.rb
 - spec/json_error_spec.rb
 - spec/logger/log_transaction_spec.rb
+- spec/logger/logger_spec.rb
+- spec/logger/parseable_spec.rb
 - spec/middleware/authentication_spec.rb
+- spec/middleware/database_stats_spec.rb
 - spec/middleware/request_stats_spec.rb
 - spec/spec_helper.rb
 - spec/stats_spec.rb
@@ -375,13 +374,19 @@ specification_version: 4
 summary: A simple framework for building APIs with Grape
 test_files:
 - spec/active_record_extensions/filter_by_hash_spec.rb
-- spec/active_record_extensions/stats_spec.rb
 - spec/authentication_spec.rb
+- spec/generators/api_generator_spec.rb
+- spec/generators/migration_generator_spec.rb
+- spec/generators/scaffold_generator_spec.rb
 - spec/grape_extensions/error_formatter_spec.rb
+- spec/grape_extensions/include_nil_spec.rb
 - spec/identity_spec.rb
 - spec/json_error_spec.rb
 - spec/logger/log_transaction_spec.rb
+- spec/logger/logger_spec.rb
+- spec/logger/parseable_spec.rb
 - spec/middleware/authentication_spec.rb
+- spec/middleware/database_stats_spec.rb
 - spec/middleware/request_stats_spec.rb
 - spec/spec_helper.rb
 - spec/stats_spec.rb

data/spec/active_record_extensions/stats_spec.rb

@@ -1,59 +0,0 @@
-require 'active_record'
-require 'spec_helper'
-require 'napa/active_record_extensions/stats.rb'
-
-# Delete any prevous instantiations of the emitter and set valid statsd env vars
-Napa::Stats.emitter = nil
-ENV['STATSD_HOST'] = 'localhost'
-ENV['STATSD_PORT'] = '8125'
-
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
-
-ActiveRecord::Schema.define(version: 1) do
-  create_table :foos do |t|
-    t.string :word
-  end
-end
-
-class Foo < ActiveRecord::Base
-end
-
-describe Napa::ActiveRecordStats do
-  before(:each) do
-    Foo.delete_all
-    @x = Foo.create(word: 'bar')
-  end
-
-  it 'should send a query_time for an insert' do
-    Napa::Stats.emitter.should_receive(:timing).with(
-      "#{Napa::Identity.name}.unknown.sql.foos.insert.query_time",
-      an_instance_of(Float)
-    )
-    Foo.create(word: 'baz')
-  end
-
-  it 'should send a query_time for a select' do
-    Napa::Stats.emitter.should_receive(:timing).with(
-      "#{Napa::Identity.name}.unknown.sql.foos.select.query_time",
-      an_instance_of(Float)
-    )
-    Foo.all
-  end
-
-  it 'should send a query_time for a delete' do
-    Napa::Stats.emitter.should_receive(:timing).with(
-      "#{Napa::Identity.name}.unknown.sql.foos.delete.query_time",
-      an_instance_of(Float)
-    )
-    @x.delete
-  end
-
-  it 'should send a query_time for an update' do
-    Napa::Stats.emitter.should_receive(:timing).with(
-      "#{Napa::Identity.name}.unknown.sql.foos.update.query_time",
-      an_instance_of(Float)
-    )
-    @x.word = 'baz'
-    @x.save
-  end
-end