smoke 0.0.3 → 0.5.9

data/lib/smoke/request.rb

@@ -0,0 +1,57 @@
+module Smoke
+  class Request # :nodoc:
+    class Failure < Exception # :nodoc:
+      attr_reader :uri
+      
+      def initialize(uri, msg)
+        @uri = URI.parse(uri)
+        Smoke.log.error "Smoke Request: Failed to get from #{@uri} (#{msg})"
+      end
+    end
+    
+    SUPPORTED_TYPES = %w(json xml javascript)
+    @@request_options = {
+      :user_agent       => Smoke.config[:user_agent],
+      :accept_encoding  => "gzip"
+    }
+    
+    attr_reader :uri, :content_type, :body, :type
+       
+    def initialize(uri, options = {})
+      @uri, @options = uri, options
+      dispatch
+    end
+    
+    private
+    def dispatch
+      get = Smoke::Cache.fetch @uri, @@request_options
+      @body = get[:body]
+      @content_type = get[:content_type]
+      
+      present! unless @options[:raw_response]
+      
+    rescue RestClient::Exception => e
+      Failure.new(@uri, e)
+    end
+    
+    def present!
+      set_type
+      parse!
+    end
+    
+    def set_type
+      @type =  @options[:type] || (SUPPORTED_TYPES.detect{|t| @content_type =~ /#{t}/ } || "unknown").to_sym
+    end
+    
+    def parse!
+      case @type
+        when :json, :javascript
+          @body = ::Crack::JSON.parse(@body).symbolize_keys!
+        when :xml
+          @body = ::Crack::XML.parse(@body).symbolize_keys!
+        when :unknown
+          Smoke.log.warn "Smoke Request: Format unknown for #{@uri} (#{@content_type})"
+      end      
+    end
+  end
+end

data/lib/smoke/source/data.rb

@@ -0,0 +1,39 @@
+module Smoke
+  module Source # :nodoc:    
+    # The "Data" source allows you to query
+    # datasources that are "complete" urls
+    # and rely on the automagic object parsing 
+    # that smoke provides.
+    #
+    # For example, you may use this source
+    # to query a complete restful api call
+    # unpackage the xml response and get a 
+    # clean ruby object.
+    #
+    # Data can take as many urls as you'd like
+    # to throw at it.
+    #
+    # Usage:
+    #   Smoke.data(:ruby) do
+    #     url "http://api.flickr.com/services/rest/?user_id=36821533%40N00&tags=benschwarz-site&nojsoncallback=1&method=flickr.photos.search&format=json&api_key=your_api_key_here
+    #     path :photos, :photo
+    #   end
+    class Data < Origin
+      attr_reader :request
+      
+      # The URL that you'd like smoke to source its data from
+      # You can also set the type for silly servers that don't set a correct content-type (Flickr!)
+      # Example:
+      #   url "http://site.com/resource.json", :type => :json
+      def url(source_url, options = {})
+        @url, @options = source_url, options
+      end
+      
+      protected
+      def dispatch          
+        @request = Smoke::Request.new(@url, @options)
+        self.items = @request.body
+      end
+    end
+  end
+end

data/lib/smoke/source/feed.rb

@@ -0,0 +1,24 @@
+module Smoke
+  module Source # :nodoc:
+    # Feed can take multiple rss or atom feeds and munge them up together.
+    # 
+    # Usage:
+    #   Smoke.feed(:ruby) do
+    #     url "domain.tld/rss"
+    #     url "site.tld/atom"
+    #   end
+    class Feed < Origin
+      attr_reader :requests
+      
+      def url(feed_uri)
+        (@feeds ||= [] ) << feed_uri
+      end
+      
+      protected
+      def dispatch
+        @requests = @feeds.map{|f| Smoke::Request.new(f, {:raw_response => true}) }
+        self.items = @requests.map{|r| ::SimpleRSS.parse(r.body).items }.flatten
+      end
+    end
+  end
+end

data/lib/smoke/source/join.rb

@@ -0,0 +1,33 @@
+module Smoke
+  module Source # :nodoc:
+    # The "Joiner" source is a special source
+    # that can be used to join multiple sources together
+    # and proxy call dispatch for each source
+    #
+    # Usage:
+    #   Smoke.join(:delicious, :twitter, :flickr) do
+    #     path :photos, :photo
+    #   end
+    class Join < Origin # :nodoc: 
+      def initialize(names, &block)
+        @names = names
+        super((names << "joined").join("_").to_sym, &block)
+      end
+      
+      protected
+      def sources
+        Smoke.active_sources.find_all{|k, v| @names.include?(k) }
+      end
+      
+      def dispatch
+        # Recall dispatch
+        sources.each do |source|
+          source.last.send(:dispatch) if source.last.respond_to?(:dispatch)
+        end
+        
+        # Re-map items
+        @items = sources.map {|source| source.last.items }.flatten
+      end
+    end
+  end
+end

data/lib/smoke/source/yql.rb

@@ -0,0 +1,85 @@
+module Smoke
+  module Source # :nodoc:      
+    # YQL will call to Yahoo YQL services
+    #
+    # Usage:
+    #   Smoke.yql(:ruby) do
+    #     select  :all
+    #     from    "search.web"
+    #     where   :query, "ruby"
+    #   end
+    class YQL < Origin
+      API_BASE = "http://query.yahooapis.com/v1/public/yql"
+      attr_reader :request
+      
+      # Select indicates what YQL will be selecting
+      # Usage:
+      #   select :all
+      #   => "SELECT *"
+      #   select :title
+      #   => "SELECT title"
+      #   select :title, :description
+      #   => "SELECT title, description"
+      def select(what = :all)
+        @select = what.join(",") and return if what.is_a? Array
+        @select = "*" and return if what == :all
+        @select = what and return
+      end
+      
+      # from corresponds to the from fragment of the YQL query
+      # Usage: 
+      #   from "search.web"
+      # or
+      #   from :html
+      def from(source)
+        @from = source.join(',') and return if source.is_a? Array
+        @from = source.to_s
+      end
+      
+      # where is a straight up match, no fancy matchers
+      # are currently supported
+      # Usage:
+      #   where :xpath, "//div/div/a"
+      # or
+      #   where :query, "python"
+      def where(column, value)
+        @where = @where || []
+        @where << "#{column.to_s} = '#{value}'"
+      end
+      
+      # `use` can be used to set the url location of the data-table
+      # that you want YQL to search upon
+      #
+      # Usage:
+      #   use "http://datatables.org/alltables.env"
+      def use(url)
+        params.merge!({:env => url})
+      end
+      
+      protected
+      def params 
+        @params || @params = {}
+      end
+      
+      def dispatch
+        @request = Smoke::Request.new(build_uri)
+        self.items = @request.body
+      end
+      
+      private
+      def build_uri
+        chunks = []
+        default_opts = {
+          :q => build_query,
+          :format => "json"
+        }.merge(params).each {|k,v| chunks << "#{k}=#{v}" }
+        
+        return URI.encode(API_BASE + "?" + chunks.join("&"))
+      end
+      
+      def build_query
+        "SELECT #{@select} FROM #{@from} WHERE #{@where.join(" AND ")}"
+      end
+    end
+  end
+end

data/rdoc/classes/Smoke.html

@@ -0,0 +1,260 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang='en'>
+  <head>
+    <title>: Smoke [smoke]</title>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
+    <link href='../rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
+    <script type='text/javascript'>
+      //<![CDATA[
+        function popupCode(url) {
+          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+        }
+        
+        function toggleCode(id) {
+          var code = document.getElementById(id)
+        
+          code.style.display = code.style.display != 'block' ? 'block' : 'none'
+          return true
+        }
+        
+        // Make codeblocks hidden by default
+        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
+      //]]>
+    </script>
+  </head>
+  <body class='page'>
+    <div class='class' id='wrapper'>
+      <div class='header'>
+        <h1 class='name'>
+          <span class='type'>Module</span>
+          Smoke
+        </h1>
+        <ol class='paths'>
+          <li>
+            <a href="../files/lib/smoke/request_rb.html">lib/smoke/request.rb</a>
+          </li>
+          <li class='other'>
+            <a href="../files/lib/smoke/origin_rb.html">lib/smoke/origin.rb</a>
+          </li>
+          <li class='other'>
+            <a href="../files/lib/smoke/source/data_rb.html">lib/smoke/source/data.rb</a>
+          </li>
+          <li class='other'>
+            <a href="../files/lib/smoke/source/feed_rb.html">lib/smoke/source/feed.rb</a>
+          </li>
+          <li class='other'>
+            <a href="../files/lib/smoke/source/join_rb.html">lib/smoke/source/join.rb</a>
+          </li>
+          <li class='other'>
+            <a href="../files/lib/smoke/source/yql_rb.html">lib/smoke/source/yql.rb</a>
+          </li>
+          <li class='other'>
+            <a href="../files/lib/smoke_rb.html">lib/smoke.rb</a>
+          </li>
+          <li>
+            <a class='show' href='#' onclick='this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false'>show all</a>
+          </li>
+        </ol>
+      </div>
+      <div id='content'>
+        <div id='text'>
+          <div id='method-list'>
+            <h2>Methods</h2>
+            <h3>public class</h3>
+            <ol>
+              <li><a href="#M000001">[]</a></li>
+              <li><a href="#M000002">activate</a></li>
+              <li><a href="#M000003">active_sources</a></li>
+              <li><a href="#M000007">data</a></li>
+              <li><a href="#M000008">feed</a></li>
+              <li><a href="#M000009">join</a></li>
+              <li><a href="#M000005">log</a></li>
+              <li><a href="#M000004">rename</a></li>
+              <li><a href="#M000006">yql</a></li>
+            </ol>
+          </div>
+          <div id='section'>
+            <div id='class-list'>
+              <h2>Classes and Modules</h2>
+              Class <a href="Smoke/Origin.html" class="link">Smoke::Origin</a><br />
+            </div>
+            <div id='attribute-list'>
+              <h2 class='section-bar'>Attributes</h2>
+              <div class='name-list'>
+                <table>
+                  <tr class='top-aligned-row context-row'>
+                    <td class='context-item-name'>active_sources</td>
+                    <td class='context-item-value'>[R]</td>
+                    <td class='context-item-desc'></td>
+                  </tr>
+                </table>
+              </div>
+            </div>
+            <div id='methods'>
+              <h2>Public class methods</h2>
+              <div class='public-class method' id='method-M000001'>
+                <a name='M000001'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>[]</span>
+                  <span class='arguments'>(source)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Access registered smoke source instances
+                  </p>
+                  <p>
+                  Usage:
+                  </p>
+                  <pre>Smoke.yql(:ruby) do ....&#x000A;&#x000A;Smoke[:ruby]&#x000A;=&gt; #&lt;Smoke::Source::YQL::0x18428d4...</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000001-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000001-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 26</span>&#x000A;26:     <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">source</span>)&#x000A;27:       <span class="ruby-identifier">active_sources</span>[<span class="ruby-identifier">source</span>]&#x000A;28:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000002'>
+                <a name='M000002'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>activate</span>
+                  <span class='arguments'>(name, source)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Activates new instances of sources Source instances are stored within the
+                  @@<a href="Smoke.html#M000003">active_sources</a> class variable for later
+                  use
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000002-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000002-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 33</span>&#x000A;33:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">activate</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">source</span>)&#x000A;34:       <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">active_sources</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">name</span>)&#x000A;35:         <span class="ruby-constant">Smoke</span>.<span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-value str">&quot;Smoke source activation: Source with idential name already initialized&quot;</span> &#x000A;36:       <span class="ruby-keyword kw">end</span>&#x000A;37:       <span class="ruby-identifier">active_sources</span>.<span class="ruby-identifier">update</span>({ <span class="ruby-identifier">name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">source</span> })&#x000A;38:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000003'>
+                <a name='M000003'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>active_sources</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Returns all activated smoke sources
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000003-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000003-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 41</span>&#x000A;41:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">active_sources</span>&#x000A;42:       <span class="ruby-ivar">@@active_sources</span>&#x000A;43:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000007'>
+                <a name='M000007'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>data</span>
+                  <span class='arguments'>(name, &amp;block)</span>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000007-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000007-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 65</span>&#x000A;65:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">data</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-constant">Smoke</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000008'>
+                <a name='M000008'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>feed</span>
+                  <span class='arguments'>(name, &amp;block)</span>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000008-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000008-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 66</span>&#x000A;66:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">feed</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-constant">Smoke</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Feed</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000009'>
+                <a name='M000009'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>join</span>
+                  <span class='arguments'>(*names, &amp;block)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Join multiple sources together into a single feed Usage:
+                  </p>
+                  <pre>Smoke.join(:delicious, :twitter, :flickr) do&#x000A;  name :stream&#x000A;  path :photos, :photo&#x000A;end</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000009-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000009-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 74</span>&#x000A;74:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">join</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-constant">Smoke</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">Join</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">names</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000005'>
+                <a name='M000005'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>log</span>
+                  <span class='arguments'>()</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Log for info, debug, error and warn with:
+                  </p>
+                  <pre>Smoke.log.info &quot;message&quot;&#x000A;Smoke.log.debug &quot;message&quot;&#x000A;Smoke.log.error &quot;message&quot;&#x000A;Smoke.log.warn &quot;message&quot;</pre>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000005-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000005-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 60</span>&#x000A;60:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>&#x000A;61:       <span class="ruby-ivar">@@log</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$stdout</span>)&#x000A;62:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000004'>
+                <a name='M000004'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>rename</span>
+                  <span class='arguments'>(candidates)</span>
+                </div>
+                <div class='description'>
+                  <p>
+                  Rename a source
+                  </p>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000004-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000004-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 46</span>&#x000A;46:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">rename</span>(<span class="ruby-identifier">candidates</span>)&#x000A;47:       <span class="ruby-identifier">candidates</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">o</span>, <span class="ruby-identifier">n</span><span class="ruby-operator">|</span> &#x000A;48:         <span class="ruby-identifier">active_sources</span>[<span class="ruby-identifier">o</span>].<span class="ruby-identifier">name</span> = <span class="ruby-identifier">n</span>.<span class="ruby-identifier">to_s</span>&#x000A;49:         <span class="ruby-identifier">active_sources</span>.<span class="ruby-identifier">rename</span>(<span class="ruby-identifier">o</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">n</span>)&#x000A;50:         <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">active_sources</span>[<span class="ruby-identifier">n</span>]&#x000A;51:       <span class="ruby-keyword kw">end</span>&#x000A;52:     <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+              <div class='public-class method' id='method-M000006'>
+                <a name='M000006'>      </a>
+                <div class='synopsis'>
+                  <span class='name'>yql</span>
+                  <span class='arguments'>(name, &amp;block)</span>
+                </div>
+                <div class='source'>
+                  <a class='source-toggle' href='#' onclick="toggleCode('M000006-source'); return false">
+                    [show source]
+                  </a>
+                  <pre id='M000006-source'>    <span class="ruby-comment cmt"># File lib/smoke.rb, line 64</span>&#x000A;64:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">yql</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-constant">Smoke</span><span class="ruby-operator">::</span><span class="ruby-constant">Source</span><span class="ruby-operator">::</span><span class="ruby-constant">YQL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>); <span class="ruby-keyword kw">end</span></pre>
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+      <div id='footer-push'></div>
+    </div>
+    <div id='footer'>
+      <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
+    </div>
+  </body>
+</html>