goods 0.0.1

data/spec/goods/offer_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+describe Goods::Offer do
+  let(:books) { Goods::Category.new(id: "1", name: "Books") }
+  let(:rur) { Goods::Currency.new(id: "RUR", rate: 1, plus: 0) }
+  let(:valid_description) do
+    {id: "1", name: "The Lord of The Rings", category_id: "1", currency_id: "RUR", price: 10} 
+  end
+  let(:valid_offer) do
+    offer = Goods::Offer.new(valid_description)
+    offer.category = books
+    offer.currency = rur
+    offer
+  end
+
+  it_should_behave_like "containable" do
+    let(:element) { valid_offer }
+  end
+
+  describe "#valid?" do
+    context "invalid cases" do
+      let(:invalid_offer) { Goods::Offer.new({}) }
+
+      [:id, :category_id, :currency_id, :price].each do |field|
+        it "should reject offers without #{field}" do
+          expect(invalid_offer).not_to be_valid
+          expect(invalid_offer.invalid_fields).to include(field)
+        end
+      end
+
+      it "should reject offers with non-positive price" do
+        invalid_offer = Goods::Offer.new(price: -5.0)
+        expect(invalid_offer).not_to be_valid
+        expect(invalid_offer.invalid_fields).to include(:price)
+      end
+    end
+
+    context "valid cases" do
+      it "should accept offer when it has id, category, currency and price" do
+        expect(valid_offer).to be_valid
+      end
+    end
+  end
+
+  [:available, :description, :model, :name, :picture, :vendor].each do |field|
+    it "should have #{field}" do
+      expect(valid_offer).to respond_to(field)
+    end
+  end
+
+  it "should have floting point price" do
+    expect(Goods::Offer.new(price: 5).price).to be_kind_of(Float)
+  end
+
+  describe "#convert_currency" do
+    let(:usd) { Goods::Currency.new(id: "USD", rate: 30, plus: 0) }
+
+    it "should change currency" do
+      valid_offer.convert_currency(usd)
+      expect(valid_offer.currency).to be(usd)
+    end
+
+    it "should leave offer valid" do
+      valid_offer.convert_currency(usd)
+      expect(valid_offer).to be_valid
+    end
+
+    it "should change price according to rate" do
+      valid_offer.convert_currency(usd)
+      expect(valid_offer.price).to eql(1.0/3)
+    end
+  end
+
+  describe "#change_category" do
+  let(:printers) { Goods::Category.new(id: "print", name: "Printers") }
+
+    it "should change category to specified one" do
+      valid_offer.change_category(printers)
+      expect(valid_offer.category).to be(printers)
+    end
+
+    it "should leave offer valid" do
+      valid_offer.change_category(printers)
+      expect(valid_offer).to be_valid
+    end
+  end
+end

data/spec/goods/offers_list_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Goods::OffersList do
+  let(:categories) { Goods::CategoriesList.new([{id: "1", name: "Category"}]) }
+  let(:currencies) { Goods::CurrenciesList.new([{id: "RUR", rate: 1, plus: 0}]) }
+  let(:offers) { Goods::OffersList.new(categories, currencies) }
+  let(:subject) { offers }
+
+  it_should_behave_like "a container",
+    Goods::Offer,
+    Goods::Offer.new(id: "1", url: "url.com", category_id: "1", currency_id: "RUR", price: 10) do
+      let(:subject) { offers }
+    end
+
+  describe "#add" do
+    it "should setup category and currency for offer" do
+      offer = Goods::Offer.new(id: "1", url: "url.com", category_id: "1", currency_id: "RUR", price: 10)
+      subject.add(offer)
+
+      expect(offer.category).to be(categories.find("1"))
+      expect(offer.currency).to be(currencies.find("RUR"))
+    end
+  end
+
+  describe "#prune_categories" do
+    let(:categories) do
+      list = Goods::CategoriesList.new [
+        {id: "1", name: "root"},
+        {id: "11", name: "root", parent_id: "1"},
+        {id: "12", name: "root", parent_id: "11"}
+      ]
+      list
+    end
+    let(:offers) do
+      list = Goods::OffersList.new categories, currencies, [
+        {id: "1", category_id: "1", currency_id: "RUR", price: 1},
+        {id: "2", category_id: "11", currency_id: "RUR", price: 1},
+        {id: "3", category_id: "12", currency_id: "RUR", price: 1}
+      ]
+      list
+    end
+
+    it "should raise error if level < 0" do
+      expect{ offers.prune_categories }.to raise_error(ArgumentError)
+    end
+
+    it "should replace deep categories with their parents on specified level" do
+      offers.prune_categories(1)
+      expect(offers.find("3").category).to be(categories.find("11"))
+    end
+
+    it "should not affect offers with categories having lower level" do
+      offers.prune_categories(1)
+      expect(offers.find("1").category).to be(categories.find("1"))
+    end
+  end
+
+  describe "#convert_currency" do
+    let(:currencies) do
+      Goods::CurrenciesList.new([
+        {id: "RUR", rate: 1, plus: 0},
+        {id: "USD", rate: 30, plus: 0},
+        {id: "GBP", rate: 50, plus: 0}
+      ])
+    end
+    let(:offers) do
+      list = Goods::OffersList.new categories, currencies, [
+        {id: "1", category_id: "1", currency_id: "USD", price: 1},
+        {id: "2", category_id: "1", currency_id: "GBP", price: 1}
+      ]
+      list
+    end
+
+    it "should convert currency for all offers" do
+      expect(offers.find("1")).to receive(:convert_currency)
+      expect(offers.find("2")).to receive(:convert_currency)
+      offers.convert_currency(currencies.find("RUR"))
+    end
+  end
+end

