Style improvements (#6)

* easy updates from swagger_ui_to_rails_assets

* required updates

Author: sethherr

.env.sample

@@ -0,0 +1,4 @@
+BIKEINDEX_APP_ID: SWEET_APP_ID
+BIKEINDEX_APP_SECRET: SOME_SECRET_THING
+DEVISE_SECRET_KEY: 89xcv98xcv98xcvxcXXXXXX
+SECRET_KEY_BASE: 9412651f423fd80bfaad4872a03ec735183cf4a2fd72779b47a45368e69ae5d34d3156c00673da471e440109ef4096bb13e987420537d0e0be45b8cd6317d083

.gitignore

@@ -13,8 +13,7 @@
 /tmp
 
 # Ignore environmental variables
-.env*
-
+.env
 
 # Ignore rvm stuff and things
 dump.rdb

.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+addons:
+  postgresql: '9.4'
+rvm:
+  - 2.2.5
+before_install:
+   - gem install bundler -v 1.9.10
+script:
+  - bundle exec rspec
+before_script:
+  - psql -c 'create database grape_doorkeeper_test' -U postgres
+  - bundle exec rake db:schema:load
+cache: bundler
+notifications:
+  email:
+    on_success: never

Gemfile

@@ -1,8 +1,8 @@
-ruby '2.2.2'
+ruby '2.2.5'
 source 'https://rubygems.org'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.2.5'
+gem 'rails', '4.2.7'
 # Use postgresql as the database for Active Record
 gem 'pg'
 gem 'sass'
@@ -40,6 +40,7 @@ gem 'wine_bouncer'
 gem 'kramdown'
 gem 'kaminari'
 gem 'grape'
+gem 'grape_logging'
 gem 'active_model_serializers'
 gem 'grape-active_model_serializers'
 gem 'grape-swagger'

Gemfile.lock

@@ -7,38 +7,38 @@ GIT
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.5)
-      actionpack (= 4.2.5)
-      actionview (= 4.2.5)
-      activejob (= 4.2.5)
+    actionmailer (4.2.7)
+      actionpack (= 4.2.7)
+      actionview (= 4.2.7)
+      activejob (= 4.2.7)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.5)
-      actionview (= 4.2.5)
-      activesupport (= 4.2.5)
+    actionpack (4.2.7)
+      actionview (= 4.2.7)
+      activesupport (= 4.2.7)
       rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.5)
-      activesupport (= 4.2.5)
+    actionview (4.2.7)
+      activesupport (= 4.2.7)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
     active_model_serializers (0.9.3)
       activemodel (>= 3.2)
-    activejob (4.2.5)
-      activesupport (= 4.2.5)
+    activejob (4.2.7)
+      activesupport (= 4.2.7)
       globalid (>= 0.3.0)
-    activemodel (4.2.5)
-      activesupport (= 4.2.5)
+    activemodel (4.2.7)
+      activesupport (= 4.2.7)
       builder (~> 3.1)
-    activerecord (4.2.5)
-      activemodel (= 4.2.5)
-      activesupport (= 4.2.5)
+    activerecord (4.2.7)
+      activemodel (= 4.2.7)
+      activesupport (= 4.2.7)
       arel (~> 6.0)
-    activesupport (4.2.5)
+    activesupport (4.2.7)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -71,7 +71,7 @@ GEM
       coffee-script-source
       execjs
     coffee-script-source (1.9.1.1)
