grape_ape_rails 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89bad81f1ef60d0be3b4f853574c8074cb8d4146
+  data.tar.gz: 2bd838b6accee93b10c03222b79812e2f8c79dcc
+SHA512:
+  metadata.gz: 37e00989c6ebfaa0d198cbec297d31b785e67a7814e9fc92c4a65073ef7197dfd19bae8549ae5fa45da9de7fb1dc233d7e712b6699bfed9423b229c0b768f5f2
+  data.tar.gz: ab3e091b4de17060f961a596293eaed147d46df39d685896b7c23f0795f5980b1469aace37a65446fe072ac649c60463815bb8aa2586914e412a88a965a4220b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/dummy/log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+grape-ape-rails

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt E. Patterson
+
+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,29 @@
+# GrapeApeRails
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape_ape_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_ape_rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/grape_ape_rails/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 new Pull Request

data/Rakefile

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

data/grape_ape_rails.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape_ape_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape_ape_rails"
+  spec.version       = GrapeApeRails::VERSION
+  spec.authors       = ["Matt E. Patterson"]
+  spec.email         = ["madraziel@gmail.com"]
+  spec.summary       = %q{Provides customized Grape API functionality inside Rails}
+  spec.description   = %q{Provides customized Grape API functionality inside Rails}
+  spec.homepage      = ""
+  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_dependency 'activesupport'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'oj'
+  spec.add_dependency "grape", "0.8.0"
+  spec.add_dependency 'grape-rabl'
+  spec.add_dependency 'grape-kaminari'
+  spec.add_dependency 'grape-rails-cache'
+  spec.add_dependency 'kramdown'
+  spec.add_dependency 'grape-active_model_serializers'
+  spec.add_dependency 'http_accept_language'
+  spec.add_dependency 'rabl'
+  spec.add_dependency 'hashie_rails'
+
+  spec.add_development_dependency "rails", "~> 4.1"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "rspec-rails", '~> 3.0.0'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock'
+end

data/lib/generators/setup_generator.rb

@@ -0,0 +1,59 @@
+require 'digest'
+module GrapeApeRails
+  module Generators
+    DEFAULT_TILT_ROOT = "app/views/api"
+
+    class SetupGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Sets up GrapeApeRails for your application"
+
+      def create_initializer
+        say "\n\nCreating an initializer..."
+        say ("-"*80)
+        org_name = ask("Provide a name for your organization (all lowercase please):")
+        if org_name.blank?
+          say_status "error", "You must provide an organization name!", :red
+          exit
+        end
+        app_name = ask("Provide a name for this app (all lowercase please):")
+        if app_name.blank?
+          say_status "error", "You must provide a name for the app!", :red
+          exit
+        end
+        api_key = ask("Provide the primary API Secret Key (leave blank and I'll create one for you):")
+        if api_key.blank?
+          api_key = Digest::SHA256.hexdigest("#{app_name}#{Time.now.to_f.to_s}")
+        end
+        copy_file "initializer.rb", "config/initializers/grape_ape_rails.rb"
+        gsub_file "config/initializers/grape_ape_rails.rb", '%%ORGNAME%%', org_name.downcase, verbose: false
+        gsub_file "config/initializers/grape_ape_rails.rb", '%%APPNAME%%', app_name.downcase, verbose: false
+        gsub_file "config/initializers/grape_ape_rails.rb", '%%APIKEY%%', api_key, verbose: false
+      end
+
+      def configure_tilt_root
+        say "\n\nConfiguring Tilt for RABL templates..."
+        say ("-"*80)
+
+        if yes?("Will you be using RABL templates? (y/n)")
+          tilt_root = ask("What will be your RABL templates' root directory (default: #{DEFAULT_TILT_ROOT})?")
+          tilt_root = DEFAULT_TILT_ROOT if tilt_root.blank?
+          tilt_root = tilt_root[1..-1] if tilt_root[0] == '/'
+          say_status "modified", "config/application.rb", :green
+          say_status "NOTE", "Added a Rack::Config middleware block. You might have to move this around later once you start adding more stuff to your application.rb. It should generally be at the end.", :white
+        else
+          tilt_root = DEFAULT_TILT_ROOT
+          say_status "NOTE", "We'll set the default in case you want to use RABL later. You can always change it in application.rb", :white
+          say_status "modified", "config/application.rb", :green
+        end
+        application do
+          <<-RUBY.gsub(/^ {4}/, '')
+    config.middleware.use(Rack::Config) do |env|
+          env['api.tilt.root'] = Rails.root.join "#{tilt_root}"
+        end
+          RUBY
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,22 @@
+GrapeApeRails.configure do |config|
+  config.app_name = "%%APPNAME%%"
+  config.organization_name = "&&ORGNAME&&"
+  config.api_secret_key = "%%APIKEY%%"
+  # config.api_header_security_enabled = true
+  # config.api_security_algorithm = "sha256"
+  # config.security_envelope_debug = false
+  config.available_locales = %i[ en ]
+end
+
+# Subscribe to grape request and log with Rails.logger
+ActiveSupport::Notifications.subscribe('grape.request') do |name, starts, ends, notification_id, payload|
+  api_version = payload[:api_version] ? "[#{payload[:api_version]}]" : nil
+  Rails.logger.info "[API]%s %s %s (%.3f ms) -> %s %s" % [
+    api_version,
+    payload[:request_method],
+    payload[:request_path],
+    (ends-starts)*1000,
+    (payload[:response_status] || "error"),
+    payload[:params] ? "| #{payload[:params].inspect}" : ""
+  ]
+end

