benschwarz-smoke 0.5.10 → 0.5.13

data/README.markdown

@@ -4,7 +4,7 @@ smoke is a Ruby based DSL that allows you to query web services such as YQL, RSS
 
 These "services" can then be re-represented, sorted and filtered. Data can be collected from multiple sources, sorted via a common property, chopped up and refried. 
 
-Then you can output as a plain ruby object (or JSON)
+Then you can output as a plain ruby object or one of your other favourites (JSON, YAML, XML)
 
 ## Examples of use
 

data/Rakefile

@@ -12,11 +12,12 @@ begin
     gem.authors = ["Ben Schwarz"]
     gem.files = FileList['lib/**/*.rb', 'rdoc/**/*', '[A-Z]*', 'spec/**/*', 'vendor/**/*'].to_a
     gem.add_dependency("simple-rss", "1.2")
-    gem.add_dependency("json", "1.1.3")
+    gem.add_dependency("json", ">= 1.1.3")
     gem.add_dependency("fakeweb", "1.2.5")
-    gem.add_dependency("crack", "0.1.1")
+    gem.add_dependency("crack", ">= 0.1.1")
     gem.add_dependency("moneta", "0.6.0")
     gem.add_dependency("rest-client", "1.0.3")
+    gem.add_dependency("nokogiri", "1.3.2")
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 10
+:patch: 13
 :major: 0
 :minor: 5

data/lib/smoke.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'crack'
 require 'moneta'
 require 'restclient'
+require 'nokogiri'
 
 module Smoke  
   class << self
@@ -103,7 +104,7 @@ module Smoke
   end
 end
 
-%w(core_ext/hash core_ext/string smoke/cache smoke/request smoke/origin).each {|r| require File.join(File.dirname(__FILE__), r)}
+%w(core_ext/hash core_ext/string smoke/cache smoke/request smoke/origin smoke/output/xml).each {|r| require File.join(File.dirname(__FILE__), r)}
 
 class Object # :nodoc: 
   include Smoke

data/lib/smoke/cache.rb

@@ -17,6 +17,11 @@ module Smoke
       def enabled?
         Smoke.config[:cache][:enabled]
       end
+    
+      # Clear all your request caches
+      def clear!
+        cache.clear
+      end
   
       protected
       def cache

data/lib/smoke/origin.rb

@@ -28,9 +28,11 @@ module Smoke
         return ::JSON.generate(@items)
       when :yaml
         return YAML.dump(@items)
+      when :xml
+        return Smoke::Output::XML.generate(@name, @items)
       else
         return @items
-      end      
+      end
     end
     
     def items=(response) # :nodoc:
@@ -225,7 +227,7 @@ module Smoke
     
     private
     def prepare!
-      @prepare.each{|p| p.call } unless @prepare.nil?
+      @prepare.each{|block| block.call} unless @prepare.empty?
     end
     
     def transform!

data/lib/smoke/output/xml.rb

@@ -0,0 +1,23 @@
+module Smoke
+  module Output
+    class XML
+      def self.generate(tree_name, items)
+        builder = Nokogiri::XML::Builder.new do |xml|
+            xml.send(tree_name) {
+              xml.items {
+                items.each do |item|
+                  xml.item {
+                    item.each_pair do |key, value|
+                      xml.send(key, value)
+                    end
+                  }
+                end
+              }
+            }
+        end
+        
+        builder.to_xml
+      end
+    end
+  end
+end

data/lib/smoke/source/join.rb

@@ -14,6 +14,28 @@ module Smoke
         super((names << "joined").join("_").to_sym, &block)
       end
       
+      # Rename sources immediately after they've been joined together
+      # Usage:
+      #   Smoke.join(:delicious, :twitter, :flickr) do
+      #     name :web_stream
+      #   end
+      def name(rename = nil)
+        return @name if rename.nil?
+        Smoke.rename(@name => rename)
+      end
+      
+      def method_missing(symbol, *args, &block)
+        ivar = "@#{symbol}"
+
+        unless args.empty?
+          sources.each do |source| 
+            source.last.instance_variable_set(ivar, args.last)
+          end
+        end
+
+        return self
+      end
+      
       protected
       def sources
         Smoke.active_sources.find_all{|k, v| @names.include?(k) }
@@ -22,6 +44,7 @@ module Smoke
       def dispatch
         # Recall dispatch
         sources.each do |source|
+          source.last.send(:prepare!)
           source.last.send(:dispatch) if source.last.respond_to?(:dispatch)
         end
         

data/spec/smoke/cache_spec.rb

@@ -6,9 +6,13 @@ describe Smoke::Cache do
       Smoke::Cache.should respond_to(:fetch)
     end
     
-    it "should responsd to enabled?" do
+    it "should respond to enabled?" do
       Smoke::Cache.should respond_to(:enabled?)
     end
+    
+    it "should respond to clear!" do
+      Smoke::Cache.should respond_to(:clear!)
+    end
   end
   
   describe "configuration" do
@@ -41,7 +45,7 @@ describe Smoke::Cache do
     end
   end
   
-  describe "caching my block" do
+  describe "caching my request" do
     before :all do
       Smoke.configure do |c| 
         c[:cache][:enabled] = true
