smoke-rack 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Schwarz
+
+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,51 @@
+# 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.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "smoke-rack"
+    gem.summary = %Q{Expose Smoke sources and transcode them into JSON, XML or YAML}
+    gem.description = %Q{Expose Smoke sources and transcode them into JSON, XML or YAML}
+    gem.email = "ben.schwarz@gmail.com"
+    gem.homepage = "http://github.com/benschwarz/smoke-rack"
+    gem.authors = ["Ben Schwarz"]
+    gem.rubyforge_project = "smoke-rack"
+    gem.add_development_dependency "rspec"
+    gem.add_dependency "smoke", "0.5.16"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "smoke-rack #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/config.ru

@@ -0,0 +1,11 @@
+# Just here to test easily
+
+# Ensure your sources (and smoke) are required before smoke-rack
+require 'examples/smoke-source'
+require 'lib/smoke-rack'
+use Smoke::Rack
+
+run Sinatra::Application
+get '/' do
+  "XYZ"
+end

data/examples/smoke-source.rb

@@ -0,0 +1,60 @@
+# Pinched from github.com/benschwarz/benschwarz-site
+
+require 'smoke'
+require 'digest/sha1'
+
+Smoke.configure do |c|
+  c[:cache][:enabled] = true
+  c[:cache][:store] = :memory
+  c[:cache][:expire_in] = 1800
+end
+
+Smoke.yql(:flickr) do
+  select :all
+  from 'flickr.photos.search'
+  where :user_id, "36821533@N00"
+  where :tags, "germanforblack-site"
+
+  path :query, :results, :photo
+end
+
+Smoke.data(:twitter) do
+  prepare :require => :username do
+    url "http://twitter.com/users/show.json?screen_name=#{username}", :format => :json  
+  end
+end
+
+Smoke.feed(:delicious) do
+  url "http://feeds.delicious.com/v2/rss/bschwarz?count=5"
+end
+
+Smoke.data(:upcoming) do
+  url "http://upcoming.yahooapis.com/services/rest/?method=user.getWatchlist&api_key=7c06afe3f8&user_id=908522&show=upcoming&format=json"
+  path :rsp, :event
+
+  emit do
+    keep :status, /attend/
+    truncate 1
+  end
+end
+
+Smoke.data(:github) do
+  url "http://github.com/api/v2/json/repos/show/benschwarz"
+  path :repositories
+  
+  emit do
+    sort :watchers
+    reverse
+    truncate 5
+  end
+end
+
+Smoke.data(:slideshare) do
+  prepare do
+    timestamp = Time.now.to_i
+    hash = Digest::SHA1.hexdigest("FeXBxg0G#{timestamp}")
+    url "http://www.slideshare.net/api/2/get_slideshows_by_user?username_for=benschwarz&api_key=uQqJ57cz&ts=#{timestamp}&hash=#{hash}"
+  end
+  
+  path :User, :Slideshow
+end

data/lib/smoke-rack.rb

@@ -0,0 +1,32 @@
+require 'sinatra'
+
+module Smoke
+  class Rack < Sinatra::Base    
+    set :public, File.join(File.dirname(__FILE__), '..', 'public')
+    set :haml, {:format => :html5, :attr_wrapper => '"'}
+    enable :static
+    
+    mime :xml,  "application/xml"
+    mime :json, "application/json"
+    mime :yaml, "application/x-yaml"
+    
+    get '/smoke' do
+      @sources = Smoke.active_sources.keys
+      haml :index
+    end
+    
+    Smoke.active_sources.keys.each do |source|
+      get "/smoke/#{source.to_s}" do
+        @source = source
+        haml :usage
+      end
+      
+      get "/smoke/#{source.to_s}.:format" do
+        format = params[:format].to_sym
+        
+        content_type format
+        Smoke.send(source).output(format)
+      end
+    end
+  end
+end

data/public/css/base.css

