napa 0.1.7 → 0.1.10

data/README.md

@@ -131,7 +131,7 @@ rake deploy:staging
 rake deploy:production
 ```
 
-**Please Note:** These tasks rely on two environment variables - `GITHUB_OAUTH_TOKEN` and `GITHUB_REPO`. For more information, see **Environment Variables** below. 
+**Please Note:** These tasks rely on two environment variables - `GITHUB_OAUTH_TOKEN` and `GITHUB_REPO`. For more information, see **Environment Variables** below.
 
 ### Grape Specific Features
 At Belly we use the [Grape Micro-Framework](https://github.com/intridea/grape) for many services, so we've included a few common features.
@@ -158,6 +158,30 @@ Used to grant access to your application on Github for deployment tagging
 #### GITHUB_REPO
 Your application's Github repo. i.e. `bellycard/napa`
 
+## Middlewares
+Napa 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,
+    "napa_revision": "running-version-of-napa"
+}
+```
+
 ## Contributing
 
 1. Fork it

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

@@ -6,12 +6,13 @@ require './app'
 #     resource '*', headers: :any, methods: :any
 #   end
 # end
-# 
+#
 # use Honeybadger::Rack
 # use Napa::Middleware::Logger
 
 use Napa::Middleware::AppMonitor
+use Napa::Middleware::Authentication
 use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
 run HelloService::API # <-- boot your service here --
-  
+

data/lib/napa/authentication.rb

@@ -0,0 +1,8 @@
+module Napa
+  class Authentication
+    def self.password_header
+      raise 'header_password_not_configured' unless ENV['HEADER_PASSWORD']
+      { 'Password' => ENV['HEADER_PASSWORD'] }
+    end
+  end
+end

data/lib/napa/identity.rb

@@ -7,7 +7,7 @@ module Napa
         revision: revision,
         pid: pid,
         parent_pid: parent_pid,
-        platform_revision: platform_revision
+        napa_revision: napa_revision
       }
     end
 
@@ -31,7 +31,7 @@ module Napa
       @ppid ||= Process.ppid
     end
 
-    def self.platform_revision
+    def self.napa_revision
       Napa::VERSION
     end
   end

data/lib/napa/middleware/authentication.rb

@@ -0,0 +1,32 @@
+module Napa
+  class Middleware
+    class Authentication
+      def initialize(app)
+        @app = app
+
+        if ENV['HEADER_PASSWORDS']
+          @allowed_passwords = ENV['HEADER_PASSWORDS'].split(',').map { |pw| pw.strip }.freeze
+        end
+      end
+
+      def call(env)
+        if authenticated_request?(env)
+          @app.call(env)
+        else
+          if @allowed_passwords
+            error_response = Napa::JsonError.new('bad_password', 'bad password').to_json
+          else
+            error_response = Napa::JsonError.new('not_configured', 'password not configured').to_json
+          end
+
+          [401, { 'Content-type' => 'application/json' }, Array.wrap(error_response)]
+        end
+
+      end
+
+      def authenticated_request?(env)
+        @allowed_passwords.include? env['HTTP_PASSWORD'] unless @allowed_passwords.nil?
+      end
+    end
+  end
+end

data/lib/napa/version.rb

@@ -1,5 +1,5 @@
 module Napa
-  VERSION = '0.1.7'
+  VERSION = '0.1.10'
 
   class Version
     class << self

data/lib/napa.rb

@@ -16,7 +16,9 @@ require 'napa/grape_extensions/error_formatter'
 require 'napa/grape_extensions/error_presenter'
 require 'napa/middleware/logger'
 require 'napa/middleware/app_monitor'
+require 'napa/middleware/authentication'
 require 'napa/activerecord'
+require 'napa/authentication'
 require 'napa/grape_api'
 require 'generators/scaffold'
 

data/spec/authentication_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'napa/authentication'
+
+describe Napa::Authentication do
+  context '#password_header' do
+    it "returns a password hash for the request header" do
+      ENV['HEADER_PASSWORD'] = 'foo'
+      Napa::Authentication.password_header.class.should eq(Hash)
+      Napa::Authentication.password_header.should eq('Password' => 'foo')
+    end
+
+    it 'raises when the HEADER_PASSWORD env var is not defined' do
+      ENV['HEADER_PASSWORD'] = nil
+      expect{Napa::Authentication.password_header}.to raise_error
+    end
+  end
+end

data/spec/identity_spec.rb

@@ -42,9 +42,9 @@ describe Napa::Identity do
     end
   end
 
-  context '#platform_revision' do
+  context '#napa_revision' do
     it 'returns the current version of the platform gem' do
-      Napa::Identity.platform_revision.should == Napa::VERSION
+      Napa::Identity.napa_revision.should == Napa::VERSION
     end
   end
 end

