service_template 0.5.0

data/lib/service_template/active_record_extensions/notifications_subscriber.rb

@@ -0,0 +1,17 @@
+if defined?(ActiveRecord)
+  ActiveSupport::Notifications.subscribe 'sql.active_record' do |name, start, finish, id, payload|
+    if payload[:sql].downcase.match(/(select|update|insert|delete)(.+)/i)
+      table, action = ServiceTemplate::ActiveRecordStats.extract_sql_content(payload[:sql])
+    end
+
+    if table
+      ServiceTemplate::Stats.emitter.timing(
+        "sql.query_time",
+      (finish - start) * 1000)
+
+      ServiceTemplate::Stats.emitter.timing(
+        "sql.table.#{table}.#{action.downcase}.query_time",
+      (finish - start) * 1000)
+    end
+  end
+end

data/lib/service_template/active_record_extensions/seeder.rb

@@ -0,0 +1,14 @@
+if defined?(ActiveRecord)
+  module ServiceTemplate
+    class ActiveRecordSeeder
+      def initialize(seed_file)
+        @seed_file = seed_file
+      end
+
+      def load_seed
+        raise "Seed file '#{@seed_file}' does not exist" unless File.file?(@seed_file)
+        load @seed_file
+      end
+    end
+  end
+end

data/lib/service_template/active_record_extensions/stats.rb

@@ -0,0 +1,37 @@
+if defined?(ActiveSupport) && defined?(ActiveRecord)
+  module ServiceTemplate
+    module ActiveRecordStats
+      SQL_INSERT_DELETE_PARSER_REGEXP = /^(?<action>\w+)\s(\w+)\s\W*(?<table>\w+)/
+      SQL_SELECT_REGEXP = /select .*? FROM \W*(?<table>\w+)/i
+      SQL_UPDATE_REGEXP = /update \W*(?<table>\w+)/i
+
+      # Returns the table and query type
+      def self.extract_from_sql_inserts_deletes(query)
+        m = query.match(SQL_INSERT_DELETE_PARSER_REGEXP)
+        [m[:table], m[:action]]
+      end
+
+      def self.extract_sql_selects(query)
+        m = query.match(SQL_SELECT_REGEXP)
+        [m[:table], 'SELECT']
+      end
+
+      def self.extract_sql_updates(query)
+        m = query.match(SQL_UPDATE_REGEXP)
+        [m[:table], 'UPDATE']
+      end
+
+      def self.extract_sql_content(query)
+        table = action = nil
+        if query.match(SQL_UPDATE_REGEXP)
+          table, action = extract_sql_updates(query)
+        elsif query.match(SQL_SELECT_REGEXP)
+          table, action =  extract_sql_selects(query)
+        elsif query.match(SQL_INSERT_DELETE_PARSER_REGEXP)
+          table, action =  extract_from_sql_inserts_deletes(query)
+        end
+        [table, action]
+      end
+    end
+  end
+end

data/lib/service_template/authentication.rb

@@ -0,0 +1,8 @@
+module ServiceTemplate
+  class Authentication
+    def self.password_header
+      raise 'header_password_not_configured' unless ENV['HEADER_PASSWORD']
+      { 'Password' => ENV['HEADER_PASSWORD'] }
+    end
+  end
+end

data/lib/service_template/cli.rb

@@ -0,0 +1,111 @@
+require 'thor'
+require 'service_template/generators'
+require 'service_template/deploy'
+require 'service_template/version'
+
+ServiceTemplate.load_environment if defined?(Dotenv)
+
+module ServiceTemplate
+  class CLI
+    class Generate < Thor
+      register(
+        Generators::ApiGenerator,
+        'api',
+        'api <api_name>',
+        'Create a Grape API, Model and Entity'
+      )
+
+      register(
+        Generators::ReadmeGenerator,
+        'readme',
+        'readme',
+        'Create a formatted README'
+      )
+    end
+  end
+
+  class CLI
+    class Base < Thor
+      desc "version", "Shows the ServiceTemplate version number"
+      def version
+        say ServiceTemplate::VERSION
+      end
+
+      desc 'console [environment]', 'Start the ServiceTemplate console'
+      options aliases: 'c'
+      def console(environment = nil)
+        ServiceTemplate.env = environment || 'development'
+
+        require 'racksh/init'
+
+        begin
+          require "pry"
+          interpreter = Pry
+        rescue LoadError
+          require "irb"
+          require "irb/completion"
+          interpreter = IRB
+          # IRB uses ARGV and does not expect these arguments.
+          ARGV.delete('console')
+          ARGV.delete(environment) if environment
+        end
+
+        Rack::Shell.init
+
+        $0 = "#{$0} console"
+        interpreter.start
+      end
+
+      desc 'server', "Start the ServiceTemplate server"
+      options aliases: 's'
+      def server
+        puts "ServiceTemplate server starting..."
+
+        require 'pty'
+        exit = "... ServiceTemplate server exited!"
+
+        begin
+          PTY.spawn('shotgun') do |stdout, stdin, pid|
+            begin
+              Signal.trap('INT') { Process.kill('INT', pid) }
+              stdout.each { |line| puts line }
+            rescue Errno::EIO
+              puts exit
+            end
+          end
+        rescue PTY::ChildExited
+          puts exit
+        end
+      end
+
+      desc 'deploy [target]', 'Deploys A Service to a given target (i.e. production, staging, etc.)'
+      method_options :force => :boolean, :revision => :string, :confirm => :boolean
+      def deploy(environment)
+        if options[:confirm] || yes?('Are you sure you want to deploy this service?', Thor::Shell::Color::YELLOW)
+          deploy = ServiceTemplate::Deploy.new(environment, force: options[:force], revision: options[:revision])
+          if deploy.deployable?
+            say(deploy.deploy!, Thor::Shell::Color::GREEN)
+          else
+            say("Deploy Failed:\n#{deploy.errors.join("\n")}", Thor::Shell::Color::RED)
+          end
+        end
+      end
+
+      register(
+        Generators::ScaffoldGenerator,
+        'new',
+        'new <app_name> [app_path]',
+        'Create a scaffold for a new ServiceTemplate service'
+      )
+
+      desc "generate api <api_name>", "Create a Grape API, Model and Representer"
+      subcommand "generate api", ServiceTemplate::CLI::Generate
+
+      desc "generate migration <migration_name> [field[:type][:index] field[:type][:index]]", "Create a Database Migration"
+      subcommand "generate", ServiceTemplate::CLI::Generate
+
+      desc "generate readme", "Create a formatted README"
+      subcommand "generate readme", ServiceTemplate::CLI::Generate
+    end
+  end
+end

