flex_commerce_api 0.6.57

data/app/models/static_page.rb

@@ -0,0 +1,60 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Static Page model
+  #
+  # This model provides access to the flex commerce static pages.
+  # As managing the static pages is the job of the administration panel, this
+  # model is read only.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all static pages
+  #
+  #   FlexCommerce::StaticPage.all #fetches all static pages (actually the first page in case there are thousands)
+  #
+  #   # Pagination
+  #
+  #   FlexCommerce::StaticPage.paginate(page:2).all # Fetches page 2 of static pages.
+  #   The page size is predefined on the server side
+  #
+  #   # Finding static pages
+  #
+  #   FlexCommerce::StaticPage.find(25) # Finds the static page with this unique id
+  #
+  #
+  class StaticPage < FlexCommerceApi::ApiBase
+    # @method find
+    # @param [String] spec
+    # Finds a static page
+    # @return [FlexCommerce::Product] The static page
+    # @raise [FlexCommerceApi::Error::NotFound] If not found
+
+    # @method all
+    # Returns all static pages
+    # @return [FlexCommerce::StaticPage[]] An array of static pages or an empty array
+
+    # @method paginate
+    # Paginates the list of static pages by a preset page size
+    # @param [Hash] options The options to paginate with
+    # @param options [Numeric|String] :page The page to fetch
+
+    has_many :slugs, class_name: "::FlexCommerce::Slug"
+    has_one :template_definition, class_name: "::FlexCommerce::TemplateDefinition"
+    has_one :template, class_name: "::FlexCommerce::Template"
+
+    # @TODO Document other popular methods that we will support
+    self.query_builder = ::FlexCommerceApi::JsonApiClientExtension::Builder
+    
+    class << self
+      def_delegators :_new_scope, :temp_search
+      def path(params, *args)
+        super
+      end
+    end
+  end
+end

data/app/models/static_page_folder.rb

@@ -0,0 +1,8 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class StaticPageFolder < FlexCommerceApi::ApiBase
+
+    has_many :static_pages, class_name: "::FlexCommerce::StaticPage"
+
+  end
+end

data/app/models/stock_level.rb

@@ -0,0 +1,21 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Stock Level model
+  #
+  # This model provides access to the flex commerce stock level
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching stock levels for specific skus
+  #   FlexCommerce::StockLevel.where(skus: "sku1,sku2,sku3").all
+  #
+  #
+  #
+  class StockLevel < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/tax_code.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class TaxCode < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/taxonomy.rb

@@ -0,0 +1,5 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class Taxonomy < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/template.rb

@@ -0,0 +1,9 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce template
+  #
+  class Template < FlexCommerceApi::ApiBase
+    has_many :sections, class_name: "::FlexCommerce::Section"
+  end
+end

data/app/models/template_component.rb

@@ -0,0 +1,11 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce template component model
+  #
+  # This model provides access to the flex commerce template component
+  #
+  #
+  class TemplateComponent < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/template_definition.rb

@@ -0,0 +1,12 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce template definition model
+  #
+  # This model provides access to the flex commerce template definition
+  #
+  #
+  class TemplateDefinition < FlexCommerceApi::ApiBase
+    has_many :template_sections, class_name: "::FlexCommerce::TemplateSection"
+  end
+end

data/app/models/template_section.rb

@@ -0,0 +1,12 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce template section model
+  #
+  # This model provides access to the flex commerce template section
+  #
+  class TemplateSection < FlexCommerceApi::ApiBase
+    belongs_to :template_definition, class_name: "::FlexCommerce::TemplateDefinition"
+    has_many :template_components, class_name: "::FlexCommerce::TemplateComponent"
+  end
+end

data/app/models/user.rb

@@ -0,0 +1,8 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class User < FlexCommerceApi::ApiBase
+    has_one :role, class_name: "FlexCommerce::Role"
+    has_one :user_profile, class_name: "FlexCommerce::UserProfile"
+  end
+end

data/app/models/user_profile.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class UserProfile < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/v2/create_order.rb

