magenthor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0ff08ef8e893c262882d2d49a92e8a8a58e09e9
-  data.tar.gz: 8dcb51d57f9594665447bbad208fdb97fc0a433f
+  metadata.gz: 589ee0fefcf3a0e84a42551a7f393caa738b58c9
+  data.tar.gz: 7b70817c5a5eb059cd3067aaf2343df5c9654f25
 SHA512:
-  metadata.gz: f83acf1b1b252bec528ff5030d4e259a1fcb0fdb4611ca520f6a57ca68864259607ad2cab44a0f6459d3ae4b27230d7db7e233ad16d6e95ee4c6f99ad6eb98be
-  data.tar.gz: dc64072c5834e32d4415eeee4fcfb99a3897e2fcd92dcb03079169f1a1d7cf779922fb5ddf0db1786980bffe62fe87dfe87fb2f0305c3266713d501be9b2fd29
+  metadata.gz: 76c4abc74187ed91ca5ad96e077bfbe18dafbe603f05f4f08de557d2d42680fb3ebdcb344e0014a0f3a97bbc0ba743f0db2aff68415cb5a474238fad9526b908
+  data.tar.gz: 2dabff7cbd1b452341a270e07763ede344819543ab7633531eb81fd27cf0bca0850c5988fc308c93ae13078e4aa9ea54e2c4e6d830169d6a41f152c6c449c382

data/lib/magenthor/base.rb

@@ -1,65 +1,85 @@
-module Magenthor
-    class Base
-        @@client = nil
-        @@session_id = nil
-        @@api_user = nil
-        @@api_key = nil
-        
-        #TODO: better description
-        #Intializer for setting up connection. Params required: host/port/api_user/api_key
-        def initialize params
-            if params.class != Hash
-                puts "Parameters Error!"
-                return false
-            end
-    
-            @@api_user = params[:api_user]
-            @@api_key = params[:api_key]
-            url = "http://#{params[:host]}:#{params[:port]}/api/xmlrpc"
-            
-            @@client = XMLRPC::Client.new2(url)
-            @@client.http_header_extra = { "accept-encoding" => "identity" }
-        end
-        
-        private
-        
-        #TODO: better description
-        def self.login
-            begin
-                @@session_id = @@client.call('login', @@api_user, @@api_key)
-                return true
-            rescue => e
-                if e.class == NoMethodError
-                    puts 'You must first set the connection parameters using Magenthor::Base.new'
-                    return false
-                end
-            end
-        end
-        
-        #TODO: better description
-        def self.logout
-            response = @@client.call('endSession', @@session_id)
-            @@session_id = nil
-        end
-        
-        #TODO: better description
-        def self.commit resource_path, params
-            if params.class == Hash
-                params = [params]   #Magento wants an Array, always!
-            end
-            
-            if login
-                begin
-                    @@client.call('call', @@session_id, resource_path, params)
-                rescue => e
-                    if e.class == XMLRPC::FaultException
-                        puts "Magento says: #{e.message}"
-                    end
-                    return false
-                ensure
-                    logout
-                end
-            end
-        end
-    end
-end
+# @author Daniele Lenares
+module Magenthor
+    class Base
+
+        @@client = nil
+        @@session_id = nil
+        @@api_user = nil
+        @@api_key = nil
+        
+
+        # Initialize the constants that will be used to make the connection to Magento
+        #
+        # @param params [Hash] contains the paramters needed for connection
+        # @return [Magenthor::Base]
+        def self.setup params
+            if params.class != Hash
+                puts "Parameters must be in an Hash."
+                return false
+            end
+
+            if !params.key? :host or !params.key? :api_user or !params.key? :api_key
+                puts "Mandatory parameter missing. Check if :host, :api_user and :api_key are there."
+                return false
+            end
+    
+            @@api_user = params[:api_user]
+            @@api_key = params[:api_key]
+            url = "http://#{params[:host]}:#{params[:port]}/api/xmlrpc"
+            
+            @@client = XMLRPC::Client.new2(url)
+            @@client.http_header_extra = { "accept-encoding" => "identity" }
+
+            return true
+        end
+        
+        private
+        
+        # Login to Magento using the parameters setted on #initialize
+        #
+        # @return [TrueClass, FalseClass] true if login successful or false
+        def self.login
+            begin
+                @@session_id = @@client.call('login', @@api_user, @@api_key)
+                return true
+            rescue => e
+                if e.class == NoMethodError
+                    puts 'You must first set the connection parameters using Magenthor::Base.setup'
+                    return false
+                end
+            end
+        end
+        
+        # End the current Magento api session
+        def self.logout
+            response = @@client.call('endSession', @@session_id)
+            @@session_id = nil
+        end
+        
+        # Call the Magento Api resource passing parameters
+        #
+        # @param resource_path [String] the Magento Api resource path to call
+        # @param params [Hash, Array] the paramters needed for the call
+        # @return [Array, FalseClass] the result set if the call is successful or false
+        def self.commit resource_path, params
+            if params.class == Hash
+                params = [params]   # Magento wants an Array, always!
+            end
+            
+            if login
+                begin
+                    @@client.call('call', @@session_id, resource_path, params)
+                rescue => e
+                    if e.class == XMLRPC::FaultException
+                        puts "Magento says: #{e.message}"
+                    end
+                    return false
+                ensure
+                    logout
+                end
+            else
+                return false
+            end
+        end
+    end
+end

