openurl 0.0.1 → 0.1.0

data/lib/openurl/metadata_formats/journal.rb

@@ -0,0 +1,36 @@
+# 
+# journal.rb
+# 
+# Created on Nov 1, 2007, 10:35:28 AM
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+require 'openurl/metadata_formats/scholarly_common'
+module OpenURL
+  class Journal < ScholarlyCommon
+    
+    def initialize
+      super()
+      @format = 'journal'
+      @metadata_keys = ['jtitle','atitle','title','stitle','place','pub','date','edition',
+        'spage','epage', 'pages','issn','eissn', 'isbn','sici','coden','chron',
+        'ssn','quarter','volume','part','issue','artnum'
+        ]
+      @valid_genres = ["journal","issue","article", "conference","proceeding",
+        "preprint","unknown" ]
+      @xml_ns = "info:ofi/fmt:xml:xsd:journal"
+      @kev_ns = "info:ofi/fmt:kev:mtx:journal"
+    end      
+  end
+  
+  class JournalFactory < ContextObjectEntityFactory
+    @@identifiers = ["info:ofi/fmt:kev:mtx:journal","info:ofi/fmt:xml:xsd:journal"]
+    def self.identifiers
+      return @@identifiers
+    end
+    def self.create()
+      return OpenURL::Journal.new
+    end    
+  end
+end

data/lib/openurl/metadata_formats/marc.rb

@@ -0,0 +1,70 @@
+# 
+# marc.rb
+# 
+# Created on Nov 12, 2007, 10:35:28 AM
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+require 'rubygems'
+require 'marc'
+module OpenURL
+  class Marc < ContextObjectEntity
+    private :kev, :set_metadata
+    attr_accessor :marc
+    def initialize      
+      super    
+      @xml_ns = "info:ofi/fmt:xml:xsd:MARC21"
+      @format = @xml_ns
+      @marc = MARC::Record.new
+      @marc_ns = "http://www.loc.gov/MARC21/slim"
+      @metadata = @marc.fields
+    end    
+    
+    def serialize_metadata(elem, label)
+      metadata = elem.add_element("ctx:metadata")
+      if @marc.is_a?(Array)
+        container = metadata.add_elements("#{label}:collection")
+        container.add_namespace(label, @marc_ns)
+        @marc.each do | mrc |
+          rec = mrc.to_xml.root          
+          mrc_elem = container.add_element rec
+          mrc_elem.name = "#{label}:#{mrc_elem.name}"
+        end
+      else
+        rec = @marc.to_xml.root 
+        rec.add_namespace(label, @marc_ns)
+        rec.name = "#{label}:#{rec.name}"
+        mrc_elem = metadata.add_element rec                                
+      end      
+    end 
+    
+    def import_xml_metadata(node)         
+      marcxml = REXML::XPath.first(node,"./ctx:metadata-by-val/ctx:metadata/fmt:collection | ./ctx:metadata-by-val/ctx:metadata/fmt:record", 
+        {"ctx"=>"info:ofi/fmt:xml:xsd:ctx","fmt"=>@marc_ns})
+      if marcxml
+        marcxml.root.prefix = ''
+        records = []
+        MARC::XMLReader.new(StringIO.new(marcxml.to_s)).each do | record |
+          records << record
+        end
+        if records.length == 1
+          @marc = records[0]
+        else
+          @marc = records
+        end
+      end
+      @metadata = @marc.fields
+    end 
+     
+  end
+  
+  class MarcFactory < ContextObjectEntityFactory
+    @@identifiers = ["info:ofi/fmt:xml:xsd:MARC21"]
+    def self.identifiers
+      return @@identifiers
+    end
+    def self.create()
+      return OpenURL::Marc.new
+    end    
+  end
+end

data/lib/openurl/metadata_formats/patent.rb