data/spec/middleware/authentication_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'napa/middleware/authentication'
+require 'pry'
+
+describe Napa::Identity do
+  before do
+    ENV['HEADER_PASSWORDS'] = 'foo'
+  end
+
+  context 'Authenticated Request' do
+    it 'allows the request to continue if given a correct password header' do
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, Array.new] }
+      middleware = Napa::Middleware::Authentication.new(app)
+      env = Rack::MockRequest.env_for('/test', {'HTTP_PASSWORD' => 'foo'})
+      status, headers, body = middleware.call(env)
+
+      status.should be(200)
+    end
+  end
+
+  context 'Failed Authentication Request' do
+    it 'returns an error message if the Password header is not supplied' do
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, Array.new] }
+      middleware = Napa::Middleware::Authentication.new(app)
+      env = Rack::MockRequest.env_for('/test')
+      status, headers, body = middleware.call(env)
+
+      status.should be(401)
+      body.should eq([Napa::JsonError.new('bad_password', 'bad password').to_json])
+    end
+
+    it 'returns an error message if an incorrect Password header is supplied' do
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, Array.new] }
+      middleware = Napa::Middleware::Authentication.new(app)
+      env = Rack::MockRequest.env_for('/test', {'HTTP_PASSWORD' => 'incorrect'})
+      status, headers, body = middleware.call(env)
+
+      status.should be(401)
+      body.should eq([Napa::JsonError.new('bad_password', 'bad password').to_json])
+    end
+
+    it 'returns an error message if HEADER_PASSWORDS is not configured' do
+      ENV['HEADER_PASSWORDS'] = nil
+
+      app = lambda { |env| [200, {'Content-Type' => 'application/json'}, Array.new] }
+      middleware = Napa::Middleware::Authentication.new(app)
+      env = Rack::MockRequest.env_for('/test', {'HTTP_PASSWORD' => 'incorrect'})
+      status, headers, body = middleware.call(env)
+
+      status.should be(401)
+      body.should eq([Napa::JsonError.new('not_configured', 'password not configured').to_json])
+    end
+  end
+end

data/tasks/version.rake

@@ -29,14 +29,14 @@ namespace :version do
         git.add('lib/napa/version.rb')
         git.commit("Version bump: #{release_tag}")
         git.add_tag(release_tag)
-        git.push(git.remote('origin'), git.branch, release_tag) if git.remote('origin')
+        git.push(git.remote('upstream'), git.branch, release_tag) if git.remote('upstream')
         puts "Version bumped: #{release_tag}"
       end
     end
 
     def write_update
       filedata = File.read('lib/napa/version.rb')
-      changed_filedata = filedata.gsub("VERSION = \"#{Napa::VERSION}\"\n", "VERSION = \"#{@new_version}\"\n")
+      changed_filedata = filedata.gsub("VERSION = '#{Napa::VERSION}'\n", "VERSION = '#{@new_version}'\n")
       File.open('lib/napa/version.rb',"w"){|file| file.puts changed_filedata}
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: napa
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -233,12 +233,12 @@ files:
 - lib/generators/templates/scaffold/config/initializers/active_record.rb
 - lib/generators/templates/scaffold/config/middleware/honeybadger.rb
 - lib/generators/templates/scaffold/console
-- lib/generators/templates/scaffold/lib/password_protected_helpers.rb
 - lib/generators/templates/scaffold/spec/apis/hello_api_spec.rb
 - lib/generators/templates/scaffold/spec/factories/.gitkeep
 - lib/generators/templates/scaffold/spec/spec_helper.rb
 - lib/napa.rb
 - lib/napa/activerecord.rb
+- lib/napa/authentication.rb
 - lib/napa/grape_api.rb
 - lib/napa/grape_extensions/error_formatter.rb
 - lib/napa/grape_extensions/error_presenter.rb
@@ -247,6 +247,7 @@ files:
 - lib/napa/logger/log_transaction.rb
 - lib/napa/logger/logger.rb
 - lib/napa/middleware/app_monitor.rb
+- lib/napa/middleware/authentication.rb
 - lib/napa/middleware/logger.rb
 - lib/napa/version.rb
 - lib/tasks/db.rake
@@ -254,10 +255,12 @@ files:
 - lib/tasks/git.rake
 - lib/tasks/routes.rake
 - napa.gemspec
+- spec/authentication_spec.rb
 - spec/grape_extensions/error_formatter_spec.rb
 - spec/identity_spec.rb
 - spec/json_error_spec.rb
 - spec/logger/log_transaction_spec.rb
+- spec/middleware/authentication_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
 - tasks/version.rake
@@ -275,7 +278,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1127754833673535971
+      hash: -1469408987136937011
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -284,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1127754833673535971
+      hash: -1469408987136937011
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -292,9 +295,11 @@ signing_key:
 specification_version: 3
 summary: A simple framework for building APIs with Grape
 test_files:
+- spec/authentication_spec.rb
 - spec/grape_extensions/error_formatter_spec.rb
 - spec/identity_spec.rb
 - spec/json_error_spec.rb
 - spec/logger/log_transaction_spec.rb
+- spec/middleware/authentication_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb

data/lib/generators/templates/scaffold/lib/password_protected_helpers.rb

@@ -1,17 +0,0 @@
-module PasswordProtectedHelpers
-  if ENV['HEADER_PASSWORDS']
-    PW_ARRAY = ENV['HEADER_PASSWORDS'].split(',').map { |pw| pw.strip }.freeze
-  else
-    PW_ARRAY = [nil].freeze
-  end
-
-  def authenticate(headers)
-    error!(error: {
-      code: 'bad_password',
-      message: 'bad password' }
-    ) unless PW_ARRAY.include? headers['Password']
-  end
-
-  # extend all endpoints to include this
-  Grape::Endpoint.send :include, self
-end