roda_api_generator 0.1.1

data/example/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) <#{Time.new.year}> <#{ENV['USERNAME'] || ENV['USER']}>
+
+ 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/example/README.md

@@ -0,0 +1,38 @@
+# Your project's name
+
+## Setting the project up
+
+### Clone the repository
+
+Fork the project and clone it to your machine.
+
+### Install the dependencies
+
+bundle install
+
+### Install the database
+
+`createdb db_development`
+`bundle exec rake db:migrate`
+
+## Development 
+
+### Launch the console
+
+??
+
+### Run the specs
+
+`bundle exec rspec`
+
+## Built With
+
+??
+
+## Contributing Guidelines
+
+??
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/example/Rakefile

@@ -0,0 +1,15 @@
+require 'dotenv'
+Dotenv.load
+
+$LOAD_PATH.unshift(File.expand_path('./application'))
+current_task = Rake.application.top_level_tasks.first
+
+require 'bundler'
+require 'bundler/setup'
+
+if current_task['db:']
+  require 'config/sequel'
+  require 'config/database'
+end
+
+Dir['./application/tasks/**/*.rake'].each { |rake_file| import(rake_file) }

data/example/application/api.rb

@@ -0,0 +1,17 @@
+# Load path and gems/bundler
+$LOAD_PATH << __dir__
+
+require 'bundler'
+require 'logger'
+Bundler.require
+
+require 'dotenv'
+Dotenv.load
+
+file_path = File.dirname(__FILE__)
+
+%w(config api/db api/models api/operations).each do |path|
+  Dir["#{file_path}/#{path}/**/*.rb"].each { |file| require file }
+end
+
+require './application/api/api_support'

data/example/application/api/api_support.rb

@@ -0,0 +1,14 @@
+class ApiSupport < Roda
+  use Rack::Session::Cookie, key: ENV['RACK_COOKIE_KEY'], secret: ENV['RACK_COOKIE_SECRET']
+  use Rack::Protection
+  use Rack::Protection::RemoteReferrer
+
+  plugin :environments
+  plugin :http_auth
+  plugin :json
+  plugin :json_parser
+
+  self.environment = ENV['ENVIRONMENT']
+
+  require_relative './routes/main.rb'
+end

data/example/application/api/models/user.rb

@@ -0,0 +1,6 @@
+module Api
+  module Models
+    class User < Sequel::Model(:user)
+    end
+  end
+end

data/example/application/api/operations/user_service.rb

@@ -0,0 +1,15 @@
+module Api
+  module Operations
+    class UserService
+      def initialize(params)
+        @params = params
+      end
+
+      attr_reader :params
+
+      def show_params
+        params['email']
+      end
+    end
+  end
+end

data/example/application/api/routes/main.rb

@@ -0,0 +1,20 @@
+class ApiSupport
+  route do |r|
+    r.root do
+      'Nothing Here'
+    end
+
+    r.on 'example' do
+      r.get do
+        begin
+          params = request.params
+        rescue StandardError
+          params = JSON.parse(request.body.read)
+        end
+
+        user = Api::Operations::UserService.new(params)
+        user.show_params
+      end
+    end
+  end
+end

data/example/application/config/database.rb

@@ -0,0 +1,2 @@
+# Sequel Configuration
+DB = Sequel.connect(ENV.fetch('DATABASE_ENV'))

data/example/application/config/sequel.rb

@@ -0,0 +1,11 @@
+require 'sequel'
+
+Sequel.database_timezone = :local
+
+# basic plugins
+# to access the full list: https://sequel.jeremyevans.net/plugins.html
+Sequel::Model.plugin :validation_helpers
+Sequel::Model.plugin :nested_attributes
+Sequel::Model.plugin :boolean_readers
+Sequel::Model.plugin :table_select
+Sequel::Model.plugin :string_stripper

