benschwarz-smoke 0.2.4 → 0.3.4

data/README.markdown

@@ -56,8 +56,8 @@ Integrity [is running for smoke](http://integrity.ffolio.net/smoke)
 
 ### TODO (working on, just mental notes)
 
-* Clean up / simplify source activation process
-* Consider variable injection (eg, allow to query sending a username within some aspect of the request)
+* Joined sources require a call to dispatch when their parent calls output
+* Sources that are renamed also need their @name's renaming
 * Implement a disaptch / request method that will actually thread property (event-machine)
 * Checkout experimental fakeweb version to stub out the yql specs
 

data/VERSION.yml

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

data/lib/smoke/origin.rb

@@ -5,7 +5,7 @@ module Smoke
     def initialize(name, &block)
       raise StandardError, "Sources must have a name" unless name
       @name = name
-      @items, @transformation = [], []
+      @items, @prepare, @transformation = [], [], []
 
       activate!
       instance_eval(&block) if block_given?
@@ -19,22 +19,23 @@ module Smoke
     #   output(:json)
     #   => "[{title: \"Ray\"}, {title: \"Peace\"}]"
     def output(type = :ruby)
+      prepare!
       dispatch if respond_to? :dispatch
       output = (@items.length == 1) ? @items.first : @items
       
       case type
-      when :ruby
-        return output
       when :json
         return ::JSON.generate(output)
       when :yaml
         return YAML.dump(output)
+      else
+        return output
       end      
     end
     
     def items=(items) # :nodoc:
       @items = items.flatten.map{|i| i.symbolize_keys! }
-      invoke_transformation
+      transform!
     end
     
     # Path allows you to traverse the tree of a the items returned to 
@@ -68,7 +69,39 @@ module Smoke
     #     rename(:href => :link)
     #   end 
     def emit(&block)
-      @transformation << DelayedBlock.new(&block)
+      @transformation << block
+    end
+    
+    # Prepare is used when you'd like to provision for 
+    # arguments / variables to be set after the source definition.
+    # Eg, create a source definition for twitter, omitting the "username".
+    # Set the username using chaining later.
+    # 
+    # Usage:
+    #   # Definition
+    #   Smoke.feed :twitter do
+    #     prepare do
+    #       url "http://twitter.com/#{username}/rss"
+    #     end
+    #   end
+    #   
+    #   # End use
+    #   Smoke[:twitter].username(:benschwarz).output
+    def prepare(&block)
+      raise ArgumentError, "requires a block" unless block_given?
+      @prepare << block
+    end
+    
+    def method_missing(symbol, *args, &block)
+      ivar = "@#{symbol}"
+      
+      if args.empty?
+        return instance_variable_get(ivar) || super  
+      else
+        instance_variable_set(ivar, args.pop)
+      end
+
+      return self
     end
 
     # Re-sort items by a particular key
@@ -134,8 +167,12 @@ module Smoke
     end
     
     private
-    def invoke_transformation
-      @transformation.each{|t| t.execute! } unless @transformation.nil?
+    def prepare!
+      @prepare.each{|p| p.call } unless @prepare.nil?
+    end
+    
+    def transform!
+      @transformation.each{|t| t.call } unless @transformation.nil?
     end
     
     def drill(*path)

data/lib/smoke/source/data.rb

@@ -1,42 +1,34 @@
 module Smoke
-  module Source # :nodoc:
-    module Data # :nodoc:
-      Smoke.register(Smoke::Source::Data)
-      
-      def data(name, &block)
-        Data.new(name, &block)
+  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
+
+      def url(source_url)
+        @url = source_url
       end
       
-      # 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
-        
-        def url(source_url)
-          @url = source_url
-        end
-        
-        protected
-        def dispatch
-          @request = Smoke::Request.new(@url)
-          self.items = (@path.nil?) ? @request.body : drill(@request.body, *@path)
-        end
+      protected
+      def dispatch
+        @request = Smoke::Request.new(@url)
+        self.items = (@path.nil?) ? @request.body : drill(@request.body, *@path)
       end
     end
   end

data/lib/smoke/source/feed.rb

@@ -1,31 +1,23 @@
 module Smoke
   module Source # :nodoc:
-    module Feed # :nodoc:
-      Smoke.register(Smoke::Source::Feed)
+    # 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 feed(name, &block)
-        Feed.new(name, &block)
+      def url(feed_uri)
+        (@feeds ||= [] ) << feed_uri
       end
       
-      # 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) }
-          self.items = @requests.map{|r| ::SimpleRSS.parse(r.body).items }.flatten
-        end
+      protected
+      def dispatch
+        @requests = @feeds.map{|f| Smoke::Request.new(f, :raw_response) }
+        self.items = @requests.map{|r| ::SimpleRSS.parse(r.body).items }.flatten
       end
     end
   end

data/lib/smoke/source/yql.rb

@@ -1,92 +1,84 @@
 module Smoke
-  module Source # :nodoc:
-    module YQL # :nodoc:
-      Smoke.register(Smoke::Source::YQL)
+  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
       
-      def yql(name, &block)
-        YQL.new(name, &block)
+      # 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.to_s
+      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
       
-      # YQL will call to Yahoo YQL services
+      # `use` can be used to set the url location of the data-table
+      # that you want YQL to search upon
       #
       # 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.to_s
-        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 = [(@path.nil?) ? @request.body : drill(@request.body, *@path)]
-        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
+      #   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 = [(@path.nil?) ? @request.body : drill(@request.body, *@path)]
+      end
+      
+      private
+      def build_uri
+        chunks = []
+        default_opts = {
+          :q => build_query,
+          :format => "json"
+        }.merge(params).each {|k,v| chunks << "#{k}=#{v}" }
         
-        def build_query
-          "SELECT #{@select} FROM #{@from} WHERE #{@where.join(" AND ")}"
-        end
+        return URI.encode(API_BASE + "?" + chunks.join("&"))
+      end
+      
+      def build_query
+        "SELECT #{@select} FROM #{@from} WHERE #{@where.join(" AND ")}"
       end
     end
   end

data/lib/smoke.rb

@@ -5,28 +5,16 @@ require 'json'
 require 'crack'
 require 'simple-rss'
 
-
 $:<< File.join(File.dirname(__FILE__))
 
 # Core ext
 require 'core_ext/hash.rb'
 
 module Smoke  
-  class << self 
-    
+  class << self
     @@active_sources = {}
     attr_reader :active_sources
     
-    # Smoke sources can invoke access to themselves
-    # via the register method:
-    #
-    #   Smoke.register(Smoke::Source::YQL)
-    #
-    # Check the supplied sources for usage
-    def register(mod)
-      class_eval { include mod }
-    end
-    
     # Access registered smoke source instances
     #
     # Usage:
@@ -34,7 +22,7 @@ module Smoke
     #     Smoke.yql(:ruby) do ....
     #
     #     Smoke[:ruby]
-    #     => #<Smoke::Source::YQL::YQL:0x18428d4...
+    #     => #<Smoke::Source::YQL::0x18428d4...
     def [](source)
       active_sources[source]
     end
@@ -49,11 +37,13 @@ module Smoke
       return source
     end
     
+    # Activates new instances of sources
+    # Source instances are stored within the 
+    # @@active_sources class variable for later use
     def activate(name, source)
       if active_sources.has_key?(name)
         Smoke.log.warn "Smoke source activation: Source with idential name already initialized" 
       end
-      
       active_sources.update({ name => source })
     end
     
@@ -77,9 +67,13 @@ module Smoke
     #   Smoke.log.error "message"
     #   Smoke.log.warn "message"
     def log
-      @logger ||= Logger.new($stdout)
+      @@log ||= Logger.new($stdout)
     end
     
+    def yql(name, &block); Smoke::Source::YQL.new(name, &block); end
+    def data(name, &block); Smoke::Source::Data.new(name, &block); end
+    def feed(name, &block); Smoke::Source::Feed.new(name, &block); end
+    
     private
     def get_sources(sources = [])
       active_sources.find_all{|k, v| sources.include?(k) }
@@ -89,7 +83,6 @@ end
 
 require 'smoke/request'
 require 'smoke/origin'
-require 'smoke/delayed_block'
 
 class Object # :nodoc: 
   include Smoke

data/spec/smoke/origin_spec.rb

@@ -97,9 +97,64 @@ describe Smoke::Origin do
     TestSource.source(:chain).sort(:header).should_not raise_error("NoMethodError")
   end
   
-  describe "variable injection" do
-    it "should allow variables to be left happlessly in your source definitions"
-    it "should allow setting of variables"
-    it "should error if output is called before a variable has been set"
+  describe "preperation" do
+    before :all do
+      @source = TestSource.source(:preperation)
+    end
+    
+    it "should respond to prepare" do
+      @source.should respond_to(:prepare)
+    end
+    
+    it "should require a block" do
+      lambda { @source.prepare }.should raise_error
+      lambda { @source.prepare {} }.should_not raise_error
+    end
+    
+    describe "call order" do
+      before :all do
+        @url = "http://domain.tld/benschwarz/feed"
+        FakeWeb.register_uri(@url, :response => File.join(SPEC_DIR, 'supports', 'flickr-photo.json'))
+        
+        Smoke.data :feed_preperation_call_order do
+          prepare do 
+            url "http://domain.tld/#{username}/feed"
+          end
+          
+          path :photos, :photo
+        end
+      end
+      
+      describe "before setting variables" do
+        it "should fail" do
+          lambda { Smoke[:feed_preperation_call_order].output }.should raise_error(NameError)
+        end
+      end
+      
+      describe "setting abstract properties" do
+        it "should not respond to a property that hasn't been set" do
+          lambda { Smoke[:feed_preperation_call_order].abstract }.should raise_error(NoMethodError)
+        end
+        
+        it "should allow setting a property" do
+          lambda { Smoke[:feed_preperation_call_order].abstract(:value) }.should_not raise_error(NoMethodError)
+          Smoke[:feed_preperation_call_order].abstract.should == :value
+        end
+        
+        it "should chain the source when setting a property" do
+          Smoke[:feed_preperation_call_order].abstract(:value).should be_an_instance_of(Smoke::Source::Data)
+        end
+      end
+      
+      describe "after setting variables" do
+        it "should output successfully" do
+          lambda { Smoke[:feed_preperation_call_order].username("benschwarz").output }.should_not raise_error
+        end
+        
+        it "should have used the correct url" do
+          Smoke[:feed_preperation_call_order].request.uri.should == @url
+        end
+      end
+    end
   end
 end

data/spec/smoke/source/data_spec.rb

@@ -12,7 +12,7 @@ describe "'Data' source" do
   end
   
   it "should have been activated" do
-    Smoke[:photos].should(be_an_instance_of(Smoke::Source::Data::Data))
+    Smoke[:photos].should(be_an_instance_of(Smoke::Source::Data))
   end
   
   it "should be a list of things" do

data/spec/smoke/source/feed_spec.rb

@@ -16,7 +16,7 @@ describe "Feed" do
   
   
   it "should have been activated" do
-    Smoke[:slashdot].should(be_an_instance_of(Smoke::Source::Feed::Feed))
+    Smoke[:slashdot].should(be_an_instance_of(Smoke::Source::Feed))
   end
   
   it "should be a list of things" do

data/spec/smoke/source/yql_spec.rb

@@ -19,7 +19,7 @@ describe "YQL" do
   end
   
   it "should have been activated" do
-    Smoke[:search].should(be_an_instance_of(Smoke::Source::YQL::YQL))
+    Smoke[:search].should(be_an_instance_of(Smoke::Source::YQL))
   end
   
   it "should be a list of things" do
@@ -31,8 +31,18 @@ describe "YQL" do
       Smoke[:search].output
     end
     
-    it "should hold the url used to query" do
-      Smoke[:search].request.uri.should == "http://query.yahooapis.com/v1/public/yql?q=SELECT%20*%20FROM%20search.web%20WHERE%20query%20=%20'ruby'&format=json"
+    describe "url" do
+      it "should contain the base uri for yql" do
+        Smoke[:search].request.uri.should =~ /^http:\/\/query.yahooapis.com\/v1\/public\/yql?/
+      end
+      
+      it "should be format=json" do
+        Smoke[:search].request.uri.should include("format=json")
+      end
+      
+      it "should contain the query" do
+        Smoke[:search].request.uri.should include("SELECT%20*%20FROM%20search.web%20WHERE%20query%20=%20'ruby'")
+      end
     end
     
     it "should have renamed url to link" do

data/spec/smoke_spec.rb

@@ -7,20 +7,6 @@ describe Smoke do
     @source_c = TestSource.source :c
   end
   
-  describe "registration" do
-    before do
-      Smoke.register(Smoke::SecretSauce) # defined in supports/mayo.rb
-    end
-    
-    it "should allow sources to register themselves" do
-      Smoke.included_modules.should include(SecretSauce)
-    end
-    
-    it "should have an instance method of 'mayo'" do
-      Smoke.instance_methods.should include("mayo")
-    end
-  end
-  
   describe "joining" do
     before do
       @joined = Smoke.join(:a, :b)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: benschwarz-smoke
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-31 00:00:00 -07:00
+date: 2009-06-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,6 @@ files:
 - lib/core_ext
 - lib/core_ext/hash.rb
 - lib/smoke
-- lib/smoke/delayed_block.rb
 - lib/smoke/origin.rb
 - lib/smoke/request.rb
 - lib/smoke/source

data/lib/smoke/delayed_block.rb

@@ -1,9 +0,0 @@
-class DelayedBlock # :nodoc:
-  def initialize(&block)
-    @block = block
-  end
-
-  def execute!
-    @block.call
-  end
-end