@@ -0,0 +1,152 @@
+# 
+# patent.rb
+# 
+# Created on Nov 1, 2007, 10:35:28 AM
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+require 'openurl/metadata_formats/scholarly_common'
+module OpenURL
+  class Patent < ContextObjectEntity
+    attr_reader :inventors
+    def initialize      
+      super
+      @format = 'patent'
+      @inventors = [OpenURL::Inventor.new]
+      @metadata_keys = ['title','co','cc','kind','applcc','applnumber','number',
+        'date','applyear','appldate','assignee','pubdate','prioritydate'
+        ]
+      @inventor_keys = ['inv', 'invlast', 'invfirst']
+      @xml_ns = "info:ofi/fmt:xml:xsd:patent"
+      @kev_ns = "info:ofi/fmt:kev:mtx:patent"
+    end    
+    
+    def method_missing(metadata, value=nil)
+      meta = metadata.to_s.sub(/=$/,'')
+      raise ArgumentError, "#{meta.to_s} is not a valid #{self.class} metadata field." unless (@inventor_keys+@metadata_keys).index(meta)
+      if metadata.to_s.match(/=$/)
+        self.set_metadata(meta, value)
+        if @inventor_keys.index(meta)
+          @inventors[0].instance_variable_set("@#{meta}", value)
+        end
+      else
+        return self.metadata[meta]
+      end
+      
+    end
+    
+    def set_metadata(key, val)
+      @metadata[key] = val
+      if @inventor_keys.index(key)
+        @inventors[0].instance_variable_set("@#{key}", val)
+      end      
+    end    
+
+    def add_inventor(inventor)
+      raise ArgumentError, "Argument must be an OpenURL::Author!" unless inventor.is_a?(OpenURL::Inventor)
+      @inventors << inventor
+    end
+    
+    def remove_inventor(inventor)
+      idx = inventor
+      idx = @inventors.index(inventor)
+      raise ArgumentError unless idx
+      @authors.delete_at(idx)      
+    end    
+
+    def serialize_metadata(elem, label)
+      meta = {}
+      metadata = elem.add_element("ctx:metadata")
+      meta["format_container"] = metadata.add_element("#{label}:#{@format}")
+      meta["format_container"].add_namespace(label, @xml_ns)
+      meta["format_container"].add_attribute("xsi:schemaLocation", "#{@xml_ns} http://www.openurl.info/registry/docs/info:ofi/fmt:xml:xsd:#{@format}")          
+      @metadata.each do |k,v|
+        next if ['inv', 'invlast', 'invfirst'].index(k)
+        meta[k] = meta["format_container"].add_element("#{label}:#{k}")
+        meta[k].text = v
+      end            
+      meta["inventor_container"] = meta["format_container"].add_element("#{label}:inventors")
+      @inventors.each do | inventor |
+        inventor.xml(meta["inventor_container"])
+      end      
+    end 
+    def import_xml_metadata(node)         
+      mbv = REXML::XPath.first(node, "./ctx:metadata-by-val/ctx:metadata/fmt:#{@format}", {"fmt"=>@xml_ns})					              
+      if mbv
+        mbv.to_a.each do |m|
+          self.set_metadata(m.name(), m.get_text.value) if m.has_text?                                  
+          if m.has_elements?
+            m.to_a.each do | md |
+              self.set_metadata(md.name(), md.get_text.value) if md.has_text?                              
+            end
+          end
+        end
+        inv_num = 0
+        REXML::XPath.each(mbv, "fmt:inventors/fmt:inventor | fmt:inventor/fmt:inv", {"fmt"=>@xml_ns}) do | inventor |                    
+          empty_node = true
+          if inventor.name == "inventor"            
+            inventor.elements.each do | inv_elem |            
+              next unless @inventor_keys.index(inv_elem.name) and inv_elem.has_text?
+              empty_node = false
+              @inventors << OpenURL::Inventor.new unless @inventors[inv_num]
+              @inventors[inv_num].instance_variable_set("@#{inv_elem.name}".to_sym, inv_elem.get_text.value)
+              self.set_metadata(inv_elem.name, inv_elem.get_text.value) if inv_num == 0
+            end
+          elsif inventor.name.match(/^inv$/)
+            next unless inventor.has_text? 
+            empty_node = false
+            @inventors << OpenURL::Inventor.new unless @inventors[inv_num]
+            @inventors[inv_num]["inv"] = inventor.get_text.value
+            self.set_metadata("inv", inventor.get_text.value) if inv_num == 0            
+          end
+          inv_num += 1 unless empty_node
+        end        
+      end					
+    end 
+    
+    # Outputs the entity as a KEV array
+    
+    def kev(abbr)
+      kevs = []
+      
+      @metadata_keys.each do |key|
+        kevs << "#{abbr}.#{key}="+CGI.escape(@metadata[key]) if @metadata[key]                      
+      end
+      
+      kevs << "#{abbr}_val_fmt="+CGI.escape(@kev_ns)      
+      
+      if @inventors[0] and not @inventors[0].empty?
+        @inventor_keys.each do | ikey |
+          key = ikey
+          key = "inventor" if ikey == "inv"          
+          kevs << "#{abbr}.#{key}="+CGI.escape(@inventors[0].ikey) if @inventors[0].ikey          
+        end
+        
+      end
+      
+      if @reference["format"] 
+        kevs << "#{abbr}_ref_fmt="+CGI.escape(@reference["format"])
+        kevs << "#{abbr}_ref="+CGI.escape(@reference["location"])      
+      end
+      
+      @identifiers.each do |id| 
+          kevs << "#{abbr}_id="+CGI.escape(id)
+      end
+      
+      kevs << "#{abbr}_dat="+CGI.escape(@private_data) if @private_data
+                    
+      return kevs      
+    end    
+  end
+  
+  class PatentFactory < ContextObjectEntityFactory
+    @@identifiers = ["info:ofi/fmt:kev:mtx:patent","info:ofi/fmt:xml:xsd:patent"]
+    def self.identifiers
+      return @@identifiers
+    end
+    def self.create()
+      return OpenURL::Patent.new
+    end    
+  end
+end

