elibri_onix 0.2.3 → 0.2.4

data/lib/elibri_onix/onix_3_0/product.rb

@@ -2,26 +2,24 @@
 module Elibri
   module ONIX
     module Release_3_0
-
+      #Klasa reprezentująca produkt
+      #Niektóre pola mogą pozostać bez wartości - zależy to od formy produktu
       class Product
         
-        #class representing one Product from eLibri.
-        #important thing - record reference is unique eLibri identifier
-      
-      
+        #:nodoc:
         ATTRIBUTES =
         [
           :elibri_dialect, :height, :width, :thickness, :weight, :ean, :isbn13, :number_of_pages, :duration, 
           :file_size, :publisher_name, :publisher_id, :imprint_name, :current_state, :reading_age_from, :reading_age_to, 
           :table_of_contents, :description, :reviews, :excerpts, :series, :title, :subtitle, :collection_title,
           :collection_part, :full_title, :original_title, :trade_title, :parsed_publishing_date, :record_reference,
-          :deletion_text, :cover_type, :cover_price, :vat, :pkwiu, :product_composition, :product_form, :imprint,
+          :deletion_text, :cover_type, :cover_price, :vat, :pkwiu, :product_composition, 
           :publisher, :product_form, :no_contributor, :edition_statement, :number_of_illustrations, :publishing_status,
           :publishing_date, :premiere, :front_cover, :series_names, :city_of_publication,
           :elibri_product_category1_id, :elibri_product_category2_id, :preview_exists, :short_description, :sale_restricted_to_poland
         ]
         
-        
+        #:nodoc:
         RELATIONS =
         [
           :contributors, #IMPORTANT
@@ -34,24 +32,166 @@ module Elibri
           :cover_designers, :inked_or_colored_bys, :editors, :revisors, :translators, :editor_in_chiefs, :read_bys
         ]
 
-        attr_accessor :elibri_dialect, :height, :width, :thickness, :weight, :ean, :isbn13, :number_of_pages, :duration, 
-                      :file_size, :publisher_name, :publisher_id, :imprint_name, :current_state, :reading_age_from, :reading_age_to, 
-                      :table_of_contents, :description, :reviews, :excerpts, :series, :title, :subtitle, :collection_title,
-                      :collection_part, :full_title, :original_title, :trade_title, :short_description,
-                      :elibri_product_category1_id, :elibri_product_category2_id, :preview_exists, :unlimited_licence,
-                      :licence_limited_to_before_type_cast, :licence_limited_to, :digital_formats, :technical_protection
+        #:doc:
+        #wysokość w milimetrach
+        attr_reader :height
+
+        #szerokość w milimetrach
+        attr_reader :width
+
+        #gruboś w milimetrach
+        attr_reader :thickness
+
+        #waga w gramach
+        attr_reader :weight
+
+        #ean, jeśli jest inny, niż isbn13
+        attr_reader :ean
+  
+        #isbn13 - bez kresek
+        attr_reader :isbn13
+
+        #ilość stron w książce drukowanej
+        attr_reader :number_of_pages
+
+        #czas trwania nagrania w audiobooku, w minutach
+        attr_reader :duration
+
+        #nazwa wydawnictwa
+        attr_reader :publisher_name
+
+        #ID wydawnictwa w systemie elibri
+        attr_reader :publisher_id
+
+        #Imprint, jeśli wydawnictwo używa imprintów. Jeżeli wydawnictwo podało imprint, to ta wartość powinna zostać wyświetlona
+        #użytkownikowi w sklepie jako nazwa wydawnictwa.
+        attr_reader :imprint_name
+
+        #Status produktu - jedna z wartości: announced, :preorder, :published, :out_of_print
+        attr_reader :current_state
+
+        #Wiek czytelnika - od
+        attr_reader :reading_age_from
+
+        #Wiek czytelnika - do
+        attr_reader :reading_age_to
+
+        #Spis treści - jeśli wydawca takowy umieścił
+        attr_reader :table_of_contents
+
+        #Opis produktu
+        attr_reader :description
+
+        #lista serii, w postaci [nazwa serii, numer w serii]
+        attr_reader :series
+
+        #tytuł ksiażki
+        attr_reader :title
+
+        #podtytuł
+        attr_reader :subtitle
+
+        #nazwa cyklu (częste przy komiksach, gdy seria jest częścią tytułu, np. Thorgal)
+        attr_reader :collection_title
+
+        #numer w cyklu
+        attr_reader :collection_part
+
+        #pełen tytuł
+        attr_reader :full_title
+
+        #tytuł oryginału
+        attr_reader :original_title
+
+        #krótki opis, jeśli wydawca takowy zamieści
+        attr_reader :short_description
+
+        #id kategorii elibri (1)
+        attr_reader :elibri_product_category1_id
+
+        #id kategorii elibri (2)
+        attr_reader :elibri_product_category2_id
+
+        #data końca licencji, jeśli licencja nie jest bezterminowa, w formacie YYYYMMDD
+        attr_reader :licence_limited_to_before_type_cast
+
+        #data końca licencji, jeśli licencja nie jest bezterminowa, instancja Date
+        attr_reader :licence_limited_to
+
+        #lista formatów, w jakich jest dostępny ebook (PDF, MOBI, EPUB)
+        attr_reader :digital_formats
+
+        #sposób zabezpieczania pliki (DRM, WATERMARK) - pliki dostępne w API transakcyjnym zawsze będą chronione watermarkiem
+        attr_reader :technical_protection
           
