magenthor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0ff08ef8e893c262882d2d49a92e8a8a58e09e9
+  data.tar.gz: 8dcb51d57f9594665447bbad208fdb97fc0a433f
+SHA512:
+  metadata.gz: f83acf1b1b252bec528ff5030d4e259a1fcb0fdb4611ca520f6a57ca68864259607ad2cab44a0f6459d3ae4b27230d7db7e233ad16d6e95ee4c6f99ad6eb98be
+  data.tar.gz: dc64072c5834e32d4415eeee4fcfb99a3897e2fcd92dcb03079169f1a1d7cf779922fb5ddf0db1786980bffe62fe87dfe87fb2f0305c3266713d501be9b2fd29

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniele Lenares
+
+MIT License
+
+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,65 @@
+# Magenthor (ALPHA)
+
+A Rubygem wrapper for the XMLRPC Magento API.
+
+This code is inspired by, but not based on, [magentor gem](https://github.com/pstuteville/magentor)
+
+## Installation
+
+Since this is still in an early stage of development, I discourage the installation except for debugging (or curiosity) purposes
+
+## Usage
+
+Initialize the connection
+```ruby
+Magenthor::Base.new({
+    :port => 80,
+    :host => 'magentohost.tld',
+    :api_user => 'apiuser',
+    :api_key => 'apikey'
+})
+```
+Get the list of customers
+```ruby
+Magnethor::Customer.list
+```
+Find a customer by ID
+```ruby
+Magenthor::Customer.find 1
+```
+Find customers by Magento attribute
+```ruby
+Magenthor::Customer.find_by_email "email@me.tld"
+Magenthor::Customer.find_by_group_id 2
+#Magenthor::Customer.find_by_[magento customer attribute]
+```
+Update a customer attributes
+```ruby
+customer = Magenthor::Customer.find 1
+customer.firstname = "John"
+customer.update
+#=> true
+```
+Create a new customer
+```ruby
+customer = Magenthor::Customer.new
+customer.email = "email@me.tld"
+customer.password = "p4ssw0rd"
+customer.website_id = 1
+customer.create
+#=> true
+```
+Delete a customer
+```ruby
+customer = Magenthor::Customer.find 1
+customer.delete
+#=> true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Ryuk87/magenthor/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/magenthor/base.rb

@@ -0,0 +1,65 @@
+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

data/lib/magenthor/customer.rb

@@ -0,0 +1,143 @@
+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 = {}
+            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

data/lib/magenthor/version.rb

@@ -0,0 +1,3 @@
+module Magenthor
+  VERSION = "0.0.1"
+end

data/lib/magenthor.rb

@@ -0,0 +1,12 @@
+require "magenthor/version"
+require "magenthor/base"
+require "xmlrpc/client"
+
+XMLRPC::Config.send(:remove_const, :ENABLE_NIL_PARSER)
+XMLRPC::Config.send(:const_set, :ENABLE_NIL_PARSER, true)
+XMLRPC::Config.send(:remove_const, :ENABLE_NIL_CREATE)
+XMLRPC::Config.send(:const_set, :ENABLE_NIL_CREATE, true)
+
+module Magenthor
+    autoload :Customer, 'magenthor/customer'
+end

data/magenthor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magenthor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magenthor"
+  spec.version       = Magenthor::VERSION
+  spec.authors       = ["Daniele Lenares"]
+  spec.email         = ["daniele.lenares@gmail.com"]
+  spec.summary       = %q{A Rubygem wrapper for the XMLRPC Magento API.}
+  spec.description   = %q{A Rubygem wrapper for the XMLRPC Magento API.}
+  spec.homepage      = "https://github.com/Ryuk87/magenthor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: magenthor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniele Lenares
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 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.
+email:
+- daniele.lenares@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/magenthor.rb
+- lib/magenthor/base.rb
+- lib/magenthor/customer.rb
+- lib/magenthor/version.rb
+- magenthor.gemspec
+homepage: https://github.com/Ryuk87/magenthor
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: A Rubygem wrapper for the XMLRPC Magento API.
+test_files: []