flex_commerce_api 0.6.57

data/lib/flex_commerce_api/error/base.rb

@@ -0,0 +1,12 @@
+module FlexCommerceApi
+  module Error
+    class Base < StandardError
+      attr_reader :response_env, :request_env
+      def initialize(request_env = nil, response_env = nil)
+        @response_env = response_env
+        @request_env = request_env
+      end
+
+    end
+  end
+end

data/lib/flex_commerce_api/error/client_error.rb

@@ -0,0 +1,7 @@
+module FlexCommerceApi
+  module Error
+    class ClientError < Base
+
+    end
+  end
+end

data/lib/flex_commerce_api/error/connection_error.rb

@@ -0,0 +1,6 @@
+module FlexCommerceApi
+  module Error
+    class ConnectionError < Base
+    end
+  end
+end

data/lib/flex_commerce_api/error/internal_server.rb

@@ -0,0 +1,37 @@
+module FlexCommerceApi
+  module Error
+    class InternalServer < Base
+      def message
+        body = response_env.fetch(:body, {"errors" => []})
+        error = extract_error(body)
+        return "Internal server error" unless error.present?
+        if error.is_a?(::Enumerable)
+          title = error.fetch("title", "")
+          detail = error.fetch("detail", "")
+          meta = error.fetch("meta", {})
+          exception = meta.fetch("exception", "")
+          backtrace = meta.fetch("backtrace", [])
+          event_id = meta.fetch("event_id", "")
+          "Internal server error - #{title} #{detail} #{event_id} #{exception} #{backtrace}"
+        else
+          "Internal server error - #{error}"
+        end
+      end
+
+      def raven_context
+        {
+          extra: {
+            body: response_env[:body]
+          }  
+        }
+      end
+
+      private
+
+      def extract_error(body)
+        return body if body.is_a?(::String)
+        body["message"] || body["errors"]&.first
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/error/not_found.rb

@@ -0,0 +1,13 @@
+module FlexCommerceApi
+  module Error
+    class NotFound < InternalServer
+      attr_reader :uri
+      def initialize(uri)
+        @uri = uri
+      end
+      def message
+        "Couldn't find resource at: #{uri.to_s}"
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/error/record_invalid.rb

@@ -0,0 +1,16 @@
+module FlexCommerceApi
+  module Error
+    class RecordInvalid < Base
+      attr_reader :record
+
+      def initialize(record)
+        @record = record
+      end
+
+      def message
+        "Record Invalid - #{record.errors.full_messages.join(", ")}"
+      end
+    end
+
+  end
+end

data/lib/flex_commerce_api/error/unexpected_status.rb

@@ -0,0 +1,7 @@
+module FlexCommerceApi
+  module Error
+    class UnexpectedStatus < JsonApiClient::Errors::UnexpectedStatus
+
+    end
+  end
+end

data/lib/flex_commerce_api/errors.rb

@@ -0,0 +1,13 @@
+module FlexCommerceApi
+  module Error
+    autoload :Base, File.expand_path(File.join("error", "base"), __dir__)
+    autoload :ClientError, File.expand_path(File.join("error", "client_error"), __dir__)
+    autoload :ConnectionError, File.expand_path(File.join("error", "connection_error"), __dir__)
+    autoload :InternalServer, File.expand_path(File.join("error", "internal_server"), __dir__)
+    autoload :UnexpectedStatus, File.expand_path(File.join("error", "unexpected_status"), __dir__)
+    autoload :NotFound, File.expand_path(File.join("error", "not_found"), __dir__)
+    autoload :AccessDenied, File.expand_path(File.join("error", "access_denied"), __dir__)
+    autoload :RecordInvalid, File.expand_path(File.join("error", "record_invalid"), __dir__)
+    autoload :BadRequest, File.expand_path(File.join("error", "bad_request"), __dir__)
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/builder.rb

@@ -0,0 +1,28 @@
+module FlexCommerceApi
+  module JsonApiClientExtension
+    class Builder < ::JsonApiClient::Query::Builder
+      def initialize(*)
+        super
+        @temp_search_criteria = nil
+      end
+      def temp_search(options = {})
+        @temp_search_criteria = options
+        self
+      end
+
+      def find(args = {})
+        case args
+          when Hash
+            where(args)
+          else
+            @primary_key = args
+        end
+        if @temp_search_criteria.nil?
+          klass.requestor.get(params)
+        else
+          klass.requestor.custom(:search, { request_method: :get }, params.merge(filter: @temp_search_criteria))
+        end
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/capture_surrogate_keys_middleware.rb