data/lib/magenthor/customer.rb

@@ -1,143 +1,166 @@
-module Magenthor
-    class Customer < Base
-        
-        attr_accessor :firstname, :lastname, :middlename, :increment_id, :store_id, 
-                    :website_id, :created_in, :email, :group_id, :prefix, :suffix, :dob,
-                    :taxvat, :confirmation, :gender, :password
-        attr_reader :customer_id, :increment_id, :created_at, :updated_at, :password_hash
-        
-        private
-        attr_writer :customer_id, :increment_id, :created_at, :updated_at, :password_hash
-        
-        public
-        
-        #TODO: better description
-        #Initialize a new customer entity
-        def initialize params = {}
+# @author Daniele Lenares
+module Magenthor
+    class Customer < Base
+        
+        attr_accessor :firstname, :lastname, :middlename, :increment_id, :store_id, 
+                    :website_id, :created_in, :email, :group_id, :prefix, :suffix, :dob,
+                    :taxvat, :confirmation, :gender, :password
+        attr_reader :customer_id, :increment_id, :created_at, :updated_at, :password_hash
+        
+        private
+        attr_writer :customer_id, :increment_id, :created_at, :updated_at, :password_hash
+        
+        public
+        
+        # Initialize a new Customer entity
+        #
+        # @param params [Hash] the to save in the instance on initialization
+        # @return [Magenthor::Customer] a new instance of Customer
+        def initialize params = {}
             methods.grep(/\w=$/).each do |m|
                 send(m, nil)
             end
