grape-gen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7f28bfcaadc1cb321a828f7c4894eff2962b043
+  data.tar.gz: b33f27008effe93350e091eb781156bbecb5f426
+SHA512:
+  metadata.gz: f8140102fd00109d2e5f58084e38ed08c70cea5d5df9b7b0d61e80e7bca6b652132f49b978247766681d8ca90988d28a53c73999e09a107cb655dd420baad188
+  data.tar.gz: 5f49879d8caae93ffbcfa9c25ed5d0eb2b4b43b72b5969bf036e38ba66de434bd84183951ec0a24431a40ddf5736073c838690f97eb6f8067d99379d6f18afb2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.ruby-

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-scaffold.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 AMar4enko
+
+MIT License
+
+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/README.md

@@ -0,0 +1,31 @@
+# Grape::Scaffold
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-scaffold'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape-scaffold
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/grape-scaffold/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/grape-gen

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'grape/generate'
+
+Grape::Generate::CLI.start(ARGV)

data/grape-scaffold.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/generate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-gen'
+  spec.version       = Grape::Generate::VERSION
+  spec.authors       = ['AMar4enko']
+  spec.email         = ['amar4enko@gmail.com']
+  spec.summary       = %q{Grape-powered rack application generator with batteries included}
+  spec.homepage      = 'https://github.com/AlexYankee/grape-gen'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/grape/generate/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Generate
+    VERSION = '0.0.1'
+  end
+end

data/lib/grape/generate.rb

@@ -0,0 +1,91 @@
+require 'grape/generate/version'
+require 'bundler/vendor/thor'
+
+module Grape
+  module Generate
+    BATTERIES = %w{sidekiq carrierwave mandrill es faye}
+    class CLI < Thor
+      include Thor::Actions
+
+      source_root File.expand_path('../../template', File.dirname(__FILE__))
+
+      desc 'app APP_NAME', 'Guides you through Grape app scaffolding process'
+      option :path
+      option :orm, default: 'mongoid'
+      option :batteries,
+             type: :array,
+             default: Generate::BATTERIES,
+             desc: 'Batteries to include'
+
+      option :'use-grape-rackbuilder', type: :boolean, default: true
+
+      attr_accessor *Generate::BATTERIES
+
+      def app(app_name)
+        Generate::BATTERIES.each do |v|
+          send("#{v}=", options[:batteries].include?(v))
+        end
+
+        @app_name = app_name
+
+        @orm = options[:orm]
+        @dev_reload = options[:'use-grape-rackbuilder']
+
+        begin
+          FileUtils.rm_r(options[:path] || app_name.downcase)
+        rescue
+        end
+
+        self.destination_root = options[:path] || app_name.downcase
+        @redis = true
+        @faye_secret = Digest::MD5.hexdigest('%s-%s'%[app_name,Time.now.to_s])
+
+        directory './', exclude_pattern: /(sidekiq|carrierwave|faye|mandrill|tire|elastic_search|search_indexes|mailers|uploaders|jobs)/
+
+        directory './log'
+        directory './tmp/pids'
+
+        @redis ||= @sidekiq || @faye
+
+        if @faye
+          template './faye.ru'
+          copy_file './config/boot_faye.rb'
+          copy_file './config/initializers/faye.rb'
+          copy_file './config/initializers/em-patches/faye.rb'
+          copy_file './public/faye.html'
+          copy_file './lib/faye_auth_extension.rb'
+          copy_file './lib/faye_publisher.rb'
+        end
+
+        if @sidekiq
+          if @faye
+            copy_file './jobs/pong_time.rb'
+          end
+          copy_file './config/initializers/sidekiq.rb'
+          copy_file './config/initializers/em-patches/sidekiq.rb'
+          template './config/sidekiq.yml'
+          template './config/boot_sidekiq.rb'
+        end
+
+        if @mandrill
+          copy_file './config/initializers/mandrill.rb'
+          copy_file './config/initializers/em-patches/mandrill.rb'
+          directory './mailers'
+        end
+
+        if @es
+          template './config/initializers/tire.rb'
+          copy_file './config/initializers/em-patches/tire.rb'
+          copy_file './lib/mongoid/tire_plugin.rb'
+          directory './search_indexes'
+        end
+
+        if @carrierwave
+          copy_file './config/initializers/em-patches/carrierwave.rb'
+          copy_file './config/initializers/carrierwave.rb'
+          directory './uploaders'
+        end
+      end
+    end
+  end
+end

