Initial sample application (app, specs, docs, etc)

Sample Grape API with Grape-Entity, Grape-OAuth2, ActiveRecord 5, Puma,
PostgreSQL, Dotenv, Rubocop and RSpec

Author: nbulaj

.env

@@ -0,0 +1,4 @@
+DATABASE_HOST=
+DATABASE_NAME=
+DATABASE_USER=
+DATABASE_PASSWORD=

.gitignore

@@ -9,9 +9,10 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/log/*.log
 
 # Used by dotenv library to load environment variables.
-# .env
+.env.*
 
 ## Specific to RubyMotion:
 .dat*
@@ -48,3 +49,5 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+/Gemfile.lock
+.idea/

.rspec

@@ -0,0 +1 @@
+--colour

.rubocop.yml

@@ -0,0 +1,14 @@
+LineLength:
+  Max: 120
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+    - 'Rakefile'
+    - db/**/*
+  DisplayCopNames: true
+Rails:
+  Enabled: false
+Documentation:
+  Enabled: false
+Style/EndOfLine:
+  Enabled: false

Gemfile

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+gem 'pg'
+
+gem 'grape', '~> 0.17.0'
+gem 'grape-entity'
+gem 'grape_oauth2', git: 'https://github.com/nbulaj/grape_oauth2.git'
+
+gem 'rake'
+gem 'rack-cors', require: 'rack/cors'
+
+gem 'dotenv'
+
+gem 'bcrypt'
+gem 'activerecord', '~> 5.0.0'
+gem 'otr-activerecord', '~> 1.1.0'
+
+gem 'puma'
+
+group :test do
+  gem 'rspec-rails', '~> 3.5'
+  gem 'database_cleaner'
+  gem 'coveralls', require: false
+  gem 'rack-test', require: 'rack/test'
+end
+
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 grape-oauth2
+Copyright (c) 2016 Grape-OAuth2 maintainers.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Procfile

@@ -0,0 +1 @@
+web: bundle exec puma -e $RACK_ENV -b unix:///tmp/web_server.sock --pidfile /tmp/web_server.pid -d -C config/puma.rb

README.md

@@ -1,2 +1,27 @@
-# grape-oauth2-sample
-Sample application using Grape and GrapeOAuth2 gem
+# Grape & Grape::OAuth2 sample application
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg)](#license)
+
+This is an example of using GrapeOAuth2 gem with the Grape API project.
+
+This app is ready to deploy to Heroku [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/grape-oauth2/grape-oauth2-sample).
+
+Project stack includes: **Grape, Grape-Entity, Grape-OAuth2, ActiveRecord 5, Puma, PostgreSQL, Dotenv, Rubocop, RSpec**.
+
+## Implemented features
+
+* API endpoints (GET, POST);
+* Resource Owner password credentials authentication;
+* Protected endpoints access with OAuth Tokens;
+* Generate new Access Token via Refresh Token.
+
+## Run
+
+To run the application do the following from your command-line:
+
+`> bundle exec rackup config.ru`
+
+## Routes
+
+To print all the API routes you can run a special Rake task:
+
+`bundle exec rake grape:routes`

Rakefile

@@ -0,0 +1,48 @@
+require 'bundler/setup'
+require_relative 'app/config/application'
+load 'tasks/otr-activerecord.rake'
+
+namespace :db do
+  task :environment do
+  end
+end
+
+namespace :grape do
+  desc 'Print Grape routes'
+  task :routes do
+    mapping = method_mapping
+
+    grape_klasses = ObjectSpace.each_object(Class).select { |klass| klass < Grape::API }
+    routes = grape_klasses.
+      flat_map(&:routes).
+      uniq { |r| r.send(mapping[:path]) + r.send(mapping[:method]).to_s }
+
+    method_width, path_width, version_width, desc_width = widths(routes, mapping)
+
+    routes.each do |api|
+      method = api.send(mapping[:method]).to_s.rjust(method_width)
+      path = api.send(mapping[:path]).to_s.ljust(path_width)
+      version = api.send(mapping[:version]).to_s.ljust(version_width)
+      desc = api.send(mapping[:description]).to_s.ljust(desc_width)
+      puts "     #{method}  |  #{path}  |  #{version}  |  #{desc}"
+    end
+  end
+
+  def widths(routes, mapping)
+    [
+      routes.map { |r| r.send(mapping[:method]).try(:length) }.compact.max || 0,
+      routes.map { |r| r.send(mapping[:path]).try(:length) }.compact.max || 0,
+      routes.map { |r| r.send(mapping[:version]).try(:length) }.compact.max || 0,
+      routes.map { |r| r.send(mapping[:description]).try(:length) }.compact.max || 0
+    ]
+  end
+
+  def method_mapping
+    {
+      method: 'request_method',
+      path: 'path',
+      version: 'version',
+      description: 'description'
+    }
+  end
+end

app.json

@@ -0,0 +1,10 @@
+{
+  "name": "GrapeOAuth2Sample",
+  "description": "GrapeOAuth2 Sample application",
+  "repository": "https://github.com/grape-oauth2/grape-oauth2-sample",
+  "keywords": ["grape_oauth2", "grape", "rest", "api", "OAuth"],
+  "scripts": {
+    "postdeploy": "bundle exec rake db:migrate"
+  },
+  "addons": ["heroku-postgresql"]
+}

app/api.rb

@@ -0,0 +1,16 @@
+module GrapeOAuth2Sample
+  class API < ::Grape::API
+    format :json
+    prefix :api
+
+    include GrapeOAuth2.api
+
+    mount ::GrapeOAuth2Sample::Endpoints::Posts
+
+    desc 'Root'
+
+    get '/' do
+      { error: ['Please check API documentation'] }
+    end
+  end
+end

app/config/application.rb

@@ -0,0 +1,37 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'dotenv'
+Dotenv.load(File.expand_path('.env.local'), File.expand_path('.env'))
+
+require 'otr-activerecord'
+require 'grape'
+require 'grape-entity'
+require 'grape_oauth2'
+
+# Initializers
+Dir[File.expand_path('../initializers/*.rb', __FILE__)].each do |initializer|
+  require_relative initializer
+end
+
+# Database
+load File.expand_path('../database.rb', __FILE__)
+
+# Models
+require_relative '../models/application_record'
+
+%w(access_token access_code application post user).each do |model|
+  require_relative "../models/#{model}"
+end
+
+# Entities
+Dir[File.expand_path('../../entities/*.rb', __FILE__)].each do |entity|
+  require_relative entity
+end
+
+# Endpoints
+Dir[File.expand_path('../../endpoints/*.rb', __FILE__)].each do |endpoint|
+  require_relative endpoint
+end
+
+require_relative '../../app/api'

app/config/database.rb

@@ -0,0 +1,9 @@
+# Dotenv required to be boot first!
+OTR::ActiveRecord.configure_from_file!(File.expand_path('../database.yml', __FILE__))
+
+env = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+
+::ActiveRecord::Base.default_timezone = :utc
+::ActiveRecord::Base.logger = Logger.new(File.expand_path("../../log/#{env}.log", __FILE__))
+
+::ActiveRecord::Migration.verbose = false

app/config/database.yml

@@ -0,0 +1,26 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  pool: 5
+
+development:
+  <<: *default
+  host: <%= ENV['DATABASE_HOST'] %>
+  database: <%= ENV['DATABASE_NAME'] %>
+  username: <%= ENV['DATABASE_USER'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+
+production:
+  <<: *default
+  host: <%= ENV['DATABASE_HOST'] %>
+  database: <%= ENV['DATABASE_NAME'] %>_production
+  username: <%= ENV['DATABASE_USER'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+
+test:
+  <<: *default
+  host: <%= ENV['DATABASE_HOST'] %>
+  database: <%= ENV['DATABASE_NAME'] %>_test
+  username: <%= ENV['DATABASE_USER'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>
+

app/config/initializers/grape_oauth2.rb

@@ -0,0 +1,10 @@
+GrapeOAuth2.configure do |config|
+  config.client_class_name = 'Application'
+  config.access_token_class_name = 'AccessToken'
+  config.access_grant_class_name = 'AccessCode'
+  config.resource_owner_class_name = 'User'
+
+  config.realm = 'Sample Grape::OAuth2'
+
+  config.allowed_grant_types << 'refresh_token'
+end