data/lib/openurl/metadata_formats/scholarly_common.rb

@@ -0,0 +1,198 @@
+# 
+# scholarly_common.rb
+# 
+# Created on Nov 5, 2007, 3:24:35 PM
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+module OpenURL
+  class ScholarlyCommon < ContextObjectEntity
+    attr_reader :authors
+    def initialize
+      super()
+      @authors = [OpenURL::Author.new]
+      @author_keys = ['aulast','aufirst','auinit','auinit1','auinitm','ausuffix',
+        'au', 'aucorp']       
+    end
+    def method_missing(metadata, value=nil)
+      meta = metadata.to_s.sub(/=$/,'')
+      raise ArgumentError, "#{meta.to_s} is not a valid #{self.class} metadata field." unless (@author_keys+@metadata_keys).index(meta)
+      if metadata.to_s.match(/=$/)
+        self.set_metadata(meta, value)
+        if @author_keys.index(meta)
+          @authors[0].instance_variable_set("@#{meta}", value)
+        end
+      else
+        return self.metadata[meta]
+      end
+      
+    end
+    
+    def set_metadata(key, val)
+      @metadata[key] = val.to_s
+      if @author_keys.index(key)
+        @authors[0].instance_variable_set("@#{key}", val)
+      end      
+    end
+    
+    def genre=(genre)
+      raise ArgumentError, "#{genre} is not a valid #{self.class} genre." unless @valid_genres.index(genre)
+      self.set_metadata('genre', genre)      
+    end
+    
+    def genre
+      return self.metadata["genre"]
+    end
+
+    def add_author(author)
+      raise ArgumentError, "Argument must be an OpenURL::Author!" unless author.is_a?(OpenURL::Author)
+      @authors << author
+    end
+    
+    def remove_author(author)
+      idx = author
+      idx = @authors.index(author)
+      raise ArgumentError unless idx
+      @authors.delete_at(idx)      
+    end
+    
+    def serialize_metadata(elem, label)
+      meta = {}
+      metadata = elem.add_element("ctx:metadata")
+      meta["format_container"] = metadata.add_element("#{label}:#{@format}")
+      meta["format_container"].add_namespace(label, @xml_ns)
+      meta["format_container"].add_attribute("xsi:schemaLocation", "#{@xml_ns} http://www.openurl.info/registry/docs/info:ofi/fmt:xml:xsd:#{@format}")          
+      @metadata.each do |k,v|
+        next if ['au', 'aucorp', 'auinit', 'auinitm', 'aulast',
+          'aufirst', 'auinit1', 'ausuffix'].index(k)
+        meta[k] = meta["format_container"].add_element("#{label}:#{k}")
+        meta[k].text = v
+      end            
+      meta["author_container"] = meta["format_container"].add_element("#{label}:authors")
+      @authors.each do | author |
+        author.xml(meta["author_container"])
+      end      
+    end
+
+    def import_xml_metadata(node)         
+      mbv = REXML::XPath.first(node, "./ctx:metadata-by-val/ctx:metadata/fmt:#{@format}", {"ctx"=>"info:ofi/fmt:xml:xsd:ctx", "fmt"=>@xml_ns})					              
+      if mbv
+        mbv.to_a.each do |m|
+          self.set_metadata(m.name(), m.get_text.value) if m.has_text?                                  
+          if m.has_elements?
+            m.to_a.each do | md |
+              self.set_metadata(md.name(), md.get_text.value) if md.has_text?                              
+            end
+          end
+        end
+        auth_num = 0
+        REXML::XPath.each(mbv, "fmt:authors/fmt:author | fmt:authors/fmt:au | fmt:authors/fmt:aucorp", {"fmt"=>@xml_ns}) do | author |                    
+          empty_node = true
+          if author.name == "author"            
+            author.elements.each do | auth_elem |            
+              next unless @author_keys.index(auth_elem.name) and auth_elem.has_text?
+              empty_node = false
+              @authors << OpenURL::Author.new unless @authors[auth_num]
+              @authors[auth_num].instance_variable_set("@#{auth_elem.name}".to_sym, auth_elem.get_text.value)
+              self.set_metadata(auth_elem.name, auth_elem.get_text.value) if auth_num == 0
+            end
+          elsif author.name.match(/^au$|^aucorp$/)
+            next unless author.has_text? 
+            empty_node = false
+            @authors << OpenURL::Author.new unless @authors[auth_num]
+            # This next line is causing an exception, replaced it with following line modeling from above clause. Don't entirely understand it. 
+            # @authors[auth_num][author.name] = author.get_text.value
+            @authors[auth_num].instance_variable_set("@#{author.name}".to_sym, author.get_text.value)
+            self.set_metadata(author.name, author.get_text.value) if auth_num == 0            
+          end
+          auth_num += 1 unless empty_node
+        end        
+      end					
+    end     
+  end
+  
+  class Author
+    attr_accessor :aulast, :aufirst, :auinit, :auinit1, :auinitm, :ausuffix,
+      :au, :aucorp
+    def initialize      
+    end
+    
+    def xml(elem)      
+      if @au        
+        au = elem.add_element("#{elem.prefix}:au") 
+        au.text = @au
+      end
+      if @aucorp
+        aucorp = elem.add_element("#{elem.prefix}:aucorp") 
+        aucorp.text = @aucorp
+      end
+      if @aulast || @aufirst || @auinit || @auinit1 || @auinitm || @ausuffix
+        author = elem.add_element("#{elem.prefix}:author")
+        if @aulast
+          aulast = author.add_element("#{elem.prefix}:aulast")
+          aulast.text = @aulast
+        end
+        if @aufirst
+          aufirst = author.add_element("#{elem.prefix}:aufirst")
+          aufirst.text = @aufirst
+        end        
+        if @auinit
+          auinit = author.add_element("#{elem.prefix}:auinit")
+          auinit.text = @auinit
+        end        
+        if @auinit1
+          auinit1 = author.add_element("#{elem.prefix}:auinit1")
+          auinit1.text = @auinit1
+        end        
+        if @auinitm
+          auinitm = author.add_element("#{elem.prefix}:auinitm")
+          auinitm.text = @auinitm
+        end        
+        if @ausuffix
+          ausuff = author.add_element("#{elem.prefix}:ausuffix")
+          ausuff.text = @ausuffix
+        end        
+      end
+    end
+    
+    def empty?
+      self.instance_variables.each do | ivar |
+        return false if self.instance_variable_get(ivar)
+      end
+      return true
+    end    
+  end  
+  
+  class Inventor
+    attr_accessor :invlast, :invfirst, :inv
+    def initialize      
+    end
+    
+    def xml(elem)      
+      if @inv        
+        inv = elem.add_element("#{elem.prefix}:inv") 
+        inv.text = @inv
+      end
+      if @invlast || @invfirst
+        inventor = elem.add_element("#{elem.prefix}:inventor")
+        if @invlast
+          invlast = inventor.add_element("#{elem.prefix}:invlast")
+          invlast.text = @invlast
+        end
+        if @invfirst
+          invfirst = inventor.add_element("#{elem.prefix}:invfirst")
+          invfirst.text = @invfirst
+        end             
+      end
+    end
+    
+    def empty?
+      self.instance_variables.each do | ivar |
+        return false if self.instance_variable_get(ivar)
+      end
+      return true
+    end
+  end   
+end