-                      #from xml_accessor
-        attr_accessor :record_reference, :notification_type, :deletion_text
-        
-                      # Load attributes specific for dialect 3.0.1
-        attr_accessor :cover_type_from_3_0_1, :cover_price_from_3_0_1, :vat_from_3_0_1, :pkwiu_from_3_0_1, :preview_exists_from_3_0_1,
-                      :product_composition, :product_form, :measures, :title_details, :collections, :contributors, :no_contributor,
-                      :languages, :extents, :subjects, :audience_ranges, :edition_statement, :number_of_illustrations, :text_contents,
-                      :supporting_resources, :imprint, :publisher, :publishing_status, :publishing_date, :sales_restrictions,
-                      :identifiers, :related_products, :supply_details, :to_xml, :city_of_publication, :sale_restricted_to_poland
+        #record reference - wewnętrzny identyfikator rekordu, niezmienny i unikatowy
+        attr_reader :record_reference
+
+        #typ okładki, np. 'miękka ze skrzydełkami'
+        attr_reader :cover_type
+  
+        #sugerowana cena detaliczna brutto produktu
+        attr_reader :cover_price
+
+        #stawka VAT
+        attr_reader :vat
+
+        #PKWiU
+        attr_reader :pkwiu
 
+        #kod ONIX typu produktu, np. 'BA' - lista dostępna pod adresem 
+        #https://github.com/elibri/elibri_onix_dict/blob/master/lib/elibri_onix_dict/onix_3_0/serialized/ProductFormCode.yml
+        attr_reader :product_form
 
+        #lista autorów, tłumaczy i innych, którzy mieli wkład w książkę, lista instancji Contributor
+        attr_reader :contributors
+        
+        #lista języków, lista intancji Language
+        attr_reader :languages
+
+        #informacja o numerze wydania
+        attr_reader :edition_statement
+
+        #liczba ilustracji
+        attr_reader :number_of_illustrations
+
+        #reprezentacja xml dla produktu
+        attr_reader :to_xml
+
+        #miasto, w którym została wydana ksiażka
+        attr_reader :city_of_publication
+
+        #:nodoc:
+        attr_reader :text_contents
+        attr_reader :file_size
+        attr_reader :elibri_dialect
+        attr_reader :reviews
+        attr_reader :excerpts
+        attr_reader :trade_title
+        attr_reader :notification_type
+        attr_reader :deletion_text
+        attr_reader :product_composition
+        attr_reader :measures
+        attr_reader :imprint
+        attr_reader :publisher
+        attr_reader :publishing_status
+        attr_reader :title_details
+        attr_reader :collections
+        attr_reader :extents
+        attr_reader :subjects
+        attr_reader :audience_ranges
+        attr_reader :supply_details
+        attr_reader :identifiers
+        attr_reader :no_contributor
+        attr_reader :supporting_resources
+        attr_reader :sales_restrictions
+        attr_reader :publishing_date
+        attr_reader :related_products
+
+        #:nodoc:
+        attr_accessor :sale_restricted_to_poland, :unlimited_licence, :no_contributor, :preview_exists
+
+        #:doc:
         def initialize(data)
           @to_xml = data.to_s
           #initialize variables that need to be array
