goods 0.0.1

data/lib/goods/xml.rb

@@ -0,0 +1,129 @@
+require "nokogiri"
+
+module Goods
+  class XML
+    class InvalidFormatError < StandardError; end
+
+    def initialize(string, url = nil, encoding = nil)
+      @xml_source = Nokogiri::XML::Document.parse(string, url, encoding)
+    end
+
+    def categories
+      @categories ||= extract_categories
+    end
+
+    def currencies
+      @currencies ||= extract_currencies
+    end
+
+    def offers
+      @offers ||= extract_offers
+    end
+
+
+    private
+
+
+    def catalog_node
+      @xml_source / "yml_catalog"
+    end
+
+    def shop_node
+      catalog_node / "shop"
+    end
+
+    # Categories part
+    def categories_node
+      shop_node / "categories" / "category"
+    end
+
+    def extract_categories
+      categories_node.map do |category|
+        category_node_to_hash(category)
+      end
+    end
+
+    def category_node_to_hash(category)
+      category_hash = {
+        id: category.attribute("id").value,
+        name: category.text
+      }
+      category_hash[:parent_id] = if category.attribute("parentId")
+                                    category.attribute("parentId").value
+                                  else
+                                    nil
+                                  end
+      category_hash
+    end
+
+    # Currencies part
+    def currencies_node
+      shop_node / "currencies" / "currency"
+    end
+
+    def extract_currencies
+      currencies_node.map do |currency|
+        currency_node_to_hash(currency)
+      end
+    end
+
+    def currency_node_to_hash(currency)
+      currency_hash = {
+        id: currency.attribute("id").value
+      }
+
+      attributes_with_defaults = {
+        rate: "1",
+        plus: "0"
+      }
+      attributes_with_defaults.each do |attr, default|
+        currency_hash[attr] = if currency.attribute(attr.to_s)
+                                currency.attribute(attr.to_s).value
+                              else
+                                default
+                              end
+      end
+
+      currency_hash
+    end
+
+    #Offers part
+    def offers_node
+      shop_node / "offers" / "offer"
+    end
+
+    def extract_offers
+      offers_node.map do |offer|
+        offer_node_to_hash(offer)
+      end
+    end
+
+    def offer_node_to_hash(offer)
+      offer_hash = {
+        id: offer.attribute("id").value
+      }
+
+      offer_hash[:available] = if attr = offer.attribute("available")
+                                 !! (attr.value =~ /true/)
+                               else
+                                 true
+                               end
+      {
+        url: "url",
+        currency_id: "currencyId",
+        category_id: "categoryId",
+        picture: "picture",
+        description: "description",
+        name: "name",
+        vendor: "vendor",
+        model: "model"
+      }.each do |property, node|
+        offer_hash[property] = (el = offer.xpath(node).first) ? el.text.strip : nil
+      end
+
+      offer_hash[:price] = offer.xpath("price").first.text.to_f
+
+      offer_hash
+    end
+  end
+end

data/lib/goods.rb

@@ -0,0 +1,42 @@
+require 'open-uri'
+require "goods/version"
+require "goods/xml/validator"
+require "goods/xml"
+require "goods/containable"
+require "goods/container"
+require "goods/category"
+require "goods/categories_list"
+require "goods/offer"
+require "goods/offers_list"
+require "goods/currency"
+require "goods/currencies_list"
+require "goods/catalog"
+
+module Goods
+  def self.from_string(xml_string, url=nil, encoding=nil)
+    validator = XML::Validator.new
+    if validator.valid? xml_string
+      Catalog.new(string: xml_string, url: url, encoding: encoding)
+    else
+      raise XML::InvalidFormatError, validator.error
+    end
+  end
+
+  def self.from_url(url, encoding=nil)
+    xml_string = self.load url
+    from_string(xml_string, url, encoding)
+  end
+
+  def self.from_file(file, encoding=nil)
+    xml_string = self.load file
+    from_string(xml_string, nil, encoding)
+  end
+
+  private
+
+  def self.load(source)
+    open(source) do |f|
+      f.read
+    end
+  end
+end

data/lib/support/shops.dtd

