Contents

# rack-smoke

Rack::Smoke allows you to expose Smoke sources and transcode them into JSON, XML or YAML.

## What are the benefits? 

* Pluggable caching, cache remote web services and rely on your own infrastructure
* Join Smoke sources together, reinterpret them, then offer them as a simple web service 

Rack::Smoke gives you a bunch of HTML screens (found at `/smoke`) that outline the Smoke sources that are found within your current environment.
![Rack::Smoke home screen](http://img.skitch.com/20100124-t55yrg8wij4yah1ebd8a7mfdmq.jpg)

From there, you'll be able to see the formats that you can get the stream in, or if they require any additional query strings.
![Twitter source details](http://img.skitch.com/20100124-m8gu8nfbknrqgfhb3aax6idnrp.jpg)


## Smoke? 

Smoke allows you to take single serve sources from around the web. Then it does a bunch of smart stuff like automagically transferring as gzip, request caching and understands the content that it gets back. YQL, Atom / RSS feeds, json and xml are all converted to ruby arrays.

Smoke-rack allows you to transcode that information and provide an API like layer of your own.

## How do I include it in my project? 

    # config.ru
    require 'rubygems'
    
    # Ensure your app has some Smoke sources
    require 'your-app'
    
    require 'rack-smoke'
    use Rack::Smoke
    
    run Sinatra::Application

Then navigate to localhost:PORT/smoke to get a list of available sources

## Installation

    gem install rack-smoke

## Note on Patches/Pull Requests
 
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
  future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
  (if you want to have your own version, that is fine but
   bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

## Copyright

Copyright (c) 2010 Ben Schwarz. See LICENSE for details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rack-smoke-1.0.0	README.md