napa 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+.rspec
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in napa.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Darby Frey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,172 @@
+# Napa
+
+The Napa gem is a simple framework for building APIs with Grape. These features include:
+
+* Generator
+* Console
+* Identity
+* Logging
+* Deployment
+* Grape Specific Features (Cache management and Route inspection) i.e. `rake routes`
+
+## Installation
+
+Napa is available as a gem, to install it run:
+
+```
+gem install napa
+```
+
+Or, if you're using Bundler, add it to your Gemfile:
+
+```
+gem 'napa'
+```
+
+And run:
+
+```
+$ bundle install
+```
+
+## Getting Started
+
+Napa comes with a useful generator to quickly scaffold up a new project. Simply run:
+
+```
+$ napa new your_project_name
+```
+
+This will generate a basic application framework for you. It includes everything you need to get started including a Hello World API.
+
+1) To get started, run Bundler to make sure you have all the gems for the project:
+
+```
+$ bundle install
+```
+
+2) Then, make sure your database connections are setup correctly. The configuration is set in the `.env` and `.env.test`. Then create your database by running:
+
+```
+$ rake db:create
+```
+
+3) Now you're ready to start up the server:
+
+```
+$ shotgun
+```
+
+4) Once the server is started, run the following command to load your service in a browser:
+
+```
+$ open http://127.0.0.1:9393/hello
+```
+
+...and you should see:
+
+```
+{
+  message: "Hello Wonderful World!"
+}
+```
+
+5) We've also provided a sample spec file. You can run the tests by running:
+
+```
+RACK_ENV='test' rake db:test:prepare
+rspec spec
+```
+
+## Usage/Features
+
+### Console
+Similar to the Rails console, load an IRB sesson with your applications environment by running:
+
+```
+ruby console
+```
+
+### Identity
+The *Identity* module exists to provide and interface to get information about the application. For example:
+
+`Napa::Identity.name` => Returns the name of the app defined by `ENV['SERVICE_NAME']`.
+
+`Napa::Identity.hostname` => Returns the name of the host running the application.
+
+`Napa::Identity.revision` => Returns the current revision from Git.
+
+`Napa::Identity.pid` => Returns the current running process id.
+
+### 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:
+
+```ruby
+use Napa::Middleware::Logger
+```
+
+You can also enable the logger for ActiveRecord by adding the following line to an initializer:
+
+```ruby
+ActiveRecord::Base.logger = Napa::Logger.logger
+```
+
+`Napa::Logger.logger` returns a Singleton instance of the Logging object, so it can be passed to other libraries or called directly. For example:
+
+```ruby
+Napa::Logger.logger.debug 'Some Debug Message'
+```
+
+### Deployment
+At Belly we leverage a git based deployment process, so we've included some rake tasks we use to automate deployments. These tasks will essentially just tag a commit with `production` or `staging` so that it can be picked up by a separate deployment process.
+
+The tasks currently available are:
+
+```ruby
+rake deploy:staging
+```
+
+
+```ruby
+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. 
+
+### 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.
+
+#### Cache Managment
+Cache control headers are sent with Grape API responses to prevent clients from caching responses unexpectedly. This feature is enabled by default, so you don't have to make any changes to enable it.
+
+#### Route Inspection
+A rake task is included to give you a Rails style list of your routes. Simpley run:
+
+```ruby
+rake routes
+```
+
+### Environment Variables
+Napa expects to find some environment variables set in your application in order for some features to work. A list is below:
+
+#### SERVICE_NAME
+The name of your app or service, used by Identity and as a label for your logs
+
+#### GITHUB\_OAUTH\_TOKEN
+Used to grant access to your application on Github for deployment tagging
+
+#### GITHUB_REPO
+Your application's Github repo. i.e. `bellycard/napa`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Todo/Feature Requests
+
+* Add specs for logger and logging middleware

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+Dir.glob('./tasks/*.rake').each { |r| import r }
+require "bundler/gem_tasks"

data/bin/napa

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'napa'
+
+actions = ['new']
+
+if actions.include?(ARGV[0])
+  if ARGV[0] == 'new'
+    if ARGV[1].nil?
+      STDOUT.write "Missing App Name, Exiting\n"
+    else
+      Napa::Generators::Scaffold.new(ARGV[1], ARGV[2])
+    end
+  end
+else
+  STDOUT.write "Unknown Action, Exiting.\n"
+end

data/lib/generators/scaffold.rb

@@ -0,0 +1,67 @@
+module Napa
+  module Generators
+    class Scaffold
+      def initialize(app_name, app_path=nil)
+        @app_name = app_name
+        @app_path = app_path.nil? ? app_name : app_path
+        @template_path = File.expand_path(File.join(File.dirname(__FILE__), 'templates/scaffold'))
+        @files = file_list
+
+        create_files!
+
+        STDOUT.write "Generator Finished!"
+      end
+
+      def file_list
+        files = [
+          "app/apis/hello_api.rb",
+          "app/models/.keep",
+          "config/database.yml",
+          "config/initializers/active_record.rb",
+          "config/middleware/honeybadger.rb",
+          "db/migrate/.keep",
+          "lib/tasks/.keep",
+          "log/.keep",
+          "public/.keep",
+          "spec/spec_helper.rb",
+          "spec/apis/hello_api_spec.rb",
+          "tmp/.keep",
+          ".env",
+          ".env.test",
+          ".gitignore",
+          "app.rb",
+          "config.ru",
+          "console",
+          "Gemfile",
+          "Rakefile",
+          "README.md"
+        ]
+      end
+
+      def create_files!
+        @files.each do |file|
+          create_file_with_template(file)
+        end
+      end
+
+      def create_file_with_template(file)
+        template_file = [@template_path, file].join("/")
+        new_file      = [@app_name, file.gsub(/.tpl$/,'')].join("/")
+
+        FileUtils.mkdir_p(File.dirname(new_file))
+
+        if File.exists?(template_file)
+          file_content = File.read(template_file)
+
+          # replace template variables
+          file_content.gsub!(/{{app_name}}/, @app_name)
+          File.open(new_file, 'w') { |file| file.write(file_content) }
+        else
+          FileUtils.touch(new_file)
+        end
+
+        STDOUT.write "Creating File: #{new_file}\n"
+      end
+    end
+  end
+end

data/lib/generators/templates/scaffold/.env

@@ -0,0 +1,6 @@
+SERVICE_NAME={{app_name}}
+
+DATABASE_USER=root
+DATABASE_PASSWORD=''
+DATABASE_HOST=localhost
+DATABASE_NAME={{app_name}}_development

data/lib/generators/templates/scaffold/.env.test

@@ -0,0 +1,7 @@
+SERVICE_NAME={{app_name}}
+RACK_ENV=test
+
+DATABASE_USER=root
+DATABASE_PASSWORD=''
+DATABASE_HOST=localhost
+DATABASE_NAME={{app_name}}_test

data/lib/generators/templates/scaffold/.gitignore.tpl

@@ -0,0 +1,10 @@
+.ruby-gemset
+.ruby-version
+.DS_Store
+.env
+.vagrant
+.rspec
+.env.*
+log/*
+tmp/*
+!.keep

data/lib/generators/templates/scaffold/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+gem 'rack-cors'
+gem 'mysql2'
+gem 'activerecord', '3.2.13', :require => 'active_record'
+gem 'honeybadger'
+gem 'json'
+gem 'shotgun'
+gem 'napa', :git => 'https://github.com/bellycard/napa.git'
+gem 'grape-pagination'
+gem 'will_paginate', '~> 3.0'
+
+group :development,:test do
+  gem 'pry'
+end
+
+group :development do
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'factory_girl'
+  gem 'rspec'
+  gem 'rack-test'
+  gem 'simplecov'
+  gem 'webmock'
+  gem 'database_cleaner'
+end

data/lib/generators/templates/scaffold/README.md

@@ -0,0 +1,3 @@
+# Welcome to Napa
+
+TODO: Add an awesome README that explains how all this stuff works!

data/lib/generators/templates/scaffold/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'dotenv'
+Dotenv.load(ENV['RACK_ENV'] == 'test' ? ".env.test" : ".env")
+
+require './app'
+require 'json'
+
+Dir.glob('./lib/tasks/*.rake').each { |r| import r }

data/lib/generators/templates/scaffold/app/apis/hello_api.rb

@@ -0,0 +1,13 @@
+module HelloService
+  class API < Grape::API
+    format :json
+
+    resource :hello do 
+      desc "Return a Hello World message"
+      get do
+        {message: "Hello Wonderful World!"}
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,21 @@
+# load bundler
+Bundler.setup(:default)
+require 'napa'
+Bundler.require(:default, Napa.env.to_sym)
+require 'will_paginate'
+require 'will_paginate/active_record' 
+
+# load environment
+Dotenv.load(Napa.env.test? ? ".env.test" : ".env")
+
+# autoload lib
+Dir['./lib/**/**/*.rb'].map {|file| require file }
+
+# autoload initalizers
+Dir['./config/initializers/**/*.rb'].map {|file| require file }
+
+# load middleware configs
+Dir['./config/middleware/**/*.rb'].map {|file| require file }
+
+# autoload app
+Dir['./app/**/**/*.rb'].map {|file| require file }

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

@@ -0,0 +1,18 @@
+defaults: &defaults
+  adapter: mysql2
+  host: <%= ENV['DATABASE_HOST'] %>
+  username: <%= ENV['DATABASE_USER'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+  database: <%= ENV['DATABASE_NAME'] %>
+
+production:
+  <<: *defaults
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults

data/lib/generators/templates/scaffold/config/initializers/active_record.rb

@@ -0,0 +1,5 @@
+require 'erb'
+db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Napa.env]
+ActiveRecord::Base.establish_connection(db)
+ActiveRecord::Base.logger = Napa::Logger.logger if Napa.env.development?
+ActiveRecord::Base.include_root_in_json = false

data/lib/generators/templates/scaffold/config/middleware/honeybadger.rb

@@ -0,0 +1,7 @@
+require 'honeybadger/rake_handler'
+
+Honeybadger.configure do |config|
+  config.rescue_rake_exceptions = true
+  config.environment_name = Napa.env
+  config.api_key = ENV['HONEYBADGER_API_KEY']
+end

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

@@ -0,0 +1,17 @@
+require './app'
+
+# use Rack::Cors do
+#   allow do
+#     origins '*'
+#     resource '*', headers: :any, methods: :any
+#   end
+# end
+# 
+# use Honeybadger::Rack
+# use Napa::Middleware::Logger
+
+use Napa::Middleware::AppMonitor
+use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+run HelloService::API # <-- boot your service here --
+  

data/lib/generators/templates/scaffold/console

@@ -0,0 +1,5 @@
+require 'bundler'
+require './app'
+require 'irb'
+require 'irb/completion'
+IRB.start

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

@@ -0,0 +1,17 @@
+module PasswordProtectedHelpers
+  if ENV['HEADER_PASSWORDS']
+    PW_ARRAY = ENV['HEADER_PASSWORDS'].split(',').collect{|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

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+def app
+  HelloService::API
+end
+
+describe HelloService::API do
+  include Rack::Test::Methods
+
+  describe 'GET /hello' do
+    it 'returns a hello world message' do
+      get '/hello'
+      expect(last_response.body).to eq({message: "Hello Wonderful World!"}.to_json)
+    end
+  end
+
+end

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

@@ -0,0 +1,35 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'webmock/rspec'
+require "rack/test"
+require 'simplecov'
+require 'factory_girl'
+
+FactoryGirl.definition_file_paths = %w{./spec/factories}
+FactoryGirl.find_definitions
+SimpleCov.start
+
+require './app'
+require 'database_cleaner'
+
+# 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.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/lib/napa/activerecord.rb

@@ -0,0 +1,21 @@
+module Napa
+  class ActiveRecord
+    class << self
+      def migration_template(migration_class)
+        <<-MIGRATION
+          class #{migration_class} < ActiveRecord::Migration
+            def up
+              # create_table :foo do |t|
+              #   t.string :name, :null => false
+              # end
+            end
+
+            def down
+              # drop_table :foo
+            end
+          end
+        MIGRATION
+      end
+    end
+  end
+end

data/lib/napa/grape_api.rb

@@ -0,0 +1,15 @@
+require 'grape'
+require 'grape-swagger'
+
+class Napa::GrapeAPI < Grape::API
+ 
+  def after
+    @app_response[1]["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
+    @app_response[1]["Pragma"] = "no-cache"
+    @app_response[1]["Expires"] = "Fri, 01 Jan 1990 00:00:00 GMT"
+    @app_response
+  end
+
+  add_swagger_documentation
+ 
+end

data/lib/napa/identity.rb

@@ -0,0 +1,38 @@
+module Napa
+  class Identity
+    def self.health
+      {
+        name: name,
+        hostname: hostname,
+        revision: revision,
+        pid: pid,
+        parent_pid: parent_pid,
+        platform_revision: platform_revision
+      }
+    end
+
+    def self.name
+      ENV['SERVICE_NAME'] || 'api-service'
+    end
+
+    def self.hostname
+      @hostname ||= `hostname`.strip
+    end
+
+    def self.revision
+      @revision ||= `git rev-parse HEAD`.strip
+    end
+
+    def self.pid
+      @pid ||= Process.pid
+    end
+
+    def self.parent_pid
+      @ppid ||= Process.ppid
+    end
+
+    def self.platform_revision
+      Napa::VERSION
+    end
+  end
+end

data/lib/napa/logger/log_transaction.rb

@@ -0,0 +1,17 @@
+module Napa
+  class LogTransaction
+    class << self
+      def id
+        Thread.current[:napa_tid].nil? ? Thread.current[:napa_tid] = SecureRandom.hex(10) : Thread.current[:napa_tid]
+      end
+
+      def id=(id)
+        Thread.current[:napa_tid] = id
+      end
+
+      def clear
+        Thread.current[:napa_tid] = nil
+      end
+    end
+  end
+end