gris 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f85d97c1f4ca0b9033d5ee37002fb6217991ff0
-  data.tar.gz: 78696b9f4b50e7b004a4895c3a1c295ec604804a
+  metadata.gz: 8e98e164c3934c02af0e32ffbee5f545cd58c7d8
+  data.tar.gz: 6260220164c8fbf9e56263fa810cb11940533904
 SHA512:
-  metadata.gz: a799d514738422209054b720e61282579d78b476f36688845f37d6b132a5044e618dd7fa7aeeb61bd8011d8ab1ae86bec87b0bbed20145a2074c01a3820bc827
-  data.tar.gz: 55814e34671b7cd39c1e581b0835700511c21e54391301628c9d30b5b2ae2f74585e3c6fd4643ab162c21ec7c46278c995ca10d74f64b1d28414f964effd4e0d
+  metadata.gz: bc2196d45fc7efb6850c5c70bdb8797d9ee4a8979df5d48590fae7e0310c80a2f244b41827b6eca8ffc3f35c0b55791fd967b75eb1c0fa4c9f40999dce38fa15
+  data.tar.gz: ad0394f1f83f04b373f3b955849c5111290b968658563725c91b6b6b16d89d44516b909f887192864ef28829374091db37f89ec914625e3dd45f1cf85fbc5486

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gris (0.0.2)
+    gris (0.0.3)
       activesupport (~> 4.2, >= 4.2.0)
       dotenv (~> 1.0.2, >= 1.0.2)
       git (~> 1.2, >= 1.2.8)

data/lib/gris.rb

@@ -11,10 +11,13 @@ require 'roar/json'
 require 'roar/json/hal'
 
 # require internal files
+require 'gris/application'
 require 'gris/deprecations'
 require 'gris/grape_extensions/crud_helpers'
+require 'gris/grape_extensions/error_helpers'
+require 'gris/grape_extensions/authentication_helpers'
 require 'gris/identity'
-require 'gris/middleware/app_monitor'
+require 'gris/middleware/health'
 require 'gris/output_formatters/paginated_presenter'
 require 'gris/output_formatters/presenter'
 require 'gris/setup'
@@ -25,13 +28,3 @@ if defined?(Rake)
   load 'tasks/routes.rake'
   load 'tasks/db.rake'
 end
-
-module Gris
-  class << self
-    def initialize
-      Gris::Deprecations.initialization_checks
-    end
-  end
-end
-
-Gris.initialize

data/lib/gris/{generators/templates/scaffold/app.rb → application.rb}

@@ -1,44 +1,31 @@
-# load bundler
-require 'bundler/setup'
-Bundler.setup(:default)
+require 'active_support/configurable'
 
-require 'gris/setup'
-Bundler.require(:default, Gris.env.to_sym)
-require 'gris'
+module Gris
+  class Application
+    include ActiveSupport::Configurable
+    config_accessor :use_health_middleware
 
-# load environment
-Gris.load_environment
-
-# autoload initalizers
-Dir['./config/initializers/**/*.rb'].map { |file| require file }
-
-# load middleware configs
-Dir['./config/middleware/**/*.rb'].map { |file| require file }
-
-# autoload app
-relative_load_paths = %w(app/apis app/presenters app/models app/workers lib)
-ActiveSupport::Dependencies.autoload_paths += relative_load_paths
-
-module Application
-  class Service
     def initialize
+      Gris::Deprecations.initialization_checks
       @filenames = ['', '.html', 'index.html', '/index.html']
       @rack_static = ::Rack::Static.new(
-        -> { [404, {}, []] },
-        root: File.expand_path('../public', __FILE__),
-        urls: ['/']
+          -> { [404, {}, []] },
+          root: File.expand_path('../public', __FILE__),
+          urls: ['/']
         )
     end
 
-    def self.instance
+    def self.instance(config = {})
       @instance ||= Rack::Builder.new do
+        use ActiveRecord::ConnectionAdapters::ConnectionManagement
+        use Gris::Middleware::Health unless config[:use_health_middleware] == false
         use Rack::Cors do
           allow do
             origins '*'
             resource '*', headers: :any, methods: :get
           end
         end
-        run Application::Service.new
+        run Gris::Application.new
       end.to_app
     end
 

data/lib/gris/application/configuration.rb

@@ -0,0 +1,16 @@
+module Gris
+  class Application
+    class Configuration
+      attr_accessor :use_app_monitor
+
+      def initialize(*)
+        super
+        @use_app_monitor = false
+      end
+
+      def app_monitor
+        puts "@use_app_monitor: #{@use_app_monitor}"
+      end
+    end
+  end
+end

