flex_commerce_api 0.6.57

data/.ruby-gemset

@@ -0,0 +1 @@
+flex-ruby-gem

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in flex-commerce-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2017 Shift Commerce Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Flex::Commerce::Api
+
+Allows any ruby application to use the FlexCommerce platform using its API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flex-commerce-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flex-commerce-api
+
+## Usage
+
+The gem provides many models in the FlexCommerce namespace.  The example below is a rails controller
+accessing a list of products.
+
+```ruby
+class ProductsController < ApplicationController
+
+  # GET /products
+  def index
+    @products = FlexCommerce::Product.paginate(params[:page])
+  end
+end
+
+```
+
+To any rails developer this will look familiar.
+
+However, we do not force you to use rails.  We appreciate that there are many frameworks out there
+and whilst rails is an excellent tool, for smaller projects you may want to look at others such
+as sinatra etc...
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/flex-commerce-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/models/address.rb

@@ -0,0 +1,41 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Address model
+  #
+  # This model provides access to the flex commerce addresses
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all addresses for a customer account
+  #
+  #   customer_account.addresses.all #fetches all addresses(actually the first page in case there are thousands)
+  #
+  #
+  class Address < FlexCommerceApi::ApiBase
+
+    # @method all
+    # Returns all addresses
+    # @return [FlexCommerce::Address[]] An array of categories or an empty array
+    class << self
+      def path(params, instance = nil)
+        if params[:filter] && params[:filter].key?(:customer_account_id)
+          customer_account_id = params[:filter].delete(:customer_account_id)
+          params.delete(:filter) if params[:filter].empty?
+          "customer_accounts/#{customer_account_id}/addresses"
+        elsif instance && instance.try(:customer_account_id).try(:present?)
+          "customer_accounts/#{instance.customer_account_id}/addresses"
+        else
+          super
+        end
+      end
+
+    end
+
+    has_one :customer_account
+  end
+end

data/app/models/asset_file.rb

@@ -0,0 +1,26 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce asset file model
+  #
+  # This model provides access to the flex asset file
+  #
+  # It is used much like an active record model.
+  #
+  class AssetFile < FlexCommerceApi::ApiBase
+    has_one :asset_folder
+    def self.path(params, resource)
+      internal_params = params.with_indifferent_access
+      if !internal_params.key?("asset_folder_id") && !internal_params.key?("path") && resource && resource.relationships["asset_folder"]["links"]["related"]=~/^\/asset_folders/
+        resource.relationships["asset_folder"]["links"]["related"].gsub(/\.json_api$/, '') + "/asset_files"
+      elsif internal_params.key?("path") && internal_params["path"].key?("asset_folder_id") && internal_params["path"]["asset_folder_id"].is_a?(String)
+        # As the asset_folder_id is going into the url, and the developer may sent it anything, then we should escape it
+        new_params = internal_params.deep_dup
+        new_params["path"]["asset_folder_id"] = URI.escape(new_params["path"]["asset_folder_id"])
+        super(new_params, resource)
+      else
+        super
+      end
+    end
+  end
+end

data/app/models/asset_folder.rb

@@ -0,0 +1,14 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce asset folder model
+  #
+  # This model provides access to the flex asset folder and associated files
+  #
+  # It is used much like an active record model.
+  #
+  class AssetFolder < FlexCommerceApi::ApiBase
+    has_many :asset_files
+    has_many :sub_folders, class_name: "::FlexCommerce::AssetFolder"
+  end
+end

data/app/models/bundle.rb

@@ -0,0 +1,20 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Bundle model
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetch all reports, paginated
+  #   FlexCommerce::Bundle.all
+  #
+  #   # Fetch by slug
+  #   FlexCommerce::Bundle.find("slug:test")
+  #
+  class Bundle < FlexCommerceApi::ApiBase
+    has_many :bundle_groups, class_name: "::FlexCommerce::BundleGroup"
+    has_many :slugs, class_name: "::FlexCommerce::Slug"
+  end
+end

data/app/models/bundle_group.rb

