grape-starter 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c3293eb8eefc93cf9a64b2e2851da7cb5c364f0
-  data.tar.gz: 2db137846716c95614976ba46ed6d3d86b560ddc
+  metadata.gz: 6ca163007e1cc40a05ddb7d54bcedb07e092d6ae
+  data.tar.gz: 4bdd0c412bbe5f0830e7171f007e41249a518060
 SHA512:
-  metadata.gz: da6534c89f52d0304370501edad3b0a3a3dabaefea1c53daf26771c81239bb3b9862852eeb2a596b9f08bccee317d9e6587b707bf78ba161dfa67d2f7860a5d2
-  data.tar.gz: '019e919f98c4eb89b63d19ea457fe63eff12b6c9d26367f18aa5dd0985a24e7cda635613997f500e49f14928e01981d2f25109d54e195f0d7dd3267d1b0fe533'
+  metadata.gz: 0f62704c5d7e8ed9bdc1a1fc1bdff82358467013dd6ddcf8ceda4d8582adeaab37b6e70198c4cbcdd63378f9f90abce55724e5d35ee403208526407a3f7c2a86
+  data.tar.gz: 2bf01d9d49175e5175736775c626b1239913a25b6c54585740ad247c8dbf059a784d2f334e50fb0a573ce4fc11b7761fe01f7d9a1faecae15b596c74550cbe92

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.travis.yml

@@ -1,5 +1,18 @@
+language: ruby
+
 sudo: false
+before_install:
+  - gem install bundler
 
-language: ruby
-rvm:
-  - 2.3.2
+matrix:
+  include:
+    - rvm: 2.4.0-rc1
+    - rvm: 2.3.3
+    - rvm: 2.2.6
+    - rvm: ruby-head
+    - rvm: jruby-9.1.6.0
+    - rvm: jruby-head
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-9.1.6.0
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### NEXT
+
+### 0.3.0
+
+- adds redoc oapi documentation viewer
+- default rake task now only spec, rubocop would be done via hound
+- adds hound ci service
+
 ### 0.2.4
 
 - fix: add mount point to api base

data/README.md

@@ -6,9 +6,15 @@
 # Grape Starter
 
 Is a tool to help you to build up a skeleton for a [Grape](http://github.com/ruby-grape/grape) API mounted on [Rack](https://github.com/rack/rack) ready to run.
-[grape-swagger](http://github.com/ruby-grape/grape-swagger) would be used to generate a  [OAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) compatible documentation.
+[grape-swagger](http://github.com/ruby-grape/grape-swagger) would be used to generate a  [OAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) compatible documentation, which could be shown with [ReDoc](https://github.com/Rebilly/ReDoc).
 
 
+## Why the next one?
+
+- build up a playground for your ideas, prototypes, testing behaviour, whatever …  
+  (I use it to implement specific behaviour and get specs of for [grape-swagger](http://github.com/ruby-grape/grape-swagger))
+- no assumtions about a backend/ORM, ergo no restrictions, only a pure grape/rack skeleton
+
 ## Usage
 
 #### Install it
@@ -39,6 +45,8 @@ This command creates a folder named `awesome_api` containing the skeleton. With
 │   ├── api
 │   │   └── version.rb
 │   └── api.rb
+├── public             # for serving static files
+│   └── redoc.html     # provides the ReDoc generated oapi documentation
 ├── script             # setup / server / test etc.
 │   └── …
 └── spec               # RSpec

data/Rakefile

@@ -11,4 +11,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: [:spec]

data/bin/grape-starter

@@ -67,7 +67,7 @@ command :add do |c|
 
     begin
       builder_options = global_options.merge(set: set).merge(options)
-      Starter::Builder.call!(resource, builder_options)
+      Starter::Builder.add!(resource, builder_options)
       created_files = Starter::Builder.save
 
       `bundle exec rubocop -a #{created_files.join(' ')}`

data/lib/starter/builder.rb

@@ -21,7 +21,7 @@ module Starter
       #                 (default: nil, possible: post, get, put, patch, delete)
       #           :force - A Boolean, if given existent files should be overwriten (default: nil -> false)
       #           :entity - A Boolean, if given an entity file would be created (default: nil -> false)
-      def call!(resource, options = {})
+      def add!(resource, options = {})
         @resource = resource
         @set = options[:set]
         @force = options[:force]
@@ -100,7 +100,6 @@ module Starter
       def save_file(new_file)
         new_file_name = "#{new_file}_name"
         should_raise?(send(new_file_name))
-
         write_file(send(new_file_name), send(new_file.strip_heredoc))
       end
 

data/lib/starter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Starter
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

data/template/README.md

@@ -1,6 +1,6 @@
 # adept it to your needs
 
-# Grape API on Rack
+## Your awesome API
 
 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.
 
@@ -26,6 +26,7 @@ $ ./script/test
 ```
 $ ./script/server
 ```
+and go to: [http://localhost:9292](http://localhost:9292)
 
 or for production, set `RACK_ENV=production`
 ```
@@ -46,18 +47,21 @@ $ ./script/update
 $ ./script/stop
 ```
 
-
 ## Rake Tasks
 
 #### List Routes
 
 ```
-rake grape:routes
+rake routes
 ```
 
 #### OpenApi Documentation and Validation
 
--> see [`grape-swagger` Rake Tasks](https://github.com/ruby-grape/grape-swagger#rake-tasks)
+```
+rake oapi:fetch
+rake oapi:validate
+```
+comming from: [`grape-swagger` Rake Tasks](https://github.com/ruby-grape/grape-swagger#rake-tasks)
 
 
 ## Contributing

data/template/api/base.rb

@@ -11,6 +11,7 @@ module Api
                               info: {
                                 title: 'Starter API'
                               },
+                              mount_path: '/oapi',
                               models: [
                                 Entities::ApiError
                               ]

data/template/config.ru

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rack/cors'
 use Rack::Cors do
   allow do
@@ -7,6 +8,9 @@ use Rack::Cors do
   end
 end
 
+require 'rack/static'
+use Rack::Static, urls: '/', root: 'public', index: 'redoc.html'
+
 require File.expand_path('../config/application', __FILE__)
 
 run Api::Base

data/template/public/redoc.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ReDoc</title>
+    <!-- needed for adaptive design -->
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <!--
+    ReDoc doesn't change outer page styles
+    -->
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url='http://localhost:9292/api/v1/oapi.json'></redoc>
+    <script src="https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js"> </script>
+  </body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - LeFnord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -145,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".inch.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -180,6 +181,7 @@ files:
 - template/config/environment.rb
 - template/lib/api.rb
 - template/lib/api/version.rb
+- template/public/redoc.html
 - template/script/console
 - template/script/server
 - template/script/setup