data/lib/gris/generators/api_generator.rb

@@ -19,12 +19,43 @@ module Gris
         '.'
       end
 
+      def append_endpoint_to_application_endpoint
+        say 'Mounting new endpoint on ApplicationEndpoint.'
+        insert_into_file './app/endpoints/application_endpoint.rb', after: "# Additional mounted endpoints\n" do
+          text =  "  mount #{name.classify.pluralize}Endpoint\n"
+          text
+        end
+      end
+
+      def append_endpoint_links_to_root_presenter
+        say 'Appending links to RootPresenter.'
+        insert_into_file './app/presenters/root_presenter.rb', after: "# Additional endpoint links\n" do
+          text =  "\n"
+          text << "  link :#{name_tableize} do |opts|\n"
+          text << "    {\n"
+          text << '      href: "#{base_url(opts)}/'
+          text << "#{name_tableize}{?page,size}\",\n"
+          text << "      templated: true\n"
+          text << "    }\n"
+          text << "  end\n"
+          text << "\n"
+          text << "  link :#{name_underscore} do |opts|\n"
+          text << "    {\n"
+          text << '      href: "#{base_url(opts)}/'
+          text << "#{name_tableize}{id}\",\n"
+          text << "      templated: true\n"
+          text << "    }\n"
+          text << "  end\n"
+          text << "\n"
+          text
+        end
+      end
+
       def api
         self.class.source_root "#{File.dirname(__FILE__)}/templates/api"
         say 'Generating api...'
         directory '.', output_directory
         say 'API files created!', :green
-        say 'Note that you will need to mount this new endpoint in your ApplicationEndpoint.', :green
       end
     end
   end

data/lib/gris/generators/templates/scaffold/.env.test.tt

@@ -9,3 +9,4 @@ DATABASE_PASSWORD=''
 DATABASE_HOST=localhost
 DATABASE_NAME=<%= app_name.underscore %>_test
 BASE_URL=http://127.0.0.1:9393
+PERMITTED_TOKENS=["replace-me"]

data/lib/gris/generators/templates/scaffold/.env.tt

@@ -8,3 +8,4 @@ DATABASE_PASSWORD=''
 DATABASE_HOST=localhost
 DATABASE_NAME=<%= app_name.underscore %>_development
 BASE_URL=http://127.0.0.1:9292
+PERMITTED_TOKENS=["replace-me"]

data/lib/gris/generators/templates/scaffold/Rakefile

@@ -3,7 +3,7 @@ require 'gris/setup'
 require 'dotenv'
 Gris.load_environment
 
-require './app'
+require File.expand_path('../config/application.rb', __FILE__)
 require 'json'
 
 Dir.glob('./lib/tasks/*.rake').each { |r| import r }

data/lib/gris/generators/templates/scaffold/app/endpoints/application_endpoint.rb

@@ -0,0 +1,22 @@
+class ApplicationEndpoint < Grape::API
+  format :json
+  formatter :json, Grape::Formatter::Roar
+
+  helpers do
+    include Gris::AuthenticationHelpers
+  end
+
+  # Adds a simple environment variable based
+  # token authentication scheme to your endpoints.
+  # Alternatively, this token_authentication!
+  # method can be added to inddividual endpoints.
+  #
+  before do
+    token_authentication!
+  end
+
+  desc 'Get the Root API Endpoint'
+  get do
+    present self, with: RootPresenter
+  end
+end

data/lib/gris/generators/templates/scaffold/app/presenters/root_presenter.rb

@@ -1,7 +1,5 @@
 module RootPresenter
-  include Roar::JSON::HAL
-  include Roar::Hypermedia
-  include Grape::Roar::Representer
+  include Gris::Presenter
 
   link :self do |opts|
     "#{base_url(opts)}"

data/lib/gris/generators/templates/scaffold/config.ru.tt

@@ -1,6 +1,3 @@
-require './app'
+require File.expand_path('../config/application.rb', __FILE__)
 
-use ActiveRecord::ConnectionAdapters::ConnectionManagement
-use Gris::Middleware::AppMonitor
-
-run Application::Service.instance
+run <%= app_name.classify %>::Application.instance

data/lib/gris/generators/templates/scaffold/config/application.rb.tt

@@ -0,0 +1,11 @@
+require File.expand_path('../boot', __FILE__)
+
+module <%= app_name.classify %>
+  class Application < Gris::Application
+    # config.use_health_middleware = false
+
+    def self.instance(*)
+      super(config)
+    end
+  end
+end

