prestashop 2.0.0

data/lib/prestashop/api/error.rb

@@ -0,0 +1,18 @@
+module Prestashop
+  module Api
+    class InvalidCredentials < RuntimeError
+      def initialize 
+        super "Your credentials are invalid" 
+      end
+    end
+
+    class RequestFailed < RuntimeError
+      attr_reader :response
+      def initialize response
+        @response = response
+      end
+    end
+
+    class ParserError < RuntimeError; end
+  end
+end

data/lib/prestashop/api/refinement.rb

@@ -0,0 +1,14 @@
+module Prestashop
+  module Api
+    module Refinement
+      refine String do 
+        def parse
+          Converter.parse self
+        end
+        def parse_error
+          Converter.parse_error self
+        end
+      end
+    end
+  end
+end

data/lib/prestashop/client.rb

@@ -0,0 +1,19 @@
+require 'prestashop/client/error'
+require 'prestashop/client/implementation'
+require 'prestashop/client/cache'
+
+module Prestashop
+  module Client
+    extend SingleForwardable
+    def_delegators  :current, :connection, :cache
+    def_delegators  :connection, :create, :read, :update, :delete, :check, :upload
+    def_delegators  :cache, :manufacturers_cache, :clear_manufacturers_cache, :categories_cache, :clear_categories_cache, :features_cache, :clear_features_cache, 
+                    :feature_values_cache, :clear_feature_values_cache, :options_cache, :clear_options_cache, :option_values_cache, :clear_option_values_cache
+    
+    # Delegate to current user implementation
+    # 
+    def self.current
+      Implementation.current
+    end
+  end
+end

data/lib/prestashop/client/cache.rb

@@ -0,0 +1,53 @@
+module Prestashop
+  module Client    
+    class Cache
+      def manufacturers_cache
+        @manufacturers_cache ||= Mapper::Manufacturer.cache
+      end
+
+      def clear_manufacturers_cache
+        @manufacturers_cache = nil
+      end
+
+      def categories_cache
+        @categories_cache ||= Mapper::Category.cache
+      end
+
+      def clear_categories_cache
+        @categories_cache = nil
+      end
+
+      def features_cache
+        @features_cache ||= Mapper::ProductFeature.cache
+      end
+
+      def clear_features_cache
+        @features_cache = nil
+      end
+      
+      def feature_values_cache
+        @feature_values_cache ||= Mapper::ProductFeatureValue.cache
+      end
+
+      def clear_feature_values_cache
+        @feature_values_cache = nil
+      end
+
+      def options_cache
+        @options_cache ||= Mapper::ProductOption.cache
+      end
+
+      def clear_options_cache
+        @options_cache = nil
+      end
+
+      def option_values_cache
+        @option_values_cache ||= Mapper::ProductOptionValue.cache
+      end
+
+      def clear_option_values_cache
+        @option_values_cache = nil
+      end
+    end
+  end
+end

data/lib/prestashop/client/error.rb

@@ -0,0 +1,9 @@
+module Prestashop
+  module Client
+    class UnitializedClient < RuntimeError
+      def initialize
+        super "Client isn't initialized"
+      end
+    end
+  end
+end

data/lib/prestashop/client/implementation.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+
+module Prestashop
+  module Client
+    class Implementation
+      include Singleton
+      attr_reader :connection, :cache
+
+      # Initialize new client see +Api::Connection#new+
+      #
+      def initialize api_key, api_url
+        @connection = Api::Connection.new api_key, api_url
+        @cache = Cache.new
+      end
+
+      class << self
+
+        # Create new user implementation, keep it in current thread to allow multithearding, see +#new+
+        #
+        def create api_key, api_url
+          Thread.current[:prestashop_client] = new api_key, api_url
+          current
+        end
+
+        # Get current client or raise exception, when client isn't initialized
+        #
+        def current
+          Thread.current[:prestashop_client] ? Thread.current[:prestashop_client] : raise(UnitializedClient)
+        end
+      end
+    end
+  end
+end