-    concurrent-ruby (1.0.1)
+    concurrent-ruby (1.0.2)
     database_cleaner (1.5.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
@@ -94,7 +94,7 @@ GEM
       http_parser.rb (~> 0.6.0)
     equalizer (0.0.11)
     erubis (2.7.0)
-    eventmachine (1.0.8)
+    eventmachine (1.2.0.1)
     execjs (2.6.0)
     factory_girl (4.5.0)
       activesupport (>= 3.0.0)
@@ -107,7 +107,7 @@ GEM
     foreman (0.78.0)
       thor (~> 0.19.1)
     formatador (0.2.5)
-    globalid (0.3.6)
+    globalid (0.3.7)
       activesupport (>= 4.1.0)
     grape (0.13.0)
       activesupport
@@ -128,6 +128,8 @@ GEM
     grape-swagger (0.10.4)
       grape (>= 0.8.0)
       grape-entity (< 0.5.0)
+    grape_logging (1.3.0)
+      grape
     growl (1.0.3)
     guard (2.13.0)
       formatador (>= 0.2.4)
@@ -174,18 +176,20 @@ GEM
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     lumberjack (1.0.9)
-    mail (2.6.3)
-      mime-types (>= 1.16, < 3)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
     method_source (0.8.2)
-    mime-types (2.99.1)
-    mini_portile2 (2.0.0)
-    minitest (5.8.4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
     nenv (0.2.0)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
     notiffany (0.0.8)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -222,16 +226,16 @@ GEM
       rack (>= 1.0.0)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.5)
-      actionmailer (= 4.2.5)
-      actionpack (= 4.2.5)
-      actionview (= 4.2.5)
-      activejob (= 4.2.5)
-      activemodel (= 4.2.5)
-      activerecord (= 4.2.5)
-      activesupport (= 4.2.5)
+    rails (4.2.7)
+      actionmailer (= 4.2.7)
+      actionpack (= 4.2.7)
+      actionview (= 4.2.7)
+      activejob (= 4.2.7)
+      activemodel (= 4.2.7)
+      activerecord (= 4.2.7)
+      activesupport (= 4.2.7)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.5)
+      railties (= 4.2.7)
       sprockets-rails
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
@@ -241,13 +245,13 @@ GEM
       rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.5)
-      actionpack (= 4.2.5)
-      activesupport (= 4.2.5)
+    railties (4.2.7)
+      actionpack (= 4.2.7)
+      activesupport (= 4.2.7)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rainbow (2.1.0)
-    rake (10.5.0)
+    rake (11.3.0)
     rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
@@ -295,10 +299,10 @@ GEM
       activesupport (>= 4.0.0)
     slop (3.6.0)
     spring (1.4.0)
-    sprockets (3.5.2)
+    sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.0.3)
+    sprockets-rails (3.2.0)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
@@ -345,6 +349,7 @@ DEPENDENCIES
   grape
   grape-active_model_serializers
   grape-swagger
+  grape_logging
   growl
   guard
   guard-livereload
@@ -361,7 +366,7 @@ DEPENDENCIES
   pry
   puma
   rack-cors
-  rails (= 4.2.5)
+  rails (= 4.2.7)
   rerun
   rspec (~> 3.3.0)
   rspec-rails
@@ -375,5 +380,8 @@ DEPENDENCIES
   vcr
   wine_bouncer
 
+RUBY VERSION
+   ruby 2.2.5p319
+
 BUNDLED WITH
-   1.11.2
+   1.13.3

Procfile_development

@@ -1,2 +1,2 @@
-custom_web: bundle exec puma -b 'tcp://0.0.0.0:3001' -C config/puma.rb
+custom_web: bundle exec puma -b 'tcp://0.0.0.0:3003' -C config/puma.rb
 log: tail -f log/development.log

README.markdown

