benschwarz-smoke 0.4.1 → 0.4.2

data/README.markdown

@@ -4,6 +4,9 @@ smoke is a Ruby based DSL that allows you to take data from YQL, RSS / Atom (and
 This "data" can then be re-represented, sorted and filtered. You can collect data from a multiude of sources, sort them on a common property
 and return a plain old ruby object or json (You could add in something to output XML too)
 
+## Examples of use
+I powered [my entire site](http://www.germanforblack.com) [using smoke](http://github.com/benschwarz/benschwarz-site/blob/44de70463c744d821d3ffd2cf940e6d3e415fbdd/lib/stream.rb), until further documentation exists, this is probably a good place to start.
+
 ## Media
 
 * [Presentation from Melbourne #roro](http://www.slideshare.net/benschwarz/smoke-1371124)

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 4
-:patch: 1
+:patch: 2
 :major: 0
+:minor: 4

data/lib/smoke/cache.rb

@@ -0,0 +1,44 @@
+require 'moneta'
+require 'digest/md5'
+
+module Smoke
+  class Cache
+    class << self
+      def configure!
+        require "moneta/#{Smoke.config[:cache][:store].to_s}" if enabled?
+      rescue LoadError
+        Smoke.log.fatal "Cache store not found. Smoke uses moneta for cache stores, ensure that you've chosen a moneta supported store"
+      end
+  
+      def fetch(name, &block)
+        key = generate_key(name)
+        output = (enabled?) ? cache[key] : block.call
+        if output
+          return output
+        else
+          output = block.call
+          persist(key, output)
+        end
+    
+        return output
+      end
+  
+      def enabled?
+        Smoke.config[:cache][:enabled]
+      end
+  
+      private
+      def cache
+        Moneta.const_get(Smoke.config[:cache][:store]).send(:new, Smoke.config[:cache][:options]) 
+      end
+        
+      def persist(key, store)
+        cache.store(key, store, :expire_in => Smoke.config[:config][:cache][:expiry])
+      end
+  
+      def generate_key(key)
+        Digest::MD5.hexdigest(key)
+      end
+    end
+  end
+end

data/lib/smoke/request.rb

@@ -10,6 +10,11 @@ module Smoke
     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 = {})
@@ -18,16 +23,14 @@ module Smoke
     end
     
     private
-    def dispatch
-      opts = {
-        :user_agent       => Smoke.config[:user_agent],
-        :accept_encoding  => "gzip"
-      }
-      Thread.new {
-        request = RestClient.get(@uri, opts)
-        @content_type = request.headers[:content_type]
-        @body = request
-      }.join
+    def dispatch  
+      Smoke::Cache.fetch @uri do
+        Thread.new {
+          request = RestClient.get(@uri, @@request_options)
+          @content_type = request.headers[:content_type]
+          @body = request
+        }.join
+      end
       
       present! unless @options[:raw_response]
       

data/lib/smoke/source/yql.rb

@@ -23,6 +23,7 @@ module Smoke
       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

data/lib/smoke.rb

@@ -9,15 +9,20 @@ module Smoke
     @@active_sources = {}
     @@config = {
       :enable_logging => true,
-      :user_agent     => "Ruby/#{RUBY_VERSION}/Smoke"
+      :user_agent     => "Ruby/#{RUBY_VERSION}/Smoke",
+      :cache          => {
+        :enabled  => false,
+        :store    => :memory,
+        :options  => {},
+        :expiry   => 1800
+      }
     }
     
     # Access registered smoke source instances
     #
-    # Usage:
-    #
+    # Define your source:
     #     Smoke.yql(:ruby) do ....
-    #
+    # Then access it:
     #     Smoke[:ruby]
     #     => #<Smoke::Source::YQL::0x18428d4...
     def [](source)
@@ -66,6 +71,7 @@ module Smoke
     #
     def configure(&block)
       yield @@config
+      Smoke::Cache.configure!
     end
     
     # Access configuration options
@@ -90,7 +96,7 @@ module Smoke
   end
 end
 
-%w(core_ext/hash smoke/request smoke/origin).each {|r| require File.join(File.dirname(__FILE__), r)}
+%w(core_ext/hash smoke/cache smoke/request smoke/origin).each {|r| require File.join(File.dirname(__FILE__), r)}
 
 class Object # :nodoc: 
   include Smoke

data/spec/smoke/cache_spec.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), "..", "spec_helper.rb")
+
+describe Smoke::Cache do
+  describe "class methods" do
+    it "should respond to configure!" do
+      Smoke::Cache.should respond_to(:configure!)
+    end
+    
+    it "should respond to fetch" do
+      Smoke::Cache.should respond_to(:fetch)
+    end
+    
+    it "should responsd to enabled?" do
+      Smoke::Cache.should respond_to(:enabled?)
+    end
+  end
+  
+  describe "configuration" do
+    it "should not be enabled (by default)" do
+      Smoke::Cache.should_not be_enabled
+    end
+    
+    it "should be enabled" do
+      Smoke.configure {|c| c[:cache][:enabled] = true }
+      Smoke::Cache.should be_enabled
+    end
+    
+    it "should not be enabled" do
+      Smoke.configure {|c| c[:cache][:enabled] = false }
+      Smoke::Cache.should_not be_enabled
+    end
+    
+    describe "invalid configuration" do
+      before do
+        @kernel = mock(Kernel)
+        @kernel.stub!(:exit)
+      end
+      
+      it "should log with bad configuration" do
+        Proc.new {
+          Smoke.should_receive(:log)
+          Smoke.configure {|c| c[:cache][:store] = :ponies }
+        }
+      end
+    end
+  end
+  
+  describe "caching my block" do
+    before :all do
+      Smoke.configure {|c| c[:cache][:store] = :memory }
+    end
+  end
+end

