grape-starter 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ca5b09c3e3577d7a93143d6fff88b91aecfd926
-  data.tar.gz: 8cd9948d9aa98b6c12cd118cca08d3d1858ad62f
+  metadata.gz: '0823711b471e505ebfbd048f139fa0276f4ebf41'
+  data.tar.gz: e784796595cc5ac6d3c43ad1a6c0317b35c0467a
 SHA512:
-  metadata.gz: 22665163096ced52badfbdd0b99e2373108f18c0a6ae68002bad33d525b75b408d807fd9cca10c91dd49631fbef466d85c69bd9a72f39fddabd32b022ad00490
-  data.tar.gz: 83e99286b0d75e30ea70b80f7430918179178982c5dd4ea1958ce9632cd20c13ee6262f908ab742cea05b9d3778344c6723e84d69560164bf9761f2f8ce7c9d8
+  metadata.gz: 67113631c915da4adead1ee145c1640ebaa1e8131dbeef240c5ed354f3be8919223f743a241ba73cb5085fbe35e40499765008b0280c5f0f5d809f3f36bc12ef
+  data.tar.gz: 4b6ba9fcd7b2b0de31a6022a72d57cf5eea654ebb2fd9b11a852a4fd3fb9b0902e6328da229cfd4b11478debf1400df8ffc7926fc55f450a62a6f1ce23d5070e

data/.inch.yml

@@ -2,4 +2,5 @@ files:
   excluded:
     - lib/starter/builder/template_endpoints.rb
     - lib/starter/builder/template_files.rb
+    - lib/starter/builder/names.rb
     - lib/starter/rake/grape_tasks.rb

data/.rubocop_todo.yml

@@ -9,4 +9,4 @@
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 13
+  Max: 20

data/.travis.yml

@@ -6,7 +6,7 @@ before_install:
 
 matrix:
   include:
-    - rvm: 2.4.0-rc1
+    - rvm: 2.4.0
     - rvm: 2.3.3
     - rvm: 2.2.6
     - rvm: ruby-head

data/Rakefile

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

data/bin/grape-starter

@@ -19,11 +19,9 @@ arguments :strict
 desc 'overwrites existend stuff'
 switch [:f, :force], negatable: false
 
-desc 'Create initial grape api skeleton'
-arg_name 'project name'
-
+desc 'Creates initial api skeleton'
+arg_name 'awesome_api'
 command :new do |c|
-
   c.action do |global_options, _, args|
     dest = args.empty? ? nil : File.join(Dir.getwd, args.first)
 
@@ -49,12 +47,9 @@ command :new do |c|
   end
 end
 
-desc 'Adds a new resource - run from inside the project'
-long_desc "
-params: \n
-resource - to add, it respects the numerus of it (required)\n
-http_verbs - specify which end-points should be created, if nothings given CRUD would be writen
-"
+desc 'Adds given new resource'
+long_desc "Adds given resource, hereby the numerus of the provided
+resource would be respected to create singular or plural endpoints"
 arg_name 'resource [post* get* put* patch* delete*]'
 command :add do |c|
   c.desc 'adds entity file'
@@ -79,7 +74,7 @@ command :add do |c|
   end
 end
 
-desc 'Removes a resource - run from inside the project'
+desc 'Removes given resource'
 arg_name 'resource'
 command :rm do |c|
   c.desc 'removes also entity file'

data/grape-starter.gemspec

@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'gli', '~> 2.14'
-  spec.add_dependency 'activesupport', '~> 5.0'
-  spec.add_dependency 'rubocop', '~> 0.40'
+  spec.required_ruby_version = '>= 2.2.6'
+
+  spec.add_dependency 'gli', '>= 2.14'
+  spec.add_dependency 'activesupport', '>= 5.0.0'
+  spec.add_dependency 'rubocop', '>= 0.40.0'
 
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'grape', '~> 0.18'