data/template/Gemfile.tt

@@ -0,0 +1,95 @@
+source 'https://rubygems.org'
+
+# Web frameworks related
+group :framework do
+  gem 'grape', '~> 0.10'
+<%- if @dev_reload -%>
+  gem 'grape-reload', github: 'AlexYankee/grape-reload'
+<%- end -%>
+  gem 'warden', '~> 1.2.3'
+  gem 'grape-jbuilder', '~> 0.2.0'
+  gem 'jbuilder', '~> 2.2.5'
+  gem 'rack-cors', '~> 0.2.9'
+end
+# ORM
+group :db do
+<%- case @orm
+  when 'mongoid' -%>
+  gem 'mongoid', '~> 4.0.0'
+  gem 'mongoid-paranoia', '~> 1.0.0'
+  <%- if @carrierwave -%>
+  gem 'carrierwave-mongoid', '~> 0.7.1'
+  <%- end -%>
+<%- else -%>
+<%- end -%>
+<%- if @carrierwave -%>
+  gem 'carrierwave', '~> 0.10.0'
+  gem 'mini_magick', '~> 4.0.2'
+<%- end -%>
+  gem 'workflow', '~> 1.2.0'
+end
+<% if @sidekiq -%>
+# Background job
+group :sidekiq do
+  gem 'sidekiq', '~> 3.2.6'
+  gem 'sidekiq-middleware', '~> 0.3.0'
+  gem 'sidekiq-scheduler', github: 'preplay/sidekiq-scheduler', ref: '4b8abd1f256ff3e577a666c181437bd5f4590438'
+end
+<% end -%>
+<%- if @mandrill -%>
+# Mailing
+group :mailer do
+  gem 'mandrill_mailer', '~> 0.5.1'
+end
+<%- end -%>
+# Utils
+group :utils do
+  gem 'settingslogic', '~> 2.0.9'
+  gem 'logging', '~> 1.8.2'
+  gem 'bcrypt', '~> 3.1.7'
+  gem 'cancancan', '~> 1.9.2'
+  gem 'hashie', '~> 3.3.2'
+  gem 'activesupport', '~> 4.2'
+  gem 'multi_json', '~> 1.10.1'
+  gem 'oj', '~> 2.11.2'
+end
+<%- if @es -%>
+# ElasticSearch
+group :elastic_search do
+  gem 'tire', '~> 0.6.2'
+  gem 'faraday', '~> 0.9.1'
+end
+<%- end -%>
+group :eventmachine do
+<%- if @redis -%>
+  gem 'em-hiredis'
+<%- end -%>
+  gem 'em-synchrony', github: 'igrigorik/em-synchrony'
+end
+<%- if @faye -%>
+group :faye do
+  gem 'faye', '~> 1.0.1'
+<%- if @redis -%>
+  gem 'faye-redis'
+<%- end -%>
+end
+<%- end -%>
+# Server
+group :rack_server do
+  gem 'thin', '~> 1.6.3'
+  gem 'rake', '~> 10.3.2'
+  gem 'rack-fiber_pool', '~> 0.9.1'
+end
+group :test do
+  gem 'rack-test', '~> 0.6.3'
+  gem 'database_cleaner', '~> 1.3.0'
+  gem 'faker', '~> 1.4.3'
+  gem 'factory_girl', '~> 4.5.0'
+  gem 'guard', '~> 2.6.1'
+  gem 'guard-spork', '~> 1.5.1'
+  gem 'guard-rspec', '~> 4.3.1'
+  gem 'rspec', '~> 3.1.0'
+  gem 'spork', github: 'manafire/spork', branch: 'rspec3_runner'
+  gem 'terminal-notifier-guard', '~> 1.5.3'
+  gem 'rspec_api_documentation', '~> 4.3.0'
+end