data/lib/grape_ape_rails/api.rb

@@ -0,0 +1,88 @@
+require 'grape'
+require 'grape-kaminari'
+require 'grape-rails-cache'
+require 'swagger/grape_swagger_modified'
+require 'hashie_rails' if defined?(::Rails)
+require 'http_accept_language'
+require 'grape_ape_rails/base'
+require 'grape_ape_rails/handlers/header_versioning'
+require 'grape_ape_rails/handlers/rails_logging'
+
+
+module GrapeApeRails
+  class API < Grape::API
+
+    def self.api_keys_map
+      @api_keys_map ||= {}
+    end
+
+    def self.api_version_cascades_map
+      @api_version_cascades ||= {}
+    end
+
+    def self.api_secret_key
+      @api_secret_key
+    end
+
+    def self.api_secret_key=(val)
+      @api_secret_key = val
+    end
+
+    def API.grape_apis(&block)
+      res = yield
+      include GrapeApeRails::Base
+      res
+    end
+
+    # args:
+    #   [0] => version name (e.g. 'v1')
+    #   [1] => (optional) an array of cascades (e.g. ['V2', 'V1'])
+    def API.api(name, *args, &block)
+      puts "Spinning up Grape API: #{name} ..."
+      @gar_api_version = name
+      mounts_klass = Class.new(GrapeApeRails::API)
+      klass = GrapeApeRails.const_set("#{name}Base", mounts_klass)
+      api_key = GrapeApeRails.configuration.api_secret_key
+      api_key = args[0] if args[0].present? && args[0].is_a?(String)
+
+      api_version = name.underscore.gsub('_','.')
+      if args[0].present? && args[0].is_a?(Array)
+        GrapeApeRails::API.api_version_cascades_map.merge!({ api_version => args[0].map{ |v| v.underscore.gsub('_','.') } })
+      elsif args[1].present? && args[1].is_a?(Array)
+        GrapeApeRails::API.api_version_cascades_map.merge!({ api_version => args[1].map{ |v| v.underscore.gsub('_','.') } })
+      end
+      dotname = name.underscore.gsub('_','.')
+      GrapeApeRails::API.api_keys_map.merge!({ dotname => api_key })
+      yield
+      mount mounts_klass
+    ensure
+      puts "Swaggering #{api_version} endpoints..."
+      klass.add_swagger_documentation hide_documentation_path: true,
+                                api_version: api_version.gsub('.','_'),
+                                mount_with_version: true,
+                                mount_path: "/api/docs"
+    end
+
+    def API.grape_mount(resource)
+      mounts_klass = "GrapeApeRails::#{@gar_api_version}Base".constantize
+      name = "API::#{@gar_api_version}::#{resource.to_s.camelize}"
+      puts "  endpoints: #{name}"
+      mounts_klass.send(:mount, name.constantize)
+    rescue NameError => e
+      puts "    [ERROR] Could not instantiate API Endpoints at '#{name}'. Maybe you still need to create the class file?"
+    end
+
+  end
+end
+
+class Grape::Endpoint
+  def error!(message, status = nil, headers = nil)
+    if defined?(::Rails) && Rails.respond_to?(:logger)
+      api_version = "[#{env['rack.routing_args'][:route_info].route_version}]" rescue nil
+      Rails.logger.warn "[API]#{api_version} Responding with #{status} #{message}"
+    end
+    status = settings[:default_error_status] unless status
+    throw :error, message: message, status: status, headers: headers
+  end
+end
+

data/lib/grape_ape_rails/base.rb

