magento-rb 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,20 @@
+ruby '1.8.7'
+
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rack", "1.6.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "1.14.5"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+end
+
+gem "savon", "2.3.0"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    akami (1.2.2)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.3)
+    git (1.2.5)
+    gyoku (1.1.1)
+      builder (>= 2.1.2)
+    httpi (2.1.1)
+      rack
+      rubyntlm (~> 0.3.2)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    mime-types (1.25.1)
+    multi_json (1.3.6)
+    nokogiri (1.5.11)
+    nori (2.3.0)
+    rack (1.6.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rubyntlm (0.3.4)
+    savon (2.3.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.1.0)
+      httpi (~> 2.1.0)
+      nokogiri (>= 1.4.0, < 1.6)
+      nori (~> 2.3.0)
+      wasabi (~> 3.2.0)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    wasabi (3.2.3)
+      httpi (~> 2.0)
+      mime-types (< 2.0.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.14.5)
+  jeweler (~> 1.8.3)
+  rack (= 1.6.5)
+  rdoc (~> 3.12)
+  savon (= 2.3.0)
+  shoulda
+  simplecov
+
+RUBY VERSION
+   ruby 1.8.7p299
+
+BUNDLED WITH
+   1.14.5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Joel Van Horn
+
+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.rdoc

@@ -0,0 +1,48 @@
+= magento-rb
+
+Use Magento's XMLRPC API like this:
+
+    require "magento-rb"
+    options = {
+        :debug => true, 
+        :proxy => http://my.host.name:port, 
+        :timeout => 90
+    }
+    xml_api = Magento::XmlApi.new "http://localhost/magento", "username", "api_key", options
+    
+    # Pass in the XMLRPC method name and ID parameter as arguments
+    response = xml_api.call("sales_order.info", "123")
+    
+    # Call XMLRPC methods on xml_api directly
+    response = xml_api.sales_order_info("123")
+    
+    # Create a new customer
+    customer_id = xml_api.customer_create(:email => email)
+
+The SOAP API v2 has a similar interface, but it is about 3x slower than XMLRPC and responses are more verbose.
+
+== Contributing to magento-rb
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Thanks
+
+Thanks to Guewen Baconnier for his quick start in XMLRPC for Magento:
+
+https://gist.github.com/1875404
+
+Learned about Savon and some of the basics from here:
+
+http://www.polyvision.org/2011/11/02/using-magento-soap-api-with-ruby-and-savon/
+
+== Copyright
+
+Copyright (c) 2012 Joel Van Horn. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "magento-rb"
+  gem.homepage = "http://github.com/joelvh/magento-rb"
+  gem.license = "MIT"
+  gem.summary = "Magento API libraries and other helpful Ruby code"
+  gem.description = "Magento API libraries and other helpful Ruby code"
+  gem.email = "joeldvanhorn@gmail.com"
+  gem.authors = ["Joel Van Horn"]
+  # dependencies defined in Gemfile
+end
+#Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "magento-rb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/magento/savon.rb

@@ -0,0 +1,48 @@
+#
+# Magento API can be found @ http://www.magentocommerce.com/wiki/doc/webservices-api/api
+#
+#
+require 'savon'
+ 
+Savon.configure do |config|
+  config.log = false            # disable logging
+  #config.log_level = :info      # changing the log level
+  #config.logger = Rails.logger  # using the Rails logger
+end
+ 
+client = Savon::Client.new do
+  wsdl.document = "#{ENV['MAGENTO_ENDPOINT']}/index.php/api/?wsdl"
+end
+ 
+response = client.request :login do
+  soap.body = { :username => ENV['MAGENTO_API_USER'], :apiKey => ENV['MAGENTO_API_KEY'] }
+end
+
+if response.success? == false
+  puts "login failed"
+  #System.exit(0)
+end
+ 
+session =  response[:login_response][:login_return];
+ 
+response = client.request :call do
+  soap.body = {:session => session, :method => 'catalog_product_attribute_media.list', :sku => '001' }
+end
+ 
+# fetching all products
+if response.success?
+  # listing found products
+  response[:call_response][:call_return][:item][:item].each do |product|
+    puts "-------------------------------------------"
+    #product = product[:item]
+    product.each do |pkey|
+        puts "#{pkey}"
+    end
+  end
+end
+ 
+#logging out
+response = client.request :endSession do
+  soap.body = {:session => session}
+end
+puts response.to_hash

data/lib/magento/soap_api_v2.rb

@@ -0,0 +1,83 @@
+require 'savon'
+
+module Magento
+  class SoapApiV2
+    extend Savon::Model
+    
+    def initialize(base_url, api_user, api_key)
+      super
+      
+      @api_user = api_user
+      @api_key = api_key
+      self.class.client.wsdl.document = "#{base_url}/api/v2_soap?wsdl=1"
+    end
+    
+    def session_id(refresh = false)
+      @session_id = nil if refresh
+      
+      unless @session_id
+        response = client.request :login, :body => { :username => @api_user, :apiKey => @api_key }
+        @session_id = response[:login_response][:login_return]
+      end
+      @session_id
+    end
+    
+    def session_request(action, body = {}, &block)
+      begin
+        # get session ID outside of client#request block because the 
+        # request object is a singleton for this client and 
+        # the session_id method may have to make a separate request for the ID
+        current_session_id = session_id
+        
+        response = client.request action, :body => body do
+          # pass objects to block
+          yield soap, wsdl, http, wsse if block
+          # add session ID before exiting block
+          soap.body ||= {}
+          # need to overwrite in case it's an expired session ID
+          soap.body[:session] = current_session_id
+          soap.body[:order!] = soap.body.keys.delete_if {|item| item == :session }.unshift(:session)
+          puts "SOAP BODY:::: #{soap.body}"
+        end
+        #Savon.config.hooks.select(:model_soap_response).call(response) || response
+        # get the response: first child named after the action
+        response.to_hash["#{action}_response".to_sym].tap do |response|
+          @retries = 0
+        end
+        
+      rescue Savon::SOAP::Fault => error
+        # 5 = session expired
+        # 2 = access denied
+        raise error unless error.to_hash[:fault][:faultcode] == "5" && @retries == 0
+        puts "SESSION EXPIRED ... TRYING AGAIN"
+        @retries = 1
+        # refresh session ID
+        session_id(true)
+        session_request action, body, &block
+      end
+      
+    end
+    
+    def end_session
+      session_request :end_session
+    end
+    
+    def method_missing(method, *args, &block)
+      class_name = self.class.name.snakecase
+      action = method
+      action = "#{class_name}_#{method}".to_sym unless client.wsdl.soap_actions.include?(action)
+      # Magento's actions turn into customer_customer_create, so this allows for customer_create instead
+      action = "#{class_name}_#{class_name}_#{method}".to_sym unless client.wsdl.soap_actions.include?(action)
+      action = "#{method.to_s.split('_').first}_#{method}".to_sym unless client.wsdl.soap_actions.include?(action)
+      puts "SOAP ACTION? #{action}"
+      
+      if client.wsdl.soap_actions.include?(action)
+        body = args.first
+        session_request action, body, &block
+      else
+        super
+      end
+    end
+    
+  end
+end

data/lib/magento/xml_api.rb

@@ -0,0 +1,95 @@
+# Copyright Camptocamp SA 2012
+# License: AGPL (GNU Affero General Public License)[http://www.gnu.org/licenses/agpl-3.0.txt]
+# Author Guewen Baconnier
+#
+# https://gist.github.com/1875404
+#
+# EXAMPLE:
+# 
+# magento=MagentoAPI.new(ENV['MAGENTO_ENDPOINT'].dup, ENV['MAGENTO_API_USER'].dup, ENV['MAGENTO_API_KEY'].dup, :debug => true)
+# order_infos = magento.call('sales_order.info', '100011892')
+# 
+# magento.call('catalog_product.update', 'SKU', {'meta_description' => 'test'})
+
+
+require "xmlrpc/client"
+require 'pp'
+
+XMLRPC::Config::ENABLE_NIL_PARSER = true
+
+module Magento
+  class XmlApi
+    
+    attr_accessor :url, :api_user, :api_key
+    
+    def initialize(base_url, api_user, api_key, options={})
+      @url = "#{base_url}/api/xmlrpc/"
+      @api_user = api_user
+      @api_key = api_key
+      @timeout = options[:timeout] || 60
+      @proxy = options[:proxy] || nil 
+      @debug = options[:debug] || false
+    end
+    
+    def call(method, *arguments)
+      request('call', session_id, method, arguments)
+    end
+    
+    # def batch(methods)
+      # client.multicall
+    # end
+    
+    private
+    
+    def client
+      @client ||= XMLRPC::Client.new2(@url,@proxy,@timeout).tap do |client|
+        http_debug(@debug)
+        client.set_debug
+      end
+    end
+    
+    def http_debug(active)
+      output = active ? $stderr : false
+        
+      XMLRPC::Client.class_eval do
+        define_method :set_debug do
+          @http.set_debug_output(output)
+        end
+      end
+    end
+    
+    def session_id
+      @session_id ||= request('login', @api_user, @api_key)
+    end
+    
+    def request(method, *arguments)
+      begin
+        client.call(method, *arguments).tap do |response|
+          @retried = false
+        end
+      rescue EOFError => error
+        
+        raise error if @retried == true
+        
+        @retried = true
+        request(method, *arguments)
+        
+      rescue XMLRPC::FaultException => error
+        raise Magento::ApiError.new(error.faultString, error.faultCode, error)
+      end
+    end
+    
+    def method_missing(method, *args, &block)
+      # convert the method name to an XMLRPC action name e.g. "sales_order.list"
+      parts = method.to_s.snakecase.split('_')
+      action = "#{parts[0..-2].join('_')}.#{parts.last}" if parts.size > 1
+      
+      if action
+        call action, *args, &block
+      else
+        super
+      end
+    end
+    
+  end
+end

data/lib/magento-rb.rb

@@ -0,0 +1,39 @@
+require "magento/api_error"
+require "magento/soap_api_v2"
+require "magento/xml_api"
+
+module Magento
+  
+  def self.api_endpoint=(value)
+    @@xml_api = nil
+    @@soap_api = nil
+    @@api_endpoint = value
+  end
+  
+  def self.api_username=(value)
+    @@xml_api = nil
+    @@soap_api = nil
+    @@api_username = value
+  end
+  
+  def self.api_password=(value)
+    @@xml_api = nil
+    @@soap_api = nil
+    @@api_password = value
+  end
+  
+  def self.debug=(value)
+    @@xml_api = nil
+    @@debug = value
+  end
+  
+  def self.xml_api(debug = nil)
+    @@xml_api = nil if debug
+    @@xml_api ||= XmlApi.new @@api_endpoint, @@api_username, @@api_password, :debug => debug || @@debug || false
+  end
+  
+  def self.soap_api
+    @@soap_api ||= SoapApiV2.new @@api_endpoint, @@api_username, @@api_password
+  end
+  
+end

data/magento-rb.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "magento-rb"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joel Van Horn"]
+  s.date = "2012-06-08"
+  s.description = "Magento API libraries and other helpful Ruby code"
+  s.email = "joeldvanhorn@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/magento-rb.rb",
+    "lib/magento/savon.rb",
+    "lib/magento/soap_api_v2.rb",
+    "lib/magento/xml_api.rb",
+    "magento-rb.gemspec",
+    "test/helper.rb",
+    "test/test_magento-rb.rb"
+  ]
+  s.homepage = "http://github.com/joelvh/magento-rb"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Magento API libraries and other helpful Ruby code"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<savon>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<savon>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.4"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'magento-rb'
+
+class Test::Unit::TestCase
+end

data/test/test_magento-rb.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMagentoRb < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: magento-rb
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Joel Van Horn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-08 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 1
+        - 4
+        version: 1.1.4
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 1
+        - 8
+        - 3
+        version: 1.8.3
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Magento API libraries and other helpful Ruby code
+email: joeldvanhorn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/magento-rb.rb
+- lib/magento/savon.rb
+- lib/magento/soap_api_v2.rb
+- lib/magento/xml_api.rb
+- magento-rb.gemspec
+- test/helper.rb
+- test/test_magento-rb.rb
+has_rdoc: true
+homepage: http://github.com/joelvh/magento-rb
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Magento API libraries and other helpful Ruby code
+test_files: []
+