data/template/Guardfile

@@ -0,0 +1,20 @@
+notification :terminal_notifier
+
+guard 'spork', rspec_env: { 'RACK_ENV' => 'test' } do
+  watch('config/.+\.rb')
+  watch('Gemfile.lock')
+  watch(%r{^spec/factories/.+\.rb$})
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard :rspec, cmd: 'bundle exec rspec --drb --color --format progress' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^api/mounts/(.+)\.rb$})  { |m| "spec/api/mounts/#{m[1]}_spec.rb" }
+  watch(%r{^models/(.+)\.rb$})      { |m| "spec/models/#{m[1]}_spec.rb" }
+  watch(%r{^abilities/(.+)\.rb$})    { |m| "spec/abilities/#{m[1]}_spec.rb" }
+  watch(%r{^views/(v[^/]+)/\.rb$})   { |m| "spec/api/**/*.rb" }
+end
+

data/template/abilities/api_ability.rb

@@ -0,0 +1,15 @@
+class ApiAbility
+  include CanCan::Ability
+  def initialize(user)
+    return unless user
+    alias_action :view, :create, :update, :delete, to: :crud
+
+    can :update_profile, user
+    can :view, Models::User
+    can :update, Models::User, { id: user.id }
+
+    if user.role == :admin
+      can :crud, :all
+    end
+  end
+end

data/template/api/api_app.rb

@@ -0,0 +1,85 @@
+module API
+  class Application < Grape::API
+    format :json
+    formatter :json, Grape::Formatter::Jbuilder
+
+    logger Logging.logger[:api]
+
+    helpers do
+      def logger; API::Application.logger end
+
+      def ability
+        @_ability ||= ApiAbility.new(current_user)
+      end
+
+      def authorize!(*args)
+        error! :unauthorized, 401 unless ability.can?(*args)
+      end
+      def current_user
+        warden.authenticate(:access_token)
+      end
+
+      def warden; env['warden'] end
+
+      def error!(msg, error = 400)
+        super(msg, error, header)
+      end
+
+      def set_locals(locals_hash)
+        env['api.tilt.locals'] = locals_hash
+      end
+
+      def add_locals(locals_hash)
+        env['api.tilt.locals'] = (env['api.tilt.locals'] || {}).merge(locals_hash)
+      end
+
+      def redis
+        REDIS_CONNECTION
+      end
+    end
+
+    route [:get, :post, :put, :patch], :unauthenticated do
+      error! :unauthenticated, 401
+    end
+
+    before do
+      header('Access-Control-Allow-Origin', '*')
+      header('Access-Control-Allow-Methods', '*')
+      header('Access-Control-Allow-Headers', 'Content-Type,Accept-Version,X-Authorize')
+    end
+
+    rescue_from Mongoid::Errors::DocumentNotFound do
+      Rack::Response.new(['Not found'], 404, env['api.endpoint'].header).finish
+    end
+
+    rescue_from :all do |exception|
+      API::Application.logger.error exception
+      Rack::Response.new(['Error'], 500, env['api.endpoint'].header).finish
+    end
+
+    rescue_from Grape::Exceptions::ValidationErrors do |exception|
+      body = [MultiJson.dump(validation: exception.errors.map{|params, errors| Hash[params.zip([errors.first.to_s] * params.length)]}.inject({},&:merge))]
+      Rack::Response.new(body, 400, env['api.endpoint'].header).finish
+    end
+
+    rescue_from Mongoid::Errors::Validations do |exception|
+      body = [MultiJson.dump(validation: exception.document.errors.messages.map{|attr, errors| {attr => errors.first}}.inject({},&:merge))]
+      Rack::Response.new(body, 400, env['api.endpoint'].header).finish
+    end
+
+    mount Mounts::Auth => '/auth'
+    mount Mounts::Profile => '/profile'
+
+    get :ping do
+      {pong: true}
+    end
+
+    post :redis_write do
+      {result: redis.set('redis_key', Time.now.to_s)}
+    end
+
+    get :redis_read do
+      {result: redis.get('redis_key')}
+    end
+  end
+end