data/lib/starter/builder.rb

@@ -14,11 +14,7 @@ module Starter
     class << self
       attr_reader :resource, :set, :force, :entity, :destination
 
-      # would be called on new command
-      # it should do following
-      # 1. copying the template to the new destination
-      # 2. replace names in …
-      #   - script/server
+      # would be called from new command
       #
       # name - A String as project name
       # source - A String which provides the template path
@@ -29,10 +25,10 @@ module Starter
 
         FileUtils.copy_entry source, destination
 
-        replace_static(File.join('script','server'))
+        replace_static(File.join('script', 'server'))
       end
 
-      # would be called on add command
+      # would be called from add command
       #
       # resource - A String as name
       # options - A Hash to provide some optional arguments (default: {})
@@ -49,7 +45,8 @@ module Starter
         self
       end
 
-      # it saves the files
+      #
+      # … it saves the files
       def save
         created_files = file_list.each_with_object([]) do |new_file, memo|
           memo << send("#{new_file}_name")
@@ -61,7 +58,7 @@ module Starter
         created_files
       end
 
-      # would be called on rm command
+      # would be called on from command
       #
       # resource - A String, which indicates the resource to remove
       # options - A Hash to provide some optional arguments (default: {})
@@ -86,14 +83,21 @@ module Starter
         content(endpoint_set).join("\n\n")
       end
 
-      # privdes the specs for the endpoints of the resource
+      # provides the specs for the endpoints of the resource
       def endpoint_specs
         content(endpoint_set.map { |x| "#{x}_spec" }).join("\n")
       end
 
       private
 
-      # provides an array of endpoints to for the new resource
+      # get content for and save new resource files
+      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
+
+      # provides an array of endpoints for the new resource
       def endpoint_set
         crud_set = singular? ? singular_one : crud
         return crud_set if set.blank?
@@ -108,39 +112,29 @@ module Starter
         entity ? standards + ['entity_file'] : standards
       end
 
-      # raises if resource exist and force == false
+      # raises if resource exist and force false
       def should_raise?(file)
         raise StandardError, '… resource exists' if File.exist?(file) && !force
       end
 
-      # add project name to static files
+      # replace something in exitend files
+      #
+      # will be called on project creation
+      #
+      # … static files such as under script folder,
       def replace_static(file)
         server_file = File.join(destination, file)
 
         file_foo(server_file) { |content| content.gsub!('{{{grape-starter}}}', "API-#{resource}") }
       end
 
+      # will be called an resource creation
+      #
+      # … add it in api base
       def add_mount_point
         file_foo(api_base_file_name) { |content| add_to_base(content) }
       end
 
-      def remove_mount_point
-        file_foo(api_base_file_name) { |content| remove_from_base(content) }
-      end
-
-      def file_foo(file)
-        content = read_file(file)
-        yield content
-        write_file(file, content)
-      end
-
-      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
-
-      # manipulating API Base file
       # … adding
       def add_to_base(file)
         occurence = file.scan(/(\s+mount\s.*?\n)/).last.first
@@ -148,18 +142,30 @@ module Starter
         file.sub!(occurence, replacement)
       end
 
+      # … remove it in api base
+      def remove_mount_point
+        file_foo(api_base_file_name) { |content| remove_from_base(content) }
+      end
+
       # … removing
       def remove_from_base(file)
         file.sub!(mount_point, '')
       end
 
       # content of the given set of files,
-      # returns an array of string
       def content(set)
         set.map { |x| send(x) }
       end
 
-      # general file
+      # general file stuff
+      #
+      # … reading and writing content
+      def file_foo(file)
+        content = read_file(file)
+        yield content
+        write_file(file, content)
+      end
+
       # … read
       def read_file(file)
         File.read(file)

data/lib/starter/version.rb

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

data/template/.rubocop_todo.yml

@@ -15,7 +15,7 @@ Metrics/LineLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 10
+  Max: 20
 
 Style/AsciiComments:
   Enabled: false