data/lib/gris/generators/templates/scaffold/config/boot.rb

@@ -0,0 +1,16 @@
+# load bundler
+require 'bundler/setup'
+Bundler.setup(:default)
+
+require 'gris/setup'
+Bundler.require(:default, Gris.env.to_sym)
+
+# load environment
+Gris.load_environment
+
+# autoload initalizers
+Dir['./config/initializers/**/*.rb'].map { |file| require file }
+
+# autoload app
+relative_load_paths = %w(app/endpoints app/presenters app/models)
+ActiveSupport::Dependencies.autoload_paths += relative_load_paths

data/lib/gris/generators/templates/scaffold/spec/{apis → endpoints}/cors_spec.rb

@@ -5,6 +5,7 @@ describe Application::Service do
 
   context 'CORS' do
     include_context 'with a running app'
+    include_context 'with token authorization'
     it 'supports options' do
       options '/', {},
               'HTTP_ORIGIN' => 'http://cors.example.com',

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

@@ -4,7 +4,8 @@ require 'webmock/rspec'
 require 'rack/test'
 require 'gris/rspec_extensions/response_helpers'
 
-require './app'
+require File.expand_path('../../config/application', __FILE__)
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir['./spec/support/**/*.rb'].each { |f| require f }

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

@@ -0,0 +1,10 @@
+shared_context 'with a running app' do
+  let(:app) { <%= app_name.classify %>::Application.instance }
+end
+
+shared_context 'with token authorization' do
+  before(:each) do
+    permitted_token = ENV['PERMITTED_TOKENS'].dup.gsub!(/[\[\]]/,'').split(/\s*,\s*/).first if ENV['PERMITTED_TOKENS']
+    header 'Http-Authorization', permitted_token
+  end
+end

data/lib/gris/grape_extensions/authentication_helpers.rb

@@ -0,0 +1,21 @@
+module Gris
+  module AuthenticationHelpers
+    def token_authentication!
+      error!('Forbidden', 401) unless permit_by_headers || permit_by_params
+    end
+
+    private
+
+    def permit_by_headers
+      permitted_tokens.include? request.headers['Http-Authorization'] if request.headers['Http-Authorization']
+    end
+
+    def permit_by_params
+      permitted_tokens.include? params[:token] if params[:token]
+    end
+
+    def permitted_tokens
+      ENV['PERMITTED_TOKENS']
+    end
+  end
+end

data/lib/gris/grape_extensions/error_helpers.rb

@@ -0,0 +1,10 @@
+module Gris
+  module ErrorHelpers
+    def error!(message, status, options = nil)
+      message = { error: message }.merge(options.is_a?(String) ? { text: options } : options) if options
+      throw :error, message: message, status: status
+    end
+
+    Grape::Endpoint.send :include, self if defined?(Grape)
+  end
+end

data/lib/gris/middleware/{app_monitor.rb → health.rb}

@@ -1,6 +1,6 @@
 module Gris
   class Middleware
-    class AppMonitor
+    class Health
       def initialize(app)
         @app = app
       end

data/lib/gris/public/errors/404.html

@@ -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/public/errors/500.html

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

@@ -1,5 +1,5 @@
 module Gris
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   class Version
     class << self

data/lib/tasks/db.rake

@@ -1,7 +1,7 @@
 unless defined?(Rails)
   task :environment do
     require 'erb'
-    require './app'
+    require './config/application.rb'
 
     fail 'ActiveRecord Not Found' unless Module.const_defined?(:ActiveRecord)
   end

data/spec/generators/api_generator_spec.rb

@@ -12,7 +12,7 @@ describe Gris::Generators::ApiGenerator do
 
   describe 'app' do
     it 'creates an endpoint class' do
-      expected_api_file = File.join(generator_tmp_directory, 'app/apis/foos_endpoint.rb')
+      expected_api_file = File.join(generator_tmp_directory, 'app/endpoints/foos_endpoint.rb')
       api_code = File.read(expected_api_file)
       expect(api_code).to match(/class FoosEndpoint/)
     end
@@ -56,7 +56,7 @@ describe Gris::Generators::ApiGenerator do
 
   describe 'spec' do
     it 'creates an api spec' do
