grape-gen 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28745d08b232ed5faeb876a406a2b3f587be9036
-  data.tar.gz: 44c2dbad904233a90c7b58010d5629004e4c06a4
+  metadata.gz: 0e50733ed46b5a0d995856b26debf1b46f85f68f
+  data.tar.gz: 667b90bcfc49d876a21bc81c52b4314f4108b627
 SHA512:
-  metadata.gz: 1c98b81b1848d883d932044fd6890675e8d12c8630a61003307e9ffb8f789c66e00618a3b97d68a622a9c6e3d746e009d0f080109b32ac320b192ac5f003f88d
-  data.tar.gz: a96d538140c5d49aac1a0d27e51d5cfd2950757ef39e08e7fcd048643af2f4cd8a3c60e042100696d266a22df8690da7b16ffa521f0e83838f2cb31a6b3e81ba
+  metadata.gz: f3d87fc13fe0d3781c44143d1efb4fb95975182d5bcd2dc9e1cfb6a96cb2fe45bae7f545e9d1a8a314df6f2f76864370d6248d8f81af685f457298332e5fc5ff
+  data.tar.gz: ce52755d2c38f7303cec926b352464d2e3fdaa94d2776538e3d0503cdd412e6395ee1a394d2a1528926dd946f4af72022a88683963d1769c7637240414ddc910

data/README.md

@@ -1,30 +1,76 @@
-# Grape::Scaffold
+# Grape::Generate
+Grape application template generator with batteries included
 
-TODO: Write a gem description
+## Getting started
 
-## Installation
+First, install gem into your system
 
-Add this line to your application's Gemfile:
+    $ gem install 'grape-gen'
+then grape-gen binary will be available in your shell.
+To generate default app skeleton, simply use:
 
-```ruby
-gem 'grape-scaffold'
-```
+    $ grape-gen app your_app_name
+After executing complete, dir __your_app_name__ will be created in current dir.  
+Navigate into created dir and do ```$ bundle```
 
-And then execute:
+## Whats included?
+* carrierwave
+* sidekiq
+* faye
+* elastic search
+* redis
 
-    $ bundle
+## Grape API rack app
+Rack app intended to be run under EventMachine-powered server (skeleton app using Thin)  
+Every library used is patched to play ball with EventMachine event loop.  
+To start web server:
 
-Or install it yourself as:
+    $ RACK_ENV=production thin start -p 9292
+Example webserver responding to following API methods:
 
-    $ gem install grape-scaffold
+* POST /api/auth/register (display_name, email)
+* POST /api/auth/approve_email (email, email_approvement_code)
+* GET  /api/profile
+* PUT  /api/profile (avatar, remove_avatar, display_name)
 
-## Usage
+/api/profile methods is restricted to use only by registered users.  
+API user must supply X-Authorize header, received from /api/auth/approve_email
 
