napa 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99dd7c64867542bf20e480334250d1e47c271df0
-  data.tar.gz: 870471e9345f770dea420b9f0edf609dbf16cd25
+  metadata.gz: 411eb368134bee542c4fb51fa4a180c5b1a65ccc
+  data.tar.gz: d2ca60df98d4c3f260e5c0df9864087bbda48dcd
 SHA512:
-  metadata.gz: ad6d3c13701b0536aaf9269e424b33ab91fb7e0cbd89b0d7e7e9b1cc8a080282fcd9a869e7161a6ebebe1f5839fe052c3087b34a9ca49444e42e832811380cc1
-  data.tar.gz: f46a872779294f28648f2f041850d46535146b763def899ac6dfebaaa9332984d654c67fae599b6ab978a0da6ebe279b057943cb900d7ef6815a75a21c1fa2fa
+  metadata.gz: c950462ba0a5d7c8e8c249a4d23243e1d91e742ead2aef1ca760af45b2bf8412340e1474f433a5fa1c0280c9ac18bb74cef37ed471ec4c82a54abc49b5eb31d9
+  data.tar.gz: 56aa083725ab045cfcafd55ff579e0ad617fdadbd90aa5df16eee7db7efc1929b26ff30040cfaf50b708e5603d31d9ef74707bee01ad92bcbacf8b40341fd0d1

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 master
 ===
