ieee-idams 0.2.6

data/lib/ieee/idams/publication_info.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative "publication_acronym"
+require_relative "isbn"
+require_relative "copyright_group"
+require_relative "publisher"
+require_relative "address"
+require_relative "pub_sponsoring_committee_set"
+require_relative "pub_topical_browse_set"
+require_relative "pub_sponsor"
+require_relative "standard_modifier_set"
+require_relative "standard_relationship"
+require_relative "standard_bundle"
+require_relative "package_member_set"
+require_relative "standard_package_set"
+require_relative "ics_codes"
+require_relative "product_number"
+require_relative "conf_group"
+
+module Ieee
+  module Idams
+    # Contains detailed metadata about an IEEE publication
+    class PublicationInfo < Lutaml::Model::Serializable
+      # System ID
+      # @return [String] IDAMS internal ID
+      attribute :idamsid, :string
+
+      # Inventory part number
+      # @return [String] inventory part number
+      attribute :invpartnumber, :string
+
+      # Standard number
+      # @return [String] standard identifier
+      attribute :stdnumber, :string
+
+      # Publication type
+      # @return [String] type of publication
+      attribute :publicationtype, :string
+
+      # Publication subtype
+      # @return [String] subtype of publication
+      attribute :publicationsubtype, :string
+
+      # Standard subtype
+      # @return [String] subtype of standard
+      attribute :standard_subtype, :string
+
+      # IEEE abbreviation
+      # @return [String] IEEE abbreviation
+      attribute :ieeeabbrev, :string
+
+      # IEEE publication acronym
+      # @return [String] IEEE publication acronym
+      attribute :acronym, PublicationAcronym
+
+      # Publication status
+      # @return [String] Active or Inactive
+      attribute :pubstatus, :string, values: %w[Active Inactive]
+
+      # Open access status
+      # @return [String] open access indicator
+      attribute :publicationopenaccess, :string
+
+      # Standard ID
+      # @return [String] standard identifier
+      attribute :standard_id, :string
+
+      # Associated PU number
+      # @return [String] associated PU number
+      attribute :associated_punumber, :string
+
+      # Standard status
+      # @return [String] standard status
+      attribute :standard_status, :string
+
+      # Standard relationship
+      # @return [String] standard relationship
+      attribute :standard_relationship, StandardRelationship
+
+      # Standard modifier set
+      # @return [StandardModifierSet] standard modifier details
+      attribute :standard_modifier_set, StandardModifierSet
+
+      # Standard bundle
+      # @return [StandardBundle] standard bundle details
+      attribute :standard_bundle, StandardBundle
+
+      # Package member set
+      # @return [PackageMemberSet] package member details
+      attribute :package_member_set, PackageMemberSet
+
+      # ISBN information
+      # @return [Isbn] ISBN details
+      attribute :isbn, Isbn
+
+      # ISBN information
+      # @return [PubSponsor] sponsor details
+      attribute :pubsponsor, PubSponsor
+
+      # Standard family
+      # @return [String] family of standards
+      attribute :standard_family, :string
+
+      # Standard package set
+      # @return [String] package of standards
+      attribute :standard_package_set, StandardPackageSet
+
+      # ICS codes
+      # @return [IcsCodes] ICS codes
+      attribute :ics_codes, IcsCodes
+
+      # Sponsoring committees
+      # @return [PubSponsoringCommitteeSet] committee information
+      attribute :pubsponsoringcommitteeset, PubSponsoringCommitteeSet
+
+      # Topical browse categories
+      # @return [PubTopicalBrowseSet] subject classifications
+      attribute :pubtopicalbrowseset, PubTopicalBrowseSet
+
+      # Copyright information
+      # @return [CopyrightGroup] copyright details
+      attribute :copyrightgroup, CopyrightGroup
+
+      # Publisher information
+      # @return [Publisher] publisher details
+      attribute :publisher, Publisher
+
+      # Product number
+      # @return [ProductNumber] product number
+      attribute :productnumber, ProductNumber
+
+      # Publication approval date
+      # @return [String] approval date
+      attribute :pubapprovaldate, :string
+
+      # Hold status
+      # @return [String] Publish or Hold
+      attribute :holdstatus, :string
+
+      # <confgroup>
+      #   <doi_permission>F</doi_permission>
+      # </confgroup>
+      attribute :confgroup, ConfGroup
+
+      # <amsid>4322</amsid>
+      attribute :amsid, :string
+
+      xml do
+        root "publicationinfo"
+        map_element "idamsid", to: :idamsid
+        map_element "invpartnumber", to: :invpartnumber
+        map_element "stdnumber", to: :stdnumber
+        map_element "publicationtype", to: :publicationtype
+        map_element "publicationsubtype", to: :publicationsubtype
+        map_element "standard_subtype", to: :standard_subtype
+        map_element "ieeeabbrev", to: :ieeeabbrev
+        map_element "acronym", to: :acronym
+        map_element "pubstatus", to: :pubstatus
+        map_element "publicationopenaccess", to: :publicationopenaccess
+        map_element "standard_id", to: :standard_id
+        map_element "associated_punumber", to: :associated_punumber
+        map_element "standard_status", to: :standard_status
+        map_element "standardmodifierset", to: :standard_modifier_set
+        map_element "standard_bundle", to: :standard_bundle
+        map_element "standard_relationship", to: :standard_relationship
+        map_element "packagememberset", to: :package_member_set
+        map_element "isbn", to: :isbn
+        map_element "pubsponsor", to: :pubsponsor
+        map_element "standard_family", to: :standard_family
+        map_element "standardpackageset", to: :standard_package_set
+        map_element "icscodes", to: :ics_codes
+        map_element "pubsponsoringcommitteeset", to: :pubsponsoringcommitteeset
+        map_element "pubtopicalbrowseset", to: :pubtopicalbrowseset
+        map_element "copyrightgroup", to: :copyrightgroup
+        map_element "publisher", to: :publisher
+        map_element "productnumber", to: :productnumber
+        map_element "PubApprovalDate", to: :pubapprovaldate
+        map_element "holdstatus", to: :holdstatus
+        map_element "confgroup", to: :confgroup
+        map_element "amsid", to: :amsid
+      end
+    end
+  end
+end

