duodealer_api 1.0.0

data/lib/duodealer_api/resources/article.rb

@@ -0,0 +1,21 @@
+module DuodealerAPI
+  class Article < Base
+    include Events
+    include Metafields
+    include DisablePrefixCheck
+
+    conditional_prefix :blog
+
+    def comments
+      Comment.find(:all, :params => { :article_id => id })
+    end
+
+    def self.authors(options = {})
+      get(:authors, options)
+    end
+
+    def self.tags(options={})
+      get(:tags, options)
+    end
+  end
+end

data/lib/duodealer_api/resources/asset.rb

@@ -0,0 +1,100 @@
+module DuodealerAPI
+  # Assets represent the files that comprise your theme.
+  # There are different buckets which hold different kinds
+  # of assets, each corresponding to one of the folders
+  # within a theme's zip file: "layout", "templates",
+  # "snippets", "assets", and "config". The full key of an
+  # asset always starts with the bucket name, and the path
+  # separator is a forward slash, like layout/theme.liquid
+  # or assets/bg-body.gif.
+  #
+  # Initialize with a key:
+  #   asset = DuodealerAPI::Asset.new(:key => 'assets/special.css', :theme_id => 12345)
+  #
+  # Find by key:
+  #   asset = DuodealerAPI::Asset.find('assets/image.png', :params => {:theme_id => 12345})
+  #
+  # Get the text or binary value:
+  #   asset.value # decodes from attachment attribute if necessary
+  #
+  # You can provide new data for assets in a few different ways:
+  #
+  #   * assign text data for the value directly:
+  #       asset.value = "div.special {color:red;}"
+  #
+  #   * provide binary data for the value:
+  #       asset.attach(File.read('image.png'))
+  #
+  #   * set a URL from which Duo Dealer will fetch the value:
+  #       asset.src = "http://mysite.com/image.png"
+  #
+  #   * set a source key of another of your assets from which
+  #     the value will be copied:
+  #       asset.source_key = "assets/another_image.png"
+  class Asset < Base
+    include DisablePrefixCheck
+
+    self.primary_key = 'key'
+
+    conditional_prefix :theme
+
+    def self.element_path(id, prefix_options = {}, query_options = nil) #:nodoc:
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+    end
+
+    # find an asset by key:
+    #   DuodealerAPI::Asset.find('layout/theme.liquid', :params => { theme_id: 99 })
+    def self.find(*args)
+      if args[0].is_a?(Symbol)
+        super
+      else
+        params = { asset: { key: args[0] } }
+        params = params.merge(args[1][:params]) if args[1] && args[1][:params]
+        path_prefix = params[:theme_id] ? "themes/#{params[:theme_id]}/" : ""
+        resource = find(
+          :one,
+          from: api_version.construct_api_path("#{path_prefix}assets.#{format.extension}"),
+          params: params
+        )
+        resource.prefix_options[:theme_id] = params[:theme_id] if resource && params[:theme_id]
+        resource
+      end
+    end
+
+    # For text assets, Duo Dealer returns the data in the 'value' attribute.
+    # For binary assets, the data is base-64-encoded and returned in the
+    # 'attachment' attribute. This accessor returns the data in both cases.
+    def value
+      attributes['value'] ||
+      (attributes['attachment'] ? Base64.decode64(attributes['attachment']) : nil)
+    end
+
+    def attach(data)
+      self.attachment = Base64.encode64(data)
+    end
+
+    def destroy
+      connection.delete(element_path(prefix_options.merge(:asset => {:key => key})), self.class.headers)
+    end
+
+    def new?
+      false
+    end
+
+    def method_missing(method_symbol, *arguments) #:nodoc:
+      if %w{value= attachment= src= source_key=}.include?(method_symbol)
+        wipe_value_attributes
+      end
+      super
+    end
+
+    private
+
+    def wipe_value_attributes
+      %w{value attachment src source_key}.each do |attr|
+        attributes.delete(attr)
+      end
+    end
+  end
+end

data/lib/duodealer_api/resources/assigned_fulfillment_order.rb

@@ -0,0 +1,16 @@
+module DuodealerAPI
+  class AssignedFulfillmentOrder < Base
+
+    def initialize(attributes = {}, persisted = false)
+      DuodealerAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
+      super(attributes, persisted)
+    end
+
+    def self.find(scope, *args)
+      DuodealerAPI::Base.version_validation!(FulfillmentOrder::MINIMUM_VERSION)
+
+      assigned_fulfillment_orders = super(scope, *args)
+      assigned_fulfillment_orders.map { |afo| FulfillmentOrder.new(afo.attributes) }
+    end
+  end
+end