data/lib/prestashop/mapper.rb

@@ -0,0 +1,9 @@
+require 'prestashop/mapper/refinement'
+require 'prestashop/mapper/extension'
+require 'prestashop/mapper/model'
+require 'prestashop/mapper/models'
+
+module Prestashop
+  module Mapper
+  end
+end

data/lib/prestashop/mapper/extension.rb

@@ -0,0 +1,161 @@
+module Prestashop
+  module Mapper
+    module Extension
+      module ClassMethods
+
+        # Determinate if model with class resource exists with given id
+        #
+        #   Car.exists?(1) # => true # if given car exist
+        #   Car.exists?(2) # => false # if given car don't exist
+        #
+        def exists? id
+          Client.check self.resource, id
+        end
+
+        # Find model by class resource and given id, returns hash
+        # with all nodes, based on node name as key, node value as value
+        #
+        #   Car.find(1) # => { id: 1, name: 'BMW' }
+        #   Car.find(2) # => nil
+        #
+        def find id
+          result = Client.read self.resource, id
+          result ? result[self.model] : nil
+        end
+
+        # Find model by class resource and params in hash
+        # Returns first result, see #where for more informations
+        #
+        #   Car.find_by(name: 'BMW') # => 1
+        #
+        def find_by options = {}
+          results = where(options)
+          results ? results.first : nil
+        end
+
+        # Get models all results by class resource, you can specifi what
+        # you should to see as result by specifiyng +:display+
+        #
+        #   Car.all # => [1,2,3]
+        #   Car.all(display: ['name']) # => [{ name: { language: { attr: { id: 2, href: 'http://localhost.com/api/languages/2'}, val: 'BMW 7'} }]
+        #
+        def all options = {}
+          result = if options[:display] 
+            Client.read self.resource, nil, display: options[:display]
+          else
+            Client.read self.resource
+          end
+          handle_result result, options
+        end
+        
+        # Get results by class resource and given conditionals
+        #
+        #   Car.where('filter[id_supplier' => 1) # => [1, 2]
+        # 
+        def where options = {}
+          result = Client.read self.resource, nil, options
+          handle_result result, options
+        end
+
+        # Destroy model by class resource and given id
+        #
+        #   Car.destroy(1) # => true
+        #
+        def destroy id
+          Client.delete self.resource, id
+        end
+
+        # Create hash suitable for update, contains #fixed_hash as hash with deleted
+        # keys, which shouldn't be in payload, if exist
+        #
+        #   Car.update_hash(1, name: 'BMW7') # => {name: 'BMW7', manufacturer: 'BMW'}
+        #
+        def update_hash id, options = {}
+          original = defined?(fixed_hash(nil)) ? fixed_hash(id) : find(id)
+          original.merge(options)
+        end
+
+        # Create payload for update, converts hash to XML
+        #
+        #   Car.update_payload(1, name: 'BMW 7') # => <prestashop xmlns:xlink="http://www.w3.org/1999/xlink"><car><name><![CDATA[BMW 7]]></name></car></prestashop>
+        #
+        def update_payload id, options = {}
+          Api::Converter.build(self.resource, self.model, update_hash(id, options))
+        end
+
+        # Update model, with class resource by +id+ and given updates
+        #
+        #   Car.update(1, name: 'BMW 7') # => {id: 1, name: 'BMW 7'}
+        #
+        def update id, options = {}
+          result = Client.update self.resource, id, update_payload(id, options)
+          result ? result[self.model] : nil
+        end 
+
+        private
+          # Handle result to return +id+ or array with +ids+ of requested objects
+          # 
+          #   handle_result({ customers: { customer: [ 1,2 ] } }) # => [1, 2]
+          #   handle_result({ customers: { customer: { attr: { id: 1 }} } }) # => [1]
+          #
+          def handle_result result, options = {}
+            if options[:display]
+              if result[self.resource].kind_of?(Hash) and result[self.resource][self.model]
+                objects = result[self.resource][self.model]
+                objects.kind_of?(Array) ? objects : [objects]
+              end
+            else
+              if result[self.resource].kind_of?(Hash) and result[self.resource][self.model]
+                [objects = result[self.resource][self.model]]
+                objects.kind_of?(Array) ? objects.map{ |o| o[:attr][:id] } : [ objects[:attr][:id] ]
+              else
+                nil
+              end    
+            end
+          end
+      end
+      
+      module InstanceMethods
+
+        # Generate hash with ID
+        #
+        #   car.hash_id(1) # => {id: 1}
+        #
+        def hash_id id
+          { id: id } if id
+        end
+
+        # Make array of unique IDs in hash
+        #
+        #   car.hash_ids(1,2,3) # => [{id: 1},{id: 2},{id: 3}]
+        # 
+        def hash_ids ids
+          ids.flatten.uniq.map{|id| hash_id(id)} if ids
+        end
+
+        # Create payload for create new object, coverts hash to XML
+        #
+        #   car.payload # => '<prestashop xmlns:xlink="http://www.w3.org/1999/xlink"><car><name><![CDATA[BMW 7]]></name><manufacturer><![CDATA[BMW]]></manufacturer></car></prestashop>'
+        #
+        def payload
+          Api::Converter.build(self.class.resource, self.class.model, hash)
+        end
+
+        # Create new model from instance, based on class resource a payload generated from
+        # hash method
+        # 
+        #   Car.new(name: 'BMW 7', manufacturer: 'BMW').create # => { id: 1, name: 'BMW 7', manufacturer: 'BMW' }
+        # 
+        def create
+          result = Client.create self.class.resource, payload
+          result ? result[self.class.model] : nil
+        end
+      end
+      
+      def self.included(receiver)
+        receiver.extend         ClassMethods
+        receiver.send :include, InstanceMethods
+      end
+    end
+  end
+end