data/lib/ieee/idams/publisher.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "address"
+
+module Ieee
+  module Idams
+    # Represents a publisher
+    class Publisher < Lutaml::Model::Serializable
+      # Publisher name
+      # @return [String] name of publishing organization
+      attribute :publishername, :string
+
+      # Publisher location
+      # @return [String] publishing location
+      attribute :publisherloc, :string
+
+      # Address details
+      # @return [Address] publisher's address
+      attribute :address, Address
+
+      xml do
+        root "publisher"
+        map_element "publishername", to: :publishername
+        map_element "publisherloc", to: :publisherloc
+        map_element "address", to: :address
+      end
+    end
+  end
+end

data/lib/ieee/idams/standard_bundle.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Standard Bundle
+    class StandardBundle < Lutaml::Model::Serializable
+      # <standard_bundle>
+      #   <bundle_name>American National Standard Recommended Practice for an On-Site, Ad Hoc Test Method for Estimating Electromagnetic Immunity of Medical Devices to Radiated Radio-Frequency (RF) Emissions from RF Transmitters - Redline</bundle_name>
+      #   <bundle_type>Suggested</bundle_type>
+      #   <base_standard_product_number>STD98685</base_standard_product_number>
+      #   <bundle_product_number>STDRL98685</bundle_product_number>
+      # </standard_bundle>
+
+      # Bundle name
+      # @return [String] bundle name
+      # @example "American ..."
+      attribute :bundle_name, :string
+
+      # Bundle type
+      # @return [String] bundle type
+      # @example "Suggested"
+      attribute :bundle_type, :string
+
+      # Base standard product number
+      # @return [String] base standard product number
+      # @example "STD98685"
+      attribute :base_standard_product_number, :string
+
+      # Bundle product number
+      # @return [String] bundle product number
+      # @example "STDRL98685"
+      attribute :bundle_product_number, :string
+
+      xml do
+        root "standard_bundle"
+        map_element "bundle_name", to: :bundle_name
+        map_element "bundle_type", to: :bundle_type
+        map_element "base_standard_product_number", to: :base_standard_product_number
+        map_element "bundle_product_number", to: :bundle_product_number
+      end
+    end
+  end
+end