@@ -76,11 +216,11 @@ module Elibri
           @record_reference = data.at_xpath('xmlns:RecordReference').try(:text)
           @notification_type = data.at_xpath('xmlns:NotificationType').try(:text)
           @deletion_text = data.at_xpath('xmlns:DeletionText').try(:text)
-          @cover_type_from_3_0_1 = data.at_xpath('elibri:CoverType').try(:text)
-          @cover_price_from_3_0_1 = BigDecimal.new(data.at_xpath('elibri:CoverPrice').try(:text)) if data.at_xpath('elibri:CoverPrice')
-          @vat_from_3_0_1 = data.at_xpath('elibri:Vat').try(:text).try(:to_i)
-          @pkwiu_from_3_0_1 = data.at_xpath('elibri:PKWiU').try(:text)
-          @preview_exists_from_3_0_1 = data.at_xpath('elibri:preview_exists').try(:text)
+          @cover_type = data.at_xpath('elibri:CoverType').try(:text)
+          @cover_price = BigDecimal.new(data.at_xpath('elibri:CoverPrice').try(:text)) if data.at_xpath('elibri:CoverPrice')
+          @vat = data.at_xpath('elibri:Vat').try(:text).try(:to_i)
+          @pkwiu = data.at_xpath('elibri:PKWiU').try(:text)
+          @preview_exists = (data.at_xpath('elibri:preview_exists').try(:text) == "true")
           @identifiers = data.xpath('xmlns:ProductIdentifier').map { |ident_data| ProductIdentifier.new(ident_data) }
           begin
             @related_products = data.at_xpath('xmlns:RelatedMaterial').xpath('xmlns:RelatedProduct').map { |related_data| RelatedProduct.new(related_data) }
@@ -116,7 +256,7 @@ module Elibri
           @title_details = data.xpath('xmlns:TitleDetail').map { |title_data| TitleDetail.new(title_data) }
           @collections = data.xpath('xmlns:Collection').map { |collection_data| Collection.new(collection_data) }
           @contributors = data.xpath('xmlns:Contributor').map { |contributor_data| Contributor.new(contributor_data) }
-          @no_contributor = data.at_xpath('xmlns:NoContributor').try(:text)
+          @no_contributor = !!data.at_xpath('xmlns:NoContributor')
           @languages = data.xpath('xmlns:Language').map { |language_data| Language.new(language_data) }
           @extents = data.xpath('xmlns:Extent').map { |extent_data| Extent.new(extent_data) }
           @subjects = data.xpath('xmlns:Subject').map { |subject_data| Subject.new(subject_data) }
@@ -159,32 +299,35 @@ module Elibri
 
         end
 
-        # Attributes in namespace elibri:* are specific for dialect >= 3.0.1.
-        # If dialect is less than 3.0.1, returns nil.
-        %w{cover_type cover_price vat pkwiu}.each do |method_name|
-          module_eval(<<-EVAL_END, __FILE__, __LINE__ + 1)
-            def #{method_name}                                      # def vat
-              if @elibri_dialect.to_s >= '3.0.1'                    #   if @elibri_dialect.to_s >= '3.0.1'
-                #{method_name}_from_3_0_1                           #     vat_from_3_0_1
-              else                                                  #   else
-                nil                                                 #     nil
-              end                                                   #   end
-            end                                                     # end
-          EVAL_END
-        end  
-
         def sales_restrictions?
           @sales_restrictions.size > 0
         end
 
+        #flaga, czy sprzedaż książki jest ograniczona do Polski
+        def sale_restricted_to_poland?
+          @sale_restricted_to_poland
+        end
+ 
+        #flaga informująca, czy licencja jest bezterminowa
+        def unlimited_licence?
+          @unlimited_licence
+        end
+
+        #flaga - true, jeśli produkt nie ma żadnego autora
         def no_contributor?
