RubyGems - gris - Versions diffs - 0.0.2 - Mend

gris 0.0.2

Files changed (74) hide show

checksums.yaml +7 -0
data/.gitignore +8 -0
data/.rspec +3 -0
data/.rubocop.yml +1 -0
data/.rubocop_todo.yml +67 -0
data/.ruby-gemset +1 -0
data/.ruby-version +1 -0
data/Gemfile +12 -0
data/Gemfile.lock +203 -0
data/Guardfile +82 -0
data/MIT-LICENSE +20 -0
data/README.md +7 -0
data/Rakefile +11 -0
data/bin/gris +5 -0
data/gris.gemspec +40 -0
data/lib/gris.rb +37 -0
data/lib/gris/cli.rb +71 -0
data/lib/gris/deprecations.rb +9 -0
data/lib/gris/deprecations/gris_setup.rb +14 -0
data/lib/gris/generators.rb +3 -0
data/lib/gris/generators/api_generator.rb +31 -0
data/lib/gris/generators/migration_generator.rb +228 -0
data/lib/gris/generators/scaffold_generator.rb +21 -0
data/lib/gris/generators/templates/api/app/apis/%name_tableize%_endpoint.rb.tt +65 -0
data/lib/gris/generators/templates/api/app/models/%name_underscore%.rb.tt +2 -0
data/lib/gris/generators/templates/api/app/presenters/%name_tableize%_presenter.rb.tt +5 -0
data/lib/gris/generators/templates/api/app/presenters/%name_underscore%_presenter.rb.tt +10 -0
data/lib/gris/generators/templates/api/spec/apis/%name_tableize%_endpoint_spec.rb.tt +70 -0
data/lib/gris/generators/templates/api/spec/fabricators/%name_tableize%_fabricator.rb.tt +2 -0
data/lib/gris/generators/templates/api/spec/models/%name_underscore%_spec.rb.tt +7 -0
data/lib/gris/generators/templates/create_table_migration/%migration_filename%.rb.tt +19 -0
data/lib/gris/generators/templates/migration/%migration_filename%.rb.tt +39 -0
data/lib/gris/generators/templates/scaffold/.Procfile.tt +1 -0
data/lib/gris/generators/templates/scaffold/.env.test.tt +11 -0
data/lib/gris/generators/templates/scaffold/.env.tt +10 -0
data/lib/gris/generators/templates/scaffold/.gitignore.tt +11 -0
data/lib/gris/generators/templates/scaffold/.rspec.tt +3 -0
data/lib/gris/generators/templates/scaffold/.rubocop.yml +18 -0
data/lib/gris/generators/templates/scaffold/.ruby-gemset.tt +1 -0
data/lib/gris/generators/templates/scaffold/.ruby-version.tt +1 -0
data/lib/gris/generators/templates/scaffold/Gemfile.tt +33 -0
data/lib/gris/generators/templates/scaffold/README.md.tt +3 -0
data/lib/gris/generators/templates/scaffold/Rakefile +9 -0
data/lib/gris/generators/templates/scaffold/app.rb +57 -0
data/lib/gris/generators/templates/scaffold/app/apis/application_endpoint.rb +9 -0
data/lib/gris/generators/templates/scaffold/app/presenters/root_presenter.rb +20 -0
data/lib/gris/generators/templates/scaffold/config.ru.tt +6 -0
data/lib/gris/generators/templates/scaffold/config/database.yml.tt +19 -0
data/lib/gris/generators/templates/scaffold/config/initializers/active_record.rb +4 -0
data/lib/gris/generators/templates/scaffold/db/schema.rb +11 -0
data/lib/gris/generators/templates/scaffold/public/errors/404.html +11 -0
data/lib/gris/generators/templates/scaffold/public/errors/500.html +11 -0
data/lib/gris/generators/templates/scaffold/spec/apis/cors_spec.rb +31 -0
data/lib/gris/generators/templates/scaffold/spec/spec_helper.rb +26 -0
data/lib/gris/generators/templates/scaffold/spec/support/app_helper.rb +3 -0
data/lib/gris/grape_extensions/crud_helpers.rb +26 -0
data/lib/gris/identity.rb +50 -0
data/lib/gris/middleware/app_monitor.rb +17 -0
data/lib/gris/output_formatters/paginated_presenter.rb +41 -0
data/lib/gris/output_formatters/presenter.rb +15 -0
data/lib/gris/rspec_extensions/response_helpers.rb +57 -0
data/lib/gris/setup.rb +17 -0
data/lib/gris/version.rb +38 -0
data/lib/tasks/db.rake +81 -0
data/lib/tasks/routes.rake +11 -0
data/spec/generators/api_generator_spec.rb +76 -0
data/spec/generators/migration_generator_spec.rb +96 -0
data/spec/generators/scaffold_generator_spec.rb +119 -0
data/spec/grape_extensions/crud_helpers_spec.rb +5 -0
data/spec/identity_spec.rb +86 -0
data/spec/spec_helper.rb +10 -0
data/spec/support/spec_generators_helper.rb +11 -0
data/spec/version_spec.rb +40 -0
metadata +426 -0

