RubyGems - ballast - Versions diffs - 2.2.4 → 2.2.5 - Mend

ballast 2.2.4 → 2.2.5

Files changed (86) hide show

checksums.yaml +4 -4
data/.rubocop.yml +6 -1
data/.travis-gemfile +2 -2
data/.travis.yml +5 -3
data/.yardopts +1 -1
data/CHANGELOG.md +9 -0
data/Gemfile +1 -1
data/LICENSE.md +21 -0
data/README.md +22 -17
data/Rakefile +1 -1
data/ballast.gemspec +1 -1
data/{doc → docs}/Ballast.html +19 -21
data/docs/Ballast/AjaxResponse.html +1470 -0
data/{doc → docs}/Ballast/Concerns.html +3 -3
data/{doc → docs}/Ballast/Concerns/AjaxHandling.html +33 -38
data/{doc → docs}/Ballast/Concerns/Common.html +45 -52
data/{doc → docs}/Ballast/Concerns/ErrorsHandling.html +13 -14
data/docs/Ballast/Concerns/JSONApi.html +127 -0
data/docs/Ballast/Concerns/JSONApi/PaginationHandling.html +617 -0
data/docs/Ballast/Concerns/JSONApi/RequestHandling.html +775 -0
data/docs/Ballast/Concerns/JSONApi/ResponseHandling.html +917 -0
data/{doc → docs}/Ballast/Concerns/View.html +35 -42
data/{doc → docs}/Ballast/Configuration.html +19 -22
data/{doc → docs}/Ballast/Emoji.html +1 -1
data/{doc → docs}/Ballast/Emoji/Character.html +15 -18
data/docs/Ballast/Emoji/Utils.html +794 -0
data/{doc → docs}/Ballast/Errors.html +1 -1
data/{doc → docs}/Ballast/Errors/Base.html +16 -18
data/{doc → docs}/Ballast/Errors/Failure.html +1 -1
data/{doc → docs}/Ballast/Errors/InvalidDomain.html +1 -1
data/{doc → docs}/Ballast/Errors/ValidationFailure.html +1 -1
data/{doc → docs}/Ballast/Middlewares.html +1 -1
data/{doc → docs}/Ballast/Middlewares/DefaultHost.html +16 -18
data/docs/Ballast/RequestDomainMatcher.html +917 -0
data/docs/Ballast/Service.html +1513 -0
data/docs/Ballast/Service/Response.html +1270 -0
data/{doc → docs}/Ballast/Version.html +5 -9
data/{doc → docs}/_index.html +45 -1
data/docs/class_list.html +58 -0
data/{doc → docs}/css/common.css +0 -0
data/{doc → docs}/css/full_list.css +0 -0
data/{doc → docs}/css/style.css +0 -0
data/{doc → docs}/file.README.html +7 -5
data/{doc → docs}/file_list.html +0 -0
data/{doc → docs}/frames.html +0 -0
data/{doc → docs}/index.html +7 -5
data/{doc → docs}/js/app.js +0 -0
data/{doc → docs}/js/full_list.js +0 -0
data/{doc → docs}/js/jquery.js +0 -0
data/{doc → docs}/method_list.html +150 -36
data/docs/top-level-namespace.html +149 -0
data/lib/ballast.rb +1 -1
data/lib/ballast/ajax_response.rb +1 -1
data/lib/ballast/concerns/ajax_handling.rb +1 -1
data/lib/ballast/concerns/common.rb +1 -1
data/lib/ballast/concerns/errors_handling.rb +1 -1
data/lib/ballast/concerns/json_api/pagination_handling.rb +83 -0
data/lib/ballast/concerns/json_api/request_handling.rb +235 -0
data/lib/ballast/concerns/json_api/response_handling.rb +70 -0
data/lib/ballast/concerns/view.rb +1 -1
data/lib/ballast/configuration.rb +1 -1
data/lib/ballast/emoji.rb +1 -1
data/lib/ballast/errors.rb +1 -1
data/lib/ballast/middlewares/default_host.rb +1 -1
data/lib/ballast/request_domain_matcher.rb +1 -1
data/lib/ballast/service.rb +1 -1
data/lib/ballast/version.rb +2 -2
data/spec/ballast/ajax_response_spec.rb +1 -1
data/spec/ballast/concerns/ajax_handling_spec.rb +1 -1
data/spec/ballast/concerns/common_spec.rb +1 -1
data/spec/ballast/concerns/errors_handling_spec.rb +1 -1
data/spec/ballast/concerns/view_spec.rb +1 -1
data/spec/ballast/configuration_spec.rb +1 -1
data/spec/ballast/errors_spec.rb +1 -1
data/spec/ballast/middlewares/default_host_spec.rb +1 -1
data/spec/ballast/request_domain_matcher_spec.rb +1 -1
data/spec/ballast_spec.rb +1 -1
data/spec/spec_helper.rb +1 -1
metadata +47 -39
data/doc/Ballast/AjaxResponse.html +0 -1478
data/doc/Ballast/Emoji/Utils.html +0 -799
data/doc/Ballast/RequestDomainMatcher.html +0 -923
data/doc/Ballast/Service.html +0 -1522
data/doc/Ballast/Service/Response.html +0 -1278
data/doc/class_list.html +0 -58
data/doc/top-level-namespace.html +0 -112

data/docs/top-level-namespace.html ADDED

@@ -0,0 +1,149 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+      <dt class="r1">Extended by:</dt>
+      <dd class="r1"><span class='object_link'><a href="Ballast/Emoji/Utils.html" title="Ballast::Emoji::Utils (module)">Ballast::Emoji::Utils</a></span></dd>
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><span class='object_link'><a href="Ballast/Emoji/Character.html" title="Ballast::Emoji::Character (module)">Ballast::Emoji::Character</a></span></dd>
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Ballast.html" title="Ballast (module)">Ballast</a></span>
+</p>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes included from <span class='object_link'><a href="Ballast/Emoji/Utils.html" title="Ballast::Emoji::Utils (module)">Ballast::Emoji::Utils</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Ballast/Emoji/Utils.html#url_mapper-instance_method" title="Ballast::Emoji::Utils#url_mapper (method)">#url_mapper</a></span></p>
+  <h2>Method Summary</h2>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Ballast/Emoji/Utils.html" title="Ballast::Emoji::Utils (module)">Ballast::Emoji::Utils</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Ballast/Emoji/Utils.html#enumerate-instance_method" title="Ballast::Emoji::Utils#enumerate (method)">enumerate</a></span>, <span class='object_link'><a href="Ballast/Emoji/Utils.html#replace-instance_method" title="Ballast::Emoji::Utils#replace (method)">replace</a></span>, <span class='object_link'><a href="Ballast/Emoji/Utils.html#replace_regex-instance_method" title="Ballast::Emoji::Utils#replace_regex (method)">replace_regex</a></span>, <span class='object_link'><a href="Ballast/Emoji/Utils.html#url_for-instance_method" title="Ballast::Emoji::Utils#url_for (method)">url_for</a></span></p>
+  <h3 class="inherited">Methods included from <span class='object_link'><a href="Ballast/Emoji/Character.html" title="Ballast::Emoji::Character (module)">Ballast::Emoji::Character</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="Ballast/Emoji/Character.html#image_tag-instance_method" title="Ballast::Emoji::Character#image_tag (method)">#image_tag</a></span>, <span class='object_link'><a href="Ballast/Emoji/Character.html#markup-instance_method" title="Ballast::Emoji::Character#markup (method)">#markup</a></span>, <span class='object_link'><a href="Ballast/Emoji/Character.html#url-instance_method" title="Ballast::Emoji::Character#url (method)">#url</a></span></p>
+</div>
+    <div id="footer">
+  Generated on Thu Aug 18 15:49:48 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.3.0).
+</div>
+  </body>
+</html>