@@ -0,0 +1,16 @@
+# Captures surrogate keys headers and collects them for passing to the client.
+module FlexCommerceApi
+  module JsonApiClientExtension
+    class CaptureSurrogateKeysMiddleware < ::Faraday::Middleware
+      def call(environment)
+        @app.call(environment).on_complete do |env|
+          surrogate_keys = env.response_headers['external-surrogate-key'].split(' ') if env.response_headers['external-surrogate-key']
+
+          if surrogate_keys && Thread.current[:shift_surrogate_keys]
+            Thread.current[:shift_surrogate_keys].concat(surrogate_keys)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/flexible_connection.rb

@@ -0,0 +1,59 @@
+require 'faraday-http-cache'
+
+module FlexCommerceApi
+  module JsonApiClientExtension
+    class FlexibleConnection < JsonApiClient::Connection
+      attr_accessor :last_response
+      def initialize(options = {})
+        site = options.fetch(:site)
+        adapter_options = Array(options.fetch(:adapter, Faraday.default_adapter))
+        add_json_api_extension = options.fetch(:add_json_api_extension, true)
+        authenticate = options.fetch(:authenticate, true)
+        include_previewed = options.fetch :include_previewed, false
+        @faraday = Faraday.new(site) do |builder|
+          builder.request :json
+          builder.use JsonApiClientExtension::SaveRequestBodyMiddleware
+          builder.use JsonApiClientExtension::JsonFormatMiddleware if add_json_api_extension
+          builder.use JsonApiClientExtension::PreviewedRequestMiddleware if include_previewed
+          builder.use JsonApiClient::Middleware::JsonRequest
+          # Surrogate Key middleware should always be above HTTP caching to ensure we're reading headers
+          # from the original response not the 304 responses
+          builder.use JsonApiClientExtension::CaptureSurrogateKeysMiddleware
+          # disable the cache when HTTP cache is set to false
+          unless false == options[:http_cache]
+            builder.use :http_cache, cache_options(options)
+          end
+          builder.use JsonApiClientExtension::StatusMiddleware
+          builder.use JsonApiClient::Middleware::ParseJson
+          builder.use JsonApiClientExtension::LoggingMiddleware unless FlexCommerceApi.logger.nil?
+          builder.adapter *adapter_options
+          builder.options[:open_timeout] = options.fetch(:open_timeout)
+          builder.options[:timeout] = options.fetch(:timeout)
+        end
+        faraday.basic_auth(ApiBase.username, ApiBase.password) if authenticate
+
+        yield(self) if block_given?
+      end
+
+      def run(*args)
+        super.tap do |response|
+          self.last_response = response
+        end
+      end
+
+      private
+      def cache_options(options)
+        {
+          # treats the cache like a client, not a proxy
+          shared_cache: false,
+          # use the Rails cache, if set, otherwise default to MemoryStore
+          store: defined?(::Rails) ? ::Rails.cache : nil,
+          # serialize the data using Marshal
+          serializer: Marshal,
+          # use our configured logger
+          logger: FlexCommerceApi.logger
+        }.merge(options.fetch(:http_cache, {}))
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/has_many_association_proxy.rb

@@ -0,0 +1,60 @@
+require "active_support/core_ext/module/delegation"
+
+module FlexCommerceApi
+  module JsonApiClientExtension
+    class HasManyAssociationProxy
+      def initialize(real_instance, container_instance, association_name, options)
+        self.real_instance = real_instance
+        self.container_instance = container_instance
+        self.association_name = association_name
+        self.options = options
+      end
+
+      delegate :empty?, :each, :each_with_index, :length, :count, :map, :select, :detect, :first, :last, :[], :any?, to: :real_instance
+      #
+      # Finds an instance by primary key
+      #
+      # @param [Integer|Number|Float] pk The primary key value to be found
+      # @return The resource found or nil if not found
+      def find(pk)
+        method = primary_key
+        real_instance.detect {|i| i.send(method) == pk}
+      end
+
+      # Creates a new associated item - if the option "inverse_of" is specified, then
+      # automatically create a relationship back to the container with the name
+      # specified in "inverse_of"
+      def new(attrs)
+        my_attrs = attrs.dup
+        if options.key?(:inverse_of)
+          my_attrs[:relationships] ||= {}
+          # Dont modify the original relationship if it was present below
+          my_attrs[:relationships] = my_attrs[:relationships].merge(options[:inverse_of] => container_instance)
+        end
+        association.association_class.new(my_attrs)
+      end
+
+      def create(attrs)
+        new(attrs).tap do |instance|
+          instance.save
+        end
+      end
+
+      def to_a
+        real_instance
+      end
+
+      private
+
+      def association
+        container_instance.class.associations.detect {|a| a.attr_name == association_name.to_sym}
+      end
+
+      def primary_key
+        association.association_class.primary_key
+      end
+
+      attr_accessor :real_instance, :container_instance, :association_name, :options
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/included_data.rb

