sell_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4275ee21382736fccb2d3d09307970eaca2b679e
+  data.tar.gz: 816e1a34a75ea6124086bfc8445aa1f73a905105
+SHA512:
+  metadata.gz: 143e61bbd203fdfe73fc87f83533b57bc13048ed28980ed49f32af990da86acdd8a5823633f19c8e90a686379af3d05956ef122350582d28c2ad54751468b554
+  data.tar.gz: ef4d0e4f751f60fe67b8957460d6bde6d53bce205636f324af952d2ae6b8cc99c55ae4b5114c1b66bc18f889b1ee09fbec368169063fcb5386051ceaff5c0756

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+
+* initial release with shopping engines: ShoppingUOL (Brazil) and Buscape (Brazil)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Ferraz
+
+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,146 @@
+# SellObject
+
+By [Ima Bold](http://imabold.com).
+
+[![Code Climate](https://codeclimate.com/github/imaboldcompany/sell_object.png)](https://codeclimate.com/github/imaboldcompany/sell_object)
+
+SellObject is an extensible solution to make it easy exporting ruby objects to be used on price comparison shopping engines. The gem adds helper methods that format your objects, making them ready to be consumable by the supported price comparison engines.
+
+Currently, the following shopping engines are supported:
+
+* Shopping UOL (Brazil)
+* Buscape (Brazil)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sell_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sell_object
+
+After you install SellObject and add it to your Gemfile, you need to run the generator:
+
+    $ rails generate sell_object:install
+
+This will add the SellObject initializer into your Rails config/initializers folder.
+
+## Usage
+
+### Setting up the class
+
+Suppose you have a class `Product` and want to make its objects sellable through Shopping UOL. 
+You do that by using `sell_through` as shown below:
+
+```ruby
+class Product
+	include SellObject
+
+	sell_through :shopping_uol
+end
+```
+
+After that, to export a given `product` object into a consumable format used in Shopping UOL, just call:
+
+```ruby
+product.to_shopping_uol
+```
+
+In this case, this will generate the XML used by Shopping UOL in its search engine, based on the `product` attributes.
+
+Now, take `products` as collection of `Product` and you want to export all the collection into a consumable format used in Shopping UOL. All you have to do is use the class method passing the `products` collection, as shown:
+
+```ruby
+Product.to_shopping_uol products
+```
+
+The same approach works for all the other supported shopping engines.
+
+### Mapping the attributes
+
+SellObject comes with a default mapping to be applied through the exporting process. Continuing the Shopping UOL example, the mapping is used to grab the `product` attributes and build the XML tags. The default mapping is defined in the following module:
+
+```ruby
+module SellObject
+	module DefaultMappings
+		def self.shopping_uol
+			{ 
+				:CODIGO => :id, 
+				:DESCRICAO => :description, 
+				:PRECO => :price,
+				:URL => :url,
+				:URL_IMAGEM => :image_url,
+				:DEPARTAMENTO => :category  
+			}
+		end
+	end	
+end
+```
+If you want to use the default mapping, just make sure that the object responds to the required methods. In our example, `product` would have to respond to `:id`, `:description`, `:price` and so forth.
+
+If you want to create your own mapping, you can define a module named with the object's class name + 'Mappings'. For our `product` example, we could define like this:
+
+```ruby
+module SellObject
+	module ProductMappings
+		def self.shopping_uol
+			{ 
+				:CODIGO => :code, 
+				:DESCRICAO => :details, 
+				:URL => :web_page  
+			}
+		end
+	end	
+end
+```
+In this case, `product` would have to respond to `:code`, `:details` and `:web_page`. Note that we didn't overwrite all the attribute mappings. The leftovers will fall back to the default mapping. So in this example, `product` would still have to respond to the `:price`, `:image_url` and `:category` methods.
+
+When defining you own mappings, you can easily unit test them using Test::Unit, Rspec or other testing solutions.
+
+### Store name
+
+Some shopping engines require a store name to be included in the final output after the exporting process is over. You can define the store name globally in the SellObject initializer, for example:
+
+```ruby
+SellObject.setup do |config|
+	config.store_name = 'Ima Bold Store'
+end
+```
+
+If you want to set the store name dynamically, you can pass it to the exporting methods, for example:
+
+```ruby
+Product.to_buscape products, 'Ima Bold Store'
+
+product.to_buscape 'Ima Bold Store'
+```
+
+If you do not pass the store name neither set it up in the initializer, an error is going to be raised when calling those methods for engines that require a store name.
+
+Here's the list of shopping engines that require a store name for the exporting process:
+
+* Buscape (Brazil)
+
+## Contributing
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/imaboldcompany/sell_object/issues).
+
+You can contribute by doing the following:
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+MIT License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/sell_object/install_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/base'
+require 'securerandom'
+
+module SellObject
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a SellObject initializer."
+
+      def copy_initializer
+        template "sell_object.rb", "config/initializers/sell_object.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/sell_object.rb

@@ -0,0 +1,5 @@
+# Use this hook to configure SellObject settings
+SellObject.setup do |config|
+	# Set up the store name to be used on engines that wrap up their outputs under this single name.
+	config.store_name = '<%= Rails.application.class.parent_name %>'
+end

data/lib/sell_object/buscape/formatter_proxy.rb

@@ -0,0 +1,11 @@
+module SellObject
+	module Buscape
+		class FormatterProxy < SellObject::FormatterProxy
+	  	def preco(target_method)
+	  		target_value = target.send target_method
+	  		raise ArgumentError, "method expects a number, got #{target_value.class.name}: #{target_value}" unless target_value.is_a? Numeric 
+	  		('%.2f' % target_value).gsub '.', ','
+	  	end
+	  end
+	end
+end

data/lib/sell_object/buscape.rb

@@ -0,0 +1,43 @@
+module SellObject
+	module Buscape
+		def self.included(base)
+	  	base.extend ClassMethods
+	  end
+
+	  def self.wrap_xml(elements, store_name = nil)
+	  	store_name ||= SellObject::Config.store_name
+	  	raise ArgumentError, 'No store name found (nil). You have to either pass it as an argument or set it up in SellObject::Config' if store_name.nil?
+	  	%Q{
+					<?xml version="1.0" encoding="UTF-8" ?>
+					<!-- #{timestamp} -->
+					<#{store_name}>
+						<produtos>
+							#{elements}
+						</produtos>
+					</#{store_name}>
+				}
+	  end
+
+	  def self.timestamp
+	  	now = Time.now
+    	zone_diff = now.strftime("%z").to_i / 100
+    	time = now.strftime "%Y-%m-%dT%H:%M:%SGMT#{'+' if zone_diff >= 0}#{zone_diff}"
+	  	"Generated at #{time}"
+	  end	  
+
+	  module ClassMethods
+			# Class methods added on inclusion
+
+			def to_buscape(objects, store_name = nil)
+				elements = objects.map {|obj| SellObject::XmlFormatter.format obj, :buscape, :produto, SellObject::Buscape::FormatterProxy.new(obj) }.join ''
+				SellObject::Buscape.wrap_xml elements, store_name
+			end
+		end	 
+
+		# Instance methods added on inclusion
+
+		def to_buscape(store_name = nil)
+			self.class.to_buscape [self], store_name
+		end
+	end
+end

data/lib/sell_object/default_mappings.rb

@@ -0,0 +1,25 @@
+module SellObject
+	module DefaultMappings
+		def self.shopping_uol
+			{
+				:CODIGO => :id, 
+				:DESCRICAO => :description, 
+				:PRECO => :price,
+				:URL => :url,
+				:URL_IMAGEM => :image_url,
+				:DEPARTAMENTO => :category
+			}
+		end
+
+		def self.buscape
+			{
+				:id_oferta => :id, 
+				:descricao => :description, 
+				:preco => :price,
+				:link_prod => :url,
+				:imagem => :image_url,
+				:categoria => :category
+			}
+		end
+	end
+end

data/lib/sell_object/formatter_proxy.rb

@@ -0,0 +1,15 @@
+module SellObject
+	class FormatterProxy
+  	attr_accessor :target
+
+  	def initialize(target_object)
+  		self.target = target_object
+  	end
+
+  	private
+
+  	def method_missing(method, *args, &block)
+  		target.send(args.first).to_s
+  	end
+  end
+end

data/lib/sell_object/shopping_uol.rb

@@ -0,0 +1,30 @@
+module SellObject
+	module ShoppingUol
+		def self.included(base)
+	  	base.extend ClassMethods
+	  end
+
+	  def self.wrap_xml(elements)
+	  	%Q{
+					<?xml version="1.0" encoding="iso-8859-1" ?>
+					<PRODUTOS>
+						#{elements}
+					</PRODUTOS>
+				}
+	  end	  
+	  module ClassMethods
+			# Class methods added on inclusion
+
+			def to_shopping_uol(objects)
+				elements = objects.map {|obj| SellObject::XmlFormatter.format obj, :shopping_uol, :PRODUTO }.join ''
+				SellObject::ShoppingUol.wrap_xml elements
+			end
+		end	 
+
+		# Instance methods added on inclusion
+
+		def to_shopping_uol
+			self.class.to_shopping_uol [self]
+		end
+	end
+end

data/lib/sell_object/version.rb

@@ -0,0 +1,3 @@
+module SellObject
+  VERSION = "0.1.0"
+end

data/lib/sell_object/xml_formatter.rb

@@ -0,0 +1,18 @@
+require 'nokogiri'
+
+module SellObject
+	module XmlFormatter
+		def self.format(obj, engine, xml_root, formatter_proxy = nil)
+	    mapping = SellObject.mapping_for obj, engine
+	    formatter_proxy ||= SellObject::FormatterProxy.new obj
+	    xml_builder = Nokogiri::XML::Builder.new do |xml|
+	    	xml.send xml_root do
+	    		mapping.each do |tag, mapped_method|
+	    			xml.send tag, formatter_proxy.send(tag, mapped_method)
+	    		end
+	    	end
+	    end
+	    xml_builder.doc.root.to_xml
+	  end
+	end
+end

data/lib/sell_object.rb

@@ -0,0 +1,59 @@
+require 'sell_object/version'
+require 'sell_object/default_mappings'
+require 'sell_object/xml_formatter'
+require 'sell_object/formatter_proxy'
+require 'sell_object/buscape/formatter_proxy'
+require 'sell_object/shopping_uol'
+require 'sell_object/buscape'
+
+module SellObject
+  def self.included(base)
+  	base.extend ClassMethods
+  end  
+
+  def self.setup
+    yield SellObject::Config
+  end
+
+  def self.supported_engines
+  	%w(shopping_uol buscape)
+  end
+
+  def self.validate_engine(engine)
+    raise ArgumentError.new("invalid shopping engine #{engine}") unless supported_engines.include? engine.to_s
+  end
+  
+  def self.mapping_for(obj, engine)
+    validate_engine engine
+    begin       
+      custom_mappings_hash = eval "SellObject::#{obj.class.name}Mappings.#{engine}"
+    rescue
+      custom_mappings_hash = {}
+    end 
+    default_mappings_hash = SellObject::DefaultMappings.send engine
+    default_mappings_hash.merge custom_mappings_hash
+  end
+
+  module ClassMethods
+  	def sell_through(*engines)
+  		raise ArgumentError.new('must pass at least one shopping engine') if engines.empty?
+  		engines.each do |engine|
+  			SellObject.validate_engine engine
+				camelized_engine = engine.to_s.split('_').map {|w| w.capitalize}.join
+  			include eval("SellObject::#{camelized_engine}")
+  		end
+  	end
+  end
+
+  module Config
+    @@store_name = nil
+
+    def self.store_name
+      @@store_name
+    end
+
+    def self.store_name=(name)
+      @@store_name = name.gsub(/ +/, '_')
+    end
+  end
+end

data/sell_object.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sell_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sell_object"
+  spec.version       = SellObject::VERSION
+  spec.authors       = ["Daniel Ferraz"]
+  spec.email         = ["d.ferrazm@gmail.com"]
+  spec.description   = %q{Extensible solution to make it easy to export ruby objects to be used on price comparison shopping engines}
+  spec.summary       = %q{Sell your Ruby on Rails objects on price comparison shopping engines}
+  spec.homepage      = "http://github.com/imaboldcompany/sell_object"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.required_ruby_version     = '>= 1.9.3p125'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "nokogiri"
+end

data/spec/sell_object/buscape/formatter_proxy_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe SellObject::Buscape::FormatterProxy do
+	let(:target_object) { double price: 10.5, description: 'Lorem ipsum' }
+	let(:formatter) { SellObject::Buscape::FormatterProxy.new target_object }
+
+	it 'extends from SellObject::FormatterProxy' do
+		expect(formatter.is_a? SellObject::FormatterProxy).to be_true
+	end
+
+	describe '#preco' do
+		it 'formats the value from the target object to include two decimal cases with comma as sepparator' do
+			expect(formatter.preco :price).to eq '10,50'
+		end
+
+		it 'returns an error when the value from the target object is not a number' do
+			expect { formatter.preco :description }.to raise_error ArgumentError, 'method expects a number, got String: Lorem ipsum'
+		end
+	end
+end

data/spec/sell_object/buscape_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+include EngineMacros::Buscape
+
+class Product
+	include SellObject::Buscape
+end
+
+describe SellObject::Buscape do
+	it_behaves_like 'shopping_engine', :buscape
+
+	context 'still behaving as shopping_engine' do
+		let(:product) { Product.new }
+
+		before do
+			SellObject::XmlFormatter.stub(:format).and_return 'xml element'
+		end
+
+		describe 'class_methods' do
+			describe "to_buscape" do
+				context 'passing the store name' do
+					it 'generates the XML with the given store name as root' do
+						expect(remove_xml_noise Product.to_buscape([product], 'great')).to match /<great><produtos>.*<\/produtos><\/great>/
+					end
+				end
+			end
+		end
+
+		describe 'instance methods' do
+			describe "to_buscape" do
+				context 'passing the store name' do
+					it 'generates the XML with the given store name as root' do
+						expect(remove_xml_noise product.to_buscape('great')).to match /<great><produtos>.*<\/produtos><\/great>/
+					end
+				end
+			end			
+		end
+	end	
+
+	describe '#wrap_xml' do
+		before do
+			SellObject::Config.stub(:store_name).and_return 'awesome'
+		end
+
+		it 'inserts the timestamp into the xml' do
+			timestamp = Time.now.to_s
+			subject.stub(:timestamp).and_return '2014-03-29 13:28:32 -0300'
+			expect(subject.wrap_xml 'xml elements').to include '<!-- 2014-03-29 13:28:32 -0300 -->'
+		end
+
+		it 'inserts the given elements inside the <produtos> tag' do
+			expect(remove_xml_noise subject.wrap_xml('xml elements')).to include '<produtos>xml elements</produtos>'			
+		end
+
+		it 'wraps the <produtos> tag with the store name set up in config' do
+			SellObject::Config.stub(:store_name).and_return 'awesome'
+			expect(remove_xml_noise subject.wrap_xml('elements')).to match /<awesome><produtos>.*<\/produtos><\/awesome>/
+		end		
+
+		it 'raises an error if theres no store name set up' do
+			SellObject::Config.stub(:store_name).and_return nil
+			expect { subject.wrap_xml 'elements' }.to raise_error ArgumentError, 'No store name found (nil). You have to either pass it as an argument or set it up in SellObject::Config'
+		end
+
+		context 'when passing the store name as an argument' do
+			it 'wraps the <produtos> tag with the given store name' do
+				expect(remove_xml_noise subject.wrap_xml('elements', 'boring')).to match /<boring><produtos>.*<\/produtos><\/boring>/
+			end		
+		end
+	end
+
+	describe '#timestamp' do
+		it 'returns the time now correctly formatted' do
+			Time.stub(:now).and_return Time.new(2014,3,28,10,42,48,'-03:00')
+			expect(subject.timestamp).to eq 'Generated at 2014-03-28T10:42:48GMT-3'
+			Time.stub(:now).and_return Time.new(2011,1,4,17,22,58,'+01:00')
+			expect(subject.timestamp).to eq 'Generated at 2011-01-04T17:22:58GMT+1'
+			Time.stub(:now).and_return Time.new(2011,1,4,17,22,58,'+00:00')
+			expect(subject.timestamp).to eq 'Generated at 2011-01-04T17:22:58GMT+0'
+		end
+	end
+end

data/spec/sell_object/default_mappings_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe SellObject::DefaultMappings do
+	describe '#shopping_uol' do
+		let(:mapping) { subject.shopping_uol }
+
+		it 'maps :CODIGO to :id' do
+			expect(mapping[:CODIGO]).to eq :id
+		end
+
+		it 'maps :DESCRICAO to :description' do
+			expect(mapping[:DESCRICAO]).to eq :description
+		end
+
+		it 'maps :PRECO to :price' do
+			expect(mapping[:PRECO]).to eq :price
+		end
+
+		it 'maps :URL to :url' do
+			expect(mapping[:URL]).to eq :url
+		end
+	end
+
+	describe '#buscape' do
+		let(:mapping) { subject.buscape }
+
+		it 'maps :id_oferta to :id' do
+			expect(mapping[:id_oferta]).to eq :id
+		end
+
+		it 'maps :descricao to :description' do
+			expect(mapping[:descricao]).to eq :description
+		end
+
+		it 'maps :preco to :price' do
+			expect(mapping[:preco]).to eq :price
+		end
+
+		it 'maps :link_prod to :url' do
+			expect(mapping[:link_prod]).to eq :url
+		end
+
+		it 'maps :imagem to :image_url' do
+			expect(mapping[:imagem]).to eq :image_url
+		end
+
+		it 'maps :categoria to :category' do
+			expect(mapping[:categoria]).to eq :category
+		end
+	end
+end

data/spec/sell_object/formatter_proxy_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe SellObject::FormatterProxy do
+	let(:target_object) { double description: 'Lorem ipsum' }
+	let(:formatter) { SellObject::FormatterProxy.new target_object }
+
+	it 'sets the target object on initialization' do
+		expect(formatter.target).to eq target_object
+	end
+
+	it 'delegates any method missing to the target method' do
+		expect(formatter.foo :description).to eq 'Lorem ipsum'
+	end
+end

data/spec/sell_object/shopping_uol_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+include EngineMacros::ShoppingUol
+
+class Product
+	include SellObject::ShoppingUol
+end
+
+describe SellObject::ShoppingUol do
+	it_behaves_like 'shopping_engine', :shopping_uol
+
+	describe '#wrap_xml' do
+		it 'inserts the given elements inside the <PRODUTOS> tag' do
+			expect(remove_xml_noise subject.wrap_xml('xml elements')).to include '<PRODUTOS>xml elements</PRODUTOS>'
+		end
+	end
+end

data/spec/sell_object/xml_formatter_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe SellObject::XmlFormatter do
+	describe '#format' do
+		let(:target_object) { double some_value: 'some value' }
+
+		before do
+			SellObject.stub(:mapping_for).with(target_object, :foo).and_return({some_tag: :some_value})
+		end
+
+		it 'formats an object into a xml element based on its mapping, given an engine and a xml root' do
+			expect(remove_xml_noise subject.format(target_object, :foo, :xml_root)).to eq remove_xml_noise %q{
+				<xml_root>
+					<some_tag>some value</some_tag>
+				</xml_root>
+			}
+		end
+
+		context 'passing a formatter proxy' do
+			let(:proxy) { double some_tag: 'proxied value' }
+
+			it 'uses the proxy on the format process' do
+				expect(remove_xml_noise subject.format(target_object, :foo, :xml_root, proxy)).to eq remove_xml_noise %q{
+					<xml_root>
+						<some_tag>proxied value</some_tag>
+					</xml_root>
+				}
+			end
+		end
+	end
+end

data/spec/sell_object_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe SellObject do
+	context 'on inclusion' do
+		before do
+			class TargetClass
+				extend SellObject::ClassMethods
+			end
+		end
+
+		after do
+			Object.send :remove_const, :TargetClass
+		end
+
+		it 'makes the target class extend SellObject::ClassMethods'	do
+			expect(TargetClass.is_a? SellObject::ClassMethods).to be_true
+		end
+
+		describe 'ClassMethods' do
+			describe '#sell_through' do		
+				context 'passing invalid arguments' do
+					it 'raises ArgumentError with an invalid engine' do
+						expect { TargetClass.sell_through :foo }.to raise_error ArgumentError, 'invalid shopping engine foo'
+					end
+
+					it 'raises ArgumentError with a blank arguments' do
+						expect { TargetClass.sell_through }.to raise_error ArgumentError, 'must pass at least one shopping engine'
+					end
+				end
+
+				context 'buscape' do			
+					it 'includes the module SellObject::Buscape in the target class' do
+						TargetClass.sell_through :buscape
+						expect(TargetClass.included_modules).to include SellObject::Buscape				
+					end
+				end
+
+				context 'shopping_uol' do			
+					it 'includes the module SellObject::ShoppingUol in the target class' do
+						TargetClass.sell_through :shopping_uol
+						expect(TargetClass.included_modules).to include SellObject::ShoppingUol				
+					end
+				end
+			end
+		end
+	end	
+
+	describe '#supported_engines' do
+		it 'returns the supported shopping engines array' do
+			expect(subject.supported_engines).to match_array %w(shopping_uol buscape)
+		end
+	end
+
+	describe '#setup' do
+		it 'yields the SellObject::Config module' do
+			config_module = nil
+			subject.setup do |config|
+				config_module = config
+			end
+			expect(config_module.name).to eq 'SellObject::Config'
+		end
+	end	
+
+	describe '#mapping_for' do
+		before do
+			SellObject.stub(:supported_engines).and_return %w(bar)
+			SellObject::DefaultMappings.stub(:bar).and_return({t1: :v1, t2: :v2})
+			
+			class TargetObject
+			end
+		end
+
+		after do
+			Object.send :remove_const, :TargetObject
+		end
+
+		it 'raises an error if the given engine is invalid' do
+			expect { subject.mapping_for TargetObject.new, :foo }.to raise_error ArgumentError, 'invalid shopping engine foo'
+		end
+
+		context 'when there\s no custom mapping defined' do
+			it 'returns the default mapping hash for the given object' do
+				expect(subject.mapping_for TargetObject.new, :bar).to eq({t1: :v1, t2: :v2})
+			end
+		end
+		
+		context 'when there\s a custom mapping defined' do
+			before do
+				module SellObject::TargetObjectMappings
+					def self.bar
+						{t2: :v2_custom, t3: :v3}
+					end
+				end
+			end
+
+			after do
+				SellObject.send :remove_const, :TargetObjectMappings
+			end
+
+			it 'returns the default mapping hash merged with the custom mapping for the given object' do
+				expect(subject.mapping_for TargetObject.new, :bar).to eq({t1: :v1, t2: :v2_custom, t3: :v3})
+			end
+		end
+	end
+
+	describe 'Config' do
+		let(:subject) { SellObject::Config }
+
+		describe '#store_name' do
+			it 'initializes it with nil' do
+				expect(subject.store_name).to be_nil
+			end
+
+			it 'underscores the given assigned name' do
+				subject.store_name = 'My Store    Name'
+				expect(subject.store_name).to eq 'My_Store_Name'
+			end
+		end		
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'sell_object'
+
+ENV["RAILS_ENV"] ||= 'test'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+RSpec.configure do |config|
+  config.include SpecMacros
+end

data/spec/support/engine_macros.rb

@@ -0,0 +1,127 @@
+module EngineMacros
+	module Buscape
+		DEFAULT_MAPPING_FIXTURE_ONE = %q{
+			<?xml version="1.0" encoding="UTF-8" ?>
+			<awesome_store>
+				<produtos>
+					<produto>
+					  <id_oferta>PR1</id_oferta>
+					  <descricao>Some lame product</descricao>
+					  <preco>10,50</preco>
+					  <link_prod>http://example.com/lame-product</link_prod>
+					  <imagem>http://example.com/images/lame-product.png</imagem>
+					  <categoria>Electronics</categoria>
+					</produto>
+				</produtos>
+			</awesome_store>
+		}
+
+		DEFAULT_MAPPING_FIXTURE_MANY = %q{
+			<?xml version="1.0" encoding="UTF-8" ?>
+			<awesome_store>
+				<produtos>
+					<produto>
+					  <id_oferta>PR1</id_oferta>
+					  <descricao>Some lame product</descricao>
+					  <preco>10,50</preco>
+					  <link_prod>http://example.com/lame-product</link_prod>
+					  <imagem>http://example.com/images/lame-product.png</imagem>
+					  <categoria>Electronics</categoria>
+					</produto>
+					<produto>
+					  <id_oferta>PR2</id_oferta>
+					  <descricao>Some boring product</descricao>
+					  <preco>7,00</preco>
+					  <link_prod>http://example.com/boring-product</link_prod>
+					  <imagem>http://example.com/images/boring-product.png</imagem>
+					  <categoria>Kitchenware</categoria>
+					</produto>
+				</produtos>
+			</awesome_store>
+		}
+
+		CUSTOM_MAPPING_FIXTURE_MANY = %q{
+			<?xml version="1.0" encoding="UTF-8" ?>
+			<awesome_store>				
+				<produtos>
+					<produto>
+					  <id_oferta>PR1</id_oferta>
+					  <descricao>My custom lame product description</descricao>
+					  <preco>10,50</preco>
+					  <link_prod>http://example.com/custom-lame-product</link_prod>
+					  <imagem>http://example.com/images/lame-product.png</imagem>
+					  <categoria>Electronics</categoria>
+					</produto>
+					<produto>
+					  <id_oferta>PR2</id_oferta>
+					  <descricao>My custom boring product description</descricao>
+					  <preco>7,00</preco>
+					  <link_prod>http://example.com/custom-boring-product</link_prod>
+					  <imagem>http://example.com/images/boring-product.png</imagem>
+					  <categoria>Kitchenware</categoria>
+					</produto>
+				</produtos>
+			</awesome_store>
+		}
+	end
+
+	module ShoppingUol
+		DEFAULT_MAPPING_FIXTURE_ONE = %q{
+			<?xml version="1.0" encoding="iso-8859-1" ?>
+			<PRODUTOS>
+				<PRODUTO>
+				  <CODIGO>PR1</CODIGO>
+				  <DESCRICAO>Some lame product</DESCRICAO>
+				  <PRECO>10.5</PRECO>
+				  <URL>http://example.com/lame-product</URL>
+				  <URL_IMAGEM>http://example.com/images/lame-product.png</URL_IMAGEM>
+				  <DEPARTAMENTO>Electronics</DEPARTAMENTO>
+				</PRODUTO>
+			</PRODUTOS>
+		}
+
+		DEFAULT_MAPPING_FIXTURE_MANY = %q{
+			<?xml version="1.0" encoding="iso-8859-1" ?>
+			<PRODUTOS>
+				<PRODUTO>
+				  <CODIGO>PR1</CODIGO>
+				  <DESCRICAO>Some lame product</DESCRICAO>
+				  <PRECO>10.5</PRECO>
+				  <URL>http://example.com/lame-product</URL>
+				  <URL_IMAGEM>http://example.com/images/lame-product.png</URL_IMAGEM>
+				  <DEPARTAMENTO>Electronics</DEPARTAMENTO>
+				</PRODUTO>
+				<PRODUTO>
+				  <CODIGO>PR2</CODIGO>
+				  <DESCRICAO>Some boring product</DESCRICAO>
+				  <PRECO>7</PRECO>
+				  <URL>http://example.com/boring-product</URL>
+				  <URL_IMAGEM>http://example.com/images/boring-product.png</URL_IMAGEM>
+				  <DEPARTAMENTO>Kitchenware</DEPARTAMENTO>
+				</PRODUTO>
+			</PRODUTOS>
+		}
+
+		CUSTOM_MAPPING_FIXTURE_MANY = %q{
+			<?xml version="1.0" encoding="iso-8859-1" ?>
+			<PRODUTOS>
+				<PRODUTO>
+				  <CODIGO>PR1</CODIGO>
+				  <DESCRICAO>My custom lame product description</DESCRICAO>
+				  <PRECO>10.5</PRECO>
+				  <URL>http://example.com/custom-lame-product</URL>
+				  <URL_IMAGEM>http://example.com/images/lame-product.png</URL_IMAGEM>
+				  <DEPARTAMENTO>Electronics</DEPARTAMENTO>
+				</PRODUTO>
+				<PRODUTO>
+				  <CODIGO>PR2</CODIGO>
+				  <DESCRICAO>My custom boring product description</DESCRICAO>
+				  <PRECO>7</PRECO>
+				  <URL>http://example.com/custom-boring-product</URL>
+				  <URL_IMAGEM>http://example.com/images/boring-product.png</URL_IMAGEM>
+				  <DEPARTAMENTO>Kitchenware</DEPARTAMENTO>
+				</PRODUTO>
+			</PRODUTOS>
+		}
+	end
+end

data/spec/support/shared_examples/shopping_engine.rb

@@ -0,0 +1,76 @@
+shared_examples_for 'shopping_engine' do |engine|
+	camelized_engine = engine.to_s.split('_').map {|w| w.capitalize}.join
+
+	let(:macros) { eval("EngineMacros::#{camelized_engine}") }
+	let(:lame_product) { Product.new }
+	let(:boring_product) { Product.new }
+	let(:products) { [lame_product, boring_product] }
+
+	before do
+		lame_product.stub(:id).and_return 'PR1'
+		lame_product.stub(:description).and_return 'Some lame product'
+		lame_product.stub(:price).and_return 10.5
+		lame_product.stub(:category).and_return 'Electronics'
+		lame_product.stub(:url).and_return 'http://example.com/lame-product'
+		lame_product.stub(:image_url).and_return 'http://example.com/images/lame-product.png'
+
+		boring_product.stub(:id).and_return 'PR2'
+		boring_product.stub(:description).and_return 'Some boring product'
+		boring_product.stub(:price).and_return 7
+		boring_product.stub(:category).and_return 'Kitchenware'
+		boring_product.stub(:url).and_return 'http://example.com/boring-product'
+		boring_product.stub(:image_url).and_return 'http://example.com/images/boring-product.png'
+
+		SellObject::Config.stub(:store_name).and_return 'awesome_store'
+	end
+
+	describe 'class_methods' do
+		describe "#to_#{engine}" do
+			context 'using default mappings' do
+				it 'generates the XML accordingly with all the objects attributes' do
+					expect(remove_xml_noise Product.send("to_#{engine}", products)).to eq remove_xml_noise macros::DEFAULT_MAPPING_FIXTURE_MANY
+				end
+			end
+
+			context 'using custom mappings' do
+				before do
+					lame_product.stub(:custom_description).and_return 'My custom lame product description'
+					lame_product.stub(:custom_url).and_return 'http://example.com/custom-lame-product'
+					boring_product.stub(:custom_description).and_return 'My custom boring product description'
+					boring_product.stub(:custom_url).and_return 'http://example.com/custom-boring-product'
+
+					module SellObject::ProductMappings
+		 				def self.buscape
+		 					{ :descricao => :custom_description,  :link_prod => :custom_url }
+		 				end
+
+		 				def self.shopping_uol
+			 				{ :DESCRICAO => :custom_description,  :URL => :custom_url }
+			 			end
+			 		end		
+				end
+
+				after do
+					SellObject.send :remove_const, :ProductMappings
+				end
+
+				it 'generates the XML accordingly with all the objects attributes and the custom mappings' do
+					expect(remove_xml_noise Product.send("to_#{engine}", products)).to eq remove_xml_noise macros::CUSTOM_MAPPING_FIXTURE_MANY
+				end
+			end			
+		end
+	end
+
+	describe 'instance methods' do
+		describe "#to_#{engine}" do
+			it 'generates the XML accordingly with the object attributes' do
+				expect(remove_xml_noise lame_product.send("to_#{engine}")).to eq remove_xml_noise macros::DEFAULT_MAPPING_FIXTURE_ONE
+			end
+
+			# it "calls the #to_#{engine} class method passing the instance wrapped in an array" do
+			# 	Product.should_receive(:"to_#{engine}").with [lame_product]
+			# 	lame_product.send "to_#{engine}"
+			# end
+		end			
+	end
+end

data/spec/support/spec_macros.rb

@@ -0,0 +1,5 @@
+module SpecMacros
+	def remove_xml_noise(xml)
+		xml.gsub("\n",'').gsub("\t",'').gsub(/<!--.*-->/, '').gsub />[ \t]+</, '><'
+	end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: sell_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Ferraz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extensible solution to make it easy to export ruby objects to be used
+  on price comparison shopping engines
+email:
+- d.ferrazm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/sell_object/install_generator.rb
+- lib/generators/templates/sell_object.rb
+- lib/sell_object.rb
+- lib/sell_object/buscape.rb
+- lib/sell_object/buscape/formatter_proxy.rb
+- lib/sell_object/default_mappings.rb
+- lib/sell_object/formatter_proxy.rb
+- lib/sell_object/shopping_uol.rb
+- lib/sell_object/version.rb
+- lib/sell_object/xml_formatter.rb
+- sell_object.gemspec
+- spec/sell_object/buscape/formatter_proxy_spec.rb
+- spec/sell_object/buscape_spec.rb
+- spec/sell_object/default_mappings_spec.rb
+- spec/sell_object/formatter_proxy_spec.rb
+- spec/sell_object/shopping_uol_spec.rb
+- spec/sell_object/xml_formatter_spec.rb
+- spec/sell_object_spec.rb
+- spec/spec_helper.rb
+- spec/support/engine_macros.rb
+- spec/support/shared_examples/shopping_engine.rb
+- spec/support/spec_macros.rb
+homepage: http://github.com/imaboldcompany/sell_object
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3p125
+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: Sell your Ruby on Rails objects on price comparison shopping engines
+test_files:
+- spec/sell_object/buscape/formatter_proxy_spec.rb
+- spec/sell_object/buscape_spec.rb
+- spec/sell_object/default_mappings_spec.rb
+- spec/sell_object/formatter_proxy_spec.rb
+- spec/sell_object/shopping_uol_spec.rb
+- spec/sell_object/xml_formatter_spec.rb
+- spec/sell_object_spec.rb
+- spec/spec_helper.rb
+- spec/support/engine_macros.rb
+- spec/support/shared_examples/shopping_engine.rb
+- spec/support/spec_macros.rb