elibri_onix 0.2.3 → 0.2.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elibri_onix (0.2.2)
+    elibri_onix (0.2.3)
       activesupport (>= 2.3.5)
       elibri_onix_dict (>= 0.0.5)
       i18n
@@ -16,6 +16,8 @@ GEM
     coderay (1.0.6)
     elibri_onix_dict (0.0.22)
     i18n (0.6.1)
+    json (1.7.6)
+    json (1.7.6-java)
     metaclass (0.0.1)
     method_source (0.7.1)
     minitest (3.0.1)
@@ -23,6 +25,7 @@ GEM
       metaclass (~> 0.0.1)
     multi_json (1.5.0)
     nokogiri (1.5.6)
+    nokogiri (1.5.6-java)
     pry (0.9.9.6)
       coderay (~> 1.0.5)
       method_source (~> 0.7.1)
@@ -33,6 +36,8 @@ GEM
       slop (>= 2.4.4, < 3)
       spoon (~> 0.0)
     rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
     slop (2.4.4)
     spoon (0.0.1)
 
@@ -47,3 +52,4 @@ DEPENDENCIES
   mocha
   pry
   rake
+  rdoc

data/README.rdoc

@@ -17,53 +17,7 @@ Elibri::ONIX::Release_3_0::ONIXMessage.new(xml_data)
 
 xml_data should be string containing ONIX xml you want to parse.
 
-Creating a new ONIXMessage object will also create embedded objects inside - representing structure of xml file.
-ONIXMessage -> many Product(s)
-  Product -> many ProductIdentifier(s)
-  Product -> many RelatedProduct(s)
-    RelatedProduct -> many ProductIdentifier(s)
-  Product -> many SupplyDetail(s)
-    SupplyDetail -> one Supplier
-    SupplyDetail -> one Price
-    SupplyDetail -> one StockQuantityCoded
-  Product -> many Measure(s)
-  Product -> many TitleDetail(s)
-    TitleDetail -> many TitleElement(s)
-  Product -> many Collection(s)
-    Collection -> many TitleElement(s)
-    Collection -> one TitleDetail
-  Product -> many Contributor(s)
-  Product -> many Language(s)
-  Product -> many Extent(s)
-  Product -> many Subject(s)
-  Product -> many AudienceRange(s)
-  Product -> many TextContent(s)
-  Product -> many SupportingResource(s)
-  Product -> one Imprint
-  Product -> one Publisher
-  Product -> one PublishingDate
-  Product -> many SalesRestriction(s)
-ONIXMessage -> one Header
-  Header -> one Sender
-
-
-However if you have only fragment of xml that you want to parse - for example Contributor, you may parse only this fragment invoking constructor of appropriate class, providing xml as an argument, for example:
-
-Elibri::ONIX::Release_3_0::Contributor.new(xml_data)
-
-Each object provide method to_xml which will return xml used to construct it.
-
-Object contains attributes, which are represented by instance variables. You can see list of attributes in FIELDS file.
-
-== Contributing to elibri_onix
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+See also description of Product
 
 == Copyright
 

data/Rakefile

@@ -24,10 +24,11 @@ task :default => :test
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = Elibri::ONIX::VERSION
-
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = 'doc'
   rdoc.title = "elibri_onix #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('FIELDS*')