data/template/Gemfile

@@ -9,9 +9,9 @@ gem 'rack-cors'
 # TODO: revert to gem after mörge and release
 gem 'grape', git: 'git@github.com:ruby-grape/grape.git'
 # gem 'grape', '~> 0.18'
-gem 'grape-entity', '~> 0.6'
-gem 'grape-swagger', '~> 0.25'
-gem 'grape-swagger-entity', '~> 0.1.5'
+gem 'grape-entity', '>= 0.6.0'
+gem 'grape-swagger', '>= 0.25.0'
+gem 'grape-swagger-entity', '>= 0.1.5'
 
 group :development, :test do
   gem 'grape-starter'

data/template/config.ru

@@ -1,6 +1,8 @@
-# frozen_string_literal: true
-
+# frozen_string_literal: false
 require 'rack/cors'
+
+use Rack::CommonLogger
+
 use Rack::Cors do
   allow do
     origins '*'
@@ -8,9 +10,10 @@ 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
+app = App.new
+app.map '/', DocApp.new
+app.map '/api', Api::Base
+
+run app

data/template/config/application.rb

@@ -20,3 +20,59 @@ Dir[File.expand_path('../../api/endpoints/*.rb', __FILE__)].each do |endpoint|
 end
 
 require 'base'
+
+require 'rack'
+
+# provides the documentation of the API
+class DocApp
+  def call(env)
+    [200, { 'Content-Type' => 'text/html' }, [re_doc(env)]]
+  end
+
+  def re_doc(env)
+    doc = template.sub('{{{server}}}', env['SERVER_NAME'])
+    doc = doc.sub('{{{port}}}', env['SERVER_PORT'])
+
+    doc
+  end
+
+  def template
+    "<!DOCTYPE html>
+    <html>
+      <head>
+        <title>ReDoc API documentation</title>
+        <meta name='viewport' content='width=device-width, initial-scale=1'>
+        <style>
+          body {
+            margin: 0;
+            padding: 0;
+          }
+        </style>
+      </head>
+      <body>
+        <redoc spec-url='http://{{{server}}}:{{{port}}}/api/v1/oapi.json'></redoc>
+        <script src='https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js'> </script>
+      </body>
+    </html>"
+  end
+end
+
+# provides the routing between the API and the html documentation of it
+class App
+  def initialize
+    @apps = {}
+  end
+
+  def map(route, app)
+    @apps[route] = app
+  end
+
+  def call(env)
+    request = Rack::Request.new(env)
+    if env['REQUEST_PATH'].start_with?('/api')
+      @apps['/api'].call(env)
+    elsif @apps[request.path]
+      @apps[request.path].call(env)
+    end
+  end
+end

data/template/script/server

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bash -l
 
 set -e
 
@@ -8,13 +8,15 @@ test -z "$RACK_ENV" &&
   RACK_ENV='development'
 
 if [ $1 ]; then
-  port=$1
+  PORT=$1
 else
-  port=9292
+  PORT=9292
 fi
 
+export PORT=$PORT
+
 if [ "$RACK_ENV" = 'production' ]; then
-  bundle exec thin start -p $port -e $RACK_ENV --tag {{{grape-starter}}} -d --threaded
+  bundle exec thin start -p $PORT -e $RACK_ENV --tag {{{grape-starter}}} -d --threaded
 else
-  bundle exec thin start -p $port -e $RACK_ENV --tag {{{grape-starter}}} -V -D
+  bundle exec thin start -p $PORT -e $RACK_ENV --tag {{{grape-starter}}} -D
 fi

data/template/spec/requests/documentation_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 
 RSpec.describe Api::Base do
   subject(:swagger) do
-    get '/api/v1/swagger_doc'
+    get '/api/v1/oapi'
     last_response
   end
 

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - LeFnord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: 0.40.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.40'
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="