roda_api_generator 0.1.1

data/lib/roda_api_generator/templates/roda/.env

@@ -0,0 +1,4 @@
+DATABASE_ENV=postgres://root@localhost/db_development
+
+RACK_COOKIE_KEY=something
+RACK_COOKIE_SECRET=oEwNzxGhy6Xpw81dPyVQc1GI1Tb49pn0vie+nwwHnyDBuu0IwKbcR9WoXBDTXNQAeso=

data/lib/roda_api_generator/templates/roda/Gemfile

@@ -0,0 +1,28 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rake', '11.2.2'
+end
+
+gem 'dotenv', '2.5.0'
+gem 'pg', '0.18.4'
+gem 'puma', '3.12.0'
+gem 'rack-protection', '1.5.5'
+gem 'roda', '~> 2.26.0'
+gem 'roda-http-auth'
+gem 'sequel', '4.35.0'
+gem 'simplecov', '0.16.1'
+
+group :development, :test do
+  gem 'awesome_print', '1.8.0'
+  gem 'pry', '0.11.3'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'factory_bot', '4.8.2'
+  gem 'faker', '1.8.7'
+  gem 'rack-test', '1.0.0'
+  gem 'rspec', '3.7.0'
+  gem 'rspec_sequel_matchers', '0.4.0'
+end

data/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/application/api/models/user.rb

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

data/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/application/config/database.rb

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

data/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/application/db/migrations/migration_template.rb

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

data/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/config.ru

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

data/lib/roda_api_generator/templates/roda/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/lib/roda_api_generator/templates/roda/spec/rspec.options

@@ -0,0 +1,2 @@
+--format documentation 
+--color

data/lib/roda_api_generator/templates/roda/spec/spec_helper.rb.erb

@@ -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/lib/roda_api_generator/version.rb

@@ -0,0 +1,3 @@
+module RubyApiGenerators
+  VERSION = '0.1.1'.freeze
+end

data/roda_api_generator.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'roda_api_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'roda_api_generator'
+  spec.version       = RubyApiGenerators::VERSION
+  spec.authors       = ['Vitor Oliveira']
+  spec.email         = ['vbrazo@gmail.com']
+  spec.summary       = 'A collection of useful Ruby API generator scripts.'
+  spec.description   = 'A collection of useful Ruby generator scripts for scaffolding APIs.'
+  spec.homepage      = 'http://github.com/napice/roda_api_generator'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.59.2'
+  spec.add_development_dependency 'simplecov', '0.16.1'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: roda_api_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vitor Oliveira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: A collection of useful Ruby generator scripts for scaffolding APIs.
+email:
+- vbrazo@gmail.com
+executables:
+- api_generators
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/.env
+- example/.rspec
+- example/Gemfile
+- example/Gemfile.lock
+- example/LICENSE
+- example/README.md
+- example/Rakefile
+- example/application/api.rb
+- example/application/api/api_support.rb
+- example/application/api/models/user.rb
+- example/application/api/operations/user_service.rb
+- example/application/api/routes/main.rb
+- example/application/config/database.rb
+- example/application/config/sequel.rb
+- example/application/db/migrations/20180930152809_add_user_table.rb
+- example/application/db/migrations/migration_template.rb
+- example/application/tasks/db.rake
+- example/config.ru
+- example/spec/root_view_spec.rb
+- example/spec/spec_helper.rb
+- exe/api_generators
+- lib/roda_api_generator.rb
+- lib/roda_api_generator/cli.rb
+- lib/roda_api_generator/generators/roda.rb
+- lib/roda_api_generator/templates/roda/.env
+- lib/roda_api_generator/templates/roda/Gemfile
+- lib/roda_api_generator/templates/roda/LICENSE
+- lib/roda_api_generator/templates/roda/README.md
+- lib/roda_api_generator/templates/roda/Rakefile
+- lib/roda_api_generator/templates/roda/application/api.rb
+- lib/roda_api_generator/templates/roda/application/api/api_support.rb
+- lib/roda_api_generator/templates/roda/application/api/models/user.rb
+- lib/roda_api_generator/templates/roda/application/api/operations/user_service.rb
+- lib/roda_api_generator/templates/roda/application/api/routes/main.rb
+- lib/roda_api_generator/templates/roda/application/config/database.rb
+- lib/roda_api_generator/templates/roda/application/config/sequel.rb
+- lib/roda_api_generator/templates/roda/application/db/migrations/20180930152809_add_user_table.rb
+- lib/roda_api_generator/templates/roda/application/db/migrations/migration_template.rb
+- lib/roda_api_generator/templates/roda/application/tasks/db.rake
+- lib/roda_api_generator/templates/roda/config.ru
+- lib/roda_api_generator/templates/roda/spec/root_view_spec.rb
+- lib/roda_api_generator/templates/roda/spec/rspec.options
+- lib/roda_api_generator/templates/roda/spec/spec_helper.rb.erb
+- lib/roda_api_generator/version.rb
+- roda_api_generator.gemspec
+homepage: http://github.com/napice/roda_api_generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A collection of useful Ruby API generator scripts.
+test_files: []