grapethor 0.2.0

data/lib/grapethor/templates/new/README.md.tt

@@ -0,0 +1,138 @@
+# <%= app_name %>
+
+## Introduction
+
+<%= app_name %> information
+
+## Dependencies
+
+- Ruby <%= app_ruby %>
+
+## Installation
+
+Clone poject
+
+Run the setup script:
+
+ ```
+ $ bin/setup
+ ```
+
+Run application:
+
+ ```
+ $ bin/server
+ ```
+
+## Console
+
+To use console, run the following command:
+
+```
+$ bin/console
+```
+
+## Tests
+
+To execute tests, run the following command:
+
+```
+$ bundle exec rake test
+```
+
+## Routes
+
+To show the application routes, run the following command:
+
+```
+$ bundle exec rake routes
+```
+
+<% if app_swagger? -%>
+## Swagger Documentation
+
+To access swagger documentation, enter the root application address in the browser:
+
+```
+http://localhost:9292
+```
+<% end -%>
+
+<% if app_docker? -%>
+## Docker
+
+Install Docker and Docker-Compose
+
+Clone the project
+
+Build the local Dockerfile
+
+```
+$ docker-compose build
+```
+
+Setup the application:
+
+ ```
+$ docker-compose run app bundle exec bin/setup
+ ```
+
+Initialize database
+
+```
+$ docker-compose run app bundle exec rake [db:drop] db:create db:migrate db:seed
+```
+
+Get the application cluster running (`-d` - in the background)
+
+```
+$ docker-compose up -d
+```
+
+Enter application console (within running `app` container)
+
+```
+$ docker-compose exec app bundle exec bin/console
+```
+
+Run the test suite
+
+```
+docker-compose exec app bundle exec rake db:setup
+docker-compose exec app bundle exec rake test
+```
+
+Inspect logs:
+
+```
+$ docker-compose logs -f
+```
+
+Restart the cluster
+
+```
+$ docker-compose restart
+```
+
+Stop (but not destroy) the cluster
+
+```
+$ docker-compose stop
+```
+
+Start (a stopped) cluster
+
+```
+$ docker-compose start
+```
+
+Destroy the cluster (usefull if config or state gets messed up)
+
+```
+$ docker-compose down
+```
+<% end -%>
+
+## License
+
+The software is available as open source under the terms of the <%= app_license_link %>.

data/lib/grapethor/templates/new/Rakefile.tt

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+<% if app_orm == 'activerecord' -%>
+load 'tasks/otr-activerecord.rake'
+
+OTR::ActiveRecord.db_dir = 'db'
+OTR::ActiveRecord.migrations_paths = ['db/migrations']
+OTR::ActiveRecord.fixtures_path = 'test/fixtures'
+OTR::ActiveRecord.seed_file = 'seeds.rb'
+
+namespace :db do
+  # Some db tasks require your app code to be loaded; they'll expect to find it here
+  task :environment do
+    ENV['RACK_ENV'] ||= 'development'
+    require File.expand_path('config/environment', __dir__)
+  end
+end
+<% end -%>
+
+#Load tasks
+Dir.glob('lib/tasks/*.rake').each { |task| load task }

data/lib/grapethor/templates/new/api/base.rb.tt

@@ -0,0 +1,19 @@
+module API
+  class Base < Grape::API
+<% unless app_prefix.empty? -%>
+    prefix :<%= app_prefix %>
+<% end -%>
+
+    # mount API<VERSION>::Base
+
+<% if app_swagger? -%>
+    add_swagger_documentation \
+      info: {
+        title: '<%= app_name %>',
+        description: '<%= app_name %> - generated with Grapethor'
+      }
+<% end -%>
+
+  end
+end
+

data/lib/grapethor/templates/new/app/exceptions/not_found_error.rb

@@ -0,0 +1 @@
+class NotFoundError < StandardError; end

data/lib/grapethor/templates/new/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../config/environment', __dir__)
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/lib/grapethor/templates/new/bin/server.tt

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+while getopts p: option
+do
+case "${option}"
+in
+p) PORT=${OPTARG};;
+esac
+done
+
+echo "Starting <%= app_name %> application server..."
+bundle exec rackup -p ${PORT:-9292}

data/lib/grapethor/templates/new/bin/setup.tt

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/grapethor/templates/new/config.ru.tt

@@ -0,0 +1,19 @@
+require File.expand_path('config/environment', __dir__)
+
+<% if app_orm == 'activerecord' -%>
+use OTR::ActiveRecord::ConnectionManagement
+<% end -%>
+
+use Rack::Cors do
+  allow do
+    origins '*'
+    resource '*', headers: :any, methods: [ :get, :post, :put, :delete, :options ]
+  end
+end
+
+use Rack::Static,
+  root: File.expand_path('./swagger-ui', __dir__),
+  urls: ["/swagger"],
+  index: 'index.html'
+
+run API::Base

data/lib/grapethor/templates/new/config/application.rb.tt

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../api', __dir__)
+$LOAD_PATH.unshift File.expand_path('../app', __dir__)
+$LOAD_PATH.unshift __dir__
+
+require 'boot'
+require 'erb'
+
+Bundler.require :default, ENV['RACK_ENV']
+
+<% if app_orm == 'activerecord' -%>
+OTR::ActiveRecord.configure_from_file! "config/database.yml"
+<% end -%>
+
+require_rel '../app'
+require_rel '../lib'
+require_rel Dir.glob('../api/*/*', base: __dir__).reject { |f| f =~ /base\.rb/ }
+require_rel '../api/*/base.rb'
+require_rel '../api/base.rb'