data/spec/goods/xml/validator_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Goods::XML::Validator do
+  let(:valid_document) { File.read(File.expand_path("../../../fixtures/simple_catalog.xml", __FILE__)) }
+  let(:invalid_document) { File.read(File.expand_path("../../../fixtures/empty_catalog.xml", __FILE__)) }
+
+  describe "#valid?" do
+    it "should return true if document is valid according to dtd" do
+      validator = Goods::XML::Validator.new
+      expect(validator.valid? valid_document).to eql(true)
+      expect(validator.error).to be_nil
+    end
+
+    it "should return false if document is not valid" do
+      validator = Goods::XML::Validator.new
+      expect(validator.valid? invalid_document).to eql(false)
+    end
+
+    it "should have non-empty errors if document is not valid" do
+      validator = Goods::XML::Validator.new
+      validator.valid? invalid_document
+      expect(validator.error).not_to be_nil
+    end
+  end
+end

data/spec/goods/xml_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe Goods::XML do
+  let(:simple_catalog_data) do
+    File.read(File.expand_path('../../fixtures/simple_catalog.xml', __FILE__))
+  end
+  let(:simple_catalog) { Goods::XML.new(simple_catalog_data) }
+  SIMPLE_CATALOG_CATEGORIES_COUNT = 9
+  SIMPLE_CATALOG_CURRENCIES_COUNT = 3
+  SIMPLE_CATALOG_OFFERS_COUNT = 2
+
+  describe "#initialize" do
+    it 'should use Nokogiri for parsing' do
+      params = ["string", "url", "encoding"]
+      expect(Nokogiri::XML::Document).to receive(:parse).with(*params)
+
+      Goods::XML.new(*params)
+    end
+
+    it 'should parse valid document' do
+      expect(simple_catalog.instance_variable_get("@xml_source")).to be_kind_of(Nokogiri::XML::Document)
+    end
+  end
+
+  describe "#categories" do
+    let(:categories) { simple_catalog.categories }
+
+    it "should extract all categories" do
+      expect(categories.count).to eq(SIMPLE_CATALOG_CATEGORIES_COUNT)
+    end
+
+    context "category format" do
+      let(:root_category) { categories[0] }
+      let(:child_category) { categories[1] }
+
+      it "should have an id" do
+        expect(root_category[:id]).to eq("1")
+      end
+
+      it "should have a name" do
+        expect(root_category[:name]).to eq("Оргтехника")
+      end
+
+      it "should have nil parent_id for root category" do
+        expect(root_category[:parent_id]).to be_nil
+      end
+
+      it "should have non-nil parent_id for child_category" do
+        expect(child_category[:parent_id]).to eq("1")
+      end
+    end
+
+    it 'should call #extract_categories only at the first invocation' do
+      expect_any_instance_of(Goods::XML).to receive(:extract_categories).once.and_call_original
+      2.times { simple_catalog.categories }
+    end
+  end
+
+  describe "#currencies" do
+    it "should extract all currencies" do
+      expect(simple_catalog.currencies.count).to eq(SIMPLE_CATALOG_CURRENCIES_COUNT)
+    end
+
+    context "currency format" do
+      let(:rur) { simple_catalog.currencies[0] }
+      let(:usd) { simple_catalog.currencies[1] }
+      let(:kzt) { simple_catalog.currencies[2] }
+
+      it "should have an id" do
+        expect(rur[:id]).to eq("RUR")
+      end
+
+      it "should have a rate" do
+        expect(rur[:rate]).to eq("1")
+      end
+
+      it "should have a custom rate" do
+        expect(usd[:rate]).to eq("30")
+      end
+
+      it "should have a default rate" do
+        expect(kzt[:rate]).to eq("1")
+      end
+
+      it "should have a plus" do
+        expect(rur[:plus]).to eq("0")
+      end
+
+      it "should have a default plus" do
+        expect(kzt[:plus]).to eq("0")
+      end
+    end
+
+    it 'should call #extract_currencies only at the first invocation' do
+      expect_any_instance_of(Goods::XML).to receive(:extract_currencies).once.and_call_original
+      2.times { simple_catalog.currencies }
+    end
+  end
+
+  describe "#offers" do
+    it 'should extract all offers' do
+      expect(simple_catalog.offers.count).to eq(SIMPLE_CATALOG_OFFERS_COUNT)
+    end
+
+    context "offer format" do
+      let(:printer) { simple_catalog.offers[0] }
+      let(:book) { simple_catalog.offers[1] }
+
+      it "should have an id" do
+        expect(printer[:id]).to eq("123")
+      end
+
+      it "should have availability status" do
+        expect(book[:available]).to eq(false)
+      end
+
+      it "should have default availability status" do
+        expect(printer[:available]).to eq(true)
+      end
+
+      it "should have a URL which is not empty" do
+        expect(printer[:url]).to eq("http://magazin.ru/product_page.asp?pid=14344")
+      end
+
+      it "should have a nil URL if offer doesn't have one" do
+        expect(book[:url]).to be_nil
+      end
+
+      it "should have a price" do
+        expect(printer[:price]).to eq(15000.00)
+      end
+
+      it "should have a currency_id" do
+        expect(printer[:currency_id]).to eq("RUR")
+      end
+
+      it "should use first category_id" do
+        expect(printer[:category_id]).to eq("100")
+      end
+
+      it "should use first picture if there at least one" do
+        expect(printer[:picture]).to eq("http://magazin.ru/img/device1.jpg")
+      end
+
+      it "should have a nil picture if offer doesn't have one" do
+        expect(book[:picture]).to be_nil
+      end
+
+      it "should have a description" do
+        expect(printer[:description]).to eq("A4, 64Mb, 600x600 dpi, USB 2.0, 29стр/мин ч/б / 15стр/мин цв, лотки на 100л и 250л, плотность до 175г/м, до 60000 стр/месяц")
+      end
+
+      it "should have a non-empty name" do
+        expect(book[:name]).to eq("Все не так. В 2 томах. Том 1")
+      end
+
+      it "should have a nil name if offer doesn't have one" do
+        expect(printer[:name]).to be_nil
+      end
+
+      it "should have a non-empty vendor" do
+        expect(printer[:vendor]).to eq("НP")
+      end
+
+      it "should have a nil vendor if offer doesn't have one" do
+        expect(book[:vendor]).to be_nil
+      end
+
+      it "should have a non-empty model" do
+        expect(printer[:model]).to eq("Color LaserJet 3000")
+      end
+
+      it "should have a nil model if offer doesn't have one" do
+        expect(book[:model]).to be_nil
+      end
+    end
+  end
+end

data/spec/goods_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Goods do
+  it 'should have a version number' do
+    expect(Goods::VERSION).to_not be_nil
+  end
+
+  describe ".from_string" do
+    let(:valid_document) { File.read(File.expand_path("../fixtures/simple_catalog.xml", __FILE__)) }
+    let(:invalid_document) { File.read(File.expand_path("../fixtures/empty_catalog.xml", __FILE__)) }
+
+    it "should return catalog if valid xml file is passed" do
+      expect(Goods::Catalog).to receive(:new).
+        with({string: valid_document, url: "url", encoding: "UTF-8"})
+      Goods.from_string(valid_document, "url", "UTF-8")
+    end
+
+    it "should raise error if invalid file is passed" do
+      expect { Goods.from_string(invalid_document) }.to raise_error(Goods::XML::InvalidFormatError)
+    end
+  end
+
+  describe ".from_file" do
+    it "should load file and call .from_string" do
+      params = {
+        file: "file", string: "string", url: nil, encoding: "UTF-8"
+      }
+      expect(Goods).to receive(:load).with(params[:file]) { params[:string] }
+      expect(Goods).to receive(:from_string).with(params[:string], nil, params[:encoding])
+      Goods.from_file params[:file], params[:encoding]
+    end
+  end
+
+  describe ".from_url" do
+    it "should load remote page and call .from_string" do
+      params = {
+        string: "string", url: "url", encoding: "UTF-8"
+      }
+      expect(Goods).to receive(:load).with(params[:url]) { params[:string] }
+      expect(Goods).to receive(:from_string).with(params[:string], params[:url], params[:encoding])
+      Goods.from_url params[:url], params[:encoding]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'goods'
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  # Limit the spec run to only specs with the focus metadata. If no specs have
+  # the filtering metadata and `run_all_when_everything_filtered = true` then
+  # all specs will run.
+  config.filter_run :focus
+
+  # Run all specs when none match the provided filter. This works well in
+  # conjunction with `config.filter_run :focus`, as it will run the entire
+  # suite when no specs have `:filter` metadata.
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = 'random'
+end