@@ -11,15 +11,15 @@ This app is ready to deploy to Heroku [![Deploy](https://www.herokucdn.com/deplo
 
 ## Set up
 
-First `bundle install` and `rake db:setup`
+- Set up the rails app and database with `bundle install` and `rake db:setup`
 
-Run `rake start` to get the server running locally. It runs at [http://localhost:3001](http://localhost:3001)
+- Run `./start` to get the server running locally. It runs at [http://localhost:3003](http://localhost:3003)
 
-You will want to change [config/initializers/secret_token.rb](config/initializers/secret_token.rb) and export `DEVISE_SECRET_KEY` (see config/initializers/devise.rb).
+- Copy [.env.sample](/.env.sample) to `.env` and replace the values with your own values.
 
-You will also probably want to delete the [imaginary item](app/models/imaginary_item.rb) class and [serializer](app/serializers/item_serializer.rb), which are included for demonstration in [the me/items endpoint](app/controllers/api/v1/me.rb#L24-L33).
+- Delete the [imaginary item](app/models/imaginary_item.rb) class and [serializer](app/serializers/item_serializer.rb), which are included for demonstration in [the me/items endpoint](app/controllers/api/v1/me.rb#L24-L33).
 
-This app includes [omniauth-bike-index](https://github.com/bikeindex/omniauth-bike-index). For Bike Index login to work, export environment variables `BIKEINDEX_APP_ID` and `BIKEINDEX_APP_SECRET`. You'll need a Bike Index app, which you can create at [BikeIndex.org/oauth/applications/new](https://BikeIndex.org/oauth/applications/new).
+This app includes [omniauth-bike-index](https://github.com/bikeindex/omniauth-bike-index). For Bike Index login to work, create a Bike Index app at [BikeIndex.org/oauth/applications/new](https://BikeIndex.org/oauth/applications/new) and add the values from `BIKEINDEX_APP_ID` and `BIKEINDEX_APP_SECRET` to the `.env` file.
 
 *Bike Index uses a similar grape, Swagger, doorkeeper setup—this is an example of [creating an OmniAuth strategy for doorkeeper](https://github.com/doorkeeper-gem/doorkeeper/wiki/Create-a-OmniAuth-strategy-for-your-provider)*.
 
@@ -48,13 +48,13 @@ Important things in the Gemfile:
 
 Also important, but maybe not as necessary to know about:
 
-- [rails_swagger-ui](https://github.com/d4be4st/swagger-ui_rails) (how we get swagger-ui)
+- [rails-assets](https://rails-assets.org) manages the js for swagger-ui
 - [Puma](http://puma.io/) (the web server)
 - [api-pagination](https://github.com/davidcelis/api-pagination)
 - [grape-active_model_serializers](https://github.com/jrhe/grape-active_model_serializers) 
 - [CORS](https://github.com/cyu/rack-cors)
 - [foreman](https://github.com/ddollar/foreman) (in development to manage processes)
-- [Haml](http://haml.info/)
+- [Haml](http://haml.info/) - and [Hamlit](https://github.com/k0kubun/hamlit), which is faster haml
 - [dotenv-rails](https://github.com/bkeepers/dotenv) (load environmental variables - .env is in .gitignore, so it isn't committed)
 - [Bootstrap](http://getbootstrap.com/)
 - Postgres
@@ -66,6 +66,7 @@ If you want to change the name of the app, swap out:
 - `GrapeDoorkeeper` in [config/application.rb](config/application.rb)
 - `grape-doorkeeper` in [config/database.yml](config/database.yml) (multiple instances)
 - `grape-doorkeeper` in [config/initializers/session_store.rb](config/initializers/session_store.rb)
+- Do a project wide search of `/grape.doorkeeper/i` to catch any lingering ones like [api_v1.html.haml](app/views/documentation/api_v1.html.haml)
 
 
 ## Testing

app/controllers/api/base.rb

@@ -1,14 +1,34 @@
+require 'grape_logging'
+
 module API
-  class Dispatch < Grape::API
-    mount API::V1::Root
-    format :json
-    route :any, '*path' do
-      Rack::Response.new({message: 'Not found'}.to_json, 404).finish
+  class Base < Grape::API
+    use GrapeLogging::Middleware::RequestLogger, instrumentation_key: 'grape_key',
+                                                 include: [GrapeLogging::Loggers::FilterParameters.new]
+    mount API::V1::RootV1
+
+    def self.respond_to_error(e)
+      logger.error e unless Rails.env.test? # Breaks tests...
+      eclass = e.class.to_s
+      message = "OAuth error: #{e}" if eclass =~ /WineBouncer::Errors/
+      opts = { error: message || e.message }
+      opts[:trace] = e.backtrace[0, 10] unless Rails.env.production?
+      Rack::Response.new(opts.to_json, status_code_for(e, eclass), {
+                           'Content-Type' => 'application/json',
+                           'Access-Control-Allow-Origin' => '*',
+                           'Access-Control-Request-Method' => '*'
+                         }).finish
     end
-  end
 
-  Base = Rack::Builder.new do
-    use API::Logger
-    run API::Dispatch
+    def self.status_code_for(error, eclass)
+      if eclass =~ /OAuthUnauthorizedError/
+        401
+      elsif eclass =~ /OAuthForbiddenError/
+        403
+      elsif (eclass =~ /RecordNotFound/) || (error.message =~ /unable to find/i)
+        404
+      else
+        (error.respond_to? :status) && error.status || 500
+      end
+    end
   end
-end
+end