opml-parser 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+rdoc/
+html/
+pkg/
+.bundle
+*.swp

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'nokogiri'
+
+group :development, :test do
+	gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013, Kevin Gillieron <kevin.gillieron@gw-computing.net>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+4. Neither the name of the author nor the names of its contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+        OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1 @@
+I will add a description and some examples in this page as soon as possible.

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+require 'rdoc/task'
+
+Rake::TestTask.new(:test) do |test|
+	test.libs << 'lib' << 'test'
+	test.pattern = 'test/**/*_test.rb'
+	test.verbose = true
+end
+
+Rake::RDocTask.new(:doc) do |rd|
+	rd.main = "README.md"
+	rd.rdoc_files.include("README.md", "lib/**/*.rb")
+end

data/lib/opml-parser/version.rb

@@ -0,0 +1,9 @@
+module OpmlParser #:nodoc:
+	module VERSION #:nodoc:
+		MAJOR = 1
+		MINOR = 0
+		TINY  = 0
+
+		STRING = [MAJOR, MINOR, TINY].join('.')
+	end
+end

data/lib/opml-parser.rb

@@ -0,0 +1,68 @@
+require 'nokogiri'
+require 'opml-parser/version'
+
+# OpmlParser Module
+#
+# A very simple and easy to use module for importing and exporting OPML.
+#
+# == Credits
+#
+# Kevin Gillieron <kevin.gillieron@gw-computing.net>
+#
+module OpmlParser
+	# Class representing an OPML outline element
+	class Outline
+		# OPML outline attributes (generally text, title, type, xmlUrl
+		# and htmlUrl)
+		attr_reader :attributes
+
+		# Initializes an outline object
+		#
+		# Arguments:
+		# 	attributes: (Hash) A Hash table that contains the attributes of the
+		# 	outline.
+		#
+		def initialize(attributes=Hash.new)
+			@attributes = attributes
+		end
+	end
+
+	# Import an OPML String as an array of Outline object
+	#
+	# Arguments:
+	# 	contents: (String) A String that contains the OMPL
+	def import(contents)
+		doc = Nokogiri.XML(contents)
+
+		doc.xpath("//body//outline").inject(Array.new) do |feeds, outline|
+			next if outline.attributes.empty?
+			feeds << Outline.new(xml_node_to_hash(outline.attributes))
+		end
+	end
+
+	# Import an OPML String as an array of Outline object
+	#
+	# Arguments:
+	# 	feeds: (Array of Outline) An array of Outline objects
+	def export(feeds)
+		builder = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
+			xml.opml(version: "1.0") do
+				xml.head { xml.title "RReader Exported Feeds" }
+				xml.body { feeds.each { |outline| xml.outline(outline.attributes) }}
+			end
+		end
+		builder.to_xml
+	end
+
+	private
+		# Convert a Nokogiri XML Node to a Hash table
+		def xml_node_to_hash(nokogiri_node)
+			attributes = Hash.new
+
+			nokogiri_node.each do |k,v|
+				attributes[k.to_sym] = v.value
+			end
+
+			return attributes
+		end
+end

data/opml-parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'opml-parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opml-parser"
+  spec.version       = OpmlParser::VERSION::STRING
+  spec.authors       = ["Kevin Gillieron"]
+  spec.email         = ["kevin.gillieron@gw-computing.net"]
+  spec.description   = %q{A simple OPML parser}
+  spec.summary       = %q{A simple OPML parser}
+  spec.homepage      = "http://projects.gw-computing.net/projects/opml-parser"
+  spec.license       = "3-clause BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/data/feeds.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<opml version="1.0">
+    <head>
+        <title>Foobar</title>
+    </head>
+    <body>
+        <outline text="foo" title="bar" type="rss" xmlUrl="http://www.gilliek.ch/feeds" htmlUrl="http://www.gilliek.ch"/>
+    </body>
+</opml>

data/test/opml_parser_test.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'opml-parser'
+
+include OpmlParser
+
+class OpmlParserTest < Test::Unit::TestCase
+	def setup
+		fin = File.open('test/data/feeds.xml')
+
+		@opml = fin.readlines.join("")
+		@outline = OpmlParser::Outline.new({
+			text:    "foo",
+		  title:   "bar",
+		  type:    "rss",
+		  xmlUrl:  "http://www.gilliek.ch/feeds",
+		  htmlUrl: "http://www.gilliek.ch" })
+
+		fin.close
+	end
+
+	#import an OMPL String as an array of Outline object
+	def test_import
+		outlines = OpmlParser::import(@opml)
+
+		assert_equal(outlines.length, 1)
+		assert_equal(outlines[0].attributes[:text]   , @outline.attributes[:text])
+		assert_equal(outlines[0].attributes[:title]  , @outline.attributes[:title])
+		assert_equal(outlines[0].attributes[:type]   , @outline.attributes[:type])
+		assert_equal(outlines[0].attributes[:xmlUrl] , @outline.attributes[:xmlUrl])
+		assert_equal(outlines[0].attributes[:htmlUrl], @outline.attributes[:htmlUrl])
+	end
+
+	# export an array of Outline object as an OPML String
+	def test_export
+		ary = Array.new
+		ary << @outline
+		opml = OpmlParser::export(ary)
+		outlines = OpmlParser::import(opml)
+
+		assert_equal(outlines.length, 1)
+		assert_equal(outlines[0].attributes[:text]   , @outline.attributes[:text])
+		assert_equal(outlines[0].attributes[:title]  , @outline.attributes[:title])
+		assert_equal(outlines[0].attributes[:type]   , @outline.attributes[:type])
+		assert_equal(outlines[0].attributes[:xmlUrl] , @outline.attributes[:xmlUrl])
+		assert_equal(outlines[0].attributes[:htmlUrl], @outline.attributes[:htmlUrl])
+	end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: opml-parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Gillieron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: A simple OPML parser
+email:
+- kevin.gillieron@gw-computing.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/opml-parser.rb
+- lib/opml-parser/version.rb
+- opml-parser.gemspec
+- test/data/feeds.xml
+- test/opml_parser_test.rb
+homepage: http://projects.gw-computing.net/projects/opml-parser
+licenses:
+- 3-clause BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A simple OPML parser
+test_files: []