@@ -0,0 +1,15 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Bundle Group model
+  #
+  # This model provides access to the flex commerce bundle group
+  #
+  # It is generally used as a relationship of products rather than by itself
+  #
+  #
+  class BundleGroup < FlexCommerceApi::ApiBase
+    belongs_to :bundle, class_name: "::FlexCommerce::Bundle"
+    has_many :products, class_name: "::FlexCommerce::Product"
+  end
+end

data/app/models/cart.rb

@@ -0,0 +1,136 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Cart model
+  #
+  # This model provides access to the flex commerce cart and associated line_items.
+  # This model allows you to create a cart, update its line items and delete a cart.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Creating a cart
+  #
+  #   FlexCommerce::Cart.create #creates and returns a new cart ready for use
+  #
+  #   # Fetching its line items
+  #
+  #   cart.line_items
+  #
+  #   # Finding a cart
+  #
+  #   FlexCommerce::Cart.find(<<cart_id>>) # Finds the cart with this unique id
+  #
+  #
+  class Cart < FlexCommerceApi::ApiBase
+    # @method find
+    # @param [String] spec
+    # Finds a cart
+    # @return [FlexCommerce::Cart] cart The cart
+    # @raise [FlexCommerceApi::Error::NotFound] If not found
+
+    # @method line_items
+    # Provides a list of associated line_items
+    # @return [FlexCommerce::LineItem[]]
+
+    # @TODO Document other popular methods that we will support
+
+    has_many :line_items, class_name: "::FlexCommerce::LineItem"
+    has_many :discount_summaries, class_name: "::FlexCommerce::DiscountSummary"
+    has_many :available_shipping_methods, class_name: "::FlexCommerceApi::ApiBase"
+    has_many :available_shipping_promotions, class_name: "::FlexCommerce::Promotion"
+    has_one :shipping_address, class_name: "::FlexCommerce::Address"
+    has_one :billing_address, class_name: "::FlexCommerce::Address"
+    has_one :shipping_method, class_name: "::FlexCommerce::ShippingMethod"
+    has_one :free_shipping_promotion, class_name: "::FlexCommerce::FreeShippingPromotion"
+
+    # properties
+    property :line_items_count, type: :integer, default: 0
+    property :total_discount, default: 0
+
+    # Here we override line_items to provide a proxy to the array so we can use new and create on it in the normal
+    # active record way
+    def line_items
+      has_many_association_proxy :line_items, (super || []), inverse_of: :container
+    end
+
+    def empty?
+      line_items_count == 0
+    end
+
+    # Merges another cart into this one using the API
+    # @param [FlexCommerce::Cart] other_cart The cart to merge from
+    def merge!(other_cart)
+      self.last_result_set = self.class.requestor.custom("merge", { request_method: :patch }, data: {type: "carts", attributes: { from_cart_id: other_cart.id, to_cart_id: id } } )
+      mark_as_persisted!
+      if updated = last_result_set.first
+        self.attributes = updated.attributes
+        self.relationships = updated.relationships
+        clear_changes_information
+      end
+      self
+    end
+
+    # This method is used when true stock levels re required - potentially from an external system
+    # To be used during checkout phases etc..
+    # Adds errors to the line items "unit_quantity" attribute if we do not have enough
+    def validate_stock!
+      return {} if empty?
+      stock_levels.each_with_object({}) do |stock_level, obj|
+        line_items.detect { |li| li.item.sku == stock_level.id }.tap do |li|
+          next if li.nil?
+          if stock_level.stock_available <= 0
+            obj[li.item.sku] = {
+              stock_level: 0,
+              line_item_quantity: li.unit_quantity,
+              message: "Out of stock"
+            }
+          elsif stock_level.stock_available < li.unit_quantity
+            obj[li.item.sku] = {
+              stock_level: stock_level.stock_available,
+              line_item_quantity: li.unit_quantity,
+              message: "Only #{stock_level.stock_available} in stock"
+            }
+          end
+          li.errors.add(:unit_quantity, obj.dig(li.item.sku, :message)) unless obj.dig(li.item.sku, :message).nil?
+        end
+      end
+    end
+
+    def add_payment_transaction(transaction)
+      self.class.requestor.custom("relationships/payment_transactions", {request_method: :post}, {id: id, data: [type: "payment_transactions", id: transaction.id.to_s]})
+    end
+
+    def self.create(args = {})
+      if FlexCommerceApi.config.order_test_mode
+        super(args.merge(test: true))
+      else
+        super
+      end
+    end
+
+    def available_shipping_methods
+      return super if relationships[:available_shipping_methods].key?("data")
+      shipping_methods = get_related(:available_shipping_methods).to_a
+      if shipping_methods.any? { |sm| sm.is_a?(FlexCommerce::RemoteShippingMethod) }
+        shipping_method_references = shipping_methods.map(&:reference)
+        # We are filtering in memory here as there will never be many shipping methods and they will almost certainly be in the cache anyway
+        FlexCommerce::ShippingMethod.all.select { |shipping_method| shipping_method_references.include?(shipping_method.reference)}
+      else
+        shipping_methods
+      end
+    end
+
+
+    private
+
+    def stock_levels
+      StockLevel.where(skus: line_items.map { |li| li.item.sku }.join(",")).all
+    end
+
+
+  end
+end

