fed 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Tom Preston-Werner
+
+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,69 @@
+RakeGem
+=======
+
+# DESCRIPTION
+
+Ever wanted to manage your RubyGem in a sane way without having to resort to
+external dependencies like Jeweler or Hoe? Ever thought that Rake and a hand
+crafted gemspec should be enough to deal with these problems? If so, then
+RakeGem is here to make your life awesome!
+
+RakeGem is not a library. It is just a few simple file templates that you can
+copy into your project and easily customize to match your specific needs. It
+ships with a few Rake tasks to help you keep your gemspec up-to-date, build
+a gem, and release your library and gem to the world.
+
+RakeGem assumes you are using Git. This makes the Rake tasks easy to write. If
+you are using something else, you should be able to get RakeGem up and running
+with your system without too much editing.
+
+The RakeGem tasks were inspired by the
+[Sinatra](http://github.com/sinatra/sinatra) project.
+
+# INSTALLATION
+
+Take a look at `Rakefile` and `NAME.gemspec`. For new projects, you can start
+with these files and edit a few lines to make them fit into your library. If
+you have an existing project, you'll probably want to take the RakeGem
+versions and copy any custom stuff from your existing Rakefile and gemspec
+into them. As long as you're careful, the rake tasks should keep working.
+
+# ASSUMPTIONS
+
+RakeGem makes a few assumptions. You will either need to satisfy these
+assumptions or modify the rake tasks to work with your setup.
+
+You should have a file named `lib/NAME.rb` (where NAME is the name of your
+library) that contains a version line. It should look something like this:
+
+    module NAME
+      VERSION = '0.1.0'
+    end
+
+It is important that you use the constant `VERSION` and that it appear on a
+line by itself.
+
+# UPDATING THE VERSION
+
+In order to make a new release, you'll want to update the version. With
+RakeGem, you only need to do that in the `lib/NAME.rb` file. Everything else
+will use this find the canonical version of the library.
+
+# TASKS
+
+RakeGem provides three rake tasks:
+
+`rake gemspec` will update your gemspec with the latest version (taken from
+the `lib/NAME.rb` file) and file list (as reported by `git ls-files`).
+
+`rake build` will update your gemspec, build your gemspec into a gem, and
+place it in the `pkg` directory.
+
+`rake release` will update your gemspec, build your gem, make a commit with
+the message `Release 0.1.0` (with the correct version, obviously), tag the
+commit with `v0.1.0` (again with the correct version), and push the `master`
+branch and new tag to `origin`.
+
+Keep in mind that these are just simple Rake tasks and you can edit them
+however you please. Don't want to auto-commit or auto-push? Just delete those
+lines. You can bend RakeGem to your own needs. That's the whole point!

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/fed.gemspec

@@ -0,0 +1,73 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'fed'
+  s.version           = '0.0.1'
+  s.date              = '2013-04-25'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "A feed parser that actually works."
+  s.description = "A feed parser that actually works and doesn't suck."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Jeremy McAnally"]
+  s.email    = 'jeremy@github.com'
+  s.homepage = 'http://github.com/jm/fed'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('nokogiri')
+  s.add_dependency('curb')  
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('contest')  
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.md
+    Rakefile
+    fed-0.0.gem
+    fed.gemspec
+    lib/fed.rb
+    lib/fed/feed/atom.rb
+    lib/fed/feed/base.rb
+    lib/fed/feed/entry.rb
+    lib/fed/feed/rss.rb
+    lib/fed/http.rb
+    lib/fed/http/curb.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/fed.rb

@@ -0,0 +1,63 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'curb'
+require 'nokogiri'
+require 'time'
+
+require 'fed/http'
+require 'fed/http/curb'
+require 'fed/feed/base'
+require 'fed/feed/atom'
+require 'fed/feed/rss'
+require 'fed/feed/entry'
+
+module Fed
+  VERSION = '0.0.1'
+
+  class <<self
+
+    def fetch_and_parse(feed_url)
+      parse fetch(feed_url)
+    end
+
+    def fetch(feed_url)
+      Fed::Http.client.get(feed_url)
+    end
+
+    def parse(xml)
+      document = Nokogiri::XML(xml)
+      parser_for(document).parse
+    end
+
+    def parser_for(doc)
+      if is_atom?(doc)
+        Fed::Feed::Atom.new(doc)
+      elsif is_rss?(doc)
+        Fed::Feed::Rss.new(doc)
+      elsif (new_url = find_link_in_html(doc))
+        parser_for(fetch(new_url))
+      else
+        raise "Bad feed."
+      end
+    end
+
+    def is_atom?(document)
+      document.css('feed entry').any?
+    end
+
+    def is_rss?(document)
+      document.css('rss channel').any?
+    end
+
+    def find_link_in_html(document)
+      elems = document.css("link[type='application/atom+xml']")
+
+      if elems.any?
+        elems.first.attributes['href'].value
+      else
+        nil
+      end
+    end
+
+  end
+end

data/lib/fed/feed/atom.rb

@@ -0,0 +1,34 @@
+module Fed
+  module Feed
+    class Atom < Base
+      def parse
+        feed = @document.css('feed').first
+
+        @title = feed.css('/title').text
+        @description = feed.css('/subtitle').text
+        @link = feed.css('/link').first.attributes['href'].value
+        @updated = DateTime.parse(feed.css('/updated').text) rescue nil
+
+        @entries = feed.css('entry').map do |entry|
+          entry_title = entry.css('/title').text
+          entry_summary = entry.css('/summary').text
+          entry_content = entry.css('/content').text
+          entry_published = DateTime.parse(entry.css('/updated').text) rescue nil
+          entry_guid = entry.css('/id').text
+          entry_author = entry.css('/author name').map {|a| a.text}.join(', ')
+
+          link_elem = entry.css("link[rel='alternate']").first
+          entry_link = if (link_elem && (attribute = link_elem.attributes['href']))
+            attribute.value
+          else
+            ""
+          end
+
+          Entry.new(entry_title, entry_link, entry_guid, entry_published, entry_author, entry_summary, entry_content)
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/fed/feed/base.rb

@@ -0,0 +1,11 @@
+module Fed
+  module Feed
+    class Base
+      attr_reader :document, :title, :description, :link, :guid, :updated, :entries
+
+      def initialize(doc)
+        @document = doc
+      end
+    end
+  end
+end

data/lib/fed/feed/entry.rb

@@ -0,0 +1,6 @@
+module Fed
+  module Feed
+    class Entry < Struct.new(:title, :link, :guid, :published, :author, :summary, :content)
+    end
+  end
+end

data/lib/fed/feed/rss.rb

@@ -0,0 +1,28 @@
+module Fed
+  module Feed
+    class Rss < Base
+      def parse
+        channel = @document.css('rss channel').first
+
+        @title = channel.css('/title').text
+        @description = channel.css('/description').text
+        @link = channel.css('/link').text
+        @updated = DateTime.parse(channel.css('/pubDate').text) rescue nil
+
+        @entries = channel.css('item').map do |item|
+          item_title = item.css('/title').text
+          item_summary = item.css('/description').text
+          item_content = item.css('/description').text
+          item_link = item.css('/link').text
+          item_published = DateTime.parse(item.css('/pubDate').text) rescue nil
+          item_guid = item.css('/guid').text
+          item_author = item.css('/author').text
+
+          Entry.new(item_title, item_link, item_guid, item_published, item_author, item_summary, item_content)
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/fed/http.rb

@@ -0,0 +1,19 @@
+module Fed
+  module Http
+    class <<self
+      attr_writer :options
+
+      def options
+        @options ||= {
+          :user_agent => "fed (Ruby feed parser) v.#{Fed::VERSION}"
+        }
+      end
+
+      attr_writer :client
+
+      def client
+        @client ||= Fed::Http::Curb
+      end
+    end
+  end
+end

data/lib/fed/http/curb.rb

@@ -0,0 +1,12 @@
+
+module Fed
+  module Http
+    class Curb
+      def self.get(url)
+        Curl.get(url) do|http|
+          http.headers['User-Agent'] = Fed::Http.options[:user_agent]
+        end.body_str
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy McAnally
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-25 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: curb
+  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: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: contest
+  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 feed parser that actually works and doesn't suck.
+email: jeremy@github.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- fed-0.0.gem
+- fed.gemspec
+- lib/fed.rb
+- lib/fed/feed/atom.rb
+- lib/fed/feed/base.rb
+- lib/fed/feed/entry.rb
+- lib/fed/feed/rss.rb
+- lib/fed/http.rb
+- lib/fed/http/curb.rb
+homepage: http://github.com/jm/fed
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.23
+signing_key: 
+specification_version: 2
+summary: A feed parser that actually works.
+test_files: []