Git Product home page Git Product logo

hyperfeed's Introduction

Hyperfeed

This gem turns RSS Feeds into ruby objects. It is a HttpMonkey middleware wich parse the feeds xml dynamically and create a hash from the given attributes.

As a gift for you this hash is Methodized, in other words, you can read the hash attributes as object methods.

*Note: currently supports only RSS feeds type (someone wants to code an Atom support???) and we let you to use feeds thats has more than W3C attributes on the content.

Installation

Add this line to your application's Gemfile:

gem 'hyperfeed'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hyperfeed

Usage

  ##################
  # Accessing the feed

  response = Hyperfeed::Client.at("http://fakefeed/articles.rss").get
  
  puts response.inspect
  => {:per_page=>10, :current_page=>1, :total_pages=>1, :total_results=>5, :result=>[ ]...
  
  ##############
  # Reading items:
  
  item = response.result.first #enclosure(media) included
  
  puts item.inspect
  => {:id=>"83a84dd1481a1d8bdbc427cac2eba403", 
   :guid=>"http://fakefeed/article-1.html", 
   :title=>"Fake Title", :category=>"fake category", :description=>"Lorem ipsum dolor sit amet", 
   :link=>"http://fakefeed/article-1.html", :source=>"Fake feed", 
   :enclosure=>[{:url=>"http://fakefeed/image-1.jpg", 
                 :type=>"image/jpeg", :title=>"Image"}]}
                 
  puts item.guid
  => "http://fakefeed/article-1.html"
                 
  puts item.id #This ID is generated by hyperfeed and you can use it to access the exact item
  => "83a84dd1481a1d8bdbc427cac2eba403"
  
  item = Hyperfeed::Client.at("http://fakefeed/articles.rss").get("83a84dd1481a1d8bdbc427cac2eba403")
  puts item.title
  => "Fake Title"
  
  #############
  # Pagination
  
  response = Hyperfeed::Client.at("http://fakefeed/articles.rss", {:per_page => 20, :page => 2}).get

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

hyperfeed's People

Contributors

gkato avatar rogerleite avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

rogerleite

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.