-TODO: Write usage instructions here
+When user approves email by calling POST /api/auth/approve_email with valid data,  
+message containing user __display_name__ will be published into faye __/user/registered__ channel  
+so all faye connections subscribed to /user/registered channel will receive info about newly registered user
+
+## Faye (optional, enabled by default)
+Include faye support into skeleton app.
+To start faye server:
+
+    $ thin start -p 9393 -R faye.ru -e production
+While running web server and faye server, please, visit http://localhost:9292/faye  
+Webpage contains simple implementation of faye client, connecting to localhost:9393 server  
+After successful connection client subscribes on two channels: __/user/registered__ and __/time__  
+Faye events received displayed at the top of webpage
+
+## Sidekiq (optional, enabled by default)
+Include support for background jobs via Sidekiq gem  
+Besides of main Sidekiq gem it also adds gem supporting jobs scheduling  
+Out of the box skeleton app have one scheduled job defined - __/jobs/pong_time.rb__  
+Job, scheduled to run each 5 seconds, simply publishes current time into /time faye channel
+so all faye connections subscribed to /time channel will receive current time string  
+For more information take a look at /config/sidekiq.yml
+
+## Mandrill (optional, enabled by default)
+Include support for email delivery with Mandrill service via MandrillMailer gem.  
+To have this gem running you should add your Mandrill api key to __/config/application.yml__  
+After successful registration with __POST /api/auth/register__ app tries to send message to  user email using __/mailers/registraion_mailer.rb__  
+To have email delivered please make sure you have changed __from__ address in __/mailers/registraion_mailer.rb__ and appropriate domain name is registered for api key you add to config.file.
+
+## TODO
+
+More documentation
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/grape-scaffold/fork )
+1. Fork it ( https://github.com/AlexYankee/grape-gen/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`)

data/lib/grape/generate/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Generate
-    VERSION = '0.0.5'
+    VERSION = '0.0.6'
   end
 end

data/lib/grape/generate.rb

@@ -43,9 +43,6 @@ module Grape
 
         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
@@ -54,8 +51,7 @@ module Grape
           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'
+          directory './lib/faye'
         end
 
         if @sidekiq

data/template/Gemfile.tt

@@ -52,6 +52,7 @@ group :utils do
   gem 'activesupport', '~> 4.2'
   gem 'multi_json', '~> 1.10.1'
   gem 'oj', '~> 2.11.2'
+  gem 'redis-namespace', '~> 1.5.1'
 end
 <%- if @es -%>
 # ElasticSearch

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

@@ -34,7 +34,7 @@ module API
         @user.save
         header['X-Authorize'] = @user.token
         <% if @faye %>
-        FayePublisher.publish('/user/registered', {display_name: @user.display_name})
+        Faye::Publisher.instance.publish('/user/registered', {display_name: @user.display_name})
         <% end %>
       end
     end

data/template/config/boot_faye.rb

@@ -18,5 +18,5 @@ 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'
+require_relative '../lib/faye/auth_extension'
+require_relative '../lib/faye/publisher'

data/template/config/initializers/em-patches/faye.rb

@@ -1,4 +1,6 @@
 require_relative 'redis_lazy_evaluated_pool'
-require_relative '../../../lib/faye_publisher'
+require_relative '../../../lib/faye/publisher'
 
-FayePublisher.redis = RedisLazyEvaluatedPool.pool_with_config(ApplicationSettings.faye.redis.to_hash.deep_symbolize_keys)
+Faye::Publisher.configure do |config|
+  config.redis = RedisLazyEvaluatedPool.pool_with_config(ApplicationSettings.faye.redis.to_hash.deep_symbolize_keys)
+end

data/template/config/initializers/em-patches/lazy_evaluated_pool.rb

@@ -14,7 +14,7 @@ class LazyEvaluatedPool < EventMachine::Synchrony::ConnectionPool
   private
   def acquire(fiber)
     if conn = @available.pop
-      conn = self.instance_eval(&conn) if conn.respond_to?(:call)
+      conn = conn.call(@config) if conn.respond_to?(:call)
       @reserved[fiber.object_id] = conn
       conn
     else
@@ -26,7 +26,7 @@ class LazyEvaluatedPool < EventMachine::Synchrony::ConnectionPool
   class << self
     def pool_with_config(config, &block)
       config[:size] ||= 10
-      LazyEvaluatedPool.new(config, &(block || connection))
+      new(config, &(block || connection))
     end
     private
     def connection; raise 'Please, override connection method or supply block' end

data/template/config/initializers/em-patches/mandrill.rb

@@ -1,3 +1,5 @@
+require 'mandrill'
+
 # Patch mandrill API to play ball with EventMachine
 module Mandrill
   class API

data/template/config/initializers/em-patches/redis_lazy_evaluated_pool.rb

@@ -1,4 +1,3 @@
-require 'redis-namespace'
 require_relative 'redis'
 require_relative 'lazy_evaluated_pool'
 
@@ -9,8 +8,8 @@ class RedisLazyEvaluatedPool < LazyEvaluatedPool
   }
   private
   def self.connection