data/lib/service_template/deploy.rb

@@ -0,0 +1,98 @@
+require 'git'
+require 'octokit'
+
+module ServiceTemplate
+  class Deploy
+    attr_reader :errors, :github_login
+
+    def initialize(environment, revision: nil, force: false, github_repo: nil, github_token: nil)
+      ServiceTemplate.load_environment
+
+      @github_repo  = github_repo || ENV['GITHUB_REPO']
+      @github_token = github_token || ENV['GITHUB_OAUTH_TOKEN']
+      @environment  = environment
+      @revision     = revision || local_head_revision
+      @force        = force
+
+      @errors       = []
+    end
+
+    def deploy!
+      if deployable?
+        set_github_tag
+        "#{@revision} tagged as #{@environment} by #{@github_login} at #{Time.now.to_s(:long)}"
+      else
+        "Deploy error(s): #{@errors.join(' --- ')}"
+      end
+    end
+
+    def set_github_tag
+      begin
+        github_client.update_ref(
+          @github_repo,
+          "tags/#{@environment}",
+          @revision,
+          @force
+        )
+      rescue Octokit::UnprocessableEntity
+        github_client.create_ref(
+          @github_repo,
+          "tags/#{@environment}",
+          @revision
+        )
+      end
+    end
+
+    def local_repo
+      @local_repo ||= Git.open('.')
+    end
+
+    def local_repo_status
+      @local_repo_status ||= local_repo.status
+    end
+
+    def github_client
+      return @github_client if @github_client
+      @errors << "ENV['GITHUB_REPO'] is not defined" if @github_repo.nil?
+      @errors << "ENV['GITHUB_OAUTH_TOKEN'] is not defined" if @github_token.nil?
+
+      client = Octokit::Client.new(access_token: @github_token)
+      begin
+        @github_login = client.login
+        return @github_client = client
+      rescue Octokit::Unauthorized
+        @errors << "Access denied for GITHUB_OAUTH_TOKEN"
+      end
+    end
+
+    def local_head_revision
+      local_repo.object('HEAD').sha
+    end
+
+    def deployable?
+      revision_exists_on_github?
+      any_local_uncommited_changes?
+      any_local_untracked_files?
+
+      @errors.empty? || @force
+    end
+
+    def revision_exists_on_github?
+      begin
+        github_client.commit(@github_repo, @revision)
+      rescue Octokit::NotFound
+        @errors << "Revision #{@revision} does not exist on #{@github_repo}, make sure you've merged your changes."
+      end
+    end
+
+    def any_local_uncommited_changes?
+      changes = local_repo_status.changed.collect{|change| change[0]}
+      @errors << "#{changes.to_sentence} have been changed and not committed." if changes.any?
+    end
+
+    def any_local_untracked_files?
+      changes = local_repo_status.untracked.collect{|change| change[0]}
+      @errors << "#{changes.to_sentence} file(s) have been added and are not tracked." if changes.any?
+    end
+  end
+end

data/lib/service_template/gem_dependency.rb

@@ -0,0 +1,37 @@
+require 'active_support/json'
+
+module ServiceTemplate
+  class GemDependency
+    def self.log_all
+      ServiceTemplate::Logger.logger.info(gems: list_all.as_json)
+    end
+
+    def self.list_all
+      Gem.loaded_specs.map { |spec| new(spec).to_hash }
+    end
+
+    def initialize(spec)
+      @spec = spec[1]
+    end
+
+    def name
+      @spec.name
+    end
+
+    def version
+      @spec.version.to_s
+    end
+
+    def git_version
+      @spec.git_version
+    end
+
+    def to_hash
+      {}.tap do |h|
+        h[:name] = name
+        h[:version] = version
+        h[:git_version] = git_version if git_version
+      end
+    end
+  end
+end