-      expected_api_file = File.join(generator_tmp_directory, 'spec/apis/foos_endpoint_spec.rb')
+      expected_api_file = File.join(generator_tmp_directory, 'spec/endpoints/foos_endpoint_spec.rb')
       api_code = File.read(expected_api_file)
       expect(api_code).to match(/describe FoosEndpoint/)
     end

data/spec/generators/scaffold_generator_spec.rb

@@ -41,9 +41,9 @@ describe Gris::Generators::ScaffoldGenerator do
       expect(env_file).to match(/#{app_name}_development/)
     end
 
-    it 'creates a .Procfile file with puma ' do
-      expect(File).to exist("#{app_path}/.Procfile")
-      env_file = File.read("#{app_path}/.Procfile")
+    it 'creates a Procfile file with puma ' do
+      expect(File).to exist("#{app_path}/Procfile")
+      env_file = File.read("#{app_path}/Procfile")
       expect(env_file).to match(/web: bundle exec puma/)
     end
 
@@ -69,11 +69,11 @@ describe Gris::Generators::ScaffoldGenerator do
     end
 
     it 'generates an application endpoint' do
-      expect(File).to exist("#{app_path}/app/apis/application_endpoint.rb")
+      expect(File).to exist("#{app_path}/app/endpoints/application_endpoint.rb")
     end
 
     context 'application_endpoint' do
-      let(:application_api_file) { File.read("#{app_path}/app/apis/application_endpoint.rb") }
+      let(:application_api_file) { File.read("#{app_path}/app/endpoints/application_endpoint.rb") }
 
       it 'the application endpoint inherits from Grape::API' do
         expect(application_api_file).to match(/class ApplicationEndpoint < Grape::API/)
@@ -103,16 +103,8 @@ describe Gris::Generators::ScaffoldGenerator do
         expect(root_presenter_file).to match(/module RootPresenter/)
       end
 
-      it 'includes Grape::Roar::Representer' do
-        expect(RootPresenter).to include(Grape::Roar::Representer)
-      end
-
-      it 'includes Roar::Hypermedia' do
-        expect(RootPresenter).to include(Roar::Hypermedia)
-      end
-
-      it 'includes Roar::JSON::HAL' do
-        expect(RootPresenter).to include(Roar::JSON::HAL)
+      it 'includes Gris::Presenter' do
+        expect(RootPresenter).to include(Gris::Presenter)
       end
     end
   end

data/spec/grape_extensions/error_helpers_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'gris/grape_extensions/error_helpers'
+
+describe Gris::ErrorHelpers do
+  before do
+    @helper = SpecApiErrorHelper.new
+  end
+  context 'error with text' do
+    it 'does not wrap a grape error without text' do
+      @helper.error!('error', 400)
+      expect(@helper.message).to eq(message: 'error', status: 400)
+      expect(@helper.thrown).to eq(:error)
+    end
+    it 'wraps a grape error with text' do
+      @helper.error!('error', 400, 'text')
+      expect(@helper.message).to eq(message: { error: 'error', text: 'text' }, status: 400)
+      expect(@helper.thrown).to eq(:error)
+    end
+  end
+end

data/spec/support/spec_api_error_helper.rb

@@ -0,0 +1,11 @@
+class SpecApiErrorHelper
+  include Gris::ErrorHelpers
+
+  attr_accessor :message
+  attr_accessor :thrown
+
+  def throw(thrown, message)
+    @message = message
+    @thrown = thrown
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gris
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dylan Fareed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -334,6 +334,8 @@ files:
 - bin/gris
 - gris.gemspec
 - lib/gris.rb
+- lib/gris/application.rb
+- lib/gris/application/configuration.rb
 - lib/gris/cli.rb
 - lib/gris/deprecations.rb
 - lib/gris/deprecations/gris_setup.rb
@@ -341,16 +343,15 @@ files:
 - lib/gris/generators/api_generator.rb
 - lib/gris/generators/migration_generator.rb
 - lib/gris/generators/scaffold_generator.rb
-- lib/gris/generators/templates/api/app/apis/%name_tableize%_endpoint.rb.tt
+- lib/gris/generators/templates/api/app/endpoints/%name_tableize%_endpoint.rb.tt
 - lib/gris/generators/templates/api/app/models/%name_underscore%.rb.tt
 - lib/gris/generators/templates/api/app/presenters/%name_tableize%_presenter.rb.tt
 - lib/gris/generators/templates/api/app/presenters/%name_underscore%_presenter.rb.tt
-- lib/gris/generators/templates/api/spec/apis/%name_tableize%_endpoint_spec.rb.tt
+- lib/gris/generators/templates/api/spec/endpoints/%name_tableize%_endpoint_spec.rb.tt
 - lib/gris/generators/templates/api/spec/fabricators/%name_tableize%_fabricator.rb.tt
 - lib/gris/generators/templates/api/spec/models/%name_underscore%_spec.rb.tt
 - lib/gris/generators/templates/create_table_migration/%migration_filename%.rb.tt
 - lib/gris/generators/templates/migration/%migration_filename%.rb.tt
-- lib/gris/generators/templates/scaffold/.Procfile.tt
 - lib/gris/generators/templates/scaffold/.env.test.tt
 - lib/gris/generators/templates/scaffold/.env.tt
 - lib/gris/generators/templates/scaffold/.gitignore.tt
@@ -359,25 +360,31 @@ files:
 - lib/gris/generators/templates/scaffold/.ruby-gemset.tt
 - lib/gris/generators/templates/scaffold/.ruby-version.tt
 - lib/gris/generators/templates/scaffold/Gemfile.tt
+- lib/gris/generators/templates/scaffold/Procfile
 - lib/gris/generators/templates/scaffold/README.md.tt
 - lib/gris/generators/templates/scaffold/Rakefile
-- lib/gris/generators/templates/scaffold/app.rb
-- lib/gris/generators/templates/scaffold/app/apis/application_endpoint.rb
+- lib/gris/generators/templates/scaffold/app/endpoints/application_endpoint.rb
 - lib/gris/generators/templates/scaffold/app/presenters/root_presenter.rb
 - lib/gris/generators/templates/scaffold/config.ru.tt
+- lib/gris/generators/templates/scaffold/config/application.rb.tt
+- lib/gris/generators/templates/scaffold/config/boot.rb
 - lib/gris/generators/templates/scaffold/config/database.yml.tt
 - lib/gris/generators/templates/scaffold/config/initializers/active_record.rb
 - lib/gris/generators/templates/scaffold/db/schema.rb
 - lib/gris/generators/templates/scaffold/public/errors/404.html
 - lib/gris/generators/templates/scaffold/public/errors/500.html
-- lib/gris/generators/templates/scaffold/spec/apis/cors_spec.rb
+- lib/gris/generators/templates/scaffold/spec/endpoints/cors_spec.rb
 - lib/gris/generators/templates/scaffold/spec/spec_helper.rb
-- lib/gris/generators/templates/scaffold/spec/support/app_helper.rb
+- lib/gris/generators/templates/scaffold/spec/support/app_helper.rb.tt
+- lib/gris/grape_extensions/authentication_helpers.rb
 - lib/gris/grape_extensions/crud_helpers.rb
+- lib/gris/grape_extensions/error_helpers.rb
 - lib/gris/identity.rb
-- lib/gris/middleware/app_monitor.rb
+- lib/gris/middleware/health.rb
 - lib/gris/output_formatters/paginated_presenter.rb
 - lib/gris/output_formatters/presenter.rb
+- lib/gris/public/errors/404.html
+- lib/gris/public/errors/500.html
 - lib/gris/rspec_extensions/response_helpers.rb
 - lib/gris/setup.rb
 - lib/gris/version.rb
@@ -387,8 +394,10 @@ files:
 - spec/generators/migration_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
 - spec/grape_extensions/crud_helpers_spec.rb
+- spec/grape_extensions/error_helpers_spec.rb
 - spec/identity_spec.rb
 - spec/spec_helper.rb
+- spec/support/spec_api_error_helper.rb
 - spec/support/spec_generators_helper.rb
 - spec/version_spec.rb
 homepage: http://github.com/dylanfareed/gris/
@@ -411,7 +420,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple api microservice generator.
@@ -420,7 +429,9 @@ test_files:
 - spec/generators/migration_generator_spec.rb
 - spec/generators/scaffold_generator_spec.rb
 - spec/grape_extensions/crud_helpers_spec.rb
+- spec/grape_extensions/error_helpers_spec.rb
 - spec/identity_spec.rb
 - spec/spec_helper.rb
+- spec/support/spec_api_error_helper.rb
 - spec/support/spec_generators_helper.rb
 - spec/version_spec.rb

data/lib/gris/generators/templates/scaffold/app/apis/application_endpoint.rb

@@ -1,9 +0,0 @@
-class ApplicationEndpoint < Grape::API
-  format :json
-  formatter :json, Grape::Formatter::Roar
-
-  desc 'Get the Root API Endpoint'
-  get do
-    present self, with: RootPresenter
-  end
-end

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

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