-    Proc.new {
-      config = RedisLazyEvaluatedPool::CONFIG_DEFAULTS.merge (@config|| {}).deep_symbolize_keys
+    Proc.new { |config|
+      config = RedisLazyEvaluatedPool::CONFIG_DEFAULTS.merge (config|| {}).deep_symbolize_keys
       connection = EventMachine::Hiredis.connect(config[:url])
       connection = Redis::Namespace.new(config[:namespace], redis: connection) if config[:namespace]
       connection

data/template/config/initializers/faye.rb

@@ -1,3 +1,5 @@
-require_relative '../../lib/faye_publisher'
+require_relative '../../lib/faye/publisher'
 
-FayePublisher.redis = ApplicationSettings.faye.redis unless FayePublisher.configured?
+Faye::Publisher.configure do |config|
+  config.redis = ApplicationSettings.faye.redis unless Faye::Publisher.configured?
+end

data/template/config/initializers/mandrill.rb

@@ -1 +1,67 @@
-MandrillMailer.config.api = ApplicationSettings.mandrill.api_key
+require 'mandrill'
+
+module Mandrill
+  constants.select{|c| /Error$/ =~ c.to_s}.each{|const| remove_const(const) }
+  class Error < StandardError
+  end
+  class ValidationError < Error
+  end
+  class InvalidKeyError < Error
+  end
+  class PaymentRequiredError < Error
+  end
+  class UnknownSubaccountError < Error
+  end
+  class UnknownTemplateError < Error
+  end
+  class ServiceUnavailableError < Error
+  end
+  class UnknownMessageError < Error
+  end
+  class InvalidTagNameError < Error
+  end
+  class InvalidRejectError < Error
+  end
+  class UnknownSenderError < Error
+  end
+  class UnknownUrlError < Error
+  end
+  class UnknownTrackingDomainError < Error
+  end
+  class InvalidTemplateError < Error
+  end
+  class UnknownWebhookError < Error
+  end
+  class UnknownInboundDomainError < Error
+  end
+  class UnknownInboundRouteError < Error
+  end
+  class UnknownExportError < Error
+  end
+  class IPProvisionLimitError < Error
+  end
+  class UnknownPoolError < Error
+  end
+  class NoSendingHistoryError < Error
+  end
+  class PoorReputationError < Error
+  end
+  class UnknownIPError < Error
+  end
+  class InvalidEmptyDefaultPoolError < Error
+  end
+  class InvalidDeleteDefaultPoolError < Error
+  end
+  class InvalidDeleteNonEmptyPoolError < Error
+  end
+  class InvalidCustomDNSError < Error
+  end
+  class InvalidCustomDNSPendingError < Error
+  end
+  class MetadataFieldLimitError < Error
+  end
+  class UnknownMetadataFieldError < Error
+  end
+end
+
+MandrillMailer.config.api_key = ApplicationSettings.mandrill.api_key

data/template/config/initializers/tire.rb

@@ -1,6 +1,70 @@
 require 'tire/http/clients/faraday'
 
+module Tire
+  class ExternalLogger < Tire::Logger
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def level
+      @logger.level
+    end
+
+    def write(message)
+      @logger.info message
+    end
+
+    def log_request(endpoint, params=nil, curl='')
+      # 2001-02-12 18:20:42:32 [_search] (articles,users)
+      #
+      # curl -X POST ....
+      #
+      content  = "# #{time}"
+      content += " [#{endpoint}]"
+      content += " (#{params.inspect})" if params
+      content += "\n#\n"
+      content += curl
+      content += "\n\n"
+      write content
+    end
+
+    def log_response(status, took=nil, json='')
+      # 2001-02-12 18:20:42:32 [200] (4 msec)
+      #
+      # {
+      #   "took" : 4,
+      #   "hits" : [...]
+      #   ...
+      # }
+      #
+      content  = "# #{time}"
+      content += " [#{status}]"
+      content += " (#{took} msec)" if took
+      content += "\n#\n" unless json.to_s !~ /\S/
+      json.to_s.each_line { |line| content += "# #{line}" } unless json.to_s !~ /\S/
+      content += "\n\n"
+      write content
+    end
+
+    def time
+      Time.now.strftime('%Y-%m-%d %H:%M:%S:%L')
+    end
+  end
+end
+
+
+module Tire
+  class Configuration
+    def self.logger(logger = nil)
+      return @logger = logger if logger
+      @logger || nil
+    end
+  end
+end
+
 Tire.configure do
   url ApplicationSettings.elasticsearch.url
-  logger Logging.logger[:elasticsearch]
-end
+  logger Tire::ExternalLogger.new(Logging.logger[:elasticsearch])
+end
+

data/template/jobs/pong_time.rb

@@ -5,7 +5,7 @@ module DelayedJobs
     sidekiq_options unique: true
 
     def perform
-      FayePublisher.publish('/time',Time.now.utc.to_s)
+      Faye::Publisher.instance.publish('/time',Time.now.utc.to_s)
     end
   end
 end

data/template/lib/{faye_auth_extension.rb → faye/auth_extension.rb}

@@ -1,4 +1,4 @@
-require_relative 'warden/token_strategy'
+require_relative '../warden/token_strategy'
 
 module Faye
   class AuthExtension

data/template/lib/faye/publisher.rb

@@ -0,0 +1,57 @@
+require 'connection_pool'
+require 'em-synchrony/connection_pool'
+
+module Faye
+  module Publisher
+    class << self
+      def instance
+        @default_instance ||= RedisPublisher.new(configuration.redis)
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      def configured?
+        !@config.nil?
+      end
+
+      private
+      def configuration
+        @config ||= OpenStruct.new(redis: {url: 'redis://localhost:6379', size: 10, namespace: 'faye'})
+      end
+    end
+
+    class RedisPublisher
+      def initialize(config)
+        case config
+          when
+          ::ConnectionPool,
+              EventMachine::Synchrony::ConnectionPool
+            @redis = config
+          else
+            @config = config
+        end
+      end
+
+      def publish(channel, payload)
+        redis.rpush(
+            'faye.messages',
+            MultiJson.dump(
+                channel: channel,
+                payload: payload
+            )
+        )
+      end
+
+      private
+      def redis
+        @redis ||= ConnectionPool::Wrapper.new(size: @config[:size] || 10) do
+          connection = Redis.new(url: @config[:url])
+          connection = Redis::Namespace.new(@config[:namespace], redis: connection) if @config[:namespace]
+          connection
+        end
+      end
+    end
+  end
+end

data/template/spec/patches/faye/publisher/test.rb

@@ -0,0 +1,19 @@
+module Faye
+  module Publisher
+    FakePublishing = Struct.new(:channel, :payload)
+
+    class RedisPublisher
+      def publish(*args)
+        publishings << Faye::Publisher::FakePublishing.new(*args)
+      end
+
+      def clear_publishings
+        @publishings.clear
+      end
+
+      def publishings
+        @publishings ||= []
+      end
+    end
+  end
+end

data/template/spec/spec_helper.rb.tt

@@ -7,8 +7,13 @@ require 'rspec_api_documentation'
 <% if @mandrill %>
 require 'mandrill_mailer/offline'
 <% end %>
+
 RACK_ENV = 'test' unless defined?(RACK_ENV)
 
+%w{patches}.each do |path|
+  Dir[File.expand_path('patches/**/*.rb', File.dirname(__FILE__))].each {|f| require f}
+end
+
 class TestApiClient < RspecApiDocumentation::RackTestClient
   def response_body
     body = JSON.load(last_response.body)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-gen
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - AMar4enko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -106,8 +106,8 @@ files:
 - template/config/sidekiq.yml.tt
 - template/faye.ru
 - template/jobs/pong_time.rb
-- template/lib/faye_auth_extension.rb
-- template/lib/faye_publisher.rb
+- template/lib/faye/auth_extension.rb
+- template/lib/faye/publisher.rb
 - template/lib/mongoid/tire_plugin.rb
 - template/lib/warden/token_strategy.rb
 - template/log/.gitkeep
@@ -118,6 +118,7 @@ files:
 - template/search_indexes/user_index.rb
 - template/spec/api/mounts/auth_spec.rb.tt
 - template/spec/factories/user.rb
+- template/spec/patches/faye/publisher/test.rb
 - template/spec/spec_helper.rb.tt
 - template/tmp/pids/.gitkeep
 - template/uploaders/avatar_uploader.rb

data/template/lib/faye_publisher.rb

@@ -1,63 +0,0 @@
-require 'connection_pool'
-require 'em-synchrony/connection_pool'
-
-module FayePublisher
-  FakePublishing = Struct.new(:channel, :payload)
-  class << self
-    def fake!
-      @fake = true
-    end
-
-    def redis=(arg)
-      case arg
-        when
-        ::ConnectionPool,
-            EventMachine::Synchrony::ConnectionPool # Or its descendants
-          @redis = arg
-        else
-          @_config = arg
-      end
-    end
-
-    def redis
-      @redis ||= begin
-        config = ApplicationSettings.faye.redis
-        ConnectionPool::Wrapper.new(size: config[:size] || 10) do
-          connection = Redis.new(url: config[:url])
-          connection = Redis::Namespace.new(config[:namespace], redis: connection) if config[:namespace]
-          connection
-        end
-      end
-    end
-
-    def publish(channel, payload)
-      if @fake
-        fake_publishings.push(FakePublishing.new(channel, payload))
-        return true
-      end
-      redis.rpush(
-          'faye.messages',
-          MultiJson.dump(
-              channel: channel,
-              payload: payload
-          )
-      )
-    end
-
-    def configured?; @connection || @_config end
-
-    def publishings
-      raise 'FayePublisher is not configured in fake! mode' unless @fake
-      fake_publishings
-    end
-
-    def clear_publishings
-      @fake_publishings.clear
-    end
-
-    private
-    def fake_publishings
-      @fake_publishings ||= []
-    end
-  end
-end