@@ -0,0 +1,27 @@
+require 'grape'
+require 'http_accept_language'
+
+module GrapeApeRails
+  module Base
+
+    extend ActiveSupport::Concern
+
+    included do
+      use ::GrapeApeRails::Handlers::RailsLogging
+
+      ['/health', '/'].each do |route|
+        get route do
+          status 200
+          nil
+        end
+      end
+
+      # global exception handler, used for error notifications
+      rescue_from :all do |e|
+        error_response(message: { error: { code: "INTERNAL_SERVER_ERROR", message: e.message } }, status: 500)
+      end
+
+    end
+
+  end
+end

data/lib/grape_ape_rails/handlers/formatters.rb

@@ -0,0 +1,134 @@
+require 'tilt'
+require 'rabl'
+require 'grape-active_model_serializers'
+
+Rabl.configure do |config|
+  config.include_json_root = false
+end
+Rabl.register!
+
+module Grape
+  module Formatter
+    module GarJsonSerializer
+      def self.call(resource, env)
+        MultiJson.dump({ result: resource })
+      end
+    end
+
+
+    module GarError
+      def self.call(message, backtrace, options, env)
+        err = { error: { code: 'ERROR', message: message } }
+        if message.is_a?(Hash) && message[:code].present? && message[:message].present?
+          full_msg = "[#{message[:code]}] #{message[:message]}"
+          err = { error: { code: message[:code], message: full_msg } }
+          err[:error].merge!({ data: message[:data] }) if message[:data].present?
+        elsif message.respond_to?(:error_code) && message.respond_to?(:message)
+          full_msg = "[#{message.error_code}] #{message.message}"
+          err = { error: { code: message.error_code, message: full_msg } }
+        end
+        MultiJson.dump err
+      end
+    end
+
+    module GarActiveModelSerializers
+      def self.call(resource, env)
+        if serializer = Grape::Formatter::ActiveModelSerializers.fetch_serializer(resource, env)
+          single = serializer.try(:resource_singular) || serializer.object.class.name.underscore
+          plural = serializer.try(:resource_plural) || serializer.object.class.name.underscore.pluralize
+          hash = serializer.as_json
+          output = if hash[single].present?
+            hash[single].is_a?(Array) ? hash[single] : [hash[single]]
+          else
+            hash.is_a?(Array) ? hash : [hash]
+          end
+          template = MultiJson.dump({ result: { plural => "***" } })
+          template.gsub(%Q("***"), MultiJson.dump(output))
+        else
+          Grape::Formatter::GarJsonSerializer.call serializer.object, env
+        end
+      end
+    end
+
+    module GarRabl
+      class << self
+        attr_reader :env
+        attr_reader :endpoint
+
+        def call(object, env)
+          @env = env
+          @endpoint = env['api.endpoint']
+          if rablable?
+            rabl do |template|
+              engine = ::Tilt.new(view_path(template), tilt_options)
+              output = engine.render endpoint, {}
+              output = wrap_output(output)
+              if layout_template
+                layout_template.render(endpoint) { output }
+              else
+                output
+              end
+            end
+          else
+            Grape::Formatter::GarJsonSerializer.call object, env
+          end
+        end
+
+        private
+
+        def wrap_output(output)
+          # root_resource = endpoint.route.route_namespace.gsub('/','').pluralize
+          template = MultiJson.dump({ result: "***" })
+          # output = "[#{output}]" if output[0] != '[' && output[-1] != ']'
+          template.gsub(%Q("***"), output)
+        end
+
+        def view_path(template)
+          # api_version = endpoint.route.route_version || '.'
+          if template.split('.')[-1] == 'rabl'
+            File.join(env['api.tilt.root'], template)
+          else
+            File.join(env['api.tilt.root'], (template + '.rabl'))
+          end
+        end
+
+        def rablable?
+          !!endpoint.options[:route_options][:rabl]
+        end
+
+        def rabl
+          template = endpoint.options[:route_options][:rabl]
+          fail 'missing rabl template' unless template
+          set_view_root unless env['api.tilt.root']
+          yield template
+        end
+
+        def set_view_root
+          fail "Use Rack::Config to set 'api.tilt.root' in config.ru"
+        end
+
+        def set_layouts_base
+          fail "Use Rack::Config to set 'api.title.layouts_base' in config.ru"
+        end
+
+        def tilt_options
+          { format: env['api.format'], view_path: env['api.tilt.root'] }
+        end
+
+        def layout_template
+          set_layouts_base unless env['api.tilt.layouts_base']
+          ver = env['rack.routing_args'][:route_info].route_version
+          layout_path = "#{env['api.tilt.layouts_base']}/#{ver}.json.haml"
+          if File.exist?(layout_path)
+            ::Tilt.new(layout_path, tilt_options.merge(format: :xhtml, ugly: true))
+          else
+            nil
+          end
+        rescue
+          nil
+        end
+      end
+    end
+
+  end
+end