data/lib/prestashop/mapper/model.rb

@@ -0,0 +1,38 @@
+using Prestashop::Mapper::Refinement
+module Prestashop
+  module Mapper
+    class Model
+      include Extension
+      extend Extension
+
+      # Meta title is same as name, when is not given
+      def meta_title
+        @meta_title ? @meta_title.plain.truncate(61) : name
+      end
+
+      # Meta description is same as description, when is not given
+      def meta_description
+        @meta_description ? @meta_description.restricted.truncate(252) : ( description_short.plain if description_short )
+      end
+
+      # Meta keywords are generated from name, when are not given
+      def meta_keywords
+        @meta_keywords ? @meta_keywords.plain.truncate(61) : name.split(' ').join(', ')
+      end
+
+      def hash_lang name, id_lang
+        { language: { val: name, attr: { id: id_lang }}} if name
+      end
+
+      class << self
+        def resource value = nil
+          value.nil? ? @resource : @resource = value
+        end
+
+        def model value = nil
+          value.nil? ? @model : @model = value
+        end
+      end
+    end    
+  end
+end

data/lib/prestashop/mapper/models.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + '/models/*.rb'].each {|file| require file }

data/lib/prestashop/mapper/models/address.rb

@@ -0,0 +1,9 @@
+using Prestashop::Mapper::Refinement
+module Prestashop
+  module Mapper
+    class Address < Model
+      resource :addresses
+      model :address
+    end
+  end
+end

data/lib/prestashop/mapper/models/carrier.rb

@@ -0,0 +1,9 @@
+using Prestashop::Mapper::Refinement
+module Prestashop
+  module Mapper
+    class Carrier < Model
+      resource :carriers
+      model :carrier
+    end
+  end
+end

data/lib/prestashop/mapper/models/cart.rb

@@ -0,0 +1,9 @@
+using Prestashop::Mapper::Refinement
+module Prestashop
+  module Mapper
+    class Cart < Model
+      resource :carts
+      model :cart
+    end
+  end
+end

data/lib/prestashop/mapper/models/cart_rule.rb