+
+0.4.3
+===
+* [Allow Napa::Authentication to receive multiple and accept multiple passwords](https://github.com/bellycard/napa/pull/190)
+* [rename to silence_thor](https://github.com/bellycard/napa/pull/189)
+* [Hey! Spec suite! Leave them streams alone!](https://github.com/bellycard/napa/pull/175)
+* [Refactoring CLI](https://github.com/bellycard/napa/pull/186)
+
+0.4.2
+===
+* [Explicitly require `filter_parameters.rb` instead of relying on `action_dispatch` autoload](https://github.com/bellycard/napa/pull/181)
+* [Default rake task runs specs](https://github.com/bellycard/napa/pull/176)
+* [Set Napa.env to the environment arg we pass in the console](https://github.com/bellycard/napa/pull/179)
+* [Add thor command to start shotgun server](https://github.com/bellycard/napa/pull/177)
+* [Lock honeybadger and roar in the meantime](https://github.com/bellycard/napa/pull/185)
+
+0.4.1
+===
 * Added a reasons object to error responses to represent active record validation errors for individual attributes
 * Added ability to filter sensitive data from logs.
 

data/README.md

@@ -1,10 +1,10 @@
+![napa-v2-01-cropped-resized](https://cloud.githubusercontent.com/assets/36847/6060268/d8cd3e00-ad00-11e4-96b9-64affc2cc802.png)
+
 [![Build Status](https://travis-ci.org/bellycard/napa.png?branch=master)](https://travis-ci.org/bellycard/napa)
 [![Dependency Status](https://gemnasium.com/bellycard/napa.png)](https://gemnasium.com/bellycard/napa)
 [![Code Climate](https://codeclimate.com/github/bellycard/napa/badges/gpa.svg)](https://codeclimate.com/github/bellycard/napa)
 [![Test Coverage](https://codeclimate.com/github/bellycard/napa/badges/coverage.svg)](https://codeclimate.com/github/bellycard/napa)
 
-# Napa
-
 Napa is a simple framework for building Rack based APIs using Grape, Roar and ActiveRecord. It's designed to make it easy to quickly create and deploy new API services by providing **generators**, **middlewares** and a **console** similar to what you would expect from a Rails app.
 
 ## Installation
@@ -37,14 +37,13 @@ Run `napa` terminal prompt to see available features:
 
 ```
 Commands:
-  napa console [environment]                                                            # Start the Napa console
-  napa generate api <api_name>                                                          # Create a Grape API, Model and Representer
-  napa generate migration <migration_name> [field[:type][:index] field[:type][:index]]  # Create a Database Migration
-  napa generate readme                                                                  # Create a formatted README
-  napa deploy <environment>                                                             # Deploy to <environment> by setting a git tag
-  napa help [COMMAND]                                                                   # Describe available commands or one specific command
-  napa new <app_name> [app_path]                                                        # Create a scaffold for a new Napa service
-  napa version                                                                          # Shows the Napa version number
+  napa console [ENVIRONMENT]  # Start the Napa console
+  napa deploy [TARGET]        # Deploys A Service to a given target (i.e. production, staging, etc.)
+  napa generate [COMMAND]     # Generate new code
+  napa help [COMMAND]         # Describe available commands or one specific command
+  napa new <NAME> [PATH]      # Create a new Napa application
+  napa server                 # Start the Napa server
+  napa version                # Shows the Napa version number
 ```
 
 
@@ -91,9 +90,9 @@ rake routes             # display all routes for Grape
 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:
+The Authentication middleware will add a simple header based authentication layer to all requests. This is just looking for a header of `'Passwords' = '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'`
+`ALLOWED_HEADER_PASSWORDS='password1,password2'`
 
 If your application doesn't require authentication, you can simply remove the middleware.
 

data/Rakefile

@@ -1,5 +1,9 @@
 #!/usr/bin/env rake
+$LOAD_PATH.unshift 'lib', __dir__
+
 Dir.glob('./tasks/*.rake').each { |r| import r }
 require 'bundler/gem_tasks'
 require 'napa/active_record_extensions/stats.rb'
 require 'napa/active_record_extensions/seeder.rb'
+
+task default: :spec

data/docs/quickstart.md

@@ -187,10 +187,10 @@ Now that the code is in place, let's start up the app and send it some requests.
 
 Napa runs on Rack, so any rack based webserver will work. Shotgun is nice to use in development because it will reload your app on each request and you don't need to restart the server when there are changes.
 
-Start the server on port 9393 by running:
+Start the shotgun server on port 9393 by running:
 
 ```
-shotgun
+napa server
 ```
 
 ### POST /people

data/lib/napa/authentication.rb

@@ -1,8 +1,11 @@
 module Napa
   class Authentication
     def self.password_header
-      raise 'header_password_not_configured' unless ENV['HEADER_PASSWORD']
-      { 'Password' => ENV['HEADER_PASSWORD'] }
+      password_hash = {}
+      password_hash['Password'] = ENV['HEADER_PASSWORD'] if ENV['HEADER_PASSWORD']
+      password_hash['Passwords'] = ENV['SENT_HEADER_PASSWORDS'] if ENV['SENT_HEADER_PASSWORDS']
+      raise 'header_password_not_configured' if password_hash.keys.blank?
+      password_hash
     end
   end
 end

data/lib/napa/cli/base/console.rb

@@ -0,0 +1,32 @@
+module Napa
+  module CLI
+    class Base < Thor
+
+      desc 'console [ENVIRONMENT]', 'Start the Napa console'
+      options aliases: 'c'
+      def console(environment = nil)
+        Napa.env = environment || 'development'
+
+        require 'racksh/init'
+
+        begin
+          require "pry"
+          interpreter = Pry
+        rescue LoadError
+          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
+
+        $0 = "#{$0} console"
+        interpreter.start
+      end
+
+    end
+  end
+end

data/lib/napa/cli/base/deploy.rb

@@ -0,0 +1,22 @@
+require 'napa/deploy'
+
+module Napa
+  module CLI
+    class Base < Thor
+
+      desc 'deploy [TARGET]', 'Deploys A Service to a given target (i.e. production, staging, etc.)'
+      method_options :force => :boolean, :revision => :string, :confirm => :boolean
+      def deploy(environment)
+        if options[:confirm] || yes?('Are you sure you want to deploy this service?', Thor::Shell::Color::YELLOW)
+          deploy = Napa::Deploy.new(environment, force: options[:force], revision: options[:revision])
+          if deploy.deployable?
+            say(deploy.deploy!, Thor::Shell::Color::GREEN)
+          else
+            say("Deploy Failed:\n#{deploy.errors.join("\n")}", Thor::Shell::Color::RED)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/napa/cli/base/new.rb

@@ -0,0 +1,49 @@
+require 'thor'
+require 'active_support/core_ext/string'
+
+module Napa
+  module CLI
+    class Base < Thor
+
+      include Thor::Actions
+
+      source_root File.expand_path("../../templates/new", __FILE__)
+
+      option :database, default: 'mysql', aliases: '-d', desc: 'Preconfigure for selected database (options: mysql/postgres/pg)'
+
+      desc "new <NAME> [PATH]", "Create a new Napa application"
+      def new(name, path = nil)
+        say 'Generating scaffold...'
+
+        @name = name
+        @path = path
+
+        @database_gem       = postgres? ? 'pg'         : 'mysql2'
+        @database_adapter   = postgres? ? 'postgresql' : 'mysql2'
+        @database_encoding  = postgres? ? 'unicode'    : 'utf8'
+        @database_user      = postgres? ? ''           : 'root'
+
+        directory ".", (path || name)
+
+        say 'Done!', :green
+      end
+
+      no_commands do
+
+        def app_name
+          @name
+        end
+
+        def app_path
+          @path
+        end
+
+        def postgres?
+          %w[pg postgres].include?(options[:database])
+        end
+
+      end
+
+    end
+  end
+end

data/lib/napa/cli/base/server.rb

@@ -0,0 +1,29 @@
+module Napa
+  module CLI
+    class Base < Thor
+
+      desc 'server', "Start the Napa server"
+      options aliases: 's'
+      def server
+        puts "Napa server starting..."
+
+        require 'pty'
+        exit = "... Napa server exited!"
+
+        begin
+          PTY.spawn('shotgun') do |stdout, stdin, pid|
+            begin
+              Signal.trap('INT') { Process.kill('INT', pid) }
+              stdout.each { |line| puts line }
+            rescue Errno::EIO
+              puts exit
+            end
+          end
+        rescue PTY::ChildExited
+          puts exit
+        end
+      end
+
+    end
+  end
+end

data/lib/napa/cli/base/version.rb

@@ -0,0 +1,14 @@
+require "napa/version"
+
+module Napa
+  module CLI
+    class Base < Thor
+
+      desc "version", "Shows the Napa version number"
+      def version
+        say Napa::VERSION
+      end
+
+    end
+  end
+end

data/lib/napa/cli/base.rb

@@ -0,0 +1,17 @@
+require "napa/cli/base/console"
+require "napa/cli/base/deploy"
+require "napa/cli/base/new"
+require "napa/cli/base/server"
+require "napa/cli/base/version"
+require "napa/cli/generate"
+
+module Napa
+  module CLI
+    class Base < Thor
+
+      desc "generate [COMMAND]", "Generate new code"
+      subcommand "generate", Napa::CLI::Generate
+
+    end
+  end
+end

data/lib/napa/cli/generate/api.rb

@@ -0,0 +1,42 @@
+require 'thor'
+require 'active_support/all'
+
+module Napa
+  module CLI
+    class Generate < Thor
+
+      include Thor::Actions
+
+      desc "api <NAME>", "Create a Grape API, Model and Entity"
+      def api(name)
+        @name = name
+
+        self.class.source_root File.expand_path("../../templates/api", __FILE__)
+        say 'Generating api...'
+        directory '.', output_directory
+        say 'Done!', :green
+      end
+
+      no_commands do
+
+        def name
+          @name
+        end
+
+        def name_underscore
+          name.underscore
+        end
+
+        def name_tableize
+          name.tableize
+        end
+
+        def output_directory
+          '.'
+        end
+
+      end
+
+    end
+  end
+end

data/lib/napa/cli/generate/readme.rb

@@ -0,0 +1,50 @@
+require 'thor'
+require 'active_support/all'
+require 'napa/setup'
+require 'napa/identity'
+require 'dotenv'
+
+module Napa
+  module CLI
+    class Generate < Thor
+
+      include Thor::Actions
+
+      desc "readme", "Create a formatted README"
+      def readme
+        self.class.source_root File.expand_path("../../templates/readme", __FILE__)
+        say 'Generating README...'
+        directory '.', output_directory
+        say 'Done!', :green
+      end
+
+      no_commands do
+
+        def service_name
+          Napa::Identity.name
+        end
+
+        def output_directory
+          '.'
+        end
+
+        def routes
+          routes = ""
+
+          if defined? ApplicationApi
+            ApplicationApi.routes.each do |api|
+              method      = api.route_method.ljust(10)
+              path        = api.route_path.ljust(40)
+              description = api.route_description
+              routes     += "     #{method} #{path} # #{description}"
+            end
+          end
+
+          routes
+        end
+
+      end
+
+    end
+  end
+end

data/lib/napa/cli/generate.rb

@@ -0,0 +1,18 @@
+require "napa/cli/generate/api"
+require "napa/cli/generate/readme"
+require "napa/cli/migration"
+
+module Napa
+  module CLI
+    class Generate < Thor
+
+      register(
+        Migration,
+        'migration',
+        'migration <NAME> [field[:type][:index] field[:type][:index]]',
+        'Create a Database Migration'
+      )
+
+    end
+  end
+end

data/lib/napa/{generators/migration_generator.rb → cli/migration.rb}

@@ -2,8 +2,8 @@ require 'thor'
 require 'active_support/all'
 
 module Napa
-  module Generators
-    class MigrationGenerator < Thor::Group
+  module CLI
+    class Migration < Thor::Group
       include Thor::Actions
       # largely ported over, with a few differences, from
       # https://github.com/rails/rails/blob/76883f92374c6395f13c16628e1d87d40b6d2399/activerecord/lib/rails/generators/active_record/migration/migration_generator.rb
@@ -212,7 +212,7 @@ module Napa
       end
 
       def password_digest?
-        name == 'password' && type == :digest 
+        name == 'password' && type == :digest
       end
 
       def inject_options

data/lib/napa/{generators/templates/scaffold → cli/templates/new}/.env.test.tt

@@ -1,5 +1,5 @@
 # Uncomment when using Napa::Middleware::Authentication
-# HEADER_PASSWORD=''
+# ALLOWED_HEADER_PASSWORDS=''
 
 SERVICE_NAME=<%= app_name %>
 RACK_ENV=test

data/lib/napa/{generators/templates/scaffold → cli/templates/new}/.env.tt

@@ -1,5 +1,5 @@
 # Uncomment when using Napa::Middleware::Authentication
-# HEADER_PASSWORD=''
+# ALLOWED_HEADER_PASSWORDS=''
 
 SERVICE_NAME=<%= app_name %>
 

data/lib/napa/{generators/templates/scaffold → cli/templates/new}/Gemfile.tt

@@ -4,10 +4,10 @@ ruby "2.0.0"
 gem 'rack-cors'
 gem '<%= @database_gem %>'
 gem 'activerecord', '~> 4.0.0', :require => 'active_record'
-gem 'honeybadger'
+gem 'honeybadger', '~> 1.16.7'
 gem 'json'
 gem 'napa'
-gem 'roar'
+gem 'roar', '~> 0.12.0'
 gem 'grape-swagger'
 
 group :development,:test do

data/lib/napa/{generators/templates/scaffold → cli/templates/new}/config.ru.tt

@@ -14,9 +14,8 @@ require './app'
 # use Napa::Middleware::Logger
 
 use Napa::Middleware::AppMonitor
-# Uncomment to require header passwords for all requestss
+# Uncomment to require header passwords for all requests
 # use Napa::Middleware::Authentication
 use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
 run ApplicationApi
-

data/lib/napa/cli/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/napa/cli.rb

@@ -1,96 +1,10 @@
 require 'thor'
-require 'napa/generators'
-require 'napa/deploy'
-require 'napa/version'
+require "napa/cli/base"
+require 'napa/cli/generate'
 
 Napa.load_environment if defined?(Dotenv)
 
 module Napa
-  class CLI
-    class Generate < Thor
-      register(
-        Generators::ApiGenerator,
-        'api',
-        'api <api_name>',
-        'Create a Grape API, Model and Entity'
-      )
-
-      register(
-        Generators::MigrationGenerator,
-        'migration',
-        'migration <migration_name> [field[:type][:index] field[:type][:index]]',
-        'Create a Database Migration'
-      )
-
-      register(
-        Generators::ReadmeGenerator,
-        'readme',
-        'readme',
-        'Create a formatted README'
-      )
-    end
-  end
-
-  class CLI
-    class Base < Thor
-      desc "version", "Shows the Napa version number"
-      def version
-        say Napa::VERSION
-      end
-
-      desc 'console [environment]', 'Start the Napa console'
-      options aliases: 'c'
-      def console(environment = nil)
-        ENV['RACK_ENV'] = environment || 'development'
-
-        require 'racksh/init'
-
-        begin
-          require "pry"
-          interpreter = Pry
-        rescue LoadError
-          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
-
-        $0 = "#{$0} console"
-        interpreter.start
-      end
-
-      desc 'deploy [target]', 'Deploys A Service to a given target (i.e. production, staging, etc.)'
-      method_options :force => :boolean, :revision => :string, :confirm => :boolean
-      def deploy(environment)
-        if options[:confirm] || yes?('Are you sure you want to deploy this service?', Thor::Shell::Color::YELLOW)
-          deploy = Napa::Deploy.new(environment, force: options[:force], revision: options[:revision])
-          if deploy.deployable?
-            say(deploy.deploy!, Thor::Shell::Color::GREEN)
-          else
-            say("Deploy Failed:\n#{deploy.errors.join("\n")}", Thor::Shell::Color::RED)
-          end
-        end
-      end
-
-      register(
-        Generators::ScaffoldGenerator,
-        'new',
-        'new <app_name> [app_path]',
-        'Create a scaffold for a new Napa service'
-      )
-
-      desc "generate api <api_name>", "Create a Grape API, Model and Representer"
-      subcommand "generate api", Napa::CLI::Generate
-
-      desc "generate migration <migration_name> [field[:type][:index] field[:type][:index]]", "Create a Database Migration"
-      subcommand "generate", Napa::CLI::Generate
-
-      desc "generate readme", "Create a formatted README"
-      subcommand "generate readme", Napa::CLI::Generate
-    end
+  module CLI
   end
 end