@@ -0,0 +1,149 @@
+<!ELEMENT yml_catalog (shop)>
+<!ATTLIST yml_catalog
+    date CDATA #REQUIRED
+    count CDATA #IMPLIED>
+
+<!ELEMENT shop (name, company, url, phone?, platform?, version?, agency?, email*, currencies, categories, store?, pickup?, delivery?, deliveryIncluded?, local_delivery_cost?, adult?, offers)>
+<!ELEMENT company (#PCDATA)>
+<!ELEMENT phone (#PCDATA)>
+
+<!ELEMENT currencies (currency+)>
+<!ELEMENT currency EMPTY>
+<!ATTLIST currency
+    id (RUR|RUB|USD|BYR|KZT|EUR|UAH) #REQUIRED
+    rate CDATA "1"
+    plus CDATA "0">
+
+
+<!ELEMENT categories (category+)>
+<!ELEMENT category (#PCDATA)>
+<!ATTLIST category
+    id CDATA #REQUIRED
+    parentId CDATA #IMPLIED
+    tid CDATA #IMPLIED
+    yid CDATA #IMPLIED>
+
+<!ELEMENT offers (offer+)>
+<!ELEMENT offer (url?, buyurl?, price, wprice?, currencyId, xCategory?, categoryId+, market_category?,
+                 picture*, store?, pickup?, delivery?, deliveryIncluded?, local_delivery_cost?, orderingTime?,
+                 ((typePrefix?, vendor, vendorCode?, model, (provider, tarifplan?)?) |
+                  (author?, name, publisher?, series?, year?, ISBN?, volume?, part?, language?, binding?, page_extent?, table_of_contents?) |
+                  (author?, name, publisher?, series?, year?, ISBN?, volume?, part?, language?, table_of_contents?, performed_by?, performance_type?, storage?, format?, recording_length?) |
+                  (artist?, title, year?, media?, starring?, director?, originalName?, country?) |
+                  (worldRegion?, country?, region?, days, dataTour*, name, hotel_stars?, room?, meal?, included, transport, price_min?, price_max?, options?) |
+                  (name, place, hall?, hall_part?, date, is_premiere?, is_kids?) |
+                  (name, vendor?, vendorCode?)
+                 ),
+                 aliases?, additional*, description?, sales_notes?, promo?,
+                 manufacturer_warranty?, country_of_origin?, downloadable?, adult?,
+                 age?,
+                 barcode*,
+                 param*,
+                 related_offer*
+                )>
+<!ATTLIST offer
+    id CDATA #IMPLIED
+    group_id CDATA #IMPLIED
+    type (vendor.model | book | audiobook | artist.title | tour | ticket | event-ticket) #IMPLIED
+    available (true | false) #IMPLIED
+    bid CDATA #IMPLIED
+    cbid CDATA #IMPLIED>
+
+<!ELEMENT url (#PCDATA)>
+<!ELEMENT store (#PCDATA)>
+<!ELEMENT email (#PCDATA)>
+<!ELEMENT platform (#PCDATA)>
+<!ELEMENT version (#PCDATA)>
+<!ELEMENT agency (#PCDATA)>
+<!ELEMENT buyurl (#PCDATA)>
+<!ELEMENT picture (#PCDATA)>
+<!ELEMENT pickup (#PCDATA)>
+<!ELEMENT delivery (#PCDATA)>
+<!ELEMENT deliveryIncluded EMPTY>
+<!ELEMENT local_delivery_cost (#PCDATA)>
+<!ELEMENT orderingTime (onstock?, ordering, deliveryTime?)>
+<!ELEMENT onstock EMPTY>
+<!ELEMENT ordering (#PCDATA)>
+<!ATTLIST ordering
+    hours CDATA #IMPLIED>
+
+<!ELEMENT deliveryTime EMPTY>
+<!ELEMENT price (#PCDATA)>
+<!ELEMENT wprice (#PCDATA)>
+<!ELEMENT currencyId (#PCDATA)>
+<!ELEMENT categoryId (#PCDATA)>
+<!ATTLIST categoryId
+    type (Yandex | Torg | Own) "Own" >
+
+<!ELEMENT market_category (#PCDATA)>
+<!ELEMENT typePrefix (#PCDATA)>
+<!ELEMENT vendor (#PCDATA)>
+<!ELEMENT vendorCode (#PCDATA)>
+<!ELEMENT model (#PCDATA)>
+<!ELEMENT author (#PCDATA)>
+<!ELEMENT name (#PCDATA)>
+<!ELEMENT publisher (#PCDATA)>
+<!ELEMENT ISBN (#PCDATA)>
+<!ELEMENT volume (#PCDATA)>
+<!ELEMENT part (#PCDATA)>
+<!ELEMENT language (#PCDATA)>
+<!ELEMENT binding (#PCDATA)>
+<!ELEMENT page_extent (#PCDATA)>
+<!ELEMENT table_of_contents (#PCDATA)>
+<!ELEMENT performed_by (#PCDATA)>
+<!ELEMENT performance_type (#PCDATA)>
+<!ELEMENT storage (#PCDATA)>
+<!ELEMENT format (#PCDATA)>
+<!ELEMENT recording_length (#PCDATA)>
+<!ELEMENT series (#PCDATA)>
+<!ELEMENT year (#PCDATA)>
+<!ELEMENT artist (#PCDATA)>
+<!ELEMENT title (#PCDATA)>
+<!ELEMENT media (#PCDATA)>
+<!ELEMENT starring (#PCDATA)>
+<!ELEMENT director (#PCDATA)>
+<!ELEMENT originalName (#PCDATA)>
+<!ELEMENT country (#PCDATA)>
+<!ELEMENT description (#PCDATA)>
+<!ELEMENT sales_notes (#PCDATA)>
+<!ELEMENT promo (#PCDATA)>
+<!ELEMENT aliases (#PCDATA)>
+<!ELEMENT provider (#PCDATA)>
+<!ELEMENT tarifplan (#PCDATA)>
+<!ELEMENT xCategory (#PCDATA)>
+<!ELEMENT additional (#PCDATA)>
+<!ELEMENT worldRegion (#PCDATA)>
+<!ELEMENT region (#PCDATA)>
+<!ELEMENT days (#PCDATA)>
+<!ELEMENT dataTour (#PCDATA)>
+<!ELEMENT hotel_stars (#PCDATA)>
+<!ELEMENT room (#PCDATA)>
+<!ELEMENT meal (#PCDATA)>
+<!ELEMENT included (#PCDATA)>
+<!ELEMENT transport (#PCDATA)>
+<!ELEMENT price_min (#PCDATA)>
+<!ELEMENT price_max (#PCDATA)>
+<!ELEMENT options (#PCDATA)>
+<!ELEMENT manufacturer_warranty (#PCDATA)>
+<!ELEMENT country_of_origin (#PCDATA)>
+<!ELEMENT downloadable (#PCDATA)>
+<!ELEMENT adult (#PCDATA)>
+<!ELEMENT age (#PCDATA)>
+<!ELEMENT barcode (#PCDATA)>
+<!ELEMENT param (#PCDATA)>
+<!ATTLIST param
+    name CDATA #REQUIRED
+    unit CDATA #IMPLIED>
+<!ELEMENT related_offer (#PCDATA)>
+
+<!ELEMENT place (#PCDATA)>
+<!ELEMENT hall (#PCDATA)>
+<!ATTLIST hall
+    plan CDATA #IMPLIED>
+
+<!ELEMENT hall_part (#PCDATA)>
+<!ELEMENT is_premiere (#PCDATA)>
+<!ELEMENT is_kids (#PCDATA)>
+<!ELEMENT date (#PCDATA)>
+
+

data/spec/fixtures/empty_catalog.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE yml_catalog SYSTEM "/Users/rainx/WebstormProjects/partner/pages/help/shops.dtd">
+<yml_catalog date="2010-04-01 17:00">
+    <shop>
+        <currencies>
+        </currencies>
+
+        <categories>
+        </categories>
+
+        <offers>
+        </offers>
+
+    </shop>
+</yml_catalog>

data/spec/fixtures/simple_catalog.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE yml_catalog SYSTEM "/Users/rainx/WebstormProjects/partner/pages/help/shops.dtd">
+<yml_catalog date="2010-04-01 17:00">
+    <shop>
+        <name>Magazin</name>
+        <company>Magazin</company>
+        <url>http://www.magazin.ru/</url>
+
+        <currencies>
+            <currency id="RUR" rate="1" plus="0"/>
+            <currency id="USD" rate="30"/>
+            <currency id="KZT"/>
+        </currencies>
+
+        <categories>
+            <category id="1">Оргтехника</category>
+            <category id="10" parentId="1">Принтеры</category>
+            <category id="100" parentId="10">Струйные принтеры</category>
+            <category id="101" parentId="10">Лазерные принтеры</category>
+
+            <category id="2">Фототехника</category>
+            <category id="11" parentId="2">Фотоаппараты</category>
+            <category id="12" parentId="2">Объективы</category>
+
+            <category id="3">Книги</category>
+            <category id="13" parentId="3">Детективы</category>
+        </categories>
+
+        <local_delivery_cost>300</local_delivery_cost>
+
+        <offers>
+            <offer id="123" type="vendor.model" bid="13" cbid="20">
+                <url>http://magazin.ru/product_page.asp?pid=14344</url>
+                <price>15000</price>
+                <currencyId>RUR</currencyId>
+                <categoryId type="Own">100</categoryId>
+                <categoryId type="Own">101</categoryId>
+                <picture>http://magazin.ru/img/device1.jpg</picture>
+                <picture>http://magazin.ru/img/device2.jpg</picture>
+                <delivery>true</delivery>
+                <local_delivery_cost>300</local_delivery_cost>
+                <typePrefix>Принтер</typePrefix>
+                <vendor>НP</vendor>
+                <vendorCode>Q7533A</vendorCode>
+                <model>Color LaserJet 3000</model>
+                <description>A4, 64Mb, 600x600 dpi, USB 2.0, 29стр/мин ч/б / 15стр/мин цв, лотки на 100л и 250л, плотность до 175г/м, до 60000 стр/месяц </description>
+                <manufacturer_warranty>true</manufacturer_warranty>
+                <country_of_origin>Япония</country_of_origin>
+            </offer>
+
+            <offer id="1234" type="book" bid="17" available="false">
+                <price>100</price>
+                <currencyId>RUR</currencyId>
+                <categoryId type="Own">13</categoryId>
+                <delivery>true</delivery>
+                <local_delivery_cost>300</local_delivery_cost>
+                <author>Александра Маринина</author>
+                <name>Все не так. В 2 томах. Том 1</name>
+                <publisher>ЭКСМО - Пресс</publisher>
+                <series>А. Маринина - королева детектива</series>
+                <year>2009</year>
+                <ISBN>978-5-699-23647-3</ISBN>
+                <volume>2</volume>
+                <part>1</part>
+                <language>rus</language>
+                <binding>70x90/32</binding>
+                <page_extent>288</page_extent>
+                <description>Все прекрасно в большом патриархальном семействе Руденко. Но — увы! — впечатление это обманчиво: каждого из многочисленных представителей семьи обуревают свои потаенные страсти и запретные желания.</description>
+                <downloadable>false</downloadable>
+            </offer>
+        </offers>
+
+    </shop>
+</yml_catalog>

data/spec/goods/catalog_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Goods::Catalog do
+  describe "#initialize" do
+    it "should call #from_string when string is passed" do
+      expect_any_instance_of(Goods::Catalog).to receive(:from_string).
+        with("string", "url", "UTF-8").once
+      Goods::Catalog.new(string: "string", url: "url", encoding: "UTF-8")
+    end
+
+    it "should raise error when none of 'string', 'url', 'file' params is passed" do
+      expect{ Goods::Catalog.new({}) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#from_string" do
+    class NullObject
+      def method_missing(name, *args)
+        self
+      end
+    end
+
+    [Goods::XML, Goods::CategoriesList, Goods::CurrenciesList, Goods::OffersList].each do |part|
+    it "should create #{part}" do
+        expect(part).to receive(:new).and_return(NullObject.new).once
+        Goods::Catalog.new(string: "xml")
+      end
+    end
+  end
+
+  describe "#prune" do
+    let(:xml) {
+      File.read(File.expand_path("../../fixtures/simple_catalog.xml", __FILE__))
+    }
+    let(:catalog) { Goods::Catalog.new string: xml}
+
+    it "should prune offers and categories" do
+      level = 2
+      expect(catalog.offers).to receive(:prune_categories).with(level)
+      expect(catalog.categories).to receive(:prune).with(level)
+      catalog.prune(level)
+    end
+
+    it "should replace categories of offers" do
+      catalog.prune(0)
+      expect(catalog.offers.find("123").category).to be(
+        catalog.categories.find("1")
+      )
+    end
+
+    it "should remove categories affected by prunning" do
+      catalog.prune(0)
+      expect(catalog.categories.size).to eql(3)
+    end
+  end
+end

data/spec/goods/categories_list_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe Goods::CategoriesList do
+  it_should_behave_like "a container", Goods::Category, Goods::Category.new(id: "1", name: "Name")
+
+  describe "#add" do
+    it "should setup parent for category" do
+      parent = Goods::Category.new(id: "1", name: "Parent")
+      child = Goods::Category.new(id: "2", name: "Child", parent_id: "1")
+      subject.add(parent); subject.add(child)
+
+      expect(child.parent).to be(parent)
+    end
+  end
+
+  describe "#prune" do
+    let(:list) do
+      list = Goods::CategoriesList.new [
+        {id: "1", name: "root"},
+        {id: "11", name: "root", parent_id: "1"},
+        {id: "12", name: "root", parent_id: "2"}
+      ]
+      list
+    end
+
+    it "should raise error if prune level < 0" do
+      expect{ list.prune(-1) }.to raise_error(ArgumentError)
+    end
+
+    it "should not make any changes to nodes with level lesser than target level" do
+      orig = list.dup
+      list.prune(3)
+      expect(list.size).to eq(orig.size)
+    end
+
+    it "should remove nodes with level greater than target level" do
+      list.prune(1)
+      expect(list.size).to eq(2)
+      list.each { |item| expect(item.level < 2).to eql(true) }
+    end
+  end
+end

data/spec/goods/category_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+describe Goods::Category do
+  let(:valid_description) { {id: "1", name: "Name"} }
+  let(:root) { Goods::Category.new valid_description }
+
+  it_should_behave_like "containable" do
+    let(:element) { Goods::Category.new(valid_description) }
+  end
+
+  describe "#valid?" do
+    it "should reject categories with no root when one should be" do
+      invalid_child = Goods::Category.new(id: "3", name: "Invalid child", parent_id: "2")
+      expect(invalid_child).not_to be_valid
+    end
+
+    it "should reject categories with incorrect parrent" do
+      invalid_child = Goods::Category.new(id: "3", name: "Invalid child", parent_id: "2")
+      invalid_child.parent = root
+      expect(invalid_child).not_to be_valid
+    end
+
+    it "should accept categories with no root" do
+      child = Goods::Category.new(valid_description)
+      child.valid?
+      expect(child).to be_valid
+    end
+
+    it "should accept categories with correct root" do
+      valid_child = Goods::Category.new(id: "3", name: "Invalid child", parent_id: "1")
+      valid_child.parent = root
+      expect(valid_child).to be_valid
+    end
+  end
+
+  context "on graph properties" do
+    let(:first_level) do
+      c = Goods::Category.new valid_description.merge parent_id: root.id
+      c.parent = root
+      c
+    end
+    let(:second_level) do
+      c = Goods::Category.new valid_description.merge parent_id: first_level.id
+      c.parent = first_level
+      c
+    end
+
+    describe "#level" do
+      it "should be 0 for root nodes" do
+        expect(root.level).to eq(0)
+      end
+
+      it "should be parent level + for for child nodes" do
+        expect(first_level.level).to eq(root.level + 1)
+      end
+    end
+
+    describe "#root" do
+      it "should be root itself if called on root" do
+        expect(root.root).to be(root)
+      end
+
+      it "should be root of a branch if called on child" do
+        expect(second_level.root).to be(root)
+      end
+    end
+
+    describe "#parent_at_level" do
+
+      it "should raise error if level < 0" do
+        expect { root.parent_at_level(-1) }.to raise_error(ArgumentError)
+      end
+
+      it "should return self if called for object's level" do
+        expect(first_level.parent_at_level(first_level.level)).to be(first_level)
+      end
+
+      it "should raise error if level > object level" do
+        expect { first_level.parent_at_level first_level.level + 1 }.
+          to raise_error(ArgumentError)
+      end
+
+      it "should return parent at specified level from the 'root'" do
+        expect(second_level.parent_at_level(1)).to be(first_level)
+        expect(second_level.parent_at_level(0)).to be(root)
+      end
+    end
+  end
+
+end

data/spec/goods/currencies_list_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Goods::CurrenciesList do
+  it_should_behave_like "a container", Goods::Currency, Goods::Currency.new(id: "1", name: "RUR", rate: 1, plus: 0)
+end

data/spec/goods/currency_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Goods::Currency do
+  let(:valid_description) { {id: "VAL_CUR", rate: 1, plus: 0} }
+  let(:valid_currency) { Goods::Currency.new(valid_description) }
+
+  it_should_behave_like "containable" do
+    let(:element) { valid_currency }
+  end
+
+  describe "#valid?" do
+    let(:invalid_description) { {id: "", rate: 0, plus: -1} }
+
+    it "should return true for valid currency" do
+      expect(Goods::Currency.new(valid_description).valid?).to be true
+    end
+
+    it "should return false for invalid currency" do
+      expect(Goods::Currency.new(invalid_description).valid?).to be false
+    end
+
+    it "should remember invalid fields" do
+      invalid_currency = Goods::Currency.new(invalid_description)
+      invalid_currency.valid?
+      [:id, :rate, :plus].each do |field|
+        expect(invalid_currency.invalid_fields).to include(field)
+      end
+    end
+  end
+
+  describe "#in" do
+    let(:rur) { Goods::Currency.new(id: "RUR", rate: 1, plus: 0) }
+    let(:usd) { Goods::Currency.new(id: "USD", rate: 30, plus: 0) }
+
+    it "should convert to another currency" do
+      expect(usd.in(rur)).to eql(30.0)
+    end
+  end
+end