@@ -0,0 +1,9 @@
+using Prestashop::Mapper::Refinement
+module Prestashop
+  module Mapper
+    class CartRule < Model
+      resource :cart_rules
+      model :cart_rule
+    end
+  end
+end

data/lib/prestashop/mapper/models/category.rb

@@ -0,0 +1,114 @@
+using Prestashop::Mapper::Refinement
+module Prestashop
+  module Mapper
+    class Category < Model
+      resource :categories
+      model :category
+
+      attr_accessor :id_lang
+      attr_accessor :id, :id_parent, :level_depth, :active, :id_shop_default, :is_root_category, :position
+      attr_writer   :name, :description, :link_rewrite
+
+      def initialize args = {}
+        @id               = args[:id]
+        @id_parent        = args.fetch(:id_parent, 2)
+        @level_depth      = args[:level_depth]
+        # nb_products_recursive
+        @active           = args.fetch(:active, 1)
+        @id_shop_default  = args.fetch(:id_shop_default, 1)
+        @is_root_category = 0
+        @position         = args[:position]
+        # date_add
+        # date_upd
+        @name             = args.fetch(:name)
+        @link_rewrite     = args[:link_rewrite]
+        @description      = args[:description]
+        @meta_title       = args[:meta_title]
+        @meta_description = args[:meta_description]
+        @meta_keywords    = args[:meta_keywords]
+
+        @id_lang          = args.fetch(:id_lang)
+      end
+
+      # Category name can't have some symbols and can't be longer than 63
+      def name
+        @name.plain.truncate(61)
+      end
+
+      # Description can have additional symbols and can't be longer than 255
+      def description
+        @description.restricted.truncate(252) if @description
+      end
+
+      # Link rewrite must be usable in uri
+      def link_rewrite
+        @link_rewrite ? @link_rewrite.parameterize : name.parameterize
+      end
+
+      # Category hash structure, which will be converted to XML
+      def hash
+        { id_parent:        id_parent,
+          active:           active ,
+          id_shop_default:  id_shop_default,
+          is_root_category: is_root_category,
+          name:             hash_lang(name, id_lang),
+          link_rewrite:     hash_lang(link_rewrite, id_lang),
+          description:      hash_lang(description, id_lang),
+          meta_title:       hash_lang(name, id_lang),
+          meta_description: hash_lang(description, id_lang),
+          meta_keywords:    hash_lang(meta_keywords, id_lang) }
+      end
+
+      # Find category by name and id parent, create new one from hash, when doesn't exist
+      def find_or_create
+        category = self.class.find_in_cache id_parent, name, id_lang
+        unless category
+          category = create
+          Client.clear_categories_cache
+        end
+        category[:id]
+      end
+
+      class << self
+
+        # Search for category based on args on cached categories, see #cache and #Client::Settings.categories_cache
+        # Returns founded category or nil
+        #
+        def find_in_cache id_parent, name, id_lang
+          Client.categories_cache.find{ |c| c[:id_parent] == id_parent and c[:name].find_lang(name, id_lang) }
+        end
+
+        # Requesting all on Prestashop API, displaying id, id_parent, name
+        def cache
+          all display: '[id, id_parent, name]'
+        end
+
+        # Create new category based on given param, delimited by delimiter in settings
+        #
+        # ==== Example:
+        #   Category.create_from_name('Apple||iPhone', 2) # => [1, 2]
+        #
+        def create_from_name category_name, id_lang
+          if category_name and !category_name.empty?
+            names = [category_name.split('||')].flatten!
+            categories = []
+            id_parent = 2
+            names.each do |name|
+              id_parent = new(name: name, id_parent: id_parent, id_lang: id_lang).find_or_create
+              categories << id_parent
+            end
+            categories
+          end
+        end
+
+        def create_from_names category_names, id_lang
+          categories = []
+          category_names.each do |category_name|
+            categories << create_from_name(category_name, id_lang)
+          end
+          categories.flatten.uniq
+        end
+      end
+    end
+  end
+end