-          @no_contributor == ""
+          @no_contributor 
         end
 
+        #flaga, czy książka to praca zbiorowa?
         def unnamed_persons?
           @contributors.size == 1 && contributors[0].unnamed_persons.present?
         end
 
+        #flaga, czy istnieje podgląd produktu
+         def preview_exists?
+           @preview_exists
+         end
+
         def authors
           unnamed_persons? ? ["praca zbiorowa"] : @contributors.find_all { |c| c.role_name == "author" }.map(&:person_name)
         end
@@ -202,27 +345,36 @@ module Elibri
           end
         end
 
+        #czy istnieje podgląd?
         def preview_exists?
           @preview_exists
         end
 
+        #okładka ksiązki, instance SupportingResource
         def front_cover
           @supporting_resources.find { |resource| resource.content_type_name == "front_cover" }
         end
 
+        #lista nazwa serii, do których należy produkt
         def series_names
           @series.map { |series| series[0] }
         end
 
+        #data premiery, jako instancja Date (tylko wtedy, gdy dokładna data jest znana)
         def premiere
           Date.new(*parsed_publishing_date) if parsed_publishing_date.size == 3
         end
+
+        def related_products_record_references
+          related_products.map(&:record_reference)
+        end
  
+        #:nodoc:
         def proprietary_identifiers 
           @identifiers.find_all { |i| i.identifier_type == "proprietary" }.inject({}) { |res, ident| res[ident.type_name] = ident.value; res }
         end
 
-        #I don't want to see roxml_references in output - it's faar to big output
+        #:nodoc:
         def pretty_print_instance_variables
           (instance_variables - ["@roxml_references", "@measures", "@identifiers", "@notification_type", "@publishing_status",
                                  "@elibri_dialect", "@product_composition", "@extents", "@publisher", "@imprint",
@@ -231,7 +383,7 @@ module Elibri
           }.sort
         end
 
-
+        #:nodoc:
         def pretty_print(pp)
           pp.object_address_group(self) {
             pp.seplist(self.pretty_print_instance_variables, lambda { pp.text ',' }) {|v|
@@ -246,7 +398,9 @@ module Elibri
             }
           }
         end
-
+        
+        #data premiery w postaci listy [rok, miesiąc, dzień], [rok, miesiąc], [rok], lub pustej listy - jeśli data premiery nie jest znana
+        #(data premiery może nie być znana w przypadku backlisty)
         def parsed_publishing_date
           if sales_restrictions?
             date = sales_restrictions[0].end_date
@@ -259,7 +413,7 @@ module Elibri
         end
 
 
-private
+    private
 
         def find_title(code)
           @title_details.find {|title_detail| title_detail.type == code}
@@ -279,8 +433,8 @@ private
           @publisher_id = @publisher.eid if publisher
           @imprint_name = @imprint.name if imprint
           @isbn13 = @identifiers.find { |identifier| identifier.identifier_type == "isbn13" }.try(:value)
-          @reading_age_from = @audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "03")}.try(:value)
-          @reading_age_to = @audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "04")}.try(:value)
+          @reading_age_from = @audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "03")}.try(:value).try(:to_i)
+          @reading_age_to = @audience_ranges.find {|ar| (ar.qualifier == "18") && (ar.precision == "04")}.try(:value).try(:to_i)
           @table_of_contents = @text_contents.find { |t| t.type_name == "table_of_contents" }
           @description = @text_contents.find { |t| t.type_name == "main_description" }
           @short_description = @text_contents.find { |t| t.type_name == "short_description" }
@@ -300,7 +454,6 @@ private
   
           @elibri_product_category1_id = subjects[0].code if subjects[0]
           @elibri_product_category2_id = subjects[1].code if subjects[1]
-          @preview_exists = (preview_exists_from_3_0_1 == "true")
 
           compute_state!
         end

data/lib/elibri_onix/onix_3_0/product_identifier.rb

@@ -3,21 +3,29 @@ module Elibri
   module ONIX
     module Release_3_0
 
+      #product identifier, for example isbn
       class ProductIdentifier
         