+  rdoc.options << "--hyperlink-all"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('FIELDS.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/elibri_onix.gemspec

@@ -33,7 +33,8 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "minitest", ">= 0"
   gem.add_development_dependency "bundler", ">= 1.0.0"
   gem.add_development_dependency "rake"
-#  gem.add_development_dependency "ruby-debug"
+  gem.add_development_dependency "rdoc"
+  #gem.add_development_dependency "ruby-debug"
   #gem.add_development_dependency "rcov", ">= 0"
   
 end

data/lib/elibri_onix/onix_3_0/contributor.rb

@@ -16,20 +16,59 @@ module Elibri
         #or by the name given on the title page and by an authority-controlled name.
         #In addition, more than one representation of the same name may be sent.
         
+        #:nodoc:
         ATTRIBUTES = 
         [
           :number, :role, :person_name, :from_language, :titles_before_names, :names_before_key, :prefix_to_key,
           :key_names, :names_after_key, :biographical_note, :unnamed_persons, :role_name
         ]
         
+        #:nodoc:
         RELATIONS =
         [
           :inspect_include_fields
         ]
         
-        attr_accessor :number, :role, :person_name, :from_language, :titles_before_names, :names_before_key, :prefix_to_key,
-          :key_names, :names_after_key, :biographical_note, :unnamed_persons, :to_xml
+        #:nodoc:
+        attr_reader :number
+
+        #:doc:
+        #kod ONIX dla roli - np. 'A01' - autor, pełna lista pod adresem 
+        #https://github.com/elibri/elibri_onix_dict/blob/master/lib/elibri_onix_dict/onix_3_0/serialized/ProductFormCode.yml
+        attr_reader :role
+
+        #pełne imię i nazwisko - to pole jest zawsze uzupełnione
+        attr_reader :person_name
+
+        #w przypadku tłumacza kod języka oryginału, lista języków dostępna pod adresem
+        #https://github.com/elibri/elibri_onix_dict/blob/master/lib/elibri_onix_dict/onix_3_0/serialized/LanguageCode.yml
+        attr_reader :from_language
+
+        #tytuł naukowy, np. prof.
+        attr_reader :titles_before_names
+
+        #imię lub imiona
+        attr_reader :names_before_key
+
+        #prefix przed nazwiskiem, np. von, van
+        attr_reader :prefix_to_key
+
+        #nazwisko lub nazwiska
+        attr_reader :key_names
+   
+        #dodatkowe oznaczenia, np. OHP (zakon)
+        attr_reader :names_after_key
+
+        #biografia
+        attr_reader :biographical_note
+
+        #:nodoc:
+        attr_reader :unnamed_persons
+ 
+        #reprezentacja danych w xml-u
+        attr_reader :to_xml
           
+
         def initialize(data)
           @to_xml = data.to_s
           @number = data.at_xpath('xmlns:SequenceNumber').try(:text).try(:to_i)

data/lib/elibri_onix/onix_3_0/header.rb

@@ -4,20 +4,24 @@ module Elibri
   module ONIX
     module Release_3_0
 
+      #Class representing ONIX header
       class Header
         
-        #from ONIX documentation:
-        #A group of data elements which together constitute a message header.
-        #Mandatory in any ONIX for Books message, and non-repeating.
-        #In ONIX 3.0, a number of redundant elements have been deleted, and the Sender and Addressee structures and
-        #the name and format of the <SentDateTime> element have been made consistent with other current ONIX formats.
-
-        attr_accessor :sent_date_time, :sender, :to_xml
-        
+        #date, at which message was sent
+        attr_accessor :sent_date_time
+   
+        #sender of the message - Elibri::ONIX::Release_3_0::Sender
+        attr_accessor :sender
+ 
+        #xml representation of message header
+        attr_accessor :to_xml
+ 
+        #:nodoc:       
         ATTRIBUTES = [
           :sent_date_time, :sender
         ]
         
+        #:nodoc:
         RELATIONS = []
         
         def initialize(data)

data/lib/elibri_onix/onix_3_0/language.rb

@@ -9,16 +9,28 @@ module Elibri
         #from ONIX documentation:
         #An optional and repeatable group of data elements which together represent a language, and specify its role and,
         #where required, whether it is a country variant.
-        
+ 
+        #:nodoc:       
         ATTRIBUTES = [
           :role, :code, :role_name, :language
         ]
         
+        #:nodoc:
         RELATIONS = [
           :inspect_include_fields
         ]
-        
-        attr_accessor :role, :code, :to_xml
+ 
+        #:doc:       
+        #kod onix roli, np. '01' 
+        #pełna lista ról: https://github.com/elibri/elibri_onix_dict/blob/master/lib/elibri_onix_dict/onix_3_0/serialized/LanguageRole.yml
+        attr_reader :role
+
+        #kod języka, np. 'pol'
+        #pełna lista kodów: https://github.com/elibri/elibri_onix_dict/blob/master/lib/elibri_onix_dict/onix_3_0/serialized/LanguageCode.yml
+        attr_reader :code
+
+        #reprezentacja w xml
+        attr_reader :to_xml
         
         def initialize(data)
           @to_xml = data.to_s
@@ -26,10 +38,12 @@ module Elibri
           @code = data.at_xpath('xmlns:LanguageCode').try(:text)
         end
 
+        #określenie roli jako string, np. language_of_text
         def role_name
           Elibri::ONIX::Dict::Release_3_0::LanguageRole.find_by_onix_code(@role).const_name.downcase
         end
    
+        #język, np. 'polski'
         def language
           Elibri::ONIX::Dict::Release_3_0::LanguageCode.find_by_onix_code(@code).name(:pl).downcase
         end

data/lib/elibri_onix/onix_3_0/measure.rb

@@ -1,16 +1,12 @@
 
-
 module Elibri
   module ONIX
     module Release_3_0
-
+      
+      #klasa abstahuje parsowanie wymiarów książki.
       class Measure
         
-                include HashId
-        
-        #from ONIX documentation:
-        #An optional and repeatable group of data elements which together identify a measurement and the units in which
-        #it is expressed; used to specify the overall dimensions of a physical product including its packaging (if any).
+        include HashId
         
         ATTRIBUTES = [
           :type, :measurement, :unit, :type_name

data/lib/elibri_onix/onix_3_0/onix_message.rb

@@ -3,17 +3,31 @@ module Elibri
   module ONIX
     module Release_3_0
 
-      class ONIXMessage        
-        attr_accessor :release, :elibri_dialect, :products, :header, :to_xml
-        
-        #class representing whole ONIX response from eLibri server
+      #class representing whole ONIX response from eLibri server
+      class ONIXMessage   
+        #list of all products returned in this mnessage
+        attr_accessor :products
+
+        #xml representation of this message
+        attr_accessor :to_xml
+
+        #ONIX version number 
+        attr_accessor :release
+
+        #:nodoc:
+        attr_accessor :elibri_dialect
+
+        #returned message header - Elibri::ONIX::Release_3_0::Header
+        attr_accessor :header
         
         include HashId
-        
+         
+        #:nodoc:
         ATTRIBUTES = [
           :release, :elibri_dialect, :header
         ]
         
+        #:nodoc:
         RELATIONS = [
           :products
         ]