-            params.each do |k, v|
-                send("#{k}=", v) if respond_to? "#{k}="
-            end
-            self.customer_id = params["customer_id"]
-            self.increment_id = params["increment_id"]
-            self.created_at = params["created_at"]
-            self.updated_at = params["updated_at"]
-            self.password_hash = params["password_hash"]
-            
-        end
-        
-        #TODO: better description
-        #Update an existing customer
-        def update
-            attributes = {}
-            methods.grep(/\w=$/).each do |m|
-                attributes[m.to_s.gsub('=','')] = send(m.to_s.gsub('=',''))
-            end
-            self.class.commit('customer.update', [self.customer_id, attributes])
-        end
-
-        #TODO: better description
-        #Create a new customer
-        def create
-            attributes = {}
-            methods.grep(/\w=$/).each do |m|
-                attributes[m.to_s.gsub('=','')] = send(m.to_s.gsub('=',''))
-            end
-            response = self.class.commit('customer.create', [attributes])
-            return false if response == false
-
-            obj = self.class.find(response)
-            methods.grep(/\w=$/).each do |m|
-                send(m, obj.send(m.to_s.gsub('=','')))
-            end
-            self.customer_id = obj.customer_id
-            self.increment_id = obj.increment_id
-            self.created_at = obj.created_at
-            self.updated_at = obj.updated_at
-            self.password_hash = obj.password_hash
-
-            return true
-        end
-
-        #TODO: better description
-        #Delete an existing customer
-        def delete
-            response = self.class.commit('customer.delete', [self.customer_id])
-            return false if response == false
-
-            methods.grep(/\w=$/).each do |m|
-                send(m, nil)
-            end
-            self.customer_id = nil
-            self.increment_id = nil
-            self.created_at = nil
-            self.updated_at = nil
-            self.password_hash = nil
-
-            return true
-        end
-
-        class << self
-            #TODO: better description
-            #List al customers with all info
-            def list filters = []
-                response = commit('customer.list', filters)
-                customers = []
-                response.each do |r|
-                    customers << find(r["customer_id"])
-                end
-                return customers
-            end
-            
-            #TODO: better description
-            #Find a customer by id
-            def find customer_id
-                response = commit('customer.info', [customer_id])
-                new(response) unless response == false
-            end
-            
-            #TODO: better description
-            #Dynamic methods to find customers based on Magento attributes
-            customer_attributes = [
-                "increment_id",
-                "created_in",
-                "store_id",
-                "website_id",
-                "email",
-                "firstname",
-                "middlename",
-                "lastname",
-                "group_id",
-                "prefix",
-                "suffix",
-                "dob",
-                "taxvat",
-                "confirmation"]
-            customer_attributes.each do |a|
-                define_method("find_by_#{a}") do |arg|
-                    find_by a, arg
-                end
-            end
-
-            
-            private
-            
-            #TODO: better description
-            #Method to find customers based on a specific Magento attribute
-            def find_by (attribute, value)
-                response = commit('customer.list', [attribute => value])
-                if response.count > 1
-                    customers = []
-                    response.each do |r|
-                        customers << find(r["customer_id"])
-                    end
-                    return customers
-                else
-                    return new(response[0])
-                end
-            end
-        end
-    end
-end
+            params.each do |k, v|
+                send("#{k}=", v) if respond_to? "#{k}="
+            end
+            self.customer_id = params["customer_id"]
+            self.increment_id = params["increment_id"]
+            self.created_at = params["created_at"]
+            self.updated_at = params["updated_at"]
+            self.password_hash = params["password_hash"]
+            
+        end
+        
+        # Save on Magento the updates on the local Customer
+        #
+        # @return [TrueCalss, FalseClass] true if successful or false
+        def update
+            attributes = {}
+            methods.grep(/\w=$/).each do |m|
+                attributes[m.to_s.gsub('=','')] = send(m.to_s.gsub('=',''))
+            end
+            self.class.commit('customer.update', [self.customer_id, attributes])
+        end
+
+        # Create on Magento the local Customer
+        #
+        # @return [TrueClass, FalseClass] true if successful or false
+        def create
+            attributes = {}
+            methods.grep(/\w=$/).each do |m|
+                attributes[m.to_s.gsub('=','')] = send(m.to_s.gsub('=',''))
+            end
+            response = self.class.commit('customer.create', [attributes])
+            return false if response == false
+
+            obj = self.class.find(response)
+            methods.grep(/\w=$/).each do |m|
+                send(m, obj.send(m.to_s.gsub('=','')))
+            end
+            self.customer_id = obj.customer_id
+            self.increment_id = obj.increment_id
+            self.created_at = obj.created_at
+            self.updated_at = obj.updated_at
+            self.password_hash = obj.password_hash
+
+            return true
+        end
+
+        # Remove from Magento the local Customer
+        #
+        # @return [TrueClass, FalseClass] true if successful or false
+        def delete
+            response = self.class.commit('customer.delete', [self.customer_id])
+            return false if response == false
+
+            methods.grep(/\w=$/).each do |m|
+                send(m, nil)
+            end
+            self.customer_id = nil
+            self.increment_id = nil
+            self.created_at = nil
+            self.updated_at = nil
+            self.password_hash = nil
+
+            return true
+        end
+
+        class << self
+
+            # Retrieve the list of all Magento customers with or without filters
+            #
+            # @param filters [Array] the filters by customer attributes
+            # @return [Array<Magenthor::Customer>, FalseClass] the list of all customers as Customer entities or false
+            def list filters = []
+                response = commit('customer.list', filters)
+                return false if response == false
+                customers = []
+                response.each do |r|
+                    customers << find(r["customer_id"])
+                end
+                return customers
+            end
+            
+            # Find a specific Customer by Magento ID
+            #
+            # @param customer_id [String, Integer] the id of the customer to retrieve
+            # @return [Magenthor::Customer, FalseClass] the customer entity or false if not found
+            def find customer_id
+                response = commit('customer.info', [customer_id])
+                new(response) unless response == false
+            end
+            
+            # Magento Customer Attributes
+            customer_attributes = [
+                "increment_id",
+                "created_in",
+                "store_id",
+                "website_id",
+                "email",
+                "firstname",
+                "middlename",
+                "lastname",
+                "group_id",
+                "prefix",
+                "suffix",
+                "dob",
+                "taxvat",
+                "confirmation"]
+            customer_attributes.each do |a|
+                # Dynamic methods to find customers based on Magento attributes
+                define_method("find_by_#{a}") do |arg|
+                    find_by a, arg
+                end
+            end
+
+            # Get the list of all Magento customer groups
+            #
+            # @return [Array, FalseClass] the list of all customer groups or false
+            def groups
+                commit('customer_group.list',  [])
+            end
+
+            
+            private
+            
+            # Method to find customers based on a specific Magento attribute, used to create the dynamic methods
+            #
+            # @param attribute [String] the attribute used to make the search
+            # @param value [String, Integer] the value of the attribute
+            # @return [Array<Magenthor::Customer>, Magenthor::Customer, FalseClass] the list of customer entities or a single customer entity or false
+            def find_by (attribute, value)
+                response = commit('customer.list', [attribute => value])
+                return false if response == false
+                if response.count > 1
+                    customers = []
+                    response.each do |r|
+                        customers << find(r["customer_id"])
+                    end
+                    return customers
+                else
+                    return new(response[0])
+                end
+            end
+        end
+    end
+end

data/lib/magenthor/version.rb

@@ -1,3 +1,4 @@
+# @author Daniele Lenares
 module Magenthor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/magenthor.rb

@@ -1,3 +1,4 @@
+# @author Daniele Lenares
 require "magenthor/version"
 require "magenthor/base"
 require "xmlrpc/client"
@@ -9,4 +10,4 @@ XMLRPC::Config.send(:const_set, :ENABLE_NIL_CREATE, true)
 
 module Magenthor
     autoload :Customer, 'magenthor/customer'
-end
+end

data/magenthor.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry", "~> 0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: magenthor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniele Lenares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: A Rubygem wrapper for the XMLRPC Magento API.
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -79,18 +79,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Rubygem wrapper for the XMLRPC Magento API.
 test_files: []
+has_rdoc: