zsff 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2008-01-15
+
+* Initial release.  Contains parse function, which includes validation.
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/zsff.rb
+test/test_zsff.rb

data/README.txt

@@ -0,0 +1,52 @@
+zsff
+    by Erik Peterson
+    http://subwindow.com/zsff
+
+== DESCRIPTION:
+  
+A parser/validator for ZSFF feeds.
+
+== FEATURES/PROBLEMS:
+  
+Right now, only one function: parse.  This does the validation and parsing all in one step.  This is intended to be used by any reader (who would take care of what links have been read, etc).
+
+== SYNOPSIS:
+
+results = Zsff.parse(url)
+results[:errors] #Any errors encountered while parsing
+results[:warnings] #Any warnings encountered while parsing
+results[:attrs] #A hash for the author, title, etc information from the feed
+results[:links] #List of links in the feed
+
+== REQUIREMENTS:
+
+None
+
+== INSTALL:
+
+sudo gem install, anything else
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Erik Peterson
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/zsff.rb'
+
+Hoe.new('zsff', Zsff::VERSION) do |p|
+  p.rubyforge_name = 'zsff'
+  p.author = 'Erik Peterson'
+  p.email = 'erik@subwindow.com'
+  p.summary = 'A parser/validator for ZSFF feeds'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/zsff.rb

@@ -0,0 +1,112 @@
+# Author::    Erik Peterson  (mailto:erik@subwindow.com)
+# Copyright:: Copyright (c) 2008 Erik Peterson
+# License::   MIT
+
+# This class parses and validates a Zsff feed by URL or a raw feed string
+
+require 'net/http'
+require 'open-uri'
+class Zsff
+  VERSION = '1.0.0'
+  attr_accessor :url
+  attr_accessor :contents
+  attr_accessor :errors
+  attr_accessor :warnings
+  attr_accessor :version
+  attr_accessor :author
+  attr_accessor :title
+  attr_accessor :site
+  attr_accessor :subtitle
+  attr_accessor :copyright
+  attr_accessor :content_type
+  attr_accessor :links
+  
+  def initialize(attributes = nil)
+    self.attributes = attributes unless attributes.nil?
+    @errors = []
+    @warnings = []
+    @links = []
+  end
+  
+  def self.parse_url(url)
+    parser = self.new(:url => url)
+    parser.parse
+    return parser
+  end
+  
+  def self.parse_contents(contents)
+    parser = self.new(:contents => contents)
+    parser.parse
+    return parser
+  end
+  
+  def attributes=(attributes)
+    attributes.each do |k, v|
+      send(k.to_s + "=", v)
+    end
+  end
+  
+  def parse
+    if self.url
+      begin
+        uri = URI.parse(url)
+        @contents = Net::HTTP.get(uri)
+      rescue
+        @errors.push("Invalid URL")
+        return false
+      end
+    end
+    
+    parse_contents
+    
+    return @errors.size == 0
+  end
+  
+  def parse_contents
+    begin
+      raw = @contents.split(/\n\n/)
+      @errors.push("Must have two line breaks between Attributes section and Links section") and return if raw.size < 2
+      
+      @version = raw.first.split(/\n/).first
+      raw.first.split(/\n/)[1..-1].each do |attribute|
+        parts = attribute.split(":")
+        next if parts.size < 2
+        self.send(parts.first.downcase.gsub(/-/, "_") + "=", parts[1..-1].join(":").strip)
+      end
+      
+      error_if :version,      @version.nil? || @version.match(/ZSFF 1\.[0-9]/).nil?
+      error_if :author,       @author.nil? || @author == ""
+      error_if :title,        @title.nil? || @title == ""
+      error_if :site,         @site.nil? || @site == ""
+      warn_if  :site,         @site.nil? || !is_valid_url?(@site) 
+      warn_if  :subtitle,     @subtitle.nil? || @subtitle == ""
+      warn_if  :copyright,    @copyright.nil? || @copyright == ""
+      error_if :content_type, @content_type.nil? || @content_type.match(/.*\/.*/).nil?
+      
+      items = raw.last.split(/\n/)
+      items.each do |item|
+        warnings.push("Item '#{item}' does not appear to be a valid URL") and next unless is_valid_url?(item)
+        unless item.match(/\.page$/)
+          content = items.select{|i|item.gsub(/\.(php|php3|asp|aspx|htm|cfm|html)$/, "") + ".page" == i}.first
+          @links.push({:link => item, :content => content}) 
+        end
+      end
+    #rescue
+    #  @errors.push("Cannot parse ZSFF file")
+    end
+    
+  end
+  
+  private
+    def error_if(attribute, condition)
+      @errors.push("Invalid #{attribute.to_s.capitalize} declaration.") if condition
+    end
+    
+    def warn_if(attribute, condition)
+      @warnings.push("#{attribute.to_s.capitalize} may be invalid.") if condition
+    end
+    
+    def is_valid_url?(url)
+      !url.match(/(^$)|(^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$)/ix).nil?
+    end
+end