data/app/models/category.rb

@@ -0,0 +1,70 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Category model
+  #
+  # This model provides access to the flex commerce categories and associated products.
+  # As managing the categories is the job of the administration panel, this
+  # model is read only.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all categories
+  #
+  #   FlexCommerce::Category.all #fetches all categories(actually the first page in case there are thousands)
+  #
+  #   # Pagination
+  #
+  #   FlexCommerce::Category.paginate(page:2).all # Fetches page 2 of categories.
+  #   The page size is predefined on the server side
+  #
+  #   # Finding categories
+  #
+  #   FlexCommerce::Product.find("my-category-slug") # Finds the category with this unique id
+  #
+  #   # Finding nested categories of the category
+  #
+  #   FlexCommerce::Category.find("my-category-slug").categories
+  #
+  #   # Finding products within the categories
+  #
+  #   FlexCommerce::Category.find("my-category-slug").products
+  #
+  #   or if you already know the category id - then
+  #
+  #   @TODO Look into this
+  #
+  class Category < FlexCommerceApi::ApiBase
+    # @method find
+    # @param [String] spec
+    # Finds a category
+    # @return [FlexCommerce::Category] category The category
+    # @raise [FlexCommerceApi::Error::NotFound] If not found
+
+    # @method all
+    # Returns all categories
+    # @return [FlexCommerce::Category[]] An array of categories or an empty array
+
+    # @method paginate
+    # Paginates the list of categories by a preset page size
+    # @param [Hash] options The options to paginate with
+    # @param options [Numeric|String] :page The page to fetch
+
+    # @method categories
+    # Provides a list of associated sub categories
+    # @return [FlexCommerce::Category[]]
+
+    # @TODO Document other popular methods that we will support
+
+    has_many :categories, class_name: "::FlexCommerce::Category"
+    has_many :products, class_name: "::FlexCommerce::Product"
+    has_many :slugs, class_name: "::FlexCommerce::Slug"
+    belongs_to :category_tree, class_name: "::FlexCommerce::CategoryTree"
+    has_one :template_definition, class_name: "::FlexCommerce::TemplateDefinition"
+    has_one :template, class_name: "::FlexCommerce::Template"
+  end
+end

data/app/models/category_tree.rb

@@ -0,0 +1,11 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Category tree model
+  #
+  # This model provides access to the flex commerce category tree and associated categories.
+  class CategoryTree < FlexCommerceApi::ApiBase
+    has_many :slugs, class_name: "::FlexCommerce::Slug"
+    has_many :categories, class_name: "::FlexCommerce::Category"
+  end
+end

data/app/models/component.rb

@@ -0,0 +1,8 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce component
+  #
+  class Component < FlexCommerceApi::ApiBase
+  end
+end