data/spec/smoke/{source/shared_spec.rb → shared_spec.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
+require File.join(File.dirname(__FILE__), "..", "spec_helper.rb")
 
 shared_examples_for "all sources" do
   describe "transforms" do

data/spec/smoke/source/yql_spec.rb

@@ -26,6 +26,30 @@ describe "YQL" do
     Smoke[:search].items.should be_an_instance_of(Array)
   end
   
+  describe "select" do
+    before do
+      FakeWeb.register_uri("http://query.yahooapis.com:80/v1/public/yql?q=SELECT%20url%20FROM%20search.images%20WHERE%20query%20=%20'amc%20pacer'&format=json", :response => File.join(SPEC_DIR, 'supports', 'amc_pacer.json.yql'))
+      
+      Smoke.yql(:pacer) do
+        select :url
+        from "search.images"
+        where :query, "amc pacer"
+        
+        path :query, :results, :result
+      end
+      
+      Smoke[:pacer].output
+    end
+    
+    it "should query correctly" do
+      Smoke[:pacer].request.uri.should == "http://query.yahooapis.com/v1/public/yql?q=SELECT%20url%20FROM%20search.images%20WHERE%20query%20=%20'amc%20pacer'&format=json"
+    end
+    
+    it "should have urls" do
+      Smoke[:pacer].output.first.should have_key(:url)
+    end
+  end
+  
   describe "after dispatch" do
     before do
      Smoke[:search].output

data/spec/smoke_spec.rb

@@ -42,9 +42,9 @@ describe Smoke do
       end
 
       it "should allow overwriting default configurations" do
-        key = Smoke.config.keys.first
-        Smoke.configure {|c| c[key] = true }
-        Smoke.config[key].should be_true
+        key = :user_agent
+        Smoke.configure {|c| c[key] = "Smoke, dude" }
+        Smoke.config[key].should == "Smoke, dude"
       end
     end
   end

data/spec/supports/amc_pacer.json.yql

@@ -0,0 +1,10 @@
+HTTP/1.1 200 OK
+Date: Mon, 10 Aug 2009 01:32:37 GMT
+P3P: policyref="http://info.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+Access-Control-Allow-Origin: *
+Cache-Control: no-cache, private
+Content-Length: 1193
+Connection: close
+Content-Type: application/json;charset=utf-8
+
+{"query":{"count":"10","created":"2009-08-10T01:32:37Z","lang":"en-US","updated":"2009-08-10T01:32:37Z","uri":"http://query.yahooapis.com/v1/yql?q=SELECT+url+FROM+search.images+WHERE+query+%3D+%27amc+pacer%27","diagnostics":{"publiclyCallable":"true","url":{"execution-time":"222","content":"http://boss.yahooapis.com/ysearch/images/v1/amc%20pacer?format=xml&start=0&count=10"},"user-time":"225","service-time":"222","build-version":"2579"},"results":{"result":[{"url":"http://www.carrera.no/images/AMC_Pacer_01.jpg"},{"url":"http://static.flickr.com/116/308140444_549b19d604.jpg"},{"url":"http://static.flickr.com/2132/2594281582_9ea9829b46.jpg"},{"url":"http://brennerworld.blogware.com/BlogEntries/BurgerPacer.jpg"},{"url":"http://www.stationwagon.com/gallery/pictures/19xx_AMC_Pacer_limo.jpg"},{"url":"http://www.stationwagon.com/gallery/pictures/1978_AMC_Pacer.jpg"},{"url":"http://www.shorey.net/Auto/American/AMC/1975%20AMC%20Pacer_2.jpg"},{"url":"http://www.allsportauto.com/photoautre5/amc/pacer/1976_amc_pacer_15_m.jpg"},{"url":"http://www.productioncars.com/send_file.php/amc_pacer_wagon_1980.jpg"},{"url":"http://www.productioncars.com/send_file.php/amc_pacer_maroon_1975.jpg"}]}}}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benschwarz-smoke
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-06 00:00:00 -07:00
+date: 2009-08-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ files:
 - lib/core_ext
 - lib/core_ext/hash.rb
 - lib/smoke
+- lib/smoke/cache.rb
 - lib/smoke/origin.rb
 - lib/smoke/request.rb
 - lib/smoke/source
@@ -68,18 +69,20 @@ files:
 - spec/core_ext
 - spec/core_ext/hash_spec.rb
 - spec/smoke
+- spec/smoke/cache_spec.rb
 - spec/smoke/origin_spec.rb
 - spec/smoke/request_spec.rb
+- spec/smoke/shared_spec.rb
 - spec/smoke/source
 - spec/smoke/source/data_spec.rb
 - spec/smoke/source/feed_spec.rb
 - spec/smoke/source/join_spec.rb
-- spec/smoke/source/shared_spec.rb
 - spec/smoke/source/yql_spec.rb
 - spec/smoke_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/supports
+- spec/supports/amc_pacer.json.yql
 - spec/supports/datatables.yql
 - spec/supports/flickr-photo.json
 - spec/supports/gzip_response.txt
@@ -88,7 +91,7 @@ files:
 - spec/supports/slashdot.xml
 - spec/supports/test_source.rb
 - LICENSE
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/benschwarz/smoke
 licenses: 
 post_install_message: