pb_core 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pb_core.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 The Public Radio Exchange, www.prx.org
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# PBCore
+
+Gem for working with PBCore 2.0 XML data:
+* http://pbcore.org/
+* http://www.pbcoreresources.org/
+
+Uses sax-machine (which relies on nokogiri) for parsing:
+* https://github.com/pauldix/sax-machine
+* http://nokogiri.org/
+
+Created for Pop Up Archive project:
+* http://popuparchive.org/
+* https://github.com/PRX/pop-up-archive
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pb_core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pb_core
+
+## Usage
+
+	require 'pb_core'
+	f = File.open(some_file)
+	doc = PBCore::V2::DescriptionDocument.parse(f)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/pb_core

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'pb_core'
+
+# TODO: create command line parser for xml files

data/lib/pb_core/v2/base.rb

@@ -0,0 +1,204 @@
+require 'sax-machine'
+
+module PBCore
+  module V2
+
+    module SourceVersionGroup
+      def SourceVersionGroup.included(mod)
+        mod.attribute :source
+        mod.attribute :ref
+        mod.attribute :version
+        mod.attribute :annotation
+      end
+    end
+
+    module StartEndTimeGroup
+      def StartEndTimeGroup.included(mod)
+        mod.attribute :startTime, :as => :start_time
+        mod.attribute :endTime, :as => :end_time
+        mod.attribute :timeAnnotation, :as => :time_annotation
+      end
+    end
+
+    module CollectionGroup
+      def CollectionGroup.included(mod)
+        mod.attribute :collectionTitle, :as => :collection_title
+        mod.attribute :collectionDescription, :as => :collection_description
+        mod.attribute :collectionSource, :as => :collection_source
+        mod.attribute :collectionRef, :as => :collection_ref
+        mod.attribute :collectionDate, :as => :collection_date
+      end
+    end
+
+    class Base
+      include SAXMachine
+
+      def self.source_version_group; include PBCore::V2::SourceVersionGroup; end
+
+      def self.start_end_time_group; include PBCore::V2::StartEndTimeGroup; end
+
+      def self.collection_group; include PBCore::V2::CollectionGroup; end
+
+      def self.instantiation_group; include PBCore::V2::InstantiationGroup; end
+    end
+
+    class Identifier < PBCore::V2::Base
+      source_version_group
+    end
+
+    class Type < PBCore::V2::Base
+      source_version_group
+    end
+
+    class Title < PBCore::V2::Base
+      source_version_group
+      start_end_time_group
+
+      attribute :titleType, :as => :type
+    end
+
+    class Description < PBCore::V2::Base
+      start_end_time_group
+
+      attribute :descriptionType, :as => :type
+      attribute :descriptionTypeSource, :as => :type_source
+      attribute :descriptionTypeRef, :as => :type_ref
+      attribute :descriptionTypeVersion, :as => :type_version
+      attribute :descriptionTypeAnnotation, :as => :type_annotation
+
+      attribute :segmentType, :as => :segment_type
+      attribute :segmentTypeSource, :as => :segment_type_source
+      attribute :segmentTypeRef, :as => :segment_type_ref
+      attribute :segmentTypeVersion, :as => :segment_type_version
+      attribute :segmentTypeAnnotation, :as => :segment_type_annotation
+
+      attribute :annotation
+    end
+
+    class DateType < PBCore::V2::Base
+      attribute :dateType, :as => :type
+    end
+
+    class Subject < PBCore::V2::Base
+      source_version_group
+      start_end_time_group
+
+      attribute :subjectType, :as => :type
+    end
+
+    class Genre < PBCore::V2::Base
+      source_version_group
+      start_end_time_group    
+    end
+
+    class Relation < PBCore::V2::Base
+      element 'relationType', :as => :type, :class => PBCore::V2::Type
+      element 'relationIdentifier', :as => :identifier, :class => PBCore::V2::Identifier
+    end
+
+    class CoverageInfo < PBCore::V2::Base
+      source_version_group
+      start_end_time_group
+    end
+
+    class Coverage < PBCore::V2::Base
+      element 'coverage', :as => :info, :class => PBCore::V2::CoverageInfo
+      element 'coverageType', :as=> :type
+    end
+
+    class Affiliate < PBCore::V2::Base
+      start_end_time_group
+
+      attribute :affiliation
+      attribute :ref
+      attribute :annotation
+    end
+
+    class Creator < PBCore::V2::Base
+      element 'creator', :as => :name, :class => PBCore::V2::Affiliate
+      element 'creatorRole', :as => :role, :class => PBCore::V2::Type
+    end
+
+    class ContributorType < PBCore::V2::Base
+      source_version_group
+
+      attribute :portrayal
+    end
+
+    class Contributor < PBCore::V2::Base
+      element 'contributer', :as => :name, :class => PBCore::V2::Affiliate
+      element 'contributerRole', :as => :role, :class => PBCore::V2::ContributorType
+    end
+
+    class Publisher < PBCore::V2::Base
+      element 'publisher', :as => :name, :class => PBCore::V2::Affiliate
+      element 'publisherRole', :as => :role, :class => PBCore::V2::Type
+    end
+
+    class Annotated < PBCore::V2::Base
+      attribute :annotation
+    end
+
+    class Rights < PBCore::V2::Base
+      start_end_time_group
+
+      element 'rightsSummary', :as => :summary, :class => PBCore::V2::Type
+      element 'rightsLink', :as => :link, :class => PBCore::V2::Annotated
+      element 'rightsEmbedded', :as => :embedded, :class => PBCore::V2::Annotated
+    end
+
+    class Measurement < PBCore::V2::Base
+      attribute :annotation
+      attribute :unitsOfMeasure, :as => :units
+    end
+
+    class Standard < PBCore::V2::Base
+      source_version_group
+
+      attribute :profile
+    end
+
+    class Annotation < PBCore::V2::Base
+      attribute :annotationType, :as => :annotation_type
+      attribute :ref
+    end
+
+    class ExtensionWrap < PBCore::V2::Base
+      attribute :annotation
+
+      element   'extensionElement', :as => :element
+      element   'extensionValue', :as => :value
+      element   'extensionAuthorityUsed', :as => :authority_used
+    end
+
+    class Extension < PBCore::V2::Base
+      element   'extensionWrap', :as => :wrap, :class => PBCore::V2::ExtensionWrap
+      element   'extensionEmbedded', :as => :embedded, :class => PBCore::V2::Annotated
+    end
+
+    class EssenceTrack < PBCore::V2::Base
+      element   'essenceTrackType', :as => :type
+      elements  'essenceTrackIdentifier', :as => :identifiers, :class => PBCore::V2::Identifier
+      element   'essenceTrackStandard', :as => :standard, :class => PBCore::V2::Type
+      element   'essenceTrackEncoding', :as => :encoding, :class => PBCore::V2::Type
+      element   'essenceTrackDataRate', :as => :data_rate, :class => PBCore::V2::Measurement
+      element   'essenceTrackFrameRate', :as => :frame_rate, :class => PBCore::V2::Measurement
+      element   'essenceTrackPlaybackSpeed', :as => :playback_speed, :class => PBCore::V2::Measurement
+      element   'essenceTrackSamplingRate', :as => :sampling_rate, :class => PBCore::V2::Measurement
+      element   'essenceTrackBitDepth', :as => :bit_depth
+      element   'essenceTrackFrameSize', :as => :frame_size, :class => PBCore::V2::Type
+      element   'essenceTrackAspectRatio', :as => :aspect_ration, :class => PBCore::V2::Type
+      element   'essenceTrackTimeStart', :as => :time_start
+      element   'essenceTrackDuration', :as => :duration
+      element   'essenceTrackLanguage', :as => :language, :class => PBCore::V2::Type
+      element   'essenceTrackAnnotation', :as => :annotation, :class => PBCore::V2::Annotation
+      elements  'essenceTrackExtension', :as => :extensions, :class =>PBCore::V2::Extension
+    end
+
+    class InstantiationRelation < PBCore::V2::Base
+      element 'instantiationRelationType', :as => :type, :class => PBCore::V2::Type
+      element 'instantiationRelationIdentifier', :as => :identifier, :class => PBCore::V2::Identifier
+    end
+
+  end
+end

data/lib/pb_core/v2/collection.rb

@@ -0,0 +1,13 @@
+require 'pb_core/v2/base'
+require 'pb_core/v2/description_document'
+
+module PBCore
+  module V2
+
+    class Collection < PBCore::V2::Base
+      collection_group
+      elements  'pbcoreDescriptionDocument', :as => :description_documents, :class => PBCore::V2::DescriptionDocument
+    end
+
+  end
+end

data/lib/pb_core/v2/description_document.rb

@@ -0,0 +1,45 @@
+require 'pb_core/v2/base'
+require 'pb_core/v2/instantiation_document'
+
+module PBCore
+  module V2
+
+    class DocumentType < PBCore::V2::Base; end
+
+    # pbcoreDescriptionDocument
+    class Part < PBCore::V2::DocumentType
+      start_end_time_group
+    end
+
+    class DocumentType < PBCore::V2::Base
+      collection_group
+
+      elements  'pbcoreAssetType', :as => :asset_types, :class => PBCore::V2::Type
+      elements  'pbcoreAssetDate', :as => :asset_dates, :class => PBCore::V2::DateType
+      elements  'pbcoreIdentifier', :as => :identifiers, :class => PBCore::V2::Identifier
+      elements  'pbcoreTitle', :as => :titles, :class => PBCore::V2::Title
+      elements  'pbcoreDescription', :as=> :descriptions, :class => PBCore::V2::Description
+      elements  'pbcoreSubject', :as=> :subjects, :class => PBCore::V2::Subject
+      elements  'pbcoreCoverage', :as => :coverages, :class => PBCore::V2::Coverage
+      elements  'pbcoreAudienceLevel', :as => :audience_levels, :class => PBCore::V2::Type
+      elements  'pbcoreAudienceRating', :as => :audience_ratings, :class => PBCore::V2::Type
+      elements  'pbcoreCreator', :as => :creators, :class => PBCore::V2::Creator
+      elements  'pbcoreContributor', :as => :contributors, :class => PBCore::V2::Contributor
+      elements  'pbcorePublisher', :as => :publishers, :class => PBCore::V2::Publisher
+      elements  'pbcoreRightsSummary', :as => :rights, :class => PBCore::V2::Rights
+      elements  'pbcoreInstantiation', :as => :instantiations, :class => PBCore::V2::Instantiation
+      elements  'pbcoreAnnotation', :as => :annotations, :class => PBCore::V2::Annotation
+      elements  'pbcorePart', :as => :parts, :class => PBCore::V2::Part
+    end
+
+    # pbcoreDescriptionDocument
+    class DescriptionDocument < PBCore::V2::DocumentType
+    end
+
+    class Collection < PBCore::V2::Base
+      collection_group
+      elements  'pbcoreDescriptionDocument', :as => :description_documents, :class => PBCore::V2::DescriptionDocument
+    end
+
+  end
+end