data/lib/gris/generators/templates/scaffold/config/database.yml.tt ADDED

@@ -0,0 +1,19 @@
+defaults: &defaults
+  encoding: unicode
+  adapter: postgresql
+  host: <%%= ENV['DATABASE_HOST'] %>
+  username: <%%= ENV['DATABASE_USER'] %>
+  password: <%%= ENV['DATABASE_PASSWORD'] %>
+  database: <%%= ENV['DATABASE_NAME'] %>
+production:
+  <<: *defaults
+development:
+  <<: *defaults
+test:
+  <<: *defaults
+staging:
+  <<: *defaults

data/lib/gris/generators/templates/scaffold/config/initializers/active_record.rb ADDED

@@ -0,0 +1,4 @@
+require 'erb'
+db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Gris.env]
+ActiveRecord::Base.establish_connection(db)
+ActiveRecord::Base.include_root_in_json = false

data/lib/gris/generators/templates/scaffold/db/schema.rb ADDED

@@ -0,0 +1,11 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.

data/lib/gris/generators/templates/scaffold/public/errors/404.html ADDED

@@ -0,0 +1,11 @@
+<html>
+ <head>
+  <title>Page Not Found</title>
+</head>
+ <body>
+  <h1>Ooops...</h1>
+  <p>
+    This page could not be found.
+  </p>
+ </body>
+</html>

data/lib/gris/generators/templates/scaffold/public/errors/500.html ADDED

@@ -0,0 +1,11 @@
+<html>
+ <head>
+  <title>Unexpected Error</title>
+</head>
+ <body>
+  <h1>Ouch...</h1>
+  <p>
+    Something went terribly wrong.
+  </p>
+ </body>
+</html>

data/lib/gris/generators/templates/scaffold/spec/apis/cors_spec.rb ADDED

@@ -0,0 +1,31 @@
+require 'spec_helper'
+describe Application::Service do
+  include Rack::Test::Methods
+  context 'CORS' do
+    include_context 'with a running app'
+    it 'supports options' do
+      options '/', {},
+              'HTTP_ORIGIN' => 'http://cors.example.com',
+              'HTTP_ACCESS_CONTROL_REQUEST_HEADERS' => 'Origin, Accept, Content-Type',
+              'HTTP_ACCESS_CONTROL_REQUEST_METHOD' => 'GET'
+      expect(response_code).to eq 200
+      expect(last_response.headers['Access-Control-Allow-Origin']).to eq 'http://cors.example.com'
+      expect(last_response.headers['Access-Control-Expose-Headers']).to eq ''
+    end
+    it 'includes Access-Control-Allow-Origin in the response' do
+      get '/', {}, 'HTTP_ORIGIN' => 'http://cors.example.com'
+      expect(response_code).to eq 200
+      expect(last_response.headers['Access-Control-Allow-Origin']).to eq 'http://cors.example.com'
+    end
+    it 'includes Access-Control-Allow-Origin in errors' do
+      get '/invalid', {}, 'HTTP_ORIGIN' => 'http://cors.example.com'
+      expect(response_code).to eq 404
+      expect(last_response.headers['Access-Control-Allow-Origin']).to eq 'http://cors.example.com'
+    end
+  end
+end

data/lib/gris/generators/templates/scaffold/spec/spec_helper.rb ADDED

@@ -0,0 +1,26 @@
+ENV['RACK_ENV'] = 'test'
+require 'webmock/rspec'
+require 'rack/test'
+require 'gris/rspec_extensions/response_helpers'
+require './app'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+RSpec.configure do |config|
+  config.include Gris::RspecExtensions::ResponseHelpers
+  config.mock_with :rspec
+  config.expect_with :rspec
+  config.before(:suite) do
+    ActiveRecord::Migration.maintain_test_schema!
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+  config.after(:each) do |_example|
+    DatabaseCleaner.clean
+  end
+end

data/lib/gris/generators/templates/scaffold/spec/support/app_helper.rb ADDED

@@ -0,0 +1,3 @@
+shared_context 'with a running app' do
+  let(:app) { Application::Service.instance }
+end

data/lib/gris/grape_extensions/crud_helpers.rb ADDED

