power-compass 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 719e6a292a665ca861af7bc67fc0e60d9b0bbcc5303b358988450178744568c1
-  data.tar.gz: 0fdb94018c58431b1bd131fd5c0bc063ab38bcf25d2243fd2408bcc54c2ecbd4
+  metadata.gz: e5cf7df2950250c91f36e08150c320557221597db0fedd203a1ab8566c528984
+  data.tar.gz: af59dfd4704c1259a1d0325db50392de17287a9ff7e97c70738e0cba40f59507
 SHA512:
-  metadata.gz: ac3054cdee5acf69b7f2f4ed71a528940b13728a44568dd800221cb1a11d9028573edf5a491b50fc55b2b59eeed8b01a8ad8320bfec4700fdeea773ea7b5483e
-  data.tar.gz: 4d9d5785bf1f07fd37dda55fd9e2348735dc7243756d088b43fe13f70f299337c5f0f0302ea4d511c2e36e9f1a6a175939a18cf129a234f406a9eeab24d7f0d8
+  metadata.gz: daf30710679b1d2fe384e108c76d06f815a6990b804aece6a7dd9338414caaa2b643694f0b7e3f211c7e06566bf5f45e15b7d2fefcb0c7dbd1e69f84bd306ab6
+  data.tar.gz: 479652082ea6161af9c39133eca13124f5e7f6843c42c36465f7c593ceb071cda687715ba0d838e65412fd91036bb59fc1a3921829af1bac8f68bb67c801c6c1

data/app/controllers/compass/application_controller.rb

@@ -3,9 +3,6 @@ module Compass
   #
   # @private
   class ApplicationController < ActionController::API
-    etag { current_context_id }
-    etag { context_modified_at }
-
     before_action :authenticate
     before_action :validate_context
 
@@ -24,17 +21,5 @@ module Compass
     def current_context_id
       instance_exec(&Compass.config.context_id)
     end
-
-    def context_modified_at
-      instance_exec(&Compass.config.modified_at)
-    end
-
-    def set_cache_headers(config)
-      if config
-        expires_in(*Array(config))
-      else
-        expires_now
-      end
-    end
   end
 end

data/app/controllers/compass/info_controller.rb

@@ -1,4 +1,7 @@
 module Compass
+  # Info controller.
+  #
+  # @private
   class InfoController < ApplicationController
     skip_before_action :validate_context
 

data/app/controllers/compass/menu_controller.rb

@@ -1,17 +1,18 @@
 module Compass
-  # Base compass controller.
+  # Menu controller.
   #
   # @private
   class MenuController < ApplicationController
+    include Cors
+    include ConditionalCache
+
     etag { filter.values.compact }
     etag { menu_items.maximum(:updated_at) }
 
     def index
-      set_cache_headers(Compass.config.menu.cache)
-
-      return unless stale? menu_items, etag: "compass-menu"
-
-      render json: menu_items, filter: filter
+      with_cache(menu_items, Compass.config.menu.cache, etag: "compass-menu") do
+        render json: menu_items, filter: filter
+      end
     end
 
   private

data/app/controllers/compass/notification_controller.rb

@@ -1,15 +1,17 @@
-require "compass/notification/provider"
-
 module Compass
+  # Notification controller.
+  #
+  # @private
   class NotificationController < ApplicationController
-    etag { providers.map(&:hash) }
-
-    def index
-      set_cache_headers(Compass.config.notification.cache)
+    include Cors
+    include ConditionalCache
 
-      return unless stale?(providers, etag: "compass-notification")
+    etag { providers.maximum(:updated_at) }
 
-      render json: providers
+    def index
+      with_cache(providers, Compass.config.notification.cache, etag: "compass-notification") do
+        render json: providers
+      end
     end
 
   private

data/app/controllers/compass/search_controller.rb

@@ -1,7 +1,10 @@
-require "compass/search/provider"
-
 module Compass
+  # Search controller.
+  #
+  # @private
   class SearchController < ApplicationController
+    include Cors
+
     def index
       if params[:q]
         results = Compass::Search::Provider.global_search(params.require(:q), current_context)