@@ -0,0 +1,27 @@
+require 'json_api_client/included_data'
+
+module FlexCommerceApi
+  module JsonApiClientExtension
+    class IncludedData < ::JsonApiClient::IncludedData
+      def initialize(result_set, *args)
+        super(result_set, *args)
+        @result_set = result_set
+      end
+
+      private
+
+      # attempt to load the record from included data first, failing that, look
+      # in the root resource(s) for the record
+      def record_for(link_def)
+        data.dig(link_def["type"], link_def["id"]) || root_record_for(link_def)
+      end
+
+      def root_record_for(link_def)
+        @result_set.find do |resource|
+          resource.attributes["type"] == link_def["type"] &&
+          resource.attributes["id"] == link_def["id"]
+        end
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/json_format_middleware.rb

@@ -0,0 +1,20 @@
+module FlexCommerceApi
+  module JsonApiClientExtension
+    #
+    #
+    # @!visibility private
+    # This class is used internally to modify the URL to have .json at the end to
+    # suit the flex platform.
+    class JsonFormatMiddleware < ::Faraday::Middleware
+      #
+      # Adds .json to the URL before it gets sent
+      #
+      def call(env)
+        env.url.tap do |url|
+          url.path << ".json_api" unless url.path=~/\.json_api$/
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/logging_middleware.rb

@@ -0,0 +1,24 @@
+module FlexCommerceApi
+  module JsonApiClientExtension
+    #
+    #
+    class LoggingMiddleware < ::Faraday::Middleware
+      attr_accessor :request_id, :logger
+      def initialize(*args)
+        super
+        self.request_id = 0
+        self.logger = FlexCommerceApi.logger
+      end
+      #
+      #
+      def call(env)
+        self.request_id += 1
+        @app.call(env).on_complete do |response_env|
+          logger.debug("FlexApi::Request  id #{request_id} #{env.method.to_s.upcase} #{env.url} started at #{Time.now}")
+          logger.debug("\t >>> #{env[:request_body]}") unless  env[:request_body].nil? || env[:request_body].empty?
+          logger.debug("\t <<< (#{env[:status]}) #{env.body}")
+        end
+      end
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/paginator.rb

@@ -0,0 +1,26 @@
+module FlexCommerceApi
+  module JsonApiClientExtension
+    # @!visibility private
+    # This class overrides the default paginator to allow for
+    # the custom things that are required by the flex platform.
+    # This class is private and should not be used by end users
+    class Paginator < ::JsonApiClient::Paginating::Paginator
+
+      def current_page
+        params.fetch("page[number]", 1).to_i
+      end
+
+      def total_pages
+        result_set.meta.page_count
+      end
+
+      def total_entries
+        result_set.meta.total_entries
+      end
+
+
+      protected
+
+    end
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/parse_json.rb

@@ -0,0 +1,23 @@
+# This module extends json_api_client's ParseJson service
+# to make sure malformed repsonse bodies is always included as context in
+# the thrown error message when json parsing fails.
+module FlexCommerceApi
+  module JsonApiClientExtension
+    module ParseJson
+      def call(environment)
+        super
+      rescue JSON::ParserError => error
+        error.define_singleton_method(:raven_context) do
+          {
+            extra: {
+              body: environment.body
+            }  
+          }
+        end
+        raise
+      end
+    end
+  end
+end
+
+JsonApiClient::Middleware::ParseJson.send :prepend, FlexCommerceApi::JsonApiClientExtension::ParseJson

data/lib/flex_commerce_api/json_api_client_extension/parsers/parser.rb

@@ -0,0 +1,16 @@
+require_relative "../included_data"
+
+module FlexCommerceApi
+  module JsonApiClientExtension
+    module Parsers
+      class Parser < ::JsonApiClient::Parsers::Parser
+        class << self
+          def handle_included(result_set, data)
+            result_set.included = ::FlexCommerceApi::JsonApiClientExtension::IncludedData.new(result_set, data.fetch("included", []))
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/flex_commerce_api/json_api_client_extension/previewed_request_middleware.rb

@@ -0,0 +1,17 @@
+require "rack/utils"
+
+# Adds preview param to all requests to Flex API.
+module FlexCommerceApi
+  module JsonApiClientExtension
+    class PreviewedRequestMiddleware < ::Faraday::Middleware
+      def call(env)
+        env.url.tap do |url|
+          parsed_query = Rack::Utils.parse_nested_query url.query
+          parsed_query[:preview] = true
+          url.query = parsed_query.to_param
+        end
+        @app.call(env)
+      end
+    end
+  end
+end