data/lib/ieee/idams/standard_modifier_set.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a set of standard modifiers
+    class StandardModifierSet < Lutaml::Model::Serializable
+      attribute :standard_modifier, :string, collection: true
+
+      xml do
+        root "standardmodifierset"
+        map_element "standard_modifier", to: :standard_modifier
+      end
+    end
+  end
+end

data/lib/ieee/idams/standard_package_set.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a set of standard packages
+    class StandardPackageSet < Lutaml::Model::Serializable
+      attribute :standard_package, :string, collection: true
+
+      xml do
+        root "standardpackageset"
+        map_element "standard_package", to: :standard_package
+      end
+    end
+  end
+end

data/lib/ieee/idams/standard_relationship.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents
+    class StandardRelationship < Lutaml::Model::Serializable
+      # Product number
+      # @return [String] product number code
+      # @example "123456"
+      attribute :prodnum, :string
+
+      # Relationship date
+      # @return [String] relationship date
+      # @example "12/31/1969 7:00:00 PM"
+      attribute :relationship_date, :string
+
+      # Standard relationship type
+      # @return [String] standard relationship type
+      # @example "F"
+      attribute :type, :string
+
+      # Date string
+      # @return [String] date string
+      # @example "9-12-1997"
+      attribute :date_string, :string
+
+      xml do
+        root "standard_relationship"
+        map_attribute "prodnum", to: :prodnum
+        map_attribute "relationship_date", to: :relationship_date
+        map_attribute "type", to: :type
+        map_content to: :date_string
+      end
+    end
+  end
+end

data/lib/ieee/idams/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    VERSION = "0.2.6"
+  end
+end

data/lib/ieee/idams/volume.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "volume_info"
+require_relative "article"
+
+module Ieee
+  module Idams
+    # Represents a volume containing articles
+    class Volume < Lutaml::Model::Serializable
+      # Volume information
+      # @return [VolumeInfo] volume metadata
+      attribute :volumeinfo, VolumeInfo
+
+      # List of articles
+      # @return [Array<Article>] articles in volume
+      attribute :article, Article, collection: true
+
+      xml do
+        root "volume"
+        map_element "volumeinfo", to: :volumeinfo
+        map_element "article", to: :article
+      end
+    end
+  end
+end

data/lib/ieee/idams/volume_info.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "volume_info_issue"
+require_relative "volume_note_group"
+
+module Ieee
+  module Idams
+    # Contains volume metadata
+    class VolumeInfo < Lutaml::Model::Serializable
+      # Publication year
+      # @return [Integer] year of publication
+      attribute :year, :integer
+
+      # System ID
+      # @return [String] IDAMS internal ID
+      attribute :idamsid, :string
+
+      # Note group
+      # @return [VolumeNoteGroup] group of notes
+      attribute :note_group, VolumeNoteGroup
+
+      # Issue information
+      # @return [VolumeInfoIssue] detailed issue metadata
+      attribute :issue, VolumeInfoIssue
+
+      xml do
+        root "volumeinfo"
+        map_element "year", to: :year
+        map_element "idamsid", to: :idamsid
+        map_element "notegroup", to: :note_group
+        map_element "issue", to: :issue
+      end
+    end
+  end
+end

data/lib/ieee/idams/volume_info_issue.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Contains information about a volume issue
+    class VolumeInfoIssue < Lutaml::Model::Serializable
+      # Issue number
+      # @return [Integer] issue number
+      attribute :amsid, :integer
+
+      # Issue status
+      # @return [String] issue status
+      attribute :issuestatus, :string
+
+      xml do
+        root "issue"
+        map_element "amsid", to: :amsid
+        map_element "issuestatus", to: :issuestatus
+      end
+    end
+  end
+end

data/lib/ieee/idams/volume_note_group.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Group of notes
+    class VolumeNoteGroup < Lutaml::Model::Serializable
+      # Textual note
+      # @return [String] A textual note
+      attribute :note, :string, collection: true
+
+      xml do
+        root "notegroup"
+        map_element "note", to: :note
+      end
+    end
+  end
+end

data/lib/ieee/idams.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "idams/version"
+require_relative "idams/publication_info"
+require_relative "idams/publication"
+require_relative "idams/isbn"
+require_relative "idams/pub_sponsoring_committee_set"
+require_relative "idams/pub_topical_browse_set"
+require_relative "idams/author_group"
+require_relative "idams/copyright_group"

data/lib/ieee-idams.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+Lutaml::Model::Config.configure do |config|
+  require "lutaml/model/xml_adapter/nokogiri_adapter"
+  config.xml_adapter = Lutaml::Model::XmlAdapter::NokogiriAdapter
+end
+
+module Ieee
+  module Idams
+    class Error < StandardError; end
+  end
+end
+
+require_relative "ieee/idams"

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: ieee-idams
+version: !ruby/object:Gem::Version
+  version: 0.2.6
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: xml-c14n
+  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'
+description: Library of Congress MODS / MADS parser
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CODE_OF_CONDUCT.md
+- README.adoc
+- Rakefile
+- lib/ieee-idams.rb
+- lib/ieee/idams.rb
+- lib/ieee/idams/address.rb
+- lib/ieee/idams/affiliation.rb
+- lib/ieee/idams/affiliation_address.rb
+- lib/ieee/idams/affiliation_group.rb
+- lib/ieee/idams/article.rb
+- lib/ieee/idams/article_abstract.rb
+- lib/ieee/idams/article_copyright.rb
+- lib/ieee/idams/article_date.rb
+- lib/ieee/idams/article_filename.rb
+- lib/ieee/idams/article_info.rb
+- lib/ieee/idams/article_page_nums.rb
+- lib/ieee/idams/author.rb
+- lib/ieee/idams/author_group.rb
+- lib/ieee/idams/conf_group.rb
+- lib/ieee/idams/copyright.rb
+- lib/ieee/idams/copyright_group.rb
+- lib/ieee/idams/ics_code_term.rb
+- lib/ieee/idams/ics_codes.rb
+- lib/ieee/idams/isbn.rb
+- lib/ieee/idams/keyword.rb
+- lib/ieee/idams/keyword_set.rb
+- lib/ieee/idams/multimedia.rb
+- lib/ieee/idams/multimedia_component.rb
+- lib/ieee/idams/multimedia_compressed.rb
+- lib/ieee/idams/package_member_set.rb
+- lib/ieee/idams/product_number.rb
+- lib/ieee/idams/pub_sponsor.rb
+- lib/ieee/idams/pub_sponsoring_committee_set.rb
+- lib/ieee/idams/pub_topical_browse_set.rb
+- lib/ieee/idams/publication.rb
+- lib/ieee/idams/publication_acronym.rb
+- lib/ieee/idams/publication_info.rb
+- lib/ieee/idams/publisher.rb
+- lib/ieee/idams/standard_bundle.rb
+- lib/ieee/idams/standard_modifier_set.rb
+- lib/ieee/idams/standard_package_set.rb
+- lib/ieee/idams/standard_relationship.rb
+- lib/ieee/idams/version.rb
+- lib/ieee/idams/volume.rb
+- lib/ieee/idams/volume_info.rb
+- lib/ieee/idams/volume_info_issue.rb
+- lib/ieee/idams/volume_note_group.rb
+- references/ieee-books-xml-metadata-documentation.pdf
+homepage: https://github.com/relaton/ieee-idams
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/relaton/ieee-idams
+  source_code_uri: https://github.com/relaton/ieee-idams
+  changelog_uri: https://github.com/relaton/ieee-idams
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key: 
+specification_version: 4
+summary: Library of Congress MODS / MADS parser
+test_files: []