grape-starter 0.2.0

data/template/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gem 'thin'
+
+gem 'rack'
+gem 'rack-cors'
+
+# TODO: revert to gem after mörge and release
+gem 'grape', git: 'git@github.com:LeFnord/grape.git', branch: 'delete_204'
+# gem 'grape', '~> 0.18'
+gem 'grape-entity', '~> 0.6'
+gem 'grape-swagger', '~> 0.25'
+gem 'grape-swagger-entity', '~> 0.1.5'
+
+group :development, :test do
+  gem 'grape-starter'
+  gem 'pry'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop'
+end

data/template/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Scholz
+
+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/template/README.md

@@ -0,0 +1,70 @@
+# adept it to your needs
+
+# Grape API on Rack
+
+A [Grape](http://github.com/ruby-grape/grape) API mounted on [Rack](https://github.com/rack/rack), starting point for API development with Grape. It also includes [grape-swagger](http://github.com/ruby-grape/grape-swagger) for documentation generating.
+
+
+## Usage
+
+#### Setup
+
+```
+$ git clone git@github.com:LeFnord/grape-starter.git
+$ cd grape-starter
+$ ./script/setup
+```
+
+#### Test
+
+```
+$ ./script/test
+```
+
+#### Run
+
+```
+$ ./script/server
+```
+
+or for production, set `RACK_ENV=production`
+```
+$ export RACK_ENV=production ./script/server
+```
+
+#### Update
+
+… dependencies
+```
+$ ./script/update
+```
+
+#### Stop
+
+… would only be used, if server started in production mode
+```
+$ ./script/stop
+```
+
+
+## Rake Tasks
+
+#### List Routes
+
+```
+rake grape:routes
+```
+
+#### OpenApi Documentation and Validation
+
+-> see [`grape-swagger` Rake Tasks](https://github.com/ruby-grape/grape-swagger#rake-tasks)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/name/repo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/template/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :environment do
+  ENV['RACK_ENV'] ||= 'development'
+  require File.expand_path('../config/environment', __FILE__)
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]
+
+require File.expand_path('../config/environment', __FILE__)
+
+require 'grape-swagger/rake/oapi_tasks'
+GrapeSwagger::Rake::OapiTasks.new(::Api::Base)
+
+require 'starter/rake/grape_tasks'
+Starter::Rake::GrapeTasks.new(::Api::Base)

data/template/api/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Api
+  class Base < Grape::API
+    prefix :api
+    version 'v1', using: :path
+    format :json
+
+    mount Endpoints::Root
+
+    add_swagger_documentation format: :json,
+                              info: {
+                                title: 'Starter API'
+                              },
+                              models: [
+                                Entities::ApiError
+                              ]
+  end
+end

data/template/api/endpoints/root.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'starter/rake/grape_tasks'
+
+module Api
+  module Endpoints
+    class Root < Grape::API
+      namespace :root do
+        desc 'Exposes all routes',
+             success: Entities::Route,
+             is_array: true
+        get do
+          api_routes = Starter::Rake::GrapeTasks.new(::Api::Base).api_routes
+
+          present :count, api_routes.length
+          present :items, api_routes, with: Entities::Route
+        end
+      end
+    end
+  end
+end

data/template/api/entities/api_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Api
+  module Entities
+    class ApiError < Grape::Entity
+      expose :code,
+             documentation: {
+               type: Integer,
+               desc: 'the http status code'
+             }
+      expose :message,
+             documentation: {
+               type: String,
+               desc: 'the error message'
+             }
+    end
+  end
+end

data/template/api/entities/route.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Api
+  module Entities
+    class Route < Grape::Entity
+      expose :verb,
+             documentation: {
+               type: String,
+               desc: 'the http method of the route'
+             }
+      expose :path,
+             documentation: {
+               type: String,
+               desc: 'the route itself'
+             }
+      expose :description,
+             documentation: {
+               type: String,
+               desc: 'the route description'
+             }
+    end
+  end
+end

data/template/config.ru

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'rack/cors'
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '*', headers: :any, methods: [:get, :post, :put, :delete, :options]
+  end
+end
+
+require File.expand_path('../config/application', __FILE__)
+
+run Api::Base

data/template/config/application.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'api'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'boot'
+
+Bundler.require :default, ENV['RACK_ENV']
+
+Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each do |lib|
+  require lib
+end
+
+Dir[File.expand_path('../../api/entities/*.rb', __FILE__)].each do |entity|
+  require entity
+end
+
+Dir[File.expand_path('../../api/endpoints/*.rb', __FILE__)].each do |endpoint|
+  require endpoint
+end
+
+require 'base'

data/template/config/boot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'rubygems'
+require 'bundler/setup'

data/template/config/environment.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+ENV['RACK_ENV'] ||= 'test'
+
+require File.expand_path('../application', __FILE__)

data/template/lib/api.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require 'api/version'
+
+module Api
+  APP_CLASS = name
+end

data/template/lib/api/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Api
+  VERSION = '0.1.0'
+end

data/template/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+require 'api'
+
+require 'pry'
+Pry.start

data/template/script/server

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+test -z "$RACK_ENV" &&
+  RACK_ENV='development'
+
+if [ "$RACK_ENV" = 'production' ]; then
+  bundle exec thin start -p 9292 -e $RACK_ENV --tag api-starter -d --threaded
+else
+  bundle exec thin start -p 9292 -e $RACK_ENV --tag api-starter -V -D
+fi

data/template/script/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/template/script/stop

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+# use only, if server was started in production mode
+thin stop

data/template/script/test

@@ -0,0 +1,17 @@
+#!/usr/bin/env sh
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+[ -z "$DEBUG" ] || set -x
+
+echo "===> Running rubocop..."
+bundle exec rake rubocop
+
+echo "===> Running specs..."
+if [ $1 ]; then
+  bundle exec rspec $1
+else
+  bundle exec rspec
+fi

data/template/script/update

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle update

data/template/spec/lib/api/version_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Api do
+  it 'has a version number' do
+    expect(Api::VERSION).not_to be nil
+  end
+end

data/template/spec/requests/documentation_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Api::Base do
+  subject(:swagger) do
+    get '/api/v1/swagger_doc'
+    last_response
+  end
+
+  specify { expect(swagger.status).to eql 200 }
+  specify { expect(swagger.body).not_to be_empty }
+end

data/template/spec/requests/root_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe Api::Base do
+  let(:exposed_keys) do
+    [
+      :verb,
+      :path,
+      :description
+    ]
+  end
+
+  subject { get '/api/v1/root' }
+  specify { expect(subject.status).to eql 200 }
+
+  let(:response) { JSON.parse(subject.body, symbolize_names: true) }
+  specify { expect(response.keys).to include :count, :items }
+
+  let(:items) { response[:items] }
+  specify 'has items with values' do
+    items.each do |item|
+      expect(item.keys).to include(*exposed_keys)
+    end
+  end
+end

data/template/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+ENV['RACK_ENV'] ||= 'test'
+
+require 'rack/test'
+require File.expand_path('../../config/environment', __FILE__)
+
+grape_starter_gem = Gem::Specification.find_by_name('grape-starter').gem_dir
+
+Dir[grape_starter_gem + '/lib/starter/rspec/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :documentation
+
+  config.mock_with :rspec
+  config.expect_with :rspec
+
+  config.raise_errors_for_deprecations!
+end
+
+include Rack::Test::Methods
+
+def app
+  Api::Base
+end