data/lib/service_template/generators.rb

@@ -0,0 +1,3 @@
+require 'service_template/generators/scaffold_generator'
+require 'service_template/generators/api_generator'
+require 'service_template/generators/readme_generator'

data/lib/service_template/generators/api_generator.rb

@@ -0,0 +1,30 @@
+require 'thor'
+require 'active_support/all'
+
+module ServiceTemplate
+  module Generators
+    class ApiGenerator < Thor::Group
+      include Thor::Actions
+      argument :name
+
+      def name_underscore
+        name.underscore
+      end
+
+      def name_tableize
+        name.tableize
+      end
+
+      def output_directory
+        '.'
+      end
+
+      def api
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/api"
+        say 'Generating api...'
+        directory '.', output_directory
+        say 'Done!', :green
+      end
+    end
+  end
+end

data/lib/service_template/generators/readme_generator.rb

@@ -0,0 +1,47 @@
+require 'thor'
+require 'active_support/all'
+require 'service_template/setup'
+require 'service_template/identity'
+require 'dotenv'
+
+module ServiceTemplate
+  module Generators
+    class ReadmeGenerator < Thor::Group
+      include Thor::Actions
+
+      def load_environment
+        ServiceTemplate.load_environment
+      end
+
+      def service_name
+        ServiceTemplate::Identity.name
+      end
+
+      def routes
+        routes = ""
+
+        if defined? ApplicationApi
+          ApplicationApi.routes.each do |api|
+            method      = api.route_method.ljust(10)
+            path        = api.route_path.ljust(40)
+            description = api.route_description
+            routes     += "     #{method} #{path} # #{description}"
+          end
+        end
+
+        routes
+      end
+
+      def output_directory
+        '.'
+      end
+
+      def readme
+        self.class.source_root "#{File.dirname(__FILE__)}/templates/readme"
+        say 'Generating readme...'
+        directory '.', output_directory
+        say 'Done!', :green
+      end
+    end
+  end
+end

data/lib/service_template/generators/scaffold_generator.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'active_support/core_ext/string'
+
+module ServiceTemplate
+  module Generators
+    class ScaffoldGenerator < Thor::Group
+      include Thor::Actions
+
+      source_root "#{File.dirname(__FILE__)}/templates/scaffold"
+
+      argument :app_name
+      argument :app_path, optional: true
+      class_option :database, default: 'mysql', aliases: '-d', desc: 'Preconfigure for selected database (options: mysql/postgres/pg)'
+
+      def generate
+        say 'Generating scaffold...'
+
+        @database_gem       = ['pg','postgres'].include?(options[:database]) ? 'pg' : 'mysql2'
+        @database_adapter   = ['pg','postgres'].include?(options[:database]) ? 'postgresql' : 'mysql2'
+        @database_encoding  = ['pg','postgres'].include?(options[:database]) ? 'unicode' : 'utf8'
+        @database_user      = ['pg','postgres'].include?(options[:database]) ? '' : 'root'
+
+        directory ".", (app_path || app_name)
+
+        say 'Done!', :green
+      end
+    end
+  end
+end

data/lib/service_template/generators/templates/api/app/apis/%name_tableize%_api.rb.tt

@@ -0,0 +1,40 @@
+class <%= name.classify.pluralize %>Api < Grape::API
+  desc 'Get a list of <%= name.underscore.tableize %>'
+  params do
+    optional :ids, type: Array, desc: 'Array of <%= name.underscore %> ids'
+  end
+  get do
+    <%= name.underscore.tableize %> = params[:ids] ? <%= name.classify %>.where(id: params[:ids]) : <%= name.classify %>.all
+    represent <%= name.underscore.tableize %>, with: <%= name.classify %>Representer
+  end
+
+  desc 'Create an <%= name.underscore %>'
+  params do
+  end
+
+  post do
+    <%= name.underscore %> = <%= name.classify %>.create!(permitted_params)
+    represent <%= name.underscore %>, with: <%= name.classify %>Representer
+  end
+
+  params do
+    requires :id, desc: 'ID of the <%= name.underscore %>'
+  end
+  route_param :id do
+    desc 'Get an <%= name.underscore %>'
+    get do
+      <%= name.underscore %> = <%= name.classify %>.find(params[:id])
+      represent <%= name.underscore %>, with: <%= name.classify %>Representer
+    end
+
+    desc 'Update an <%= name.underscore %>'
+    params do
+    end
+    put do
+      # fetch <%= name.underscore %> record and update attributes.  exceptions caught in app.rb
+      <%= name.underscore %> = <%= name.classify %>.find(params[:id])
+      <%= name.underscore %>.update_attributes!(permitted_params)
+      represent <%= name.underscore %>, with: <%= name.classify %>Representer
+    end
+  end
+end