@@ -0,0 +1,24 @@
+body { font-family: Helvetica, Arial; }
+#container { width: 550px; margin: 0 auto; }
+
+h1 { font-size: 3em; text-transform: lowercase; margin-bottom: 1.5em; }
+h2 { font-size: 1.3em; }
+h1 + h2 { margin-top : -3em; font-style: italic; font-weight: normal; font-size: 0.9em; color: #999;}
+
+header { margin: 4em 0; }
+
+p { margin: 1em 0; }
+li { margin: 0.3em 0; }
+pre { display: inline-block; margin: 2em 0; }
+code { font-size: 1em; background-color: #eee; padding: 0.6em; }
+a { color: #666; }
+a.back {  margin-left: -10em; margin-top: 1.8em; position: absolute;  }
+
+footer { clear: left; text-align: right; border-top: 1px solid #ccc; padding-top: 0.5em; margin: 2em 0; }
+footer a { color: #999; font-size: 0.7em; font-style: italic; }
+footer a:hover { color: #666; }
+
+#sources { margin-top: 2em; }
+#sources li { font-size: 2em; background-color: #eee; padding: 0.6em; }
+#sources li:hover { background-color: #ccc; }
+#sources li:hover a { color: black;}

data/public/css/reset.css

@@ -0,0 +1,58 @@
+/* http://meyerweb.com/eric/tools/css/reset/ */
+/* v1.0 | 20080212 */
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td, 
+nav, aside, figure, header, article {
+	margin: 0;
+	padding: 0;
+	border: 0;
+	outline: 0;
+	font-size: 100%;
+	vertical-align: baseline;
+	background: transparent;
+}
+body {
+	line-height: 1;
+}
+ol, ul {
+	list-style: none;
+}
+blockquote, q {
+	quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+	content: '';
+	content: none;
+}
+
+/* remember to define focus styles! */
+:focus {
+	outline: 0;
+}
+
+/* remember to highlight inserts somehow! */
+ins {
+	text-decoration: none;
+}
+del {
+	text-decoration: line-through;
+}
+
+/* tables still need 'cellspacing="0"' in the markup */
+table {
+	border-collapse: collapse;
+	border-spacing: 0;
+}
+
+
+/* Makes HTML5 structural elements structural */
+article, aside, footer, header, nav, section {display: block;}

data/smoke-rack.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{smoke-rack}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Schwarz"]
+  s.date = %q{2009-10-21}
+  s.description = %q{Expose Smoke sources and transcode them into JSON, XML or YAML}
+  s.email = %q{ben.schwarz@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "config.ru",
+     "examples/smoke-source.rb",
+     "lib/smoke-rack.rb",
+     "public/css/base.css",
+     "public/css/reset.css",
+     "smoke-rack.gemspec",
+     "spec/smoke-rack_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/source.rb",
+     "views/index.haml",
+     "views/layout.haml",
+     "views/usage.haml"
+  ]
+  s.homepage = %q{http://github.com/benschwarz/smoke-rack}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{smoke-rack}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Expose Smoke sources and transcode them into JSON, XML or YAML}
+  s.test_files = [
+    "spec/smoke-rack_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/source.rb",
+     "examples/smoke-source.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<smoke>, ["= 0.5.16"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<smoke>, ["= 0.5.16"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<smoke>, ["= 0.5.16"])
+  end
+end

data/spec/smoke-rack_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SmokeRack" do
+  include Rack::Test::Methods
+
+  def app
+    Smoke::Rack
+  end
+    
+  it "renders the index" do
+    get '/smoke'
+    last_response.should be_ok
+  end
+  
+  it "should list the sources" do
+    get '/smoke'
+    last_response.body.should include "<a href=\"/smoke/github\">github</a>"
+  end
+  
+  describe "github source" do
+    it "should be okay" do
+      get '/smoke/github'
+      last_response.should be_ok
+    end
+    
+    describe "formats" do
+      %w(json yaml xml).each do |format|
+        it "should be okay serving #{format}" do
+          get "/smoke/github.#{format}"
+          last_response.should be_ok
+        end
+        
+        it "should serve using the correct content_type" do
+          get "/smoke/github.#{format}"
+          last_response.content_type.should include(format)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+require 'rack/test'
+
+gem 'smoke', '>= 0.5.16'
+require 'smoke'
+require 'support/source'
+require 'smoke-rack'
+
+set :environment, :test
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/support/source.rb

@@ -0,0 +1,16 @@
+Smoke.configure do |c|
+  c[:cache][:enabled] = true
+  c[:cache][:store] = :memory
+  c[:cache][:expire_in] = 1800
+end
+
+Smoke.data(:github) do
+  url "http://github.com/api/v2/json/repos/show/benschwarz"
+  path :repositories
+  
+  emit do
+    sort :watchers
+    reverse
+    truncate 5
+  end
+end

data/views/index.haml

@@ -0,0 +1,18 @@
+%header
+  %h1 smoke-rack
+  %h2 Put more smoke in the air than the chinese at new years
+
+%p Smoke::Rack allows you to expose Smoke sources and transcode them into JSON, XML or YAML.  
+
+%section#sources
+  - if @sources.empty?
+    %p 
+    You don't have any sources specified yet, maybe checkout the 
+    %a{:href => "http://github.com/benschwarz/smoke"} Smoke readme
+    to get started
+  - else
+    %ul
+      - @sources.each do |source|
+        %li
+          %a{:href => "/smoke/#{source}"}= source
+  %h2

data/views/layout.haml

@@ -0,0 +1,20 @@
+!!!
+%html{:lang => "en"}
+  %head
+    %meta{"http-equiv" => 'Content-Type', :content => 'text/html; charset=utf-8'}
+    %meta{:name => "author", :content => "Ben Schwarz"}
+
+    /[if IE]
+      %script{:src => " http://html5shiv.googlecode.com/svn/trunk/html5.js"}
+
+    %title Smoke::Rack
+    %link{:rel => "stylesheet", :href => "/css/reset.css", :type => "text/css", :media => "screen"}
+    %link{:rel => "stylesheet", :href => "/css/base.css", :type => "text/css", :media => "screen"}
+    
+  %body
+    %section#container
+      = yield
+    
+      %footer
+        %a{:href => "http://github.com/benschwarz/smoke-rack", :title => "Smoke::Rack on Github"} Smoke::Rack on Github
+      

data/views/usage.haml

@@ -0,0 +1,22 @@
+%header
+  %a.back{:href => "/smoke"} « Back to docs
+  %h1= @source
+  %h2 Try these neat examples in your console
+
+- %w(json yaml xml).each do |format|
+  %h2= "In #{format.upcase}"
+  %pre
+    %code= "curl -i http://#{env["HTTP_HOST"]}/smoke/#{@source}.#{format}"
+- if Smoke.send(@source).requirements.any? 
+  %h2 Requirements
+  %p 
+    You must set these properties before calling
+    %code output.
+    This can be done by adding query strings to your get requests.
+  - Smoke.send(@source).requirements.each do |requirement|
+    %li
+      = requirement.to_s
+      %pre
+        %code= "http://#{env["HTTP_HOST"]}/smoke/#{@source}.(json|yaml|xml)?#{requirement}=string"
+  
+  

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: smoke-rack
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Schwarz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: smoke
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.5.16
+    version: 
+description: Expose Smoke sources and transcode them into JSON, XML or YAML
+email: ben.schwarz@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- config.ru
+- examples/smoke-source.rb
+- lib/smoke-rack.rb
+- public/css/base.css
+- public/css/reset.css
+- smoke-rack.gemspec
+- spec/smoke-rack_spec.rb
+- spec/spec_helper.rb
+- spec/support/source.rb
+- views/index.haml
+- views/layout.haml
+- views/usage.haml
+has_rdoc: true
+homepage: http://github.com/benschwarz/smoke-rack
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: smoke-rack
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Expose Smoke sources and transcode them into JSON, XML or YAML
+test_files: 
+- spec/smoke-rack_spec.rb
+- spec/spec_helper.rb
+- spec/support/source.rb
+- examples/smoke-source.rb