magento-api 0.1.0

data/Manifest

@@ -0,0 +1,28 @@
+config/magento.yml
+init.rb
+lib/abstract.rb
+lib/category.rb
+lib/configuration.rb
+lib/country.rb
+lib/customer.rb
+lib/customer_address.rb
+lib/customer_groups.rb
+lib/extensions.rb
+lib/inventory.rb
+lib/invoice.rb
+lib/magento.rb
+lib/order.rb
+lib/product.rb
+lib/product_images.rb
+lib/product_types.rb
+lib/region.rb
+lib/server.rb
+lib/shipment.rb
+Rakefile
+README.rdoc
+test/test_customer.rb
+test/test_helper.rb
+test/test_inventory.rb
+test/test_magento.rb
+test/test_order.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,12 @@
+== Magento ===================
+
+This is a simple gem which wraps Magento XMLRPC calls with Ruby classes.
+This allows for you to integrate your Magento Shopping Cart into your Rails Application.
+
+== Usage =====================
+
+See Rdoc
+
+== Issues ====================
+
+A patch needs to be applied to XMLRPC for this to work.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('magento-api', '0.1.0') do |p|
+  p.description              = "Rubygem for connecting to a Magento store via the Magento Core API"
+  p.url                      = ""
+  p.author                   = "Tim Matheson"
+  p.email                    = "me@timmatheson.com"
+  p.ignore_pattern           = ["tmp/*","script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/config/magento.yml

@@ -0,0 +1,6 @@
+username: "tmatheson"
+api_key: "123456"
+host: "127.0.0.1"
+path: "/magento/api/xmlrpc"
+port: 8888
+

data/init.rb

@@ -0,0 +1 @@
+require 'magento'

data/lib/abstract.rb

@@ -0,0 +1,42 @@
+module Magento
+  class Abstract
+    attr_accessor :attributes
+    
+    def initialize(attributes = {})
+      @connection = Magento::Connection.new
+      @attributes = attributes.dup
+    end
+    
+    def self.connect
+      @connection ||= Magento::Connection.new
+    end
+
+    def self.first
+      return nil unless respond_to?(:list)
+      n = 0
+      while list(n)[0] == nil
+        n+=1
+      end
+      return list(n)[0]
+    end
+
+    def object_attributes=(new_attributes)
+      return if new_attributes.nil?
+      attributes = new_attributes.dup
+      attributes.stringify_keys!
+      attributes.each do |k, v|
+        send(k + "=", v)
+      end
+    end
+    
+    def self.commit(method, *args)
+      connect
+      @connection.call(method, args)
+    end
+    
+    def method_missing(method, *args)
+      return nil unless @attributes
+      @attributes[method.to_s]
+    end
+  end
+end

data/lib/category.rb

@@ -0,0 +1,96 @@
+require 'magento'
+module Magento
+  class Category < Abstract
+    def current_store(store_view = nil)
+      connect
+      @connection.call("category.currentStore",store_view)
+    end
+    
+    def self.tree(category_id = nil, store_view = nil)
+      connect
+      fields = [category_id,store_view].compact
+      if fields.empty?
+        @connection.call("category.level")
+      else
+        @connection.call("category.level",fields)
+      end
+    end
+    
+    def self.level(website = nil, store_view = nil, parent_category = nil)
+      connect
+      fields = [website,store_view,parent_category].compact
+      if fields.empty?
+        @connection.call("category.level")
+      else
+        @connection.call("category.level",fields)
+      end
+    end
+    
+    def self.find(category_id, store_view = nil, *args)
+      connect
+      fields = [store_view].compact
+      if fields.empty?
+        @connection.call("category.info",category_id)
+      else
+        @connection.call("category.info",category_id,fields,args)
+      end
+    end
+    
+    def self.create(parent_id, category_data, store_view = nil)
+      connect
+      if store_view.nil?
+        @connection.call("category.create", parent_id, category_data)
+      else
+        @connection.call("category.create", parent_id, category_data, store_view)
+      end
+    end
+    
+    def self.update(parent_id, category_data, store_view = nil)
+      connect
+      if store_view.nil?
+        @connection.call("category.update", parent_id, category_data)
+      else
+        @connection.call("category.update", parent_id, category_data, store_view)
+      end
+    end
+    
+    def self.move(category_id, parent_id, after_id)
+      connect
+      @connection.call("category.move", category_id, parent_id, after_id)
+    end
+    
+    def self.delete(category_id)
+      connect
+      @connection.call("category.delete",category_id)
+    end
+    
+    def self.assigned_products(category_id, store_id)
+      connect
+      @connection.call("category.assignedProducts",category_id, store_id)
+    end
+    
+    def assigned_products(store_id)
+      if store_id
+        Category.assigned_products(self.id, store_id)
+      else
+        Category.assigned_products(self.id)
+      end
+    end
+    
+    def assign_product(product_id)
+      connect
+      @connection.call("category.assignProduct",self.id, product_id)
+    end
+    
+    def update_product(product_id, position = 1)
+      connect
+      @connection.call("category.updateProduct",self.id, product_id, position)
+    end
+    
+    def remove_product(product_id)
+      connect
+      @connection.call("category.removeProduct",self.id, product_id)
+    end
+    
+  end
+end

data/lib/configuration.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+module Magento
+  class Configuration
+    attr_accessor :username, :api_key, :host, :path, :port
+    
+    CONFIG_PATH = File.dirname(__FILE__) + "/../config/magento.yml"
+    
+    def initialize
+      raise ConfigurationException, "Missing configuration file" unless File.exists?(CONFIG_PATH)
+      options = YAML.load_file(CONFIG_PATH)
+      @username = options["username"]
+      @api_key  = options["api_key"]
+      @host     = options["host"]
+      @path     = options["path"]
+      @port     = options["port"]
+      yield self if block_given?
+    end
+  end
+  
+  class ConfigurationException; end;
+end

data/lib/country.rb

@@ -0,0 +1,9 @@
+require 'magento'
+module Magento
+  class Country < Abstract
+    def self.list
+      connect
+      @connection.call("country.list")
+    end
+  end
+end

data/lib/customer.rb

@@ -0,0 +1,39 @@
+require 'magento'
+require 'abstract'
+
+module Magento
+  class Customer < Abstract
+    
+    def initialize
+      connect
+    end
+    
+    def self.find(*args)
+      connect
+      @connection.call("customer.info",args)
+    end
+    
+    def self.list(*args)
+      connect
+      customers = @connection.call("customer.list",args)
+      customer_list = []
+      customers.each do |customer|
+        customer_list.push(customer.to_struct(self.class.to_s))
+      end
+      customer_list
+    end 
+    
+    def self.create(*args)
+      connect
+      @connection.call("customer.create",args)
+    end
+    
+    def self.delete(customer_id = nil)
+      raise CustomerException, "Invalid customer id" if customer_id.nil?
+      connect
+      @connection.call("customer.delete",customer_id)
+    end
+  end
+  
+  class CustomerException < StandardError; end;
+end

data/lib/customer_address.rb

@@ -0,0 +1,32 @@
+require 'magento'
+module Magento
+  class CustomerAddress < Abstract
+    
+    def self.list(customer_address_id)
+      connect
+      @connection.call("customer_address.list", customer_address_id)
+    end
+    
+    def self.find(customer_address_id)
+      connect
+      @connection.call("customer_address.info", customer_address_id)
+    end
+    
+    def self.create(address_attributes)
+      connect
+      @connection.call("customer_address.create", address_attributes)
+    end
+    
+    def self.update(address_attributes)
+      connect
+      @connection.call("customer_address.update", address_attributes)
+    end
+    
+    def self.delete(customer_address_id)
+      connect
+      @connection.call("customer_address.delete",customer_address_id)
+    end
+  end
+end
+
+puts Magento::CustomerAddress.list

data/lib/customer_groups.rb

@@ -0,0 +1,8 @@
+module Magento
+  class CustomerGroups < Abstract
+    def self.list
+      connect
+      @connection.call("customer_group.list")
+    end
+  end
+end

data/lib/extensions.rb

@@ -0,0 +1,16 @@
+class Hash
+   def to_struct(struct_name)
+      Struct.new(struct_name,*keys).new(*values)
+   end
+   
+   def stringify_keys!
+     keys.each do |key|
+       self[key.to_s] = delete(key)
+     end
+     self
+   end
+   
+   def method_missing(method, *args)
+     self["#{method}"]
+   end
+end

data/lib/inventory.rb

@@ -0,0 +1,32 @@
+require 'magento'
+module Magento
+  class Inventory < Abstract
+    def new(attributes = {})
+      attributes.each do |attr, val|
+        instance_variable_set(:"@#{attr}",val)
+      end
+    end
+    
+    def self.list(*args)
+      list = []
+      commit("product_stock.list", args).each do |inventory|
+        list.push(new(inventory))
+      end
+      list
+    end
+
+    def self.update(id,*args)
+      #commit("product_stock.update", args)
+      connect
+      @connection.call("product_stock.update",id,args)
+    end
+    
+    def update(*args)
+      commit("product_stock.update", product_id, args)
+    end
+    
+    def in_stock?
+      is_in_stock.to_i == 1
+    end
+  end
+end

data/lib/invoice.rb

@@ -0,0 +1,6 @@
+require 'magento'
+module Magento
+  class Invoice < Abstract
+     
+  end
+end

data/lib/magento.rb

@@ -0,0 +1,24 @@
+require 'extensions'
+require 'xmlrpc'
+require 'xmlrpc/client'
+require 'configuration'
+require 'customer'
+require 'inventory'
+require 'invoice'
+require 'order'
+
+module Magento
+  class Connection 
+    attr_accessor :client
+    def initialize(*args)
+      @config = Configuration.new
+      @client = XMLRPC::Client.new(@config.host,@config.path,@config.port)
+      @session = @client.call("login", @config.username, @config.api_key)
+      self
+    end
+    
+    def call(method = nil, *args)
+      client.call("call",@session, method, args)
+    end
+  end
+end

data/lib/order.rb

@@ -0,0 +1,44 @@
+require 'magento'
+module Magento
+  class Order < Abstract
+    def self.list(*args)
+      orders = commit("order.list",args)
+      order_list = []
+      orders.each do |order|
+        order_list.push(order.to_struct(self.class.to_s))
+      end
+      order_list
+    end
+    
+    def self.find(*args)
+      order_attributes = commit("order.info", args)
+      new(order_attributes)
+    end
+    
+    def add_comment(comment = nil, notify = false)
+      return false if comment.nil?
+      commit("order.addComment",self.increment_id,"Pending",comment,notify)
+    end
+    
+    def comments
+      status_history
+    end
+    
+    def hold
+      commit("order.hold",self.increment_id)
+    end
+    
+    def unhold
+      commit("order.unhold",self.increment_id)
+    end
+    
+    def cancel
+      commit("order.cancel",self.increment_id)
+    end
+  end
+end
+
+#o = Magento::Order.find("100000001")
+#puts o.attributes
+
+puts Magento::Order.find("100000001").hold

data/lib/product.rb

@@ -0,0 +1,4 @@
+module Magento
+  class Product
+  end
+end

data/lib/product_images.rb

@@ -0,0 +1,4 @@
+module Magento
+  class ProductImages
+  end
+end 

data/lib/product_types.rb

@@ -0,0 +1,4 @@
+module Magento
+  class ProductTypes
+  end
+end

data/lib/region.rb

@@ -0,0 +1,14 @@
+require 'magento'
+module Magento #:nodoc:
+  class Region < Abstract #:nodoc:
+    def self.list(country = nil)
+      raise RegionException, "Invalid country code" if country.nil?
+      connect
+      regions = []
+      @connection.call("region.list", country)
+    end
+  end
+  
+  class RegionException < StandardError #:nodoc:
+  end
+end

data/lib/server.rb

@@ -0,0 +1,4 @@
+module Magento
+  class Server
+  end
+end

data/lib/shipment.rb

@@ -0,0 +1,48 @@
+require 'magento'
+module Magento #:nodoc:
+  class Shipment < Abstract #:nodoc:
+    CARRIERS = { :usps => "usps", :ups => "ups", :dhl => "dhl", :fedex => "fedex" }
+    
+    def self.list(*args)
+      connect
+      shipments = @connection.call("order_shipment.list",args)
+      shipment_list = []
+      shipments.each do |order|
+        shipment_list.push(order.to_struct(self.class.to_s))
+      end
+      shipment_list
+    end
+    
+    def self.find(*args)
+      connect
+      shipment_attributes = @connection.call("order_shipment.info", args)
+      new(shipment_attributes)
+    end
+    
+    def self.create(order_id, items, comment = "", notify = false, include_in_email = false)
+      connect
+      @connection.call("order_shipment.create",order_id, items, comment, notify, include_in_email)
+    end
+    
+    def add_comment(comment = nil, notify = false, include_in_email = false)
+      return false if comment.nil?
+      @connection.call("order_shipment.addComment",self.increment_id,comment,notify,include_in_email)
+    end
+    
+    def add_tracking_number(carrier_code, number, title = "")
+      raise ShipmentException, "Invalid carrier code" unless CARRIERS.values.include?(carrier_code)
+      @connection.call("order_shipment.addTrack",self.increment_id,carrier_code,title,number)
+    end
+    
+    def remove_tracking_number(tracking_number_id)
+      @connection.call("order_shipment.removeTrack",self.increment_id,tracking_number_id)
+    end
+    
+    def self.get_carriers(order_id)
+      @connection.call("order_shipment.getCarriers",order_id)
+    end
+  end
+  
+  class ShipmentException < StandardError #:nodoc:
+  end
+end

data/magento-api.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{magento-api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Matheson"]
+  s.date = %q{2009-08-12}
+  s.description = %q{Rubygem for connecting to a Magento store via the Magento Core API}
+  s.email = %q{me@timmatheson.com}
+  s.extra_rdoc_files = ["lib/abstract.rb", "lib/category.rb", "lib/configuration.rb", "lib/country.rb", "lib/customer.rb", "lib/customer_address.rb", "lib/customer_groups.rb", "lib/extensions.rb", "lib/inventory.rb", "lib/invoice.rb", "lib/magento.rb", "lib/order.rb", "lib/product.rb", "lib/product_images.rb", "lib/product_types.rb", "lib/region.rb", "lib/server.rb", "lib/shipment.rb", "README.rdoc"]
+  s.files = ["config/magento.yml", "init.rb", "lib/abstract.rb", "lib/category.rb", "lib/configuration.rb", "lib/country.rb", "lib/customer.rb", "lib/customer_address.rb", "lib/customer_groups.rb", "lib/extensions.rb", "lib/inventory.rb", "lib/invoice.rb", "lib/magento.rb", "lib/order.rb", "lib/product.rb", "lib/product_images.rb", "lib/product_types.rb", "lib/region.rb", "lib/server.rb", "lib/shipment.rb", "Rakefile", "README.rdoc", "test/test_customer.rb", "test/test_helper.rb", "test/test_inventory.rb", "test/test_magento.rb", "test/test_order.rb", "Manifest", "magento-api.gemspec"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Magento-api", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{magento-api}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Rubygem for connecting to a Magento store via the Magento Core API}
+  s.test_files = ["test/test_customer.rb", "test/test_helper.rb", "test/test_inventory.rb", "test/test_magento.rb", "test/test_order.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/test_customer.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+class CustomerTest < Test::Unit::TestCase  
+  def test_creation
+    customer = Magento::Customer.new
+    assert_not_nil customer
+  end
+  
+  def test_firstname
+    customer = Magento::Customer.find("1")
+    assert_equal("Tim",customer["firstname"])
+  end
+  
+  def test_lastname
+    customer = Magento::Customer.find("1")
+    assert_equal("Matheson",customer["lastname"])
+  end
+  
+  def test_email
+    customer = Magento::Customer.find("1")
+    assert_equal("tim.matheson@ordercup.com",customer["email"])
+  end
+    
+  def test_find
+    customer = Magento::Customer.find("1")
+    assert_not_nil customer
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'autotest'
+require 'rubygems'
+require 'redgreen'
+require 'test/unit'
+require 'magento'
+
+
+

data/test/test_inventory.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby
+require "test_helper"
+
+class InventoryTest < Test::Unit::TestCase  
+  def test_creation
+    inventory = Magento::Inventory.new
+    assert_not_nil inventory
+  end
+  
+  def test_product_id
+    inventory = Magento::Inventory.list("1")[0]
+    assert_equal("1",inventory.product_id)
+  end
+  
+  def test_qty
+    inventory = Magento::Inventory.list("1")[0]
+    assert_equal(10,inventory.qty.to_i)
+  end
+  
+  def test_sku
+    inventory = Magento::Inventory.list("1")[0]
+    assert_equal("123456789",inventory.sku)
+  end
+  
+  def test_first
+    inventory = Magento::Inventory.first
+    assert_not_nil inventory
+  end
+  
+end

data/test/test_order.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+class OrderTest < Test::Unit::TestCase
+  def test_creation
+    order = Magento::Order.new
+    assert_not_nil order
+  end
+  
+  def test_find
+    order = Magento::Order.find("100000001")
+    assert_not_nil order
+  end
+  
+  def test_add_comment
+    order = Magento::Order.find("100000001")
+    comment_text = "This is a test comment #{rand(10)}"
+    order.add_comment(comment_text)
+    assert order.comments.map{|c| c.comment }.include?(comment_text)
+  end
+  
+  def test_list
+    list = Magento::Order.list
+    assert !list.empty?
+  end
+  
+  def test_hold
+    assert Magento::Order.find("100000001").hold
+  end
+  
+  def test_unhold
+    assert Magento::Order.find("100000001").unhold
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: magento-api
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Matheson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rubygem for connecting to a Magento store via the Magento Core API
+email: me@timmatheson.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/abstract.rb
+- lib/category.rb
+- lib/configuration.rb
+- lib/country.rb
+- lib/customer.rb
+- lib/customer_address.rb
+- lib/customer_groups.rb
+- lib/extensions.rb
+- lib/inventory.rb
+- lib/invoice.rb
+- lib/magento.rb
+- lib/order.rb
+- lib/product.rb
+- lib/product_images.rb
+- lib/product_types.rb
+- lib/region.rb
+- lib/server.rb
+- lib/shipment.rb
+- README.rdoc
+files: 
+- config/magento.yml
+- init.rb
+- lib/abstract.rb
+- lib/category.rb
+- lib/configuration.rb
+- lib/country.rb
+- lib/customer.rb
+- lib/customer_address.rb
+- lib/customer_groups.rb
+- lib/extensions.rb
+- lib/inventory.rb
+- lib/invoice.rb
+- lib/magento.rb
+- lib/order.rb
+- lib/product.rb
+- lib/product_images.rb
+- lib/product_types.rb
+- lib/region.rb
+- lib/server.rb
+- lib/shipment.rb
+- Rakefile
+- README.rdoc
+- test/test_customer.rb
+- test/test_helper.rb
+- test/test_inventory.rb
+- test/test_magento.rb
+- test/test_order.rb
+- Manifest
+- magento-api.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Magento-api
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: magento-api
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Rubygem for connecting to a Magento store via the Magento Core API
+test_files: 
+- test/test_customer.rb
+- test/test_helper.rb
+- test/test_inventory.rb
+- test/test_magento.rb
+- test/test_order.rb