@@ -0,0 +1,10 @@
+require "flex_commerce_api/v2/api_base"
+module FlexCommerce
+  module V2
+    class CreateOrder < FlexCommerceApi::V2::ApiBase
+      def self.table_name
+        "create_order"
+      end
+    end
+  end
+end

data/app/models/v2/deallocate_order.rb

@@ -0,0 +1,10 @@
+require "flex_commerce_api/v2/api_base"
+module FlexCommerce
+  module V2
+    class DeallocateOrder < FlexCommerceApi::V2::ApiBase
+      def self.table_name
+        "deallocate_order"
+      end
+    end
+  end
+end

data/app/models/v2/line_item.rb

@@ -0,0 +1,9 @@
+require "flex_commerce_api/v2/api_base"
+
+module FlexCommerce
+  module V2
+    class LineItem < FlexCommerceApi::V2::ApiBase
+      belongs_to :order, class_name: "::FlexCommerce::V2::Order"
+    end
+  end
+end

data/app/models/v2/order.rb

@@ -0,0 +1,9 @@
+require "flex_commerce_api/v2/api_base"
+
+module FlexCommerce
+  module V2
+    class Order < FlexCommerceApi::V2::ApiBase
+      has_many :line_items, class_name: "::FlexCommerce::V2::LineItem"
+    end
+  end
+end

data/app/models/v2/unallocate_order.rb

@@ -0,0 +1,10 @@
+require "flex_commerce_api/v2/api_base"
+module FlexCommerce
+  module V2
+    class UnallocateOrder < FlexCommerceApi::V2::ApiBase
+      def self.table_name
+        "unallocate_order"
+      end
+    end
+  end
+end

data/app/models/variant.rb

@@ -0,0 +1,18 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce variant model
+  #
+  # This model is used by the Product model as an association so is not
+  # usable directly on the API as there is no corresponding URL
+  #
+  #
+  class Variant < FlexCommerceApi::ApiBase
+    has_one :product
+    has_many :asset_files
+    has_many :markdown_prices
+    def add_markdown_prices(markdown_prices)
+      self.class.requestor.custom("relationships/markdown_prices", {request_method: :post}, {id: id, data: markdown_prices.map(&:as_relation)})
+    end
+  end
+end

data/app/models/webhook.rb

@@ -0,0 +1,17 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Webhooks model
+  #
+  # This model provides access to the Shift Webhooks feature.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetch all webhooks, paginated
+  #   FlexCommerce::Webhook.all
+  #
+  class Webhook < FlexCommerceApi::ApiBase
+  end
+end

data/app/services/param_to_shql.rb

@@ -0,0 +1,72 @@
+#
+# ParamToShql
+# 
+# Service for converting UI-based filters (using common UI idioms such as 
+# checkboxes) into SHQL, the SHiftQueryLanguage understandable by the API.
+#
+# e.g. 
+#   {"meta.colour"=>{"blue"=>"on", "red"=>"on"},"price"=>{"gt"=>"", "lt"=>""}}
+# would become
+#   "or" => [{"meta.colour"=>{"eq"=>"blue"}},{"meta.colour"=>{"eq"=>"red"}}...]
+#
+# TODO: More documentation
+#
+module FlexCommerce
+  class ParamToShql
+
+    #
+    # initialize
+    #
+    def initialize(filter_param)
+      @filter_param = filter_param
+    end
+    
+
+    # 
+    # call
+    #
+    def call
+      return {} unless @filter_param
+
+      facet_filters = []
+      @filter_param.each do |label,facet|
+        facet_filter = []
+        if (facet.keys & ['lt', 'lte', 'gt', 'gte']).any?
+          range_filter =  range_param_to_shql(label, facet)
+          facet_filter << range_filter if !(range_filter == "" || range_filter == nil)
+        else
+          facet.keys.each do |value| 
+            facet_filter << { label => { "eq" => value } }
+          end
+        end
+        facet_filters << { "or" => facet_filter }
+      end
+      facet_filters.count == 1 ? facet_filters.first : { "and" => facet_filters }
+    end
+
+    private
+
+
+    #
+    # range_param_to_shql
+    # 
+    # e.g. "variants.price"=>{"gt"=>10, "lt"=>20}
+    #
+    # name:           e.g. variants.price
+    # attrs:          e.g. { "gt" => 10 }
+    #
+    def range_param_to_shql(name, attrs)
+      range_filter = { "and" => [] }
+
+      attrs.each do |op,value| 
+        next if (value == "" || value == nil)
+        range_filter["and"] << { name => { op => value } }
+      end
+      if range_filter["and"].any?
+        range_filter
+      else
+        nil
+      end
+    end
+  end
+end

data/app/services/surrogate_keys.rb

@@ -0,0 +1,44 @@
+# Class: SurrogateKeys
+# This class implements the getter and setter methods for surrogate keys
+# This is used in 'CartManagement' in rails-site
+# 
+module FlexCommerce
+  class SurrogateKeys
+
+    # Returns the filtered external surrogate keys from api response,
+    # if no filter value is set, it will return all keys
+    # 
+    # ===== Examples
+    #     Thread.current[:shift_surrogate_keys] = ["matalanb%2Fcarts", "matalanb%2Fshipping_methods", "matalanb%2Fpromotion_shipping_methods"]
+    # 
+    #     FlexCommerce::SurrogateKeys.keys(filter: 'cart')
+    #       # => ["matalanb%2Fcarts"]
+    #     FlexCommerce::SurrogateKeys.keys
+    #       # => ["matalanb%2Fcarts", "matalanb%2Fshipping_methods", "matalanb%2Fpromotion_shipping_methods"]
+
+    def self.keys(filter: nil)
+      surrogate_keys = Thread.current[:shift_surrogate_keys]
+      # Return all the surrogate keys, if not requested for a particular key
+      return surrogate_keys if filter.nil?
+      # Select only the surrogate keys, which includes the requested key
+      surrogate_keys.nil?  ? [] : surrogate_keys.select { |k| k.include?(filter) }
+    end
+
+    # Appends the keys to the Thread shift_surrogate_keys variable.
+    # 
+    # ==== Examples
+    #     Thread.current[:shift_surrogate_keys] = ["matalanb%2Fcarts", "matalanb%2Fcart%2F31719184"]
+    #     keys = ["matalanb%2Fcarts", "matalanb%2Fcart%2F31719184"]
+    # 
+    #     FlexCommerce::SurrogateKeys.append_keys(keys)
+    #         # => ["matalanb%2Fcarts", "matalanb%2Fcart%2F31719184", "matalanb%2Fcarts", "matalanb%2Fcart%2F31719184"]
+    # 
+    def self.append_keys(*keys)
+      # Check if surrogate key is available, if not initiate it
+      Thread.current[:shift_surrogate_keys] ||= []
+      Thread.current[:shift_surrogate_keys] += keys.flatten
+      Thread.current[:shift_surrogate_keys] = Thread.current[:shift_surrogate_keys].uniq
+    end
+
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flex_commerce_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/payments.en.yml

@@ -0,0 +1,3 @@
+en:
+  payment_setup:
+    shipping_method_not_available: "Shipping method not available"

data/flex-commerce-api.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "flex_commerce_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "flex_commerce_api"
+  spec.version = FlexCommerceApi::VERSION
+  spec.authors = ["Gary Taylor"]
+  spec.email = ["gary.taylor@flexcommerce.com"]
+
+  spec.summary = "Access the flex-commerce API"
+  spec.description = "Allows any ruby application to access the flex-commerce API"
+  spec.homepage = "https://github.com/shiftcommerce/flex-ruby-gem"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "webmock", "~> 1.21"
+  spec.add_development_dependency "factory_bot", "~> 4.8"
+  spec.add_development_dependency "faker", "~> 1.4"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "json-schema", "~> 2.6"
+  spec.add_development_dependency "pry", "~> 0.10.0"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "thor", "~> 0.19"
+  spec.add_development_dependency "json_matchers", ["~> 0.5", ">= 0.5.1"]
+
+  spec.add_dependency "oj", "~> 2.12"
+  spec.add_runtime_dependency "json_api_client", "1.1.1"
+  spec.add_runtime_dependency "activesupport", ">= 4.0"
+  spec.add_runtime_dependency "rack", ">= 1.6"
+  spec.add_runtime_dependency "faraday-http-cache", "1.3.0"
+end