Sha256: c82457cc008c826000f145b691edfd9548f4afef23367cbd4720fb9d133a117f

Contents?: true

Size: 1.84 KB

Versions: 2

Compression:

Stored size: 1.84 KB

Contents

# smoke-rack

Smoke::Rack 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 

Smoke::Rack gives you a bunch of HTML screens (found at `/smoke`) that outline the Smoke sources that are found within your current environment.
![Smoke-rack home screen](http://farm3.static.flickr.com/2627/3964835379_5d245a98e2.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://farm3.static.flickr.com/2566/3964835179_f543c25681.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 'smoke-rack'
    use Smoke::Rack
    
    run Sinatra::Application


## 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) 2009 Ben Schwarz. See LICENSE for details.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
smoke-rack-0.0.2 README.md
smoke-rack-0.0.1 README.md