-        #from ONIX documentation:
-        #A repeatable group of data elements which together define an identifier of a product in accordance with a specified scheme.
-        #As well as standard identifiers, the composite allows proprietary identifiers (SKUs) assigned by wholesalers or
-        #vendors to be sent as part of the ONIX record.
-        
         include HashId
 
-        attr_accessor :type, :type_name, :value, :to_xml
+        #onix code of type (see elibri_onix_dict, Elibri::ONIX::Dict::Release_3_0::ProductIDType)
+        attr_accessor :type
+
+        #if type is prioprietery (01) - then the name of type
+        attr_accessor :type_name
+  
+        #identifier value
+        attr_accessor :value
+
+        #xml representation of identifier
+        attr_accessor :to_xml
         
+        #:nodoc:
         ATTRIBUTES = [
           :type, :type_name, :value, :identifier_type
         ]
         
+        #:nodoc:
         RELATIONS = [
           :inspect_include_fields
         ]
@@ -29,10 +37,12 @@ module Elibri
           @value = data.at_xpath('xmlns:IDValue').try(:text)
         end
 
+        #returs the string name of value type
         def identifier_type
           Elibri::ONIX::Dict::Release_3_0::ProductIDType.find_by_onix_code(@type).const_name.downcase
         end
 
+        #:nodoc:
         def inspect_include_fields
           [:identifier_type]
         end

data/lib/elibri_onix/onix_3_0/related_product.rb

@@ -1,7 +1,5 @@
 
 
-
-
 module Elibri
   module ONIX
     module Release_3_0
@@ -12,16 +10,20 @@ module Elibri
         #An optional and repeatable group of data elements which together describe a product which has a specified relationship
         #to the product described in the ONIX record.
         include HashId        
-        
+ 
+        #:nodoc:       
         ATTRIBUTES = [
           :relation_code, :proprietary_identifiers, :record_reference
         ]
         
+        #:nodoc:
         RELATIONS = [
           :identifiers
         ]
         
-        attr_accessor :relation_code, :identifiers, :to_xml
+        attr_reader :relation_code
+        attr_reader :identifiers
+        attr_reader :to_xml
         
         def initialize(data)
           @to_xml = data.to_s

data/lib/elibri_onix/onix_3_0/sender.rb

@@ -2,19 +2,28 @@
 module Elibri
   module ONIX
     module Release_3_0
-
+ 
+      #Sender of the message
       class Sender
         
-        #from ONIX documentation
-        #A group of data elements which together specify the sender of an ONIX for Books message.
-        #Mandatory in any ONIX for Books message, and non-repeating.
-        
-        attr_accessor :sender_name, :contact_name, :email_address, :to_xml
+        #name of company, which sent the message
+        attr_accessor :sender_name
+
+        #contact person 
+        attr_accessor :contact_name
+
+        #contact email
+        attr_accessor :email_address
+
+        #xml representation of sender
+        attr_accessor :to_xml
         
+        #:nodoc:
         ATTRIBUTES = [
           :sender_name, :contact_name, :email_address
         ]
         
+        #:nodoc:
         RELATIONS = []
         
         def initialize(data)

data/lib/elibri_onix/version.rb

@@ -2,7 +2,7 @@ module Elibri
   module ONIX
     z = $VERBOSE
     $VERBOSE = nil
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
     Version = VERSION
     $VERBOSE = z
   end

data/test/elibri_licence_information_test.rb

@@ -6,10 +6,10 @@ describe Elibri::ONIX::Release_3_0::ONIXMessage do
   it "should be able to parse licence end info" do
 
     product = load_fixture("onix_unlimited_book_sample_example.xml") 
-    assert product.unlimited_licence
+    assert product.unlimited_licence?
 
     product = load_fixture("onix_epub_details_example.xml")
-    assert !product.unlimited_licence
+    assert !product.unlimited_licence?
     assert_equal "20140307", product.licence_limited_to_before_type_cast
     assert_equal Date.new(2014, 3, 7), product.licence_limited_to
   end

data/test/elibri_onix_release_3_0_onix_message_test.rb

@@ -167,20 +167,4 @@ describe Elibri::ONIX::Release_3_0::ONIXMessage do
     end
   end
 