@@ -0,0 +1,26 @@
+module Gris
+  module CrudHelpers
+    def create(type, options = {})
+      instance = type.create! options[:from]
+      present instance, with: options[:with]
+    end
+    def update(instance, options = {})
+      instance.update_attributes! options[:from]
+      present instance, with: options[:with]
+    end
+    def delete(instance, options = {})
+      instance.destroy
+      present instance, with: options[:with]
+    end
+    def permitted_params(options = {})
+      options = { include_missing: false }.merge(options)
+      declared(params, options)
+    end
+    # extend all endpoints to include this
+    Grape::Endpoint.send :include, self if defined?(Grape)
+  end
+end

data/lib/gris/identity.rb ADDED

@@ -0,0 +1,50 @@
+module Gris
+  class Identity
+    def self.health
+      {
+        name: name,
+        base_url: base_url,
+        hostname: hostname,
+        revision: revision,
+        pid: pid,
+        parent_pid: parent_pid,
+        platform: platform
+      }
+    end
+    def self.name
+      ENV['SERVICE_NAME'] || 'api-service'
+    end
+    def self.base_url
+      ENV['BASE_URL'] || 'http://localhost:9292'
+    end
+    def self.hostname
+      @hostname ||= `hostname`.strip
+    end
+    def self.revision
+      @revision ||= `git rev-parse HEAD`.strip
+    end
+    def self.pid
+      @pid ||= Process.pid
+    end
+    def self.parent_pid
+      @ppid ||= Process.ppid
+    end
+    def self.platform
+      {
+        version: platform_revision,
+        name: 'Gris'
+      }
+    end
+    def self.platform_revision
+      Gris::VERSION
+    end
+  end
+end

data/lib/gris/middleware/app_monitor.rb ADDED

@@ -0,0 +1,17 @@
+module Gris
+  class Middleware
+    class AppMonitor
+      def initialize(app)
+        @app = app
+      end
+      def call(env)
+        if ['/health', '/health.json'].include? env['PATH_INFO']
+          [200, { 'Content-type' => 'application/json' }, [Gris::Identity.health.to_json]]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/gris/output_formatters/paginated_presenter.rb ADDED

@@ -0,0 +1,41 @@
+module Gris
+  module PaginatedPresenter
+    def self.included(base)
+      base.class_eval do
+        include Gris::Presenter
+        property :total_count
+        property :total_pages
+        property :current_page
+        property :next_page
+        property :prev_page
+        link :self do |opts|
+          "#{request_url(opts)}?#{query_string_for_page(represented.current_page, opts)}"
+        end
+        link :next do |opts|
+          "#{request_url(opts)}?#{query_string_for_page(represented.next_page, opts)}" if represented.next_page
+        end
+        link :prev do |opts|
+          "#{request_url(opts)}?#{query_string_for_page(represented.prev_page, opts)}" if represented.prev_page
+        end
+        private
+        def request_url(opts)
+          request = Grape::Request.new(opts[:env])
+          "#{request.base_url}#{opts[:env]['PATH_INFO']}"
+        end
+        # replace the page parameter in the query string
+        def query_string_for_page(page, opts)
+          qs = Rack::Utils.parse_nested_query(opts[:env]['QUERY_STRING'])
+          qs['page'] = page
+          qs.to_query
+        end
+      end
+    end
+  end
+end

data/lib/gris/output_formatters/presenter.rb ADDED

@@ -0,0 +1,15 @@
+require 'roar/representer'
+require 'roar/json'
+require 'roar/json/hal'
+module Gris
+  module Presenter
+    def self.included(base)
+      base.class_eval do
+        include Roar::JSON::HAL
+        include Roar::Hypermedia
+        include Grape::Roar::Representer
+      end
+    end
+  end
+end

data/lib/gris/rspec_extensions/response_helpers.rb ADDED

@@ -0,0 +1,57 @@
+module Gris
+  module RspecExtensions
+    module ResponseHelpers
+      def response_code
+        last_response.status
+      end
+      def response_body
+        last_response.body
+      end
+      def parsed_response
+        Hashie::Mash.new(JSON.parse(last_response.body))
+      end
+      def result
+        parsed_response
+      end
+      def embedded_results(klass)
+        parsed_response[:_embedded][klass.name.tableize.to_sym]
+      end
+      def embedded_results_count(klass)
+        embedded_results(klass).count
+      end
+      def expect_embedded_results_count_of(count, klass)
+        expect(embedded_results_count(klass)).to eq(count)
+      end
+      def first_embedded_result(klass)
+        embedded_results(klass).first
+      end
+      def embedded_result_with_id(id, klass)
+        embedded_results(klass).select { |r| r.id == id }.first
+      end
+      def links
+        parsed_response['_links']
+      end
+      def link_to_self
+        links['self']
+      end
+      def link_to_next
+        links['next']
+      end
+      def link_to_previous
+        links['prev']
+      end
+    end
+  end
+end