data/lib/grapethor/templates/new/config/boot.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'bundler/setup'

data/lib/grapethor/templates/new/config/environment.rb

@@ -0,0 +1,3 @@
+ENV['RACK_ENV'] ||= 'development'
+
+require File.expand_path('application', __dir__)

data/lib/grapethor/templates/new/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/lib/grapethor/templates/new/lib/tasks/routes.rake

@@ -0,0 +1,8 @@
+ desc "API Routes"
+ task routes: :environment do
+   API::Base.routes.each do |api|
+     method = api.request_method.ljust(10)
+     path   = api.path
+     puts "     #{method} #{path}"
+   end
+ end

data/lib/grapethor/templates/postgresql/config/database.yml.tt

@@ -0,0 +1,38 @@
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  port: 5432
+
+local: &local
+  <<: *default
+<% if app_docker? -%>
+  username: postgres
+  password:
+  host: db
+<% else -%>
+  username: <%= app_name.downcase %>
+  password: <%= app_name.downcase %>
+  host: localhost
+<% end -%>
+
+remote: &remote
+  <<: *default
+  database: <%%= ENV['DB'] %%>
+  username: <%%= ENV['DB_USER'] %%>
+  password: <%%= ENV['DB_PASSWORD'] %%>
+  host: <%%= ENV['DB_HOST'] %%>
+  pool: 5
+
+development:
+  <<: *local
+  database: <%= app_name.downcase %>_development
+
+test:
+  <<: *local
+  database: <%= app_name.downcase %>_test
+
+staging:
+  <<: *remote
+
+production:
+  <<: *remote

data/lib/grapethor/templates/resource/api/%api_version%/%res_name_plural%.rb.tt

@@ -0,0 +1,95 @@
+module API<%= api_version %>
+  class <%= res_name.classify.pluralize %> < Grape::API
+    rescue_from NotFoundError, ActiveRecord::RecordNotFound do |exception|
+      error!('<%= res_name.classify %> not found', 404)
+    end
+
+    rescue_from ActiveRecord::RecordInvalid do |exception|
+      error!(exception.message, 409)
+    end
+
+
+    helpers do
+      def return_no_content_status
+        status :no_content
+        ''
+      end
+
+      def <%= res_name %>_params(params)
+        {
+<% res_attrs.each_key do |name| -%>
+          <%= name %>: params[:<%= name %>],
+<% end -%>
+        }
+      end
+    end
+
+
+    resource :<%= res_name.pluralize %> do
+      # GET '<%= api_version%>/<%= res_name.pluralize %>'
+      desc 'Returns <%= res_name.pluralize %> list'
+      get do
+        present <%= res_name.classify %>.all, with: API::Entities::<%= res_name.classify %>
+      end
+
+
+      # GET '<%= api_version%>/<%= res_name.pluralize %>/:id'
+      desc 'Returns <%= res_name %> by id'
+      params do
+        requires :id, type: Integer
+      end
+      get ':id' do
+        <%= res_name %> = <%= res_name.classify %>.find(params[:id])
+        raise NotFoundError if <%= res_name %>.nil?
+
+        present <%= res_name %>, with: API::Entities::<%= res_name.classify %>
+      end
+
+
+      # POST '<%= api_version%>/<%= res_name.pluralize %>'
+      desc 'Creates new <%= res_name %>'
+<% unless res_attrs.empty? -%>
+      params do
+  <% res_attrs.each do |name, type| -%>
+        requires :<%= name %>, type: <%= param_to_type(type) %>
+  <% end -%>
+      end
+<% end -%>
+      post do
+        <%= res_name %> = <%= res_name.classify %>.new(<%= res_name %>_params(params))
+        <%= res_name %>.save!
+
+        present <%= res_name %>, with: API::Entities::<%= res_name.classify %>
+      end
+
+
+      # PUT '<%= api_version%>/<%= res_name.pluralize %>/:id'
+      desc 'Updates <%= res_name %>'
+      params do
+        requires :id, type: Integer
+<% res_attrs.each do |name, type| -%>
+        requires :<%= name %>, type: <%= param_to_type(type) %>
+<% end -%>
+      end
+      put ':id' do
+        <%= res_name %> = <%= res_name.classify %>.find(params[:id])
+        <%= res_name %>.update_attributes!(<%= res_name %>_params(params))
+
+        return_no_content_status
+      end
+
+
+      # DELETE '<%= api_version%>/<%= res_name.pluralize %>/:id'
+      desc 'Deletes <%= res_name %>'
+      params do
+        requires :id, type: Integer
+      end
+      delete ':id' do
+        <%= res_name %> = <%= res_name.classify %>.find(params[:id])
+        <%= res_name %>.destroy!
+
+        return_no_content_status
+      end
+    end
+  end
+end

data/lib/grapethor/templates/resource/api/entities/%res_name%.rb.tt

@@ -0,0 +1,10 @@
+module API
+  module Entities
+    class <%= res_name.classify %> < Grape::Entity
+      expose :id
+<% res_attrs.each_key do |name| -%>
+      expose :<%= name %>
+<% end -%>
+    end
+  end
+end