data/template/api/mounts/auth.rb.tt

@@ -0,0 +1,42 @@
+module API
+  module Mounts
+    class Auth < Grape::API
+      params do
+        requires :display_name, type: String
+        requires :email, type: String
+      end
+      post :register do
+        params[:email] = params[:email].downcase
+        user = Models::User.where(email: params[:email]).first
+        if user
+          error! :waiting_for_approvement if user.registered?
+          error! :already_exists, 400
+        end
+
+        user = Models::User.register(declared(params, include_missing: false))
+
+      <%- if @mandrill -%>
+        begin
+          RegistrationMailer.registered(user).deliver
+        rescue
+          logger.error $!
+        end
+      <%- end -%>
+      end
+
+      params do
+        requires :email, type: String
+        requires :email_approvement_code, type: String
+      end
+      post :approve_email, jbuilder: 'v1/user/profile.json' do
+        @user = Models::User.find_by(email: params[:email].downcase, email_approvement_code: params[:email_approvement_code])
+        @user.email_approved!
+        @user.save
+        header['X-Authorize'] = @user.token
+        <% if @faye %>
+        FayePublisher.publish('/user/registered', {display_name: @user.display_name})
+        <% end %>
+      end
+    end
+  end
+end

data/template/api/mounts/profile.rb.tt

@@ -0,0 +1,24 @@
+module API
+  module Mounts
+    class Profile < Grape::API
+      before {
+        @user = current_user
+        authorize! :update_profile, @user
+      }
+      params do
+        optional :display_name
+        <% if @carrierwave %>
+        optional :avatar
+        optional :remove_avatar
+        mutually_exclusive :avatar, :remove_avatar
+        <% end %>
+      end
+      put jbuilder: 'v1/user/profile.json' do
+        declared(params, include_missing: false).each {|k,v| @user.send("#{k}=", v) }
+        @user.save!
+      end
+
+      get jbuilder: 'v1/user/profile.json'
+    end
+  end
+end

data/template/config/application.yml.tt

@@ -0,0 +1,33 @@
+development: &dev
+  api_root: http://localhost:9292/api
+<% if @redis -%>
+  redis:
+    url: redis://localhost:6379/0
+    size: 20
+<% end -%>
+<% if @mandrill -%>
+  mandrill:
+    api_key: your_mandrill_key
+<% end -%>
+<% if @es -%>
+  elasticsearch:
+    url: http://localhost:9200
+<% end -%>
+<% if @faye -%>
+  faye:
+    server_secret: <%= @faye_secret %>
+    redis:
+      url: redis://localhost:6379/0
+      namespace: faye
+      size: 20 # Pool size
+<% end -%>
+<% if @sidekiq %>
+  sidekiq:
+    redis:
+      url: redis://localhost:6379/0
+      size: 20 # Pool size
+<% end %>
+
+production: *dev
+test:
+  api_root: http://localhost/api

data/template/config/boot.rb.tt