data/example/application/db/migrations/20180930152809_add_user_table.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    create_table(:user) do
+      primary_key :id
+      String :first_name, null: false
+      String :last_name, null: false
+      String :email, null: false
+      String :username, null: false
+    end
+  end
+
+  down do
+    drop_table(:users)
+  end
+end

data/example/application/db/migrations/migration_template.rb

@@ -0,0 +1,4 @@
+Sequel.migration do
+  change do
+  end
+end

data/example/application/tasks/db.rake

@@ -0,0 +1,30 @@
+namespace :db do
+  desc 'Performs migration up to latest migration available'
+  task :migrate do
+    Sequel.extension :migration, :core_extensions
+    Sequel::Migrator.run(DB, 'application/db/migrations')
+  end
+
+  desc 'Generates a new timestamped Sequel migration'
+  task :migration, :name do |_, args|
+    if args[:name].nil?
+      puts 'Please specify a name for your migration (e.g. rake generate:migration[add_user_table])'
+      exit false
+    end
+
+    timestamp = Time.now.utc.strftime('%Y%m%d%H%M%S')
+    filename = File.join('application/db/migrations', "#{timestamp}_#{args[:name]}.rb")
+
+    require 'fileutils'
+    FileUtils.cp_r('application/db/migrations/migration_template.rb', filename)
+
+    puts "Created the migration #{filename}"
+  end
+
+  desc 'Drop all database tables and re-run migrations'
+  task :reset do
+    DB.tables.each { |table| DB.drop_table(table.to_sym) }
+
+    Rake::Task['db:migrate'].execute
+  end
+end

data/example/config.ru

@@ -0,0 +1,3 @@
+require './application/api'
+
+run Rack::Cascade.new [ApiSupport]

data/example/spec/root_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe 'Do a GET request in the root_path' do
+  it 'should render root page' do
+    get '/'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('Nothing Here')
+  end
+
+  it 'should render example page' do
+    get '/example', email: 'email'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq('email')
+  end
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,69 @@
+# Add Simplecov configuration
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/.bundle/'
+  add_filter '/application/config/'
+  add_filter '/application/db/'
+  add_filter '/spec/'
+end
+
+# Require gems and files
+require 'rspec/core'
+require 'rack/test'
+require './application/api'
+require 'faker'
+require 'factory_bot'
+require 'rspec_sequel_matchers'
+
+# Set locale en-US for faker
+Faker::Config.locale = 'en-US'
+
+# Necessary to test a cascading rack app and middleware
+module RSpecHelpers
+  include Rack::Test::Methods
+
+  def login_as(user)
+    inject_header
+
+    Api.class_variable_set(:@@current_user, user)
+  end
+
+  def app
+    Rack::Builder.parse_file('config.ru').first
+  end
+
+  def inject_header
+    header 'AUTHORIZATION', %(Token token="abc", foo="bar")
+  end
+
+  def response_body
+    JSON.parse(last_response.body, symbolize_names: true)
+  end
+end
+
+# FactoryBot is expecting ActiveRecord
+module Sequel
+  class Model
+    alias save! save
+  end
+end
+
+# Set up rspec basic configurations
+RSpec.configure do |config|
+  config.extend RSpecHelpers
+  config.include RSpecHelpers
+  config.include FactoryBot::Syntax::Methods
+  config.include RspecSequel::Matchers
+
+  config.disable_monkey_patching!
+  config.filter_run_excluding :slow
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:suite) do
+    FactoryBot.definition_file_paths = %w(./spec/factories)
+    FactoryBot.find_definitions
+  end
+end

data/exe/api_generators

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'roda_api_generator'
+
+ApiGenerators::CLI.start(ARGV)

data/lib/roda_api_generator.rb

@@ -0,0 +1,6 @@
+require 'roda_api_generator/generators/roda'
+require 'roda_api_generator/version'
+require 'roda_api_generator/cli'
+
+# RubyApiGenerators global module
+module RubyApiGenerators; end

data/lib/roda_api_generator/cli.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+# Responsibility: handle the command line interface
+module ApiGenerators
+  class CLI < Thor
+    desc 'roda', 'Generate generic Roda API via CLI'
+
+    option :name, type: :string
+    option :test_framework, type: :string, default: :rspec
+
+    def roda
+      args = [options[:name] || 'test_app']
+
+      script = RubyApiGenerators::Generators::Roda.new(args, opts_hash)
+      script.invoke_all
+    end
+
+    private
+
+    def opts_hash
+      {
+        test_framework: options[:test_framework]
+      }
+    end
+  end
+end

data/lib/roda_api_generator/generators/roda.rb

@@ -0,0 +1,101 @@
+require 'thor'
+
+module RubyApiGenerators
+  module Generators
+    class Roda < Thor::Group
+      include Thor::Actions
+
+      argument :name
+      class_option :test_framework
+
+      def self.source_root
+        File.join(File.dirname(__FILE__), '..', 'templates', 'roda')
+      end
+
+      def build_test_suite_folder
+        empty_directory "#{name}/spec"
+        copy_file 'spec/rspec.options', "#{name}/.rspec"
+        template 'spec/spec_helper.rb.erb', "#{name}/spec/spec_helper.rb"
+        copy_file 'spec/root_view_spec.rb', "#{name}/spec/root_view_spec.rb"
+      end
+
+      def copy_gemfile
+        copy_file 'Gemfile', "#{name}/Gemfile"
+      end
+
+      def copy_licence
+        copy_file 'LICENSE', "#{name}/LICENSE"
+      end
+
+      def copy_readme
+        copy_file 'README.md', "#{name}/README.md"
+      end
+
+      def copy_config_ru
+        copy_file 'config.ru', "#{name}/config.ru"
+      end
+
+      def copy_rakefile
+        copy_file 'Rakefile', "#{name}/Rakefile"
+      end
+
+      def copy_env_file
+        copy_file '.env', "#{name}/.env"
+      end
+
+      def set_up_application_folder
+        build_application_folder
+        build_models_folder
+        build_routes_folder
+        build_operations_folder
+        build_tasks_folder
+        build_config_folder
+        build_db_folder
+      end
+
+      private
+
+      def build_application_folder
+        empty_directory "#{name}/application"
+        copy_file 'application/api.rb', "#{name}/application/api.rb"
+        copy_file 'application/api/api_support.rb', "#{name}/application/api/api_support.rb"
+      end
+
+      def build_config_folder
+        empty_directory "#{name}/application/config"
+        copy_file 'application/config/database.rb', "#{name}/application/config/database.rb"
+        copy_file 'application/config/sequel.rb', "#{name}/application/config/sequel.rb"
+      end
+
+      def build_db_folder
+        empty_directory "#{name}/application/db"
+        copy_file 'application/db/migrations/20180930152809_add_user_table.rb',
+                  "#{name}/application/db/migrations/20180930152809_add_user_table.rb"
+        copy_file 'application/db/migrations/migration_template.rb',
+                  "#{name}/application/db/migrations/migration_template.rb"
+      end
+
+      def build_models_folder
+        empty_directory "#{name}/application/api/models"
+        copy_file 'application/api/models/user.rb', "#{name}/application/api/models/user.rb"
+      end
+
+      def build_operations_folder
+        empty_directory "#{name}/application/api/operations"
+        copy_file 'application/api/operations/user_service.rb',
+                  "#{name}/application/api/operations/user_service.rb"
+      end
+
+      def build_tasks_folder
+        empty_directory "#{name}/application/tasks"
+        copy_file 'application/tasks/db.rake',
+                  "#{name}/application/tasks/db.rake"
+      end
+
+      def build_routes_folder
+        empty_directory "#{name}/application/api/routes"
+        copy_file 'application/api/routes/main.rb', "#{name}/application/api/routes/main.rb"
+      end
+    end
+  end
+end