-
-  it "should consider elibri_dialect attribute and ignore attributes unrecognized in specified dialect" do
-    xml_string = File.read File.join(File.dirname(__FILE__), "..", "test", "fixtures", "old_dialect.xml")
-    
-    onix = Elibri::ONIX::Release_3_0::ONIXMessage.new(xml_string)
-    assert_equal '3.0', onix.release
-    assert_equal '3.0.0', onix.elibri_dialect
-
-    product = onix.products.first
-    assert_equal '3.0.0', product.elibri_dialect
-    assert_nil product.cover_type 
-    assert_nil product.cover_price
-    assert_nil product.vat
-    assert_nil product.pkwiu
-  end
-
 end

data/test/elibri_related_products_test.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+describe Elibri::ONIX::Release_3_0::ONIXMessage do
+
+  it "should be able to parse related products info" do
+    product = load_fixture("onix_related_products_example.xml")
+    assert_equal ["c486ef9c55659d3e123b"], product.related_products_record_references
+  end
+
+end

data/test/elibri_territorial_rights_test.rb

@@ -6,9 +6,9 @@ describe Elibri::ONIX::Release_3_0::ONIXMessage do
   it "should be able to parse territorial rights info" do
 
     product1 = load_fixture("onix_territorial_rights_example.xml", 0)
-    assert product1.sale_restricted_to_poland
+    assert product1.sale_restricted_to_poland?
 
     product2 = load_fixture("onix_territorial_rights_example.xml", 1)
-    assert !product2.sale_restricted_to_poland
+    assert !product2.sale_restricted_to_poland?
   end
 end

data/test/fixtures/onix_related_products_example.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ONIXMessage xmlns="http://ns.editeur.org/onix/3.0/reference" xmlns:elibri="http://elibri.com.pl/ns/extensions" release="3.0">
+  <elibri:Dialect>3.0.1</elibri:Dialect>
+  <Header>
+    <Sender>
+      <SenderName>Elibri.com.pl</SenderName>
+      <ContactName>Tomasz Meka</ContactName>
+      <EmailAddress>kontakt@elibri.com.pl</EmailAddress>
+    </Sender>
+    <SentDateTime>20130124</SentDateTime>
+  </Header>
+  <Product>
+    <RecordReference>fdb8fa072be774d97a97</RecordReference>
+    <NotificationType>03</NotificationType>
+    <ProductIdentifier>
+      <ProductIDType>15</ProductIDType>
+      <IDValue>9788324799992</IDValue>
+    </ProductIdentifier>
+    <DescriptiveDetail>
+      <ProductComposition>00</ProductComposition>
+      <ProductForm>BA</ProductForm>
+      <TitleDetail>
+        <TitleType>01</TitleType>
+        <TitleElement>
+          <TitleElementLevel>01</TitleElementLevel>
+          <TitleText>Nielegalni</TitleText>
+        </TitleElement>
+      </TitleDetail>
+    </DescriptiveDetail>
+    <PublishingDetail>
+      <Publisher>
+        <PublishingRole>01</PublishingRole>
+        <PublisherIdentifier>
+          <PublisherIDType>01</PublisherIDType>
+          <IDTypeName>ElibriPublisherCode</IDTypeName>
+          <IDValue>11</IDValue>
+        </PublisherIdentifier>
+        <PublisherName>GREG</PublisherName>
+      </Publisher>
+      <CityOfPublication>Warszawa</CityOfPublication>
+      <PublishingStatus>04</PublishingStatus>
+      <SalesRights>
+        <SalesRightsType>01</SalesRightsType>
+        <Territory>
+          <RegionsIncluded>WORLD</RegionsIncluded>
+        </Territory>
+      </SalesRights>
+    </PublishingDetail>
+    <RelatedMaterial>
+      <RelatedProduct>
+        <ProductRelationCode>24</ProductRelationCode>
+        <ProductIdentifier>
+          <ProductIDType>01</ProductIDType>
+          <IDTypeName>elibri</IDTypeName>
+          <IDValue>c486ef9c55659d3e123b</IDValue>
+        </ProductIdentifier>
+      </RelatedProduct>
+    </RelatedMaterial>
+    <elibri:preview_exists>false</elibri:preview_exists>
+  </Product>
+</ONIXMessage>