data/lib/gris/setup.rb ADDED

@@ -0,0 +1,17 @@
+require 'active_support'
+module Gris
+  class << self
+    def load_environment
+      Dotenv.load(Gris.env.test? ? '.env.test' : '.env')
+    end
+    def env
+      @_env ||= ActiveSupport::StringInquirer.new(ENV['RACK_ENV'] || 'development')
+    end
+    def env=(environment)
+      @_env = ActiveSupport::StringInquirer.new(environment)
+    end
+  end
+end

data/lib/gris/version.rb ADDED

@@ -0,0 +1,38 @@
+module Gris
+  VERSION = '0.0.2'
+  class Version
+    class << self
+      def next_major
+        next_level(:major)
+      end
+      def next_minor
+        next_level(:minor)
+      end
+      def next_patch
+        next_level(:patch)
+      end
+      def next_level(level)
+        fail 'Unidentified Level' unless [:major, :minor, :patch].include?(level)
+        parts = Gris::VERSION.split('.').map(&:to_i)
+        if level == :major
+          parts[0] += 1
+          significant_index = 1
+        end
+        if level == :minor
+          parts[1] += 1
+          significant_index = 2
+        end
+        if level == :patch
+          parts[2] += 1
+          significant_index = 3
+        end
+        parts.map.with_index { |_p, i| parts[i] = 0 if i >= significant_index }
+        parts.join('.')
+      end
+    end
+  end
+end

data/lib/tasks/db.rake ADDED

@@ -0,0 +1,81 @@
+unless defined?(Rails)
+  task :environment do
+    require 'erb'
+    require './app'
+    fail 'ActiveRecord Not Found' unless Module.const_defined?(:ActiveRecord)
+  end
+  namespace :db do
+    desc 'Migrate the database through scripts in db/migrate. Target specific version with VERSION=x'
+    task migrate: :environment do
+      ActiveRecord::Migrator.migrate('db/migrate', ENV['VERSION'] ? ENV['VERSION'].to_i : nil)
+      Rake::Task['db:schema:dump'].invoke unless Gris.env.production?
+    end
+    desc 'Rollback to a previous migration. Go back multiple steps with STEP=x'
+    task rollback: :environment do
+      ActiveRecord::Migration.verbose = true
+      step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+      ActiveRecord::Migrator.rollback('db/migrate', step)
+    end
+    desc 'Create the database'
+    task create: :environment do
+      db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Gris.env]
+      options = {}.tap do |o|
+        o[:adapter] = db['adapter']
+        o[:database] = 'postgres' if db['adapter'] == 'postgresql'
+      end
+      ActiveRecord::Base.establish_connection(options)
+      ActiveRecord::Base.connection.create_database(db['database'])
+    end
+    desc 'Delete the database'
+    task drop: :environment do
+      db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Gris.env]
+      options = {}.tap do |o|
+        o[:adapter] = db['adapter']
+        o[:database] = 'postgres' if db['adapter'] == 'postgresql'
+      end
+      ActiveRecord::Base.establish_connection(options)
+      ActiveRecord::Base.connection.drop_database(db['database'])
+    end
+    desc 'Create the test database'
+    task reset: :environment do
+      Rake::Task['db:drop'].invoke
+      Rake::Task['db:create'].invoke
+      Rake::Task['db:schema:load'].invoke
+    end
+    namespace :schema do
+      desc 'Create a db/schema.rb file that can be portably used against any DB supported by AR'
+      task dump: :environment do
+        require 'active_record/schema_dumper'
+        File.open(ENV['SCHEMA'] || 'db/schema.rb', 'w') do |file|
+          ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+        end
+      end
+      desc 'Load a schema.rb file into the database'
+      task load: :environment do
+        file = ENV['SCHEMA'] || 'db/schema.rb'
+        db = YAML.load(ERB.new(File.read('./config/database.yml')).result)[Gris.env]
+        ActiveRecord::Base.establish_connection(db)
+        ActiveRecord::Schema.verbose = true
+        load(file)
+      end
+    end
+    desc 'Load the seed data from db/seeds.rb'
+    task seed: :environment do
+      ActiveRecord::Tasks::DatabaseTasks.seed_loader = Gris::ActiveRecordSeeder.new './db/seeds.rb'
+      ActiveRecord::Tasks::DatabaseTasks.load_seed
+    end
+  end
+end