data/lib/duodealer_api/resources/base.rb

@@ -0,0 +1,162 @@
+require 'duodealer_api/version'
+
+module DuodealerAPI
+  class Base < ActiveResource::Base
+    class InvalidSessionError < StandardError; end
+    extend Countable
+
+    self.timeout = 90
+    self.include_root_in_json = false
+    self.headers['User-Agent'] = ["DuodealerAPI/#{DuodealerAPI::VERSION}",
+                                  "ActiveResource/#{ActiveResource::VERSION::STRING}",
+                                  "Ruby/#{RUBY_VERSION}"].join(' ')
+
+    self.collection_parser = DuodealerAPI::PaginatedCollection
+
+    def encode(options = {})
+      same = dup
+      same.attributes = {self.class.element_name => same.attributes} if self.class.format.extension == 'json'
+
+      same.send("to_#{self.class.format.extension}", options)
+    end
+
+    def as_json(options = nil)
+      root = options[:root] if options.try(:key?, :root)
+      if include_root_in_json
+        root = self.class.model_name.element if root == true
+        { root => serializable_hash(options) }
+      else
+        serializable_hash(options)
+      end
+    end
+
+    class << self
+      threadsafe_attribute(:_api_version)
+      def headers
+        if _headers_defined?
+          _headers
+        elsif superclass != Object && superclass.headers
+          superclass.headers
+        else
+          _headers ||= {}
+        end
+      end
+
+      def activate_session(session)
+        raise InvalidSessionError.new("Session cannot be nil") if session.nil?
+        self.site = session.site
+        self.headers.merge!('X-DuoDealer-Access-Token' => session.token)
+        self.api_version = session.api_version
+      end
+
+      def clear_session
+        self.site = nil
+        self.password = nil
+        self.user = nil
+        self.api_version = nil
+        self.headers.delete('X-DuoDealer-Access-Token')
+      end
+
+      def api_version
+        if _api_version_defined?
+          _api_version
+        elsif superclass != Object && superclass.site
+          superclass.api_version.dup.freeze
+        else
+          ApiVersion::NullVersion
+        end
+      end
+
+      def api_version=(version)
+        self._api_version = ApiVersion::NullVersion.matches?(version) ? ApiVersion::NullVersion : ApiVersion.find_version(version)
+      end
+
+      def prefix(options = {})
+        api_version.construct_api_path(resource_prefix(options))
+      end
+
+      def prefix_source
+        ''
+      end
+
+      def resource_prefix(_options = {})
+        ''
+      end
+
+      # Sets the \prefix for a resource's nested URL (e.g., <tt>prefix/collectionname/1.json</tt>).
+      # Default value is <tt>site.path</tt>.
+      def resource_prefix=(value)
+        @prefix_parameters = nil
+
+        resource_prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.parser.escape options[#{key}].to_s}" }
+
+        silence_warnings do
+          # Redefine the new methods.
+          instance_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+            def prefix_source() "#{value}" end
+            def resource_prefix(options={}) "#{resource_prefix_call}" end
+          RUBY_EVAL
+        end
+      rescue => e
+        logger&.error("Couldn't set prefix: #{e}\n  #{code}")
+        raise
+      end
+
+      def prefix=(value)
+        if value.start_with?('/admin')
+          raise ArgumentError, "'#{value}' can no longer start /admin/. Change to using resource_prefix="
+        end
+
+        warn(
+          '[DEPRECATED] DuodealerAPI::Base#prefix= is deprecated and will be removed in a future version. ' \
+            'Use `self.resource_prefix=` instead.'
+        )
+        self.resource_prefix = value
+      end
+
+      alias_method :set_prefix, :prefix=
+
+      def init_prefix(resource)
+        init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
+      end
+
+      def init_prefix_explicit(resource_type, resource_id)
+        self.resource_prefix = "#{resource_type}/:#{resource_id}/"
+
+        define_method resource_id.to_sym do
+          @prefix_options[resource_id]
+        end
+      end
+
+      def early_july_pagination?
+        !!early_july_pagination
+      end
+
+      def version_validation!(minimum_version)
+        available_in_version = DuodealerAPI::ApiVersion.find_version(minimum_version)
+
+        unless DuodealerAPI::Base.api_version >= available_in_version
+          raise NotImplementedError, "The minimum supported version is #{minimum_version}."
+        end
+      end
+
+      private
+
+      attr_accessor :early_july_pagination
+
+      def early_july_pagination_release!
+        self.early_july_pagination = true
+      end
+    end
+
+    def persisted?
+      !id.nil?
+    end
+
+    private
+
+    def only_id
+      encode(:only => :id, :include => [], :methods => [])
+    end
+  end
+end

data/lib/duodealer_api/resources/billing_address.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class BillingAddress < Base
+  end
+end

data/lib/duodealer_api/resources/blog.rb

@@ -0,0 +1,10 @@
+module DuodealerAPI
+  class Blog < Base
+    include Events
+    include Metafields
+
+    def articles
+      Article.find(:all, :params => { :blog_id => id })
+    end
+  end
+end

data/lib/duodealer_api/resources/carrier_service.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class CarrierService < Base
+  end
+end

data/lib/duodealer_api/resources/cart.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class Cart < Base
+  end
+end

data/lib/duodealer_api/resources/checkout.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class Checkout < Base
+    self.primary_key = :token
+
+    def self.headers
+      super.merge('X-DuoDealer-Checkout-Version' => '2016-09-06')
+    end
+
+    def complete
+      post(:complete)
+    end
+
+    def ready?
+      return false unless persisted?
+
+      reload
+      [200, 201].include?(DuodealerAPI::Base.connection.response.code.to_i)
+    end
+
+    def payments
+      Payment.find(:all, params: { checkout_id: id })
+    end
+
+    def shipping_rates
+      ShippingRate.find(:all, params: { checkout_id: id })
+    end
+  end
+end

data/lib/duodealer_api/resources/collect.rb

@@ -0,0 +1,6 @@
+module DuodealerAPI
+  # For adding/removing products from custom collections
+  class Collect < Base
+    early_july_pagination_release!
+  end
+end

data/lib/duodealer_api/resources/collection.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class Collection < Base
+    include Events
+    include Metafields
+
+    def products(options = {})
+      available_in_version = DuodealerAPI::ApiVersion.find_version('2020-01')
+      raise NotImplementedError unless DuodealerAPI::Base.api_version >= available_in_version
+      Product.find(:all, from: "#{self.class.prefix}collections/#{id}/products.json", params: options)
+    end
+  end
+end

data/lib/duodealer_api/resources/collection_listing.rb

@@ -0,0 +1,18 @@
+module DuodealerAPI
+  class CollectionListing < Base
+    self.primary_key = :collection_id
+
+    early_july_pagination_release!
+
+    def product_ids
+      ProductId.all(params: { collection_id: collection_id })
+    end
+
+    class ProductId < ArrayBase
+      self.resource_prefix = 'collection_listings/:collection_id/'
+
+      early_july_pagination_release!
+    end
+    private_constant :ProductId
+  end
+end

data/lib/duodealer_api/resources/collection_publication.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module DuodealerAPI
+  class CollectionPublication < Base
+    init_prefix :publication
+
+    def publication_id
+      @prefix_options[:publication_id]
+    end
+  end
+end

data/lib/duodealer_api/resources/comment.rb

@@ -0,0 +1,9 @@
+module DuodealerAPI
+  class Comment < Base
+    def remove;   load_attributes_from_response(post(:remove, {}, only_id)); end
+    def spam;     load_attributes_from_response(post(:spam, {}, only_id)); end
+    def approve;  load_attributes_from_response(post(:approve, {}, only_id)); end
+    def restore;  load_attributes_from_response(post(:restore, {}, only_id)); end
+    def not_spam; load_attributes_from_response(post(:not_spam, {}, only_id)); end
+  end
+end

data/lib/duodealer_api/resources/country.rb

@@ -0,0 +1,4 @@
+module DuodealerAPI
+  class Country < Base
+  end
+end

data/lib/duodealer_api/resources/currency.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DuodealerAPI
+  class Currency < Base
+  end
+end

data/lib/duodealer_api/resources/custom_collection.rb

@@ -0,0 +1,19 @@
+module DuodealerAPI
+  class CustomCollection < Base
+    include Events
+    include Metafields
+
+    def products
+      Product.find(:all, :params => {:collection_id => self.id})
+    end
+
+    def add_product(product)
+      Collect.create(:collection_id => self.id, :product_id => product.id)
+    end
+
+    def remove_product(product)
+      collect = Collect.find(:first, :params => {:collection_id => self.id, :product_id => product.id})
+      collect.destroy if collect
+    end
+  end
+end