@@ -71,5 +75,10 @@ describe Smoke::Cache do
       Smoke::Cache.fetch @url, {}
       @store['33af9f13054e64520430f7a437cdd377'].should_not be_nil
     end
+    
+    it "should be cleared" do
+      Smoke::Cache.clear!
+      @store['33af9f13054e64520430f7a437cdd377'].should be_nil
+    end
   end
 end

data/spec/smoke/output/xml_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
+
+describe Smoke::Output::XML do
+  before do
+    @tree = "tree"
+    @items = [{:animal => "monkey"}]
+    @xml = Smoke::Output::XML.generate(@tree, @items)
+    @document = Nokogiri::XML(@xml)
+  end
+  
+  it "should respond to generate" do
+    Smoke::Output::XML.should respond_to(:generate)
+  end
+  
+  it "should start the tree off with a named key" do
+    @document.css("tree").should_not be_nil
+  end
+  
+  it "should contain items" do
+    @document.css("items").each do |item|
+      item.content.should =~ /monkey/
+    end
+  end
+end

data/spec/smoke/source/join_spec.rb

@@ -11,15 +11,14 @@ describe "Join" do
     before do
       @source = Smoke.join(:a, :b)
     end
-    
-    # it_should_behave_like "all sources"
-    
+        
     it "should be named in a_b_joined" do
       Smoke[:a_b_joined].should be_an_instance_of(Smoke::Source::Join)
     end
     
     it "should contain items from sources a and b" do
       Smoke[:a_b_joined].output.size.should == (@source_a.output.size + @source_b.output.size)
+      Smoke[:a_b_joined].output.first.should == @source_a.output.first
     end
     
     it "should accept a block" do
@@ -34,6 +33,20 @@ describe "Join" do
       Smoke[:a_b_joined].should respond_to(:output)
     end
     
+    describe "renaming, within a block" do
+      it "should respond to name" do
+        Smoke[:a_b_joined].should respond_to(:name)
+      end
+      
+      it "should rename the source" do      
+        Smoke.join(:b, :c) do
+          name :bee_and_cee
+        end
+        
+        Smoke[:bee_and_cee].should_not be_nil
+      end
+    end
+        
     describe "dispatching" do
       before :all do
         FakeWeb.register_uri("http://photos.tld", :response => File.join(SPEC_DIR, 'supports', 'flickr-photo.json'))
@@ -48,6 +61,36 @@ describe "Join" do
         Smoke[:should_dispatch].should_receive(:dispatch)
         Smoke.join(:a, :should_dispatch).output
       end
+      
+      it "should call prepare blocks before dispatching" do
+        Smoke.data(:prepare_dispatch) do
+          prepare do
+            url "http://photos.tld"
+          end
+          
+          path :photos, :photo
+        end
+
+        Smoke.join(:prepare_dispatch) do
+          name :always_be_prepared
+        end
+        
+        lambda { Smoke.always_be_prepared.output }.should_not raise_error(ArgumentError)
+      end
+    end
+    
+    describe "variable injection" do
+      before :all do
+        TestSource.source :variable
+        TestSource.source :injection
+        Smoke.join(:variable, :injection)
+      end
+      
+      it "should inject variables to its source items" do
+        Smoke.variable_injection_joined.some_ivar("value")
+        Smoke.variable.some_ivar.should == "value"
+        Smoke.injection.some_ivar.should == "value"
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benschwarz-smoke
 version: !ruby/object:Gem::Version 
-  version: 0.5.10
+  version: 0.5.13
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-12 00:00:00 -07:00
+date: 2009-09-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,7 +28,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 1.1.3
     version: 
@@ -48,7 +48,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 0.1.1
     version: 
@@ -72,6 +72,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.3
     version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+    version: 
 description: 
 email: ben.schwarz@gmail.com
 executables: []
@@ -91,6 +101,7 @@ files:
 - lib/smoke.rb
 - lib/smoke/cache.rb
 - lib/smoke/origin.rb
+- lib/smoke/output/xml.rb
 - lib/smoke/request.rb
 - lib/smoke/source/data.rb
 - lib/smoke/source/feed.rb
@@ -119,6 +130,7 @@ files:
 - spec/core_ext/hash_spec.rb
 - spec/smoke/cache_spec.rb
 - spec/smoke/origin_spec.rb
+- spec/smoke/output/xml_spec.rb
 - spec/smoke/request_spec.rb
 - spec/smoke/shared_spec.rb
 - spec/smoke/source/data_spec.rb
@@ -138,6 +150,7 @@ files:
 - spec/supports/test_source.rb
 has_rdoc: false
 homepage: http://github.com/benschwarz/smoke
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -158,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: smoke is a Ruby based DSL that allows you to query web services such as YQL, RSS / Atom and JSON or XML in an elegant manner.
@@ -166,6 +179,7 @@ test_files:
 - spec/core_ext/hash_spec.rb
 - spec/smoke/cache_spec.rb
 - spec/smoke/origin_spec.rb
+- spec/smoke/output/xml_spec.rb
 - spec/smoke/request_spec.rb
 - spec/smoke/shared_spec.rb
 - spec/smoke/source/data_spec.rb