@@ -0,0 +1,85 @@
+# Defines our constants
+RACK_ENV = ENV['RACK_ENV'] || 'development' unless defined?(RACK_ENV)
+APP_ROOT = File.expand_path('../..', __FILE__) unless defined?(APP_ROOT)
+
+# Load our dependencies
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+require 'yaml'
+
+# Load initializers
+Bundler.require(
+    :framework,
+    :db,
+<% if @sidekiq -%>
+    :sidekiq,
+<% end -%>
+<% if @mandrill -%>
+    :mailer,
+<% end -%>
+    :utils,
+<% if @es -%>
+    :elastic_search,
+<% end -%>
+    :eventmachine,
+    :rack_server,
+    RACK_ENV
+)
+
+require_relative 'settings'
+
+ApplicationSettings.source File.expand_path('config/application.yml', APP_ROOT)
+ApplicationSettings.root = APP_ROOT
+
+require_relative 'database'
+
+Dir[ApplicationSettings.root('config/initializers/em-patches/*.rb')].each {|initializer| require initializer}
+Dir[ApplicationSettings.root('config/initializers/*.rb')].each {|initializer| require initializer}
+
+
+REDIS_CONNECTION = RedisLazyEvaluatedPool.pool_with_config(ApplicationSettings.redis)
+
+<% if @dev_reload %>
+RACK_APPLICATION = Grape::RackBuilder.setup do
+  %w{api models lib uploaders models abilities jobs search_indexes mailers}.each do |path|
+    add_source_path ApplicationSettings.root("#{path}/**/*.rb")
+    add_source_path ApplicationSettings.root("#{path}/*.rb")
+  end
+  
+  use Warden::Manager do |config|
+    config.strategies.add(:access_token, TokenStrategy)
+    config.default_strategies :access_token
+    config.failure_app = API::Application
+    config.intercept_401 = false
+  end
+  
+  use Rack::Config do |env|
+    env['api.tilt.root'] = ApplicationSettings.root('views')
+  end
+  
+  mount 'API::Application', to: '/api'
+  
+  logger Logging.logger[:rackbuilder]
+end.boot!.application
+<% else %>
+%w{lib models uploaders models abilities jobs search_indexes mailers api}.each do |path|
+  Dir[ApplicationSettings.root("#{path}/**/*.rb")].each {|f| require f}
+end
+    
+RACK_APPLICATION = Rack::Builder.new do
+  use Warden::Manager do |config|
+    config.strategies.add(:access_token, TokenStrategy)
+    config.default_strategies :access_token
+    config.failure_app = API::Application
+    config.intercept_401 = false
+  end
+  
+  use Rack::Config do |env|
+    env['api.tilt.root'] = ApplicationSettings.root('views')
+  end
+  
+  map '/api' do
+    run API::Application
+  end
+end
+<% end %>

data/template/config/boot_faye.rb

@@ -0,0 +1,22 @@
+# Defines our constants
+RACK_ENV = :production
+APP_ROOT = File.expand_path('../..', __FILE__) unless defined?(APP_ROOT)
+
+# Load our dependencies
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+# Load initializers
+Bundler.require(:faye, RACK_ENV)
+require 'warden'
+require 'active_support/core_ext/hash/keys'
+require 'hashie/mash'
+require 'redis-namespace'
+require_relative 'initializers/patches/redis_namespace'
+require_relative 'settings'
+
+ApplicationSettings.source File.expand_path('config/application.yml', APP_ROOT)
+ApplicationSettings.root = APP_ROOT
+
+require_relative 'initializers/logging'
+require_relative '../lib/faye_auth_extension'
+require_relative '../lib/faye_publisher'

data/template/config/boot_sidekiq.rb.tt

@@ -0,0 +1,33 @@
+# Load our dependencies
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+
+Bundler.require(:utils, :db)
+Bundler.require(
+    :sidekiq,
+<% if @mandrill -%>
+    :mailer,
+<% end -%>
+<% if @es -%>
+    :elastic_search,
+<% end -%>
+)
+
+# Defines our constants
+RACK_ENV = Sidekiq.options[:environment] || ENV['RACK_ENV'] || :development
+APP_ROOT = File.expand_path('../..', __FILE__) unless defined?(APP_ROOT)
+Bundler.require(RACK_ENV)
+
+require 'warden'
+
+require_relative 'settings'
+
+ApplicationSettings.source File.expand_path('config/application.yml', APP_ROOT)
+ApplicationSettings.root = APP_ROOT
+
+# Load initializers
+Dir[ApplicationSettings.root('config/initializers/*.rb')].each {|file_name| require file_name}
+
+%w{lib jobs uploaders models search_indexes}.each do |path|
+  Dir[ApplicationSettings.root("#{path}/**/*.rb")].each {|f| require f}
+end