flex_commerce_api 0.6.57

data/lib/flex_commerce.rb

@@ -0,0 +1,95 @@
+module FlexCommerce
+  def self.gem_root
+    File.expand_path("../", __dir__)
+  end
+
+  # V2 Models
+  module V2
+    autoload :CreateOrder, File.join(FlexCommerce.gem_root, "app", "models", "v2", "create_order")
+    autoload :DeallocateOrder, File.join(FlexCommerce.gem_root, "app", "models", "v2", "deallocate_order")
+    autoload :LineItem, File.join(FlexCommerce.gem_root, "app", "models", "v2", "line_item")
+    autoload :Order, File.join(FlexCommerce.gem_root, "app", "models", "v2", "order")
+    autoload :UnallocateOrder, File.join(FlexCommerce.gem_root, "app", "models", "v2", "unallocate_order")
+  end
+
+  # V1 Models
+  autoload :Address, File.join(gem_root, "app", "models", "address")
+  autoload :AssetFile, File.join(gem_root, "app", "models", "asset_file")
+  autoload :AssetFolder, File.join(gem_root, "app", "models", "asset_folder")
+  autoload :Bundle, File.join(gem_root, "app", "models", "bundle")
+  autoload :BundleGroup, File.join(gem_root, "app", "models", "bundle_group")
+  autoload :Cart, File.join(gem_root, "app", "models", "cart")
+  autoload :Category, File.join(gem_root, "app", "models", "category")
+  autoload :CategoryTree, File.join(gem_root, "app", "models", "category_tree")
+  autoload :Component, File.join(gem_root, "app", "models", "component")
+  autoload :ContainerCoupon, File.join(gem_root, "app", "models", "container_coupon")
+  autoload :Country, File.join(gem_root, "app", "models", "country")
+  autoload :Coupon, File.join(gem_root, "app", "models", "coupon")
+  autoload :CustomerAccount, File.join(gem_root, "app", "models", "customer_account")
+  autoload :CustomerAccountAuthentication, File.join(gem_root, "app", "models", "customer_account_authentication")
+  autoload :CustomerSegment, File.join(gem_root, "app", "models", "customer_segment")
+  autoload :CustomerSegmentMember, File.join(gem_root, "app", "models", "customer_segment_member")
+  autoload :DataAttribute, File.join(gem_root, "app", "models", "data_attribute")
+  autoload :DataStoreRecord, File.join(gem_root, "app", "models", "data_store_record")
+  autoload :DataStoreType, File.join(gem_root, "app", "models", "data_store_type")
+  autoload :DiscountSummary, File.join(gem_root, "app", "models", "discount_summary")
+  autoload :Email, File.join(gem_root, "app", "models", "email")
+  autoload :EwisOptIn, File.join(gem_root, "app", "models", "ewis_opt_in")
+  autoload :ExternalUrl, File.join(gem_root, "app", "models", "external_url")
+  autoload :FreeShippingPromotion, File.join(gem_root, "app", "models", "free_shipping_promotion")
+  autoload :Import, File.join(gem_root, "app", "models", "import")
+  autoload :ImportEntry, File.join(gem_root, "app", "models", "import_entry")
+  autoload :LineItem, File.join(gem_root, "app", "models", "line_item")
+  autoload :LineItemDiscount, File.join(gem_root, "app", "models", "line_item_discount")
+  autoload :MarkdownPrice, File.join(gem_root, "app", "models", "markdown_price")
+  autoload :Menu, File.join(gem_root, "app", "models", "menu")
+  autoload :MenuItem, File.join(gem_root, "app", "models", "menu_item")
+  autoload :MenuItemItem, File.join(gem_root, "app", "models", "menu_item_item")
+  autoload :Note, File.join(gem_root, "app", "models", "note")
+  autoload :Order, File.join(gem_root, "app", "models", "order")
+  autoload :PasswordRecovery, File.join(gem_root, "app", "models", "password_recovery")
+  autoload :PaymentAdditionalInfo, File.join(gem_root, "app", "models", "payment_additional_info")
+  autoload :PaymentAddressVerification, File.join(gem_root, "app", "models", "payment_address_verification")
+  autoload :PaymentProcess, File.join(gem_root, "app", "models", "payment_process")
+  autoload :PaymentProvider, File.join(gem_root, "app", "models", "payment_provider")
+  autoload :PaymentProviderSetup, File.join(gem_root, "app", "models", "payment_provider_setup")
+  autoload :PaymentTransaction, File.join(gem_root, "app", "models", "payment_transaction")
+  autoload :Product, File.join(gem_root, "app", "models", "product")
+  autoload :ProductAssetFile, File.join(gem_root, "app", "models", "product_asset_file")
+  autoload :Promotion, File.join(gem_root, "app", "models", "promotion")
+  autoload :PromotionQualifyingProductExclusion, File.join(gem_root, "app", "models", "promotion_qualifying_product_exclusion")
+  autoload :Redirect, File.join(gem_root, "app", "models", "redirect")
+  autoload :Refund, File.join(gem_root, "app", "models", "refund")
+  autoload :RemoteAddress, File.join(gem_root, "app", "models", "remote_address")
+  autoload :RemoteLineItem, File.join(gem_root, "app", "models", "remote_line_item")
+  autoload :RemoteOrder, File.join(gem_root, "app", "models", "remote_order")
+  autoload :RemoteShippingMethod, File.join(gem_root, "app", "models", "remote_shipping_method")
+  autoload :Role, File.join(gem_root, "app", "models", "role")
+  autoload :Report, File.join(gem_root, "app", "models", "report")
+  autoload :ReportInvocation, File.join(gem_root, "app", "models", "report_invocation")
+  autoload :RetailStore, File.join(gem_root, "app", "models", "retail_store")
+  autoload :SearchSuggestion, File.join(gem_root, "app", "models", "search_suggestion")
+  autoload :Section, File.join(gem_root, "app", "models", "section")
+  autoload :Session, File.join(gem_root, "app", "models", "session")
+  autoload :ShippingMethod, File.join(gem_root, "app", "models", "shipping_method")
+  autoload :Slug, File.join(gem_root, "app", "models", "slug")
+  autoload :StaticPage, File.join(gem_root, "app", "models", "static_page")
+  autoload :StaticPageFolder, File.join(gem_root, "app", "models", "static_page_folder")
+  autoload :StockLevel, File.join(gem_root, "app", "models", "stock_level")
+  autoload :TaxCode, File.join(gem_root, "app", "models", "tax_code")
+  autoload :Taxonomy, File.join(gem_root, "app", "models", "taxonomy")
+  autoload :Template, File.join(gem_root, "app", "models", "template")
+  autoload :TemplateComponent, File.join(gem_root, "app", "models", "template_component")
+  autoload :TemplateDefinition, File.join(gem_root, "app", "models", "template_definition")
+  autoload :TemplateSection, File.join(gem_root, "app", "models", "template_section")
+  autoload :User, File.join(gem_root, "app", "models", "user")
+  autoload :UserProfile, File.join(gem_root, "app", "models", "user_profile")
+  autoload :Variant, File.join(gem_root, "app", "models", "variant")
+  autoload :Webhook, File.join(gem_root, "app", "models", "webhook")
+
+  # Services
+  autoload :ParamToShql, File.join(gem_root, "app", "services", "param_to_shql")
+  autoload :SurrogateKeys, File.join(gem_root, "app", "services", "surrogate_keys")
+  autoload :PaypalExpress, File.join(gem_root, "lib", "paypal_express")
+  autoload :Retry, File.join(gem_root, "lib", "retry")
+end

data/lib/flex_commerce_api.rb

@@ -0,0 +1,21 @@
+require "patches"
+require "paypal_express"
+require "flex_commerce_api/config"
+require "flex_commerce"
+require "flex_commerce_api/errors"
+require "flex_commerce_api/json_api_client_extension/parse_json"
+
+module FlexCommerceApi
+  def self.config
+    FlexCommerceApi::Config.instance.tap do |config|
+      yield config if block_given?
+      config.reconfigure_all! if block_given?
+    end
+  end
+  def self.gem_root
+    File.expand_path("../", __dir__)
+  end
+  def self.logger
+    FlexCommerceApi::Config.instance.logger
+  end
+end

data/lib/flex_commerce_api/api_base.rb

@@ -0,0 +1,11 @@
+require "flex_commerce_api/base_resource"
+
+module FlexCommerceApi
+  class ApiBase < BaseResource
+    def self.endpoint_version
+      "v1"
+    end
+
+    reconfigure
+  end
+end

data/lib/flex_commerce_api/base_resource.rb

@@ -0,0 +1,250 @@
+require "json_api_client"
+require "faraday/request/basic_authentication"
+require "uri"
+require "active_support/core_ext/hash/indifferent_access"
+require "flex_commerce_api/json_api_client_extension/paginator"
+require "flex_commerce_api/json_api_client_extension/requestor"
+require "flex_commerce_api/json_api_client_extension/save_request_body_middleware"
+require "flex_commerce_api/json_api_client_extension/logging_middleware"
+require "flex_commerce_api/json_api_client_extension/status_middleware"
+require "flex_commerce_api/json_api_client_extension/json_format_middleware"
+require "flex_commerce_api/json_api_client_extension/previewed_request_middleware"
+require "flex_commerce_api/json_api_client_extension/capture_surrogate_keys_middleware"
+require "flex_commerce_api/json_api_client_extension/has_many_association_proxy"
+require "flex_commerce_api/json_api_client_extension/builder"
+require "flex_commerce_api/json_api_client_extension/flexible_connection"
+require "flex_commerce_api/json_api_client_extension/parsers/parser"
+require "flex_commerce_api/json_api_client_extension/remote_builder"
+
+module FlexCommerceApi
+  #
+  # Base class for all flex commerce models
+  #
+  class BaseResource < JsonApiClient::Resource
+    PRIVATE_ATTRIBUTES = %w(id type relationships links meta)
+    RELATED_META_RESOURCES = %w(related-categories related-static_pages related-resources related-files related-products)
+
+    # set the api base url in an abstract base class
+    self.paginator = JsonApiClientExtension::Paginator
+    self.requestor_class = JsonApiClientExtension::Requestor
+    self.connection_class = ::FlexCommerceApi::JsonApiClientExtension::FlexibleConnection
+    self.parser = ::FlexCommerceApi::JsonApiClientExtension::Parsers::Parser
+
+    class << self
+      def create!(*args)
+        create(*args).tap do |resource|
+          raise(::FlexCommerceApi::Error::RecordInvalid.new(resource)) unless resource.errors.empty?
+        end
+      end
+
+      # @method all
+      # Returns all resources
+      # @return [FlexCommerceApi::ApiBase[]] An array of resources or an empty array
+
+      # @method paginate
+      # Paginates the list of resources by a preset page size
+      # @param [Hash] options The options to paginate with
+      # @param options [Numeric|String] :page The page to fetch
+
+      # @method find_all
+      # Finds many resources, always returning an array, even if 1 result
+      alias_method :find_all, :find
+
+      # @method find
+      # @param [String] spec The spec of what to find
+      #
+      # Finds a resource
+      # @return [FlexCommerceApi::ApiBase] resource The resource found
+      # @raise [FlexCommerceApi::Error::NotFound] If not found
+      def find(*args)
+        # This is required as currently the underlying gem returns an array
+        # even if 1 record is found.  This is inconsistent with active record
+        result = super
+        result.length <= 1 ? result.first : result
+      end
+
+      # The username to use for authentication.
+      # @return [String] The username
+      def username
+        username = FlexCommerceApi.config.flex_account
+        username = URI.parse(site).path.split("/").reject(&:empty?).first if username.nil? || username.empty?
+        username
+      end
+
+      # The password to use for authentication.  This is the same as
+      # the access key token from the flex platform.
+      # @return [String] The password
+      def password
+        FlexCommerceApi.config.flex_api_key
+      end
+
+      def path(params = nil, record = nil)
+        super(params)
+      end
+
+      def capture_surrogate_keys
+        Thread.current[:shift_surrogate_keys] = []
+        yield
+        Thread.current[:shift_surrogate_keys].uniq!
+        results = Thread.current[:shift_surrogate_keys].join(' ')
+        Thread.current[:shift_surrogate_keys] = nil
+        results
+      end
+
+      def reconfigure_all options = {}
+        self.subclasses.each do |sub|
+          sub.reconfigure_api_base options
+        end
+      end
+
+      def reconfigure_api_base options = {}
+        self.subclasses.each do |sub|
+          sub.reconfigure options
+        end
+        reconfigure options
+      end
+
+      def reconfigure options = {}
+        self.site = append_version(FlexCommerceApi.config.api_base_url)
+        base_options = {
+          adapter: FlexCommerceApi.config.adapter || :net_http,
+          http_cache: FlexCommerceApi.config.http_cache,
+          timeout: FlexCommerceApi.config.timeout,
+          open_timeout: FlexCommerceApi.config.open_timeout
+        }
+        self.connection_options.delete(:include_previewed)
+        self.connection_options = connection_options.merge(base_options).merge(options)
+        reload_connection_if_required
+      end
+
+      def reload_connection_if_required
+        _build_connection(true) if connection_object
+      end
+
+      # Allows ApiBase to be used as the class and the real class is then calculated from the type
+      def load(params)
+        return super unless self == FlexCommerceApi::ApiBase
+        klass = JsonApiClient::Utils.compute_type(FlexCommerce, params["type"].singularize.classify)
+        klass.load(params)
+      end
+
+      def append_version(base_url)
+        "#{base_url}/#{endpoint_version}"
+      end
+
+      def endpoint_version
+        raise NotImplementedError
+      end
+    end
+
+    def freeze
+      attributes.freeze
+      associations.freeze
+      links.freeze
+      relationships.freeze
+      self
+    end
+
+    # Ensures all attributes are with indifferent access
+    def initialize(attrs = {})
+      super attrs.with_indifferent_access
+    end
+
+    def save!
+      return if save
+      raise_record_invalid
+    end
+
+    def public_attributes
+      attributes.reject { |k, v| PRIVATE_ATTRIBUTES.include?(k.to_s) }
+    end
+
+    def meta_attribute(key)
+      begin
+        return self.send(key) if RELATED_META_RESOURCES.include?(attributes[:meta_attributes][key][:data_type])
+        attributes[:meta_attributes][key][:value]
+      rescue NoMethodError
+        nil
+      end
+    end
+
+    def method_missing(method, *args)
+      if relationships and relationships.has_attribute?(method)
+        super
+      else
+        has_attribute?(method) || method.to_s=~(/=$/) || method.to_s=~/!$/ ? super : nil
+      end
+    end
+
+    def as_json_api(*args)
+      convert_relationship_attributes! super(*args)
+    end
+
+    private
+
+    def convert_relationship_attributes!(h)
+      valid_relationships = relationship_attributes
+      (h["attributes"].keys & valid_relationships).each do |attr|
+        h["attributes"][attr] = convert_relationship_attribute(h["attributes"][attr])
+      end
+      h
+    end
+
+    def relationship_attributes
+      @relationship_attributes ||= self.class.associations.map { |a| a.is_a?(JsonApiClient::Associations::HasMany::Association) ? "#{a.attr_name}_resources" : "#{a.attr_name}_resource" }
+    end
+
+    def convert_relationship_attribute(data)
+      case data
+        when Array
+          data.map do |d|
+            convert_relationship_attribute(d)
+          end
+        when FlexCommerceApi::ApiBase
+          data.as_json_api
+        else
+          data
+      end
+    end
+
+    def raise_record_invalid
+      raise(::FlexCommerceApi::Error::RecordInvalid.new(self))
+    end
+
+    # This is temporary code - eventually this will be in the lower level gem
+    def has_many_association_proxy(assoc_name, real_instance, options = {})
+      JsonApiClientExtension::HasManyAssociationProxy.new(real_instance, self, assoc_name, options)
+    end
+
+    # Gets a relationship using its related link - but returns a builder allowing for it to be
+    # paginated, searched and more.
+    def get_related(relationship)
+      relationship_definitions = relationships[relationship]
+      association = association_for(relationship)
+      raise "#{relationship} is not defined in #{self.class.name}" unless association
+      if relationship_definitions["links"] && url = relationship_definitions["links"]["related"]
+        url = URI.parse(url)
+        site = url.clone.tap { |u|
+          u.path = ""
+          u.query = nil
+          u.fragment = nil
+        }.to_s
+        path = url.clone.tap { |u|
+          u.scheme = nil
+          u.host = nil
+          u.port = nil
+          u.userinfo = nil
+        }.to_s
+        connection = if site.empty?
+                       self.class.connection
+                     else
+                       FlexCommerceApi::JsonApiClientExtension::FlexibleConnection.new(self.class.connection_options.merge(site: site, add_json_api_extension: false, authenticate: false))
+                     end
+        FlexCommerceApi::JsonApiClientExtension::RemoteBuilder.new(association.association_class, path: path, connection: connection)
+      end
+
+    end
+
+
+  end
+end

data/lib/flex_commerce_api/config.rb

@@ -0,0 +1,55 @@
+require "singleton"
+module FlexCommerceApi
+  #
+  # Global configuration object
+  #
+  # This is not accessed directly but using code similar to this example :-
+  #
+  #   FlexCommerceApi.config do |config|
+  #     config.flex_root_url=ENV["FLEX_ROOT_URL"]
+  #     config.flex_account=ENV["FLEX_ACCOUNT"]
+  #     config.flex_api_key=ENV["FLEX_API_KEY"]
+  #     config.logger = Rails.logger
+  #     config.order_test_mode = ENV.key?("ORDER_TEST_MODE")
+  #   end
+  #
+  # The above code would typically be found in a rails initializer as an example.
+  class Config
+    include Singleton
+    # @!attribute flex_root_url
+    #  The root url for the flex server.  Must NOT include the account name at the end
+    #  For example https://api.flexcommerce.com
+    # @!attribute flex_account
+    #  The account to be used on the flex server.
+    #  For example myaccount
+    # @!attribute flex_api_key
+    #  The API key to access the flex server with.  This comes from the 'Access Keys'
+    #  section of the admin panel
+    # @!attribute order_test_mode
+    #  The order test mode.This config determines if orders are processed as test or real orders
+    attr_accessor :flex_root_url, :flex_api_key, :flex_account, :logger, :adapter, :order_test_mode, :http_cache, :open_timeout, :timeout, :paypal_login, :paypal_password, :paypal_signature, :order_test_mode, :paypal_connection_errors_no_of_retries
+    attr_reader :api_version
+
+    def initialize
+      self.order_test_mode = false
+      self.http_cache = {}
+      self.open_timeout = ENV.fetch('SHIFT_OPEN_TIMEOUT', 2).to_i
+      self.timeout = ENV.fetch('SHIFT_TIMEOUT', 15).to_i
+    end
+
+    # The api base URL
+    # @return [String] The base URL for the flex system.  Calculated from the
+    #  flex_root_url and _api_verision
+    def api_base_url
+      "#{flex_root_url}/#{flex_account}"
+    end
+
+    # Informs all models that the configuration may have changed
+    # but only if ApiBase is defined - else nothing has loaded yet
+    # so they wont need reconfiguring
+    def reconfigure_all!
+      FlexCommerceApi::BaseResource.reconfigure_all if FlexCommerceApi.const_defined? "ApiBase"
+    end
+
+  end
+end

data/lib/flex_commerce_api/error/access_denied.rb

@@ -0,0 +1,6 @@
+module FlexCommerceApi
+  module Error
+    class AccessDenied < ClientError
+    end
+  end
+end

data/lib/flex_commerce_api/error/bad_request.rb

@@ -0,0 +1,10 @@
+module FlexCommerceApi
+  module Error
+    class BadRequest < ClientError
+      def message
+        msg = response_env[:body]["errors"].map {|e| "#{e['title']} - #{e['detail']}"}.join(" , ")
+        "Bad Request #{msg}"
+      end
+    end
+  end
+end