data/lib/pb_core/v2/instantiation_document.rb

@@ -0,0 +1,48 @@
+require 'pb_core/v2/base'
+
+module PBCore
+  module V2
+
+    class InstantiationType < PBCore::V2::Base
+    end
+
+    class InstantiationPart < PBCore::V2::InstantiationType
+    end
+
+    class Instantiation < PBCore::V2::InstantiationType
+    end
+
+    class InstantiationDocument < PBCore::V2::InstantiationType
+    end
+
+    class InstantiationType < PBCore::V2::Base
+      start_end_time_group
+
+      elements  'instantiationIdentifier', :as => :identifiers, :class => PBCore::V2::Identifier
+      elements  'instantiationDate', :as => :dates, :class => PBCore::V2::DateType
+      elements  'instantiationDimensions', :as => :dimensions, :class => PBCore::V2::Measurement
+      element   'instantiationPhysical', :as => :physical, :class => PBCore::V2::Type
+      element   'instantiationDigital', :as => :digital, :class => PBCore::V2::Type
+      element   'instantiationStandard', :as => :standard, :class => PBCore::V2::Standard
+      element   'instantiationLocation', :as => :location
+      element   'instantiationMediaType', :as => :media_type, :class => PBCore::V2::Type
+      elements  'instantiationGenerations', :as => :generations, :class => PBCore::V2::Type
+      element   'instantiationFileSize', :as => :file_size, :class=> PBCore::V2::Measurement
+      element   'instantiationTimeStart', :as => :time_start
+      element   'instantiationDuration', :as => :duration
+      element   'instantiationDataRate', :as => :data_rate, :class=> PBCore::V2::Measurement
+      element   'instantiationColors', :as => :colors, :class=> PBCore::V2::Type
+      element   'instantiationTracks', :as => :tracks
+      element   'instantiationChannelConfiguration', :as => :channel_configuration
+      element   'instantiationLanguage', :as => :language, :class=> PBCore::V2::Type
+      element   'instantiationAlternativeModes', :as => :alternative_modes
+      elements  'instantiationEssenceTrack', :as => :essence_tracks, :class => PBCore::V2::EssenceTrack
+      elements  'instantiationRelation', :as => :relations, :class => PBCore::V2::InstantiationRelation
+      elements  'instantiationRights', :as => :rights, :class => PBCore::V2::Rights
+      elements  'instantiationAnnotation', :as => :annotations, :class => PBCore::V2::Annotation
+      elements  'instantiationPart', :as => :parts, :class => PBCore::V2::InstantiationPart
+      elements  'instantiationExtension', :as => :extensions, :class => PBCore::V2::Extension
+    end
+
+  end
+end

data/lib/pb_core/version.rb

@@ -0,0 +1,3 @@
+module PBCore
+  VERSION = "0.0.1"
+end

data/lib/pb_core.rb

@@ -0,0 +1,9 @@
+require 'sax-machine'
+
+require "pb_core/version"
+require 'pb_core/v2/base'
+require 'pb_core/v2/instantiation_document'
+require 'pb_core/v2/collection'
+
+module PBCore
+end

data/pb_core.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pb_core/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pb_core"
+  gem.version       = PBCore::VERSION
+  gem.authors       = ["Andrew Kuklewicz"]
+  gem.email         = ["andrew@prx.org"]
+  gem.description   = %q{Gem for working with PBCore 2.0 XML data}
+  gem.summary       = %q{Gem for working with PBCore 2.0 XML data}
+  gem.homepage      = "https://github.com/PRX/pb_core"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'sax-machine'
+
+  gem.add_development_dependency 'rake'
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: pb_core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Kuklewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sax-machine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for working with PBCore 2.0 XML data
+email:
+- andrew@prx.org
+executables:
+- pb_core
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/pb_core
+- lib/pb_core.rb
+- lib/pb_core/v2/base.rb
+- lib/pb_core/v2/collection.rb
+- lib/pb_core/v2/description_document.rb
+- lib/pb_core/v2/instantiation_document.rb
+- lib/pb_core/version.rb
+- pb_core.gemspec
+homepage: https://github.com/PRX/pb_core
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -630219332878205399
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -630219332878205399
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gem for working with PBCore 2.0 XML data
+test_files: []