data/spec/support/shared_examples_for_containable.rb

@@ -0,0 +1,16 @@
+shared_examples "containable" do
+  [:description, :id, :invalid_fields].each do |prop|
+    it "should give access to #{prop}" do
+      expect(element).to respond_to(prop)
+    end
+  end
+
+  describe "#reset_validation" do
+    it "should clear invalid_fields" do
+      element.instance_variable_set("@invalid_fields", [:a, :b])
+      expect(element.invalid_fields.size).to eql(2)
+      element.send :reset_validation
+      expect(element.invalid_fields).to be_empty
+    end
+  end
+end

data/spec/support/shared_examples_for_container.rb

@@ -0,0 +1,43 @@
+shared_examples "a container" do |containable_class, element|
+  describe "#add" do
+    context "when hash is passed" do
+      it "should at first create an object" do
+        expect(containable_class).to receive(:new) { element }
+        subject.add({})
+      end
+    end
+
+    context "when object is passed" do
+      it "should not create new object" do
+        expect(containable_class).to_not receive(:new)
+        subject.add element
+      end
+
+      it "should add to list valid elements" do
+        expect { subject.add(element) }.to change(subject, :size).by(1)
+      end
+
+      it "should remember invalid elements" do
+        allow(element).to receive(:valid?).and_return(false)
+        expect { subject.add(element) }.to change(subject.defectives, :size).by(1)
+      end
+    end
+  end
+
+  describe "#find" do
+    [:one, :two].each do |el|
+      let(el) { 
+        el = containable_class.new({})
+        allow(el).to receive(:valid?) { true }
+        allow(el).to receive(:id) { el.to_s.upcase }
+        el
+      }
+    end
+
+    it "should return element with correct id" do
+      subject.add(one); subject.add(two)
+      expect(subject.size).to eq(2)
+      expect(subject.find(one.id)).to eq(one)
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: goods
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artem Pyanykh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 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: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  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'
+- !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: |2
+    The purpose of this gem is to provide simple, yet reliable solution for parsing
+    YML (Yandex Market Language) files, with clean and convenient interface,
+    and extra capabilites, such as categories prunning.
+email:
+- artem.pyanykh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- goods.gemspec
+- lib/goods.rb
+- lib/goods/catalog.rb
+- lib/goods/categories_list.rb
+- lib/goods/category.rb
+- lib/goods/containable.rb
+- lib/goods/container.rb
+- lib/goods/currencies_list.rb
+- lib/goods/currency.rb
+- lib/goods/offer.rb
+- lib/goods/offers_list.rb
+- lib/goods/version.rb
+- lib/goods/xml.rb
+- lib/goods/xml/validator.rb
+- lib/support/shops.dtd
+- spec/fixtures/empty_catalog.xml
+- spec/fixtures/simple_catalog.xml
+- spec/goods/catalog_spec.rb
+- spec/goods/categories_list_spec.rb
+- spec/goods/category_spec.rb
+- spec/goods/currencies_list_spec.rb
+- spec/goods/currency_spec.rb
+- spec/goods/offer_spec.rb
+- spec/goods/offers_list_spec.rb
+- spec/goods/xml/validator_spec.rb
+- spec/goods/xml_spec.rb
+- spec/goods_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples_for_containable.rb
+- spec/support/shared_examples_for_container.rb
+homepage: https://github.com/ArtemPyanykh/goods
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Simple parser for YML (Yandex Market Language) files with a few twists.
+test_files:
+- spec/fixtures/empty_catalog.xml
+- spec/fixtures/simple_catalog.xml
+- spec/goods/catalog_spec.rb
+- spec/goods/categories_list_spec.rb
+- spec/goods/category_spec.rb
+- spec/goods/currencies_list_spec.rb
+- spec/goods/currency_spec.rb
+- spec/goods/offer_spec.rb
+- spec/goods/offers_list_spec.rb
+- spec/goods/xml/validator_spec.rb
+- spec/goods/xml_spec.rb
+- spec/goods_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples_for_containable.rb
+- spec/support/shared_examples_for_container.rb