data/app/controllers/concerns/compass/conditional_cache.rb

@@ -0,0 +1,27 @@
+module Compass
+  # Shared ETag sources and cache header helpers for Compass controllers.
+  #
+  # @private
+  module ConditionalCache
+    extend ActiveSupport::Concern
+
+    included do
+      etag { current_context_id }
+      etag { context_modified_at }
+
+    private
+
+      def context_modified_at
+        instance_exec(&Compass.config.modified_at)
+      end
+    end
+
+    def with_cache(items, config, etag:)
+      config ? expires_in(*Array(config)) : expires_now
+
+      return unless stale? items, etag: etag
+
+      yield
+    end
+  end
+end

data/app/controllers/concerns/compass/cors.rb

@@ -0,0 +1,40 @@
+module Compass
+  # Shared CORS headers for Compass controllers.
+  #
+  # @private
+  module Cors
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_cors_headers
+      skip_before_action :authenticate, only: :cors
+      skip_before_action :validate_context, only: :cors
+
+    private
+
+      def set_cors_headers
+        headers["Access-Control-Allow-Origin"] = request.headers["Origin"] if allowed_origin?
+        headers["Access-Control-Allow-Methods"] = "GET, OPTIONS"
+        headers["Access-Control-Allow-Headers"] = "Origin, Content-Type, Accept, Authorization, Cache-Control"
+      end
+
+      def allowed_origin?
+        return true if request.headers["sec-fetch-site"] == "same-origin"
+        return false if request.headers["Origin"].blank?
+
+        parsed_origin = URI.parse(request.headers["Origin"])
+
+        Compass.config.backends.any? do |backend|
+          backend_uri = URI.parse(backend) rescue nil
+          parsed_origin.scheme == backend_uri&.scheme &&
+            parsed_origin.host == backend_uri&.host &&
+            parsed_origin.port == backend_uri&.port
+        end
+      rescue URI::InvalidURIError
+        false
+      end
+    end
+
+    def cors = head :ok
+  end
+end

data/config/routes.rb

@@ -2,13 +2,19 @@ Compass::Engine.routes.draw do
   root to: "info#index", as: :root
 
   get ":context_id/menu", to: "menu#index", as: :menu
+  options ":context_id/menu", to: "menu#cors"
 
   get ":context_id/search", to: "search#index", as: :search
+  options ":context_id/search", to: "search#cors"
+
   get ":context_id/search/providers", to: "search#providers", as: :search_providers
-  get ":context_id/search/:provider_name",
-      to: "search#show",
-      as: :search_provider,
-      constraints: { provider_name: /[a-zA-Z_]+/ }
+  options ":context_id/search/providers", to: "search#cors"
+
+  get ":context_id/search/:provider_name", to: "search#show",
+                                           as: :search_provider,
+                                           constraints: { provider_name: /[a-zA-Z_]+/ }
+  options ":context_id/search/:provider_name", to: "search#cors"
 
   get ":context_id/notifications", to: "notification#index", as: :notifications
+  options ":context_id/notifications", to: "notification#cors"
 end

data/lib/compass/engine.rb

@@ -18,6 +18,7 @@ module Compass
     config.paths["app"].skip_eager_load!
     config.paths.add "app/components", autoload: true
     config.paths.add "app/components/concerns", autoload: true
+    config.paths.add "app/controllers/concerns", autoload: true
 
     initializer "compass.logger" do
       Compass.logger ||= Rails.logger.respond_to?(:tagged) ? Rails.logger.tagged("Compass") : Rails.logger

data/lib/compass/version.rb

@@ -1,3 +1,3 @@
 module Compass
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-compass
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Carlos Palhares
@@ -98,6 +98,8 @@ files:
 - app/controllers/compass/menu_controller.rb
 - app/controllers/compass/notification_controller.rb
 - app/controllers/compass/search_controller.rb
+- app/controllers/concerns/compass/conditional_cache.rb
+- app/controllers/concerns/compass/cors.rb
 - config/routes.rb
 - lib/compass.rb
 - lib/compass/breadcrumb.rb