data/lib/ballast.rb CHANGED

@@ -1,6 +1,6 @@
 #
 # This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
-# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
 #
 # PI: Ignore flog on this file.

data/lib/ballast/ajax_response.rb CHANGED

@@ -1,6 +1,6 @@
 #
 # This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
-# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
 #
 module Ballast

data/lib/ballast/concerns/ajax_handling.rb CHANGED

@@ -1,6 +1,6 @@
 #
 # This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
-# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
 #
 module Ballast

data/lib/ballast/concerns/common.rb CHANGED

@@ -1,6 +1,6 @@
 #
 # This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
-# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
 #
 module Ballast

data/lib/ballast/concerns/errors_handling.rb CHANGED

@@ -1,6 +1,6 @@
 #
 # This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
-# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
 #
 module Ballast

data/lib/ballast/concerns/json_api/pagination_handling.rb ADDED

@@ -0,0 +1,83 @@
+#
+# This file is part of the ballast gem. Copyright (C) 2013 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at https://choosealicense.com/licenses/mit.
+#
+module Ballast
+  module Concerns
+    module JSONApi
+      # A concern to handle errors. It requires the Ajax concern.
+      module PaginationHandling
+        # Paginates a collection.
+        #
+        # @param collection [ActiveRecord::Relation] The collection to handle.
+        # @param sort_field [Symbol] The field to sort on.
+        # @param sort_order [Symbol] The sorting order.
+        # return [ActiveRecord::Relation] A paginated and sorted collection.
+        def paginate(collection, sort_field: :id, sort_order: :desc)
+          direction = @cursor.direction
+          value = @cursor.value
+          # Apply the query
+          collection = apply_value(collection, value, sort_field, sort_order)
+          collection = collection.limit(@cursor.size).order(sprintf("%s %s", sort_field, sort_order.upcase))
+          # If we're fetching previous we reverse the order to make sure we fetch the results adiacents to the previous request,
+          # then we reverse results to ensure the order requested
+          if direction != "next"
+            collection = collection.reverse_order
+            collection = collection.reverse
+          end
+          collection
+        end
+        # Returns the field used for pagination.
+        #
+        # @return [Symbol] The field used for pagination.
+        def pagination_field
+          @pagination_field ||= :id
+        end
+        # Returns whether pagination should be skipped in templates rendering for JSON API.
+        #
+        # @return [Boolean] Whether pagination should be skipped.
+        def pagination_skip?
+          @skip_pagination
+        end
+        # Returns whether pagination is supported for the current set of objects for JSON API.
+        #
+        # @return [Boolean] Whether pagination is supported.
+        def pagination_supported?
+          @objects.respond_to?(:first) && @objects.respond_to?(:last)
+        end
+        # Returns a URL to get a specific page of the current set of objects.
+        #
+        # @param key [String] The page to get. Supported values are `next`, `prev`, `previous` and `first`.
+        # @return [String] A URL.
+        def pagination_url(key = nil)
+          exist = @cursor.might_exist?(key, @objects)
+          exist ? url_for(request.params.merge(page: @cursor.save(@objects, key, field: pagination_field)).merge(only_path: false)) : nil
+        end
+        private
+        # :nodoc:
+        def apply_value(collection, value, sort_field, sort_order)
+          if value
+            if cursor.use_offset
+              collection = collection.offset(value)
+            else
+              value = DateTime.parse(value, PaginationCursor::TIMESTAMP_FORMAT) if collection.columns_hash[sort_field.to_s].type == :datetime
+              collection = collection.where(sprintf("%s %s ?", sort_field, @cursor.operator(sort_order)), value)
+            end
+          end
+          collection
+        end
+      end
+    end
+  end
+end

data/lib/ballast/concerns/json_api/request_handling.rb ADDED

@@ -0,0 +1,235 @@
+module Ballast
+  module Concerns
+    # A concern to handle JSON API backends.
+    module JSONApi
+      # A concern to handle JSON API requests.
+      module RequestHandling
+        # The default JSON API Content-Type.
+        CONTENT_TYPE = "application/vnd.api+json".freeze
+        # Adds Cross Origin Request (CORS) headers.
+        def request_handle_cors
+          headers["Access-Control-Allow-Origin"] = Rails.env.development? ? "http://#{request_source_host}:4200" : Rails.application.secrets.cors_source
+          headers["Access-Control-Allow-Methods"] = "POST, GET, PUT, DELETE, OPTIONS"
+          headers["Access-Control-Allow-Headers"] = "Content-Type, X-User-Email, X-User-Token"
+          headers["Access-Control-Max-Age"] = 1.year.to_i.to_s
+        end
+        # Validates a request.
+        #
+        # @return [Object] The request data
+        def request_validate
+          content_type = request_valid_content_type
+          request.format = :json
+          response.content_type = content_type unless Rails.env.development? && params["json"]
+          @cursor = PaginationCursor.new(params, :page)
+          params[:data] ||= HashWithIndifferentAccess.new
+          validate_data(content_type)
+        end
+        # Returns the current source host.
+        #
+        # @return [String] The current source host.
+        def request_source_host
+          @api_source ||= URI.parse(request.url).host
+        end
+        # Returns the valid Content-Type for JSON API requests.
+        #
+        # @return [String] The valid Content-Type for JSON API requests.
+        def request_valid_content_type
+          Ballast::Concerns::JSONApi::RequestHandling::CONTENT_TYPE
+        end
+        # Extract a model attributes from request data
+        #
+        # @param target [Object] The target object.
+        # @param type_field [Symbol] The field of the request data which contains the data type.
+        # @param attributes_field [Object] The field of the request data which contains the data attributes.
+        # @param relationships_field [Object] The field of the request data which contains the data relationships.
+        # @return [Hash] The model attributes.
+        def request_extract_model(target, type_field: :type, attributes_field: :attributes, relationships_field: :relationships)
+          data = params[:data]
+          request_validate_model_type(target, data, type_field)
+          data = data[attributes_field]
+          fail_request!(:bad_request, "Missing attributes in the \"attributes\" field.") if data.blank?
+          # Extract attributes using strong parameters
+          data = unembed_relationships(validate_attributes(data, target), target, relationships_field)
+          # Extract relationships
+          data.merge!(validate_relationships(params[:data], target, relationships_field))
+          data
+        end
+        # Casts attributes according to the target object definitions.
+        #
+        # @param target [Object] The target object.
+        # @param attributes [Hash] The attributes to cast.
+        # @return [Hash] The casted attributes.
+        def request_cast_attributes(target, attributes)
+          types = target.class.column_types
+          attributes.each do |k, v|
+            request_cast_attribute(target, attributes, types, k, v)
+          end
+          attributes
+        end
+        private
+        # :nodoc:
+        def validate_data(content_type)
+          if request.post? || request.patch?
+            raise(Errors::BadRequestError) unless request.content_type == content_type
+            request_load_data
+            raise(Errors::MissingDataError) unless params[:data].present?
+          end
+        end
+        # :nodoc:
+        def request_load_data
+          data_source =
+            begin
+              request.body.read
+            rescue
+              nil
+            end
+          return if data_source.blank?
+          data = ActiveSupport::JSON.decode(data_source)
+          params[:data] = data.fetch("data", {}).with_indifferent_access
+        rescue JSON::ParserError
+          raise(Errors::InvalidDataError)
+        end
+        # :nodoc:
+        def request_validate_model_type(target, data, type_field)
+          provided_type = data[type_field]
+          expected_type = sanitize_model_name(target.class.name)
+          return if sanitize_model_name(data[type_field]) == expected_type
+          fail_request!(
+            :bad_request, "#{provided_type.present? ? "Invalid type \"#{provided_type}\"" : "No type"} provided when type \"#{expected_type}\" was expected."
+          )
+        end
+        # :nodoc:
+        def request_cast_attribute(target, attributes, types, key, value)
+          case types[key].type
+          when :boolean then
+            Validators::BooleanValidator.parse(value, raise_errors: true)
+            attributes[key] = value.to_boolean
+          when :datetime
+            value = Validators::TimestampValidator.parse(value, raise_errors: true)
+            attributes[key] = value
+          end
+        rescue => e
+          target.additional_errors.add(key, e.message)
+        end
+        # :nodoc:
+        def sanitize_model_name(name)
+          name.ensure_string.underscore.singularize
+        end
+        # :nodoc:
+        def validate_attributes(data, target)
+          # Before performing the validation, copy all embedded data to a temporary hash and replace with boolean in order to pass validation
+          copied = {}
+          data.each do |k, v|
+            if v.is_a?(Hash)
+              copied[k] = v
+              data[k] = true
+            end
+          end
+          ActionController::Parameters.new(data).permit(target.class::ATTRIBUTES).merge(copied) # Now return by restoring copied attributes
+        rescue ActionController::UnpermittedParameters => e
+          e.params.map! { |s| sprintf("attributes.%s", s) }
+          raise e
+        end
+        # :nodoc:
+        def unembed_relationships(data, target, field)
+          return data unless defined?(target.class::RELATIONSHIPS)
+          relationships = target.class::RELATIONSHIPS
+          data.each do |k, v|
+            k = k.to_sym
+            next unless relationships.include?(k)
+            params[:data][field] ||= {}
+            params[:data][field][k] = {data: {type: sanitize_model_name(relationships[k] || k), id: v}}
+            data.delete(k)
+          end
+          data
+        end
+        # :nodoc:
+        def validate_relationships(data, target, field)
+          return {} unless defined?(target.class::RELATIONSHIPS)
+          relationships = target.class::RELATIONSHIPS
+          allowed = relationships.keys.reduce({}) do |accu, k|
+            accu[k] = {data: [:type, :id]}
+            accu
+          end
+          resolve_references(target, relationships, ActionController::Parameters.new(data[field]).permit(allowed))
+        rescue ActionController::UnpermittedParameters => e
+          e.params.map! { |s| sprintf("%s.%s", field, s) }
+          raise e
+        end
+        # :nodoc:
+        def resolve_references(target, relationships, references)
+          references.reduce({}) do |accu, (field, data)|
+            begin
+              expected, id, sanitized, type = prepare_resolution(data, field, relationships)
+              accu[field] = validate_reference(expected, id, sanitized, type)
+            rescue => e
+              raise e if e.is_a?(Lazier::Exceptions::Debug)
+              target.additional_errors.add(field, e.message)
+            end
+            accu
+          end
+        end
+        # :nodoc:
+        def validate_reference(expected, id, sanitized, type)
+          raise("Relationship does not contain the \"data.type\" attribute") if type.blank?
+          raise("Relationship does not contain the \"data.id\" attribute") if id.blank?
+          raise("Invalid relationship type \"#{type}\" provided for when type \"#{expected}\" was expected.") unless sanitized == sanitize_model_name(expected)
+          reference = expected.classify.constantize.find_with_any(id)
+          raise("Refers to a non existing \"#{sanitized}\" resource.") unless reference
+          reference
+        end
+        # :nodoc:
+        def prepare_resolution(data, field, relationships)
+          type = data.dig(:data, :type)
+          id = data.dig(:data, :id)
+          expected = sanitize_model_name(relationships[field.to_sym] || field.classify)
+          sanitized = sanitize_model_name(type)
+          [expected, id, sanitized, type]
+        end
+      end
+    end
+  end
+end