data/test/test_zsff.rb

@@ -0,0 +1,113 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/zsff'
+class ZsffTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_parse_url
+    parser = Zsff.new(:url => "http://subwindow.com/articles.zsff")
+    
+    assert_equal true, parser.parse
+    assert_equal [], parser.errors
+    assert_equal [], parser.warnings
+    assert_equal "ZSFF 1.0", parser.version
+    assert_equal "Erik Peterson", parser.author
+    assert_equal "subWindow Blog", parser.title
+    assert_equal "http://www.subwindow.com/", parser.site
+    assert_equal "Just another crappy programmer's blog", parser.subtitle
+    assert_equal "2008", parser.copyright
+    assert_equal "text/plain", parser.content_type
+    assert parser.links.size > 2
+  end
+  
+  def test_static_parse_url
+    parser = Zsff::parse_url("http://subwindow.com/articles.zsff")
+    
+    assert_equal [], parser.errors
+    assert_equal [], parser.warnings
+  end
+  
+  def test_static_parse_contents
+    zsff = <<ZSFFSTR
+ZSFF 1.0
+Author: Erik Peterson
+Title: subWindow Blog
+Site: http://www.subwindow.com/
+Subtitle: Just another crappy programmer's blog
+Copyright: 2008
+Content-type: text/plain
+
+http://subwindow.com/articles/3.page
+http://subwindow.com/articles/3.html
+http://subwindow.com/articles/2
+http://subwindow.com/articles/2.page
+http://subwindow.com/articles/1
+ZSFFSTR
+
+    parser = Zsff::parse_contents(zsff)
+
+    assert_equal [], parser.errors
+    assert_equal [], parser.warnings
+  end
+  
+  def test_parse_string
+    zsff = <<ZSFFSTR
+ZSFF 1.0
+Author: Erik Peterson
+Title: subWindow Blog
+Site: http://www.subwindow.com/
+Subtitle: Just another crappy programmer's blog
+Copyright: 2008
+Content-type: text/plain
+
+http://subwindow.com/articles/3.page
+http://subwindow.com/articles/3.html
+http://subwindow.com/articles/2
+http://subwindow.com/articles/2.page
+http://subwindow.com/articles/1
+ZSFFSTR
+
+    parser = Zsff.new(:contents => zsff)
+    assert_equal true, parser.parse
+    assert_equal [], parser.errors
+    assert_equal [], parser.warnings
+    assert_equal "ZSFF 1.0", parser.version
+    assert_equal "Erik Peterson", parser.author
+    assert_equal "subWindow Blog", parser.title
+    assert_equal "http://www.subwindow.com/", parser.site
+    assert_equal "Just another crappy programmer's blog", parser.subtitle
+    assert_equal "2008", parser.copyright
+    assert_equal "text/plain", parser.content_type
+    assert_equal 3, parser.links.size
+    assert_equal "http://subwindow.com/articles/3.html", parser.links[0][:link]
+    assert_equal "http://subwindow.com/articles/3.page", parser.links[0][:content]
+    assert_equal "http://subwindow.com/articles/2", parser.links[1][:link]
+    assert_equal "http://subwindow.com/articles/2.page", parser.links[1][:content]
+    assert_equal "http://subwindow.com/articles/1", parser.links[2][:link]
+    assert_equal nil, parser.links[2][:content]
+  end
+  
+  def test_fail_parse
+    zsff = "THIS IS NOT A VALID ZSFF FEED"
+
+    parser = Zsff.new(:url => zsff)
+    assert_equal false, parser.parse
+    assert parser.errors.include?("Invalid URL")
+  end
+  
+  def test_fail_links
+    zsff = <<ZSFFSTR
+ZSFF 1.0
+Author: Erik Peterson
+Title: subWindow Blog
+Site: http://www.subwindow.com/
+Subtitle: Just another crappy programmer's blog
+Copyright: 2008
+Content-type: text/plain
+http://subwindow.com/articles/3
+http://subwindow.com/articles/2
+ZSFFSTR
+
+    parser = Zsff.new(:contents => zsff)
+    assert_equal false, parser.parse
+    assert parser.errors.include?("Must have two line breaks between Attributes section and Links section")
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: zsff
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Erik Peterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "== FEATURES/PROBLEMS:  Right now, only one function: parse.  This does the validation and parsing all in one step.  This is intended to be used by any reader (who would take care of what links have been read, etc).  == SYNOPSIS:  results = Zsff.parse(url) results[:errors] #Any errors encountered while parsing results[:warnings] #Any warnings encountered while parsing results[:attrs] #A hash for the author, title, etc information from the feed results[:links] #List of links in the feed  == REQUIREMENTS:"
+email: erik@subwindow.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/zsff.rb
+- test/test_zsff.rb
+has_rdoc: true
+homepage: "    by Erik Peterson"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: zsff
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A parser/validator for ZSFF feeds
+test_files: 
+- test/test_zsff.rb