smoke 0.5.17 → 0.5.19

data/README.markdown

@@ -14,6 +14,7 @@ Then you can output as a plain ruby object or one of your other favourites (JSON
 
 ## Media
 
+* [Presentation from Webjam11 in Perth](http://www.slideshare.net/benschwarz/how-to-reinterpret-the-web-in-180-seconds)
 * [Presentation from Melbourne #roro](http://www.slideshare.net/benschwarz/smoke-1371124)
 * Early [screencast](http://vimeo.com/4272804) to get developer / peer feedback
 
@@ -77,11 +78,10 @@ Execution:
 
 
 ### TODO (working on, just mental notes)
-#### Later / maybe
-* YQL w/oAuth
-* YQL Subqueries?
-* Implement basic auth for sources
-
+* Items returned from smoke to be Hashie "rich" objects
+* Output as a web feed (atom, rss)
+  * How to push through values like "author"?
+  * Passing modified time headers through to the atom formatter
 
 #### For wiki pages (docs, later)
 * Document all sources with their irrespective differential methods

data/Rakefile

@@ -18,6 +18,7 @@ begin
     gem.add_dependency("moneta", "0.6.0")
     gem.add_dependency("rest-client", "1.0.3")
     gem.add_dependency("nokogiri", "1.3.2")
+    gem.add_dependency("registry", ">=0.1.2")
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 rescue LoadError

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 17
+:minor: 5
+:patch: 19
 :major: 0
 :build: 
-:minor: 5

data/lib/core_ext/array.rb

@@ -0,0 +1,12 @@
+class Array # :nodoc: 
+  
+  # Thanks merb!
+  def symbolize_keys!
+    each do |k,v| 
+      sym = k.respond_to?(:to_sym) ? k.to_sym : k 
+      self[sym] = Hash === v ? v.symbolize_keys! : v 
+      delete(k) unless k == sym
+    end
+    self
+  end
+end

data/lib/smoke.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'digest/md5'
+require 'yaml'
 
 require 'simple-rss'
 require 'json'
@@ -7,8 +8,11 @@ require 'crack'
 require 'moneta'
 require 'restclient'
 require 'nokogiri'
+require 'registry'
 
-module Smoke  
+module Smoke
+  class NotRegistered < StandardError; end
+   
   class << self
     @@active_sources = {}
     @@config = {
@@ -22,6 +26,15 @@ module Smoke
       }
     }
     
+    def root
+      File.join(File.dirname(__FILE__))
+    end
+    
+    def version
+      @@version ||= YAML::load(File.read("#{root}/../VERSION.YML"))
+      "#{@@version[:major]}.#{@@version[:minor]}.#{@@version[:patch]}"
+    end
+    
     # Access registered smoke source instances
     #
     # Define your source:
@@ -39,6 +52,8 @@ module Smoke
     # Usage:
     #   Smoke.twitter(:username => "benschwarz")
     def method_missing(sym, args = {})
+      raise NotRegistered, "Smoke source not registered" if self[sym].nil?
+      
       args.each_pair {|k, v| self[sym].send(k, v) }
       self[sym]
     end
@@ -47,8 +62,8 @@ module Smoke
     # 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" 
+      if active_sources.key?(name)
+        Smoke.log.warn "Smoke source activation: Source with identical name already initialized" 
       end
       active_sources.update({ name => source })
     end
@@ -115,15 +130,11 @@ module Smoke
     #   end
     def join(*names, &block); Smoke::Join.new(names, &block); end
   end
+  
+  autoload :YQL, "smoke/source/yql"
+  autoload :Data, "smoke/source/data"
+  autoload :Feed, "smoke/source/feed"
+  autoload :Join, "smoke/source/join"
 end
 
-%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)}
-
-# Autoload the source classes
-%w(YQL Data Feed Join).each do |r|
-  Smoke.autoload(r.to_sym, File.join(File.dirname(__FILE__), "smoke", "source", r.downcase))
-end
-
-class Object # :nodoc: 
-  include Smoke
-end
+Dir["#{File.dirname(__FILE__)}/{core_ext,smoke,smoke/transformers}/*.rb"].each {|r| require r}

data/lib/smoke/cache.rb

@@ -39,8 +39,8 @@ module Smoke
       
       def query(uri, options)
         request = RestClient.get(uri, options)
-        write(uri, request, request.headers[:content_type]) if enabled?
-        {:body => request, :content_type => request.headers[:content_type]}
+        write(uri, request, request.headers) if enabled?
+        {:body => request, :headers => request.headers}
       end
       
       def read(uri)
@@ -48,8 +48,8 @@ module Smoke
         return cache[key]
       end
       
-      def write(uri, body, content_type)
-        store = {:body => body, :content_type => content_type}
+      def write(uri, body, headers)
+        store = {:body => body, :headers => headers}
         self.cache.store(generate_key(uri), store, :expire_in => Smoke.config[:cache][:expiry])
       end
   

data/lib/smoke/origin.rb

@@ -1,5 +1,7 @@
 module Smoke
   class Origin
+    class UnavailableFormat < StandardError; end
+    
     attr_reader :items, :requirements, :exposed
     attr_accessor :name
     
@@ -13,7 +15,7 @@ module Smoke
       instance_eval(&block) if block_given?
     end
     
-    # Output your items in a range of formats (:ruby, :json and :yaml currently)
+    # Output your items in a range of formats (:ruby, :json, :xml and :yaml currently)
     # Ruby is the default format and will automagically yielded from your source
     #
     # Usage
@@ -24,16 +26,9 @@ module Smoke
       prepare!
       dispatch if respond_to? :dispatch
       
-      case type
-      when :json
-        return ::JSON.generate(@items)
-      when :yaml
-        return YAML.dump(@items)
-      when :xml
-        return Smoke::Output::XML.generate(@name, @items)
-      else
-        return @items
-      end
+      Transformer.for(type).generate(name, items)
+    rescue Registry::NotRegistered => e
+      raise UnavailableFormat, e.message
     end
     
     def items=(response) # :nodoc:

data/lib/smoke/request.rb

@@ -9,7 +9,7 @@ module Smoke
       end
     end
     
-    SUPPORTED_TYPES = %w(json xml javascript excel)
+    SUPPORTED_TYPES = %w(json xml javascript)
     @@request_options = {
       :user_agent       => Smoke.config[:user_agent],
       :accept_encoding  => "gzip, deflate"
@@ -30,7 +30,7 @@ module Smoke
     def dispatch
       get = Smoke::Cache.fetch @uri, @@request_options
       @body = get[:body]
-      @content_type = get[:content_type]
+      @content_type = get[:headers][:content_type]
       
       parse! unless @options[:raw_response]
       
@@ -39,18 +39,9 @@ module Smoke
     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 :excel
-          # Convert the excel document into an XML document
-          doc = @body
-          ::Crack::XML.parse().symbolize_keys!
-        when :unknown
-          Smoke.log.warn "Smoke Request: Format unknown for #{@uri} (#{@content_type})"
-      end      
+      @body = Transformer.for(type).parse(body).symbolize_keys!
+    rescue Registry::NotRegistered
+      Smoke.log.warn "Smoke Request: Format unknown for #{@uri} (#{@content_type})"
     end
   end
 end

data/lib/smoke/transformer.rb

@@ -0,0 +1,7 @@
+module Smoke
+  # A class that will either transfer objects from Ruby to another format
+  # or it will parse objects into Ruby. (JSON, XML & Yaml)
+  class Transformer
+    extend Registry
+  end
+end

data/lib/smoke/transformers/json.rb

@@ -0,0 +1,15 @@
+module Smoke
+  module Transformers
+    class Json < Transformer
+      identifier :json
+    
+      def self.generate(tree_name, objects)
+        ::JSON.generate(objects)
+      end
+      
+      def self.parse(string)
+        ::Crack::JSON.parse(string)
+      end
+    end
+  end
+end

data/lib/smoke/transformers/ruby.rb

@@ -0,0 +1,11 @@
+module Smoke
+  module Transformers
+    class Ruby < Transformer
+      identifier :ruby
+    
+      def self.generate(tree_name, objects)
+        objects
+      end
+    end
+  end
+end

data/lib/smoke/{output → transformers}/xml.rb

@@ -1,23 +1,29 @@
 module Smoke
-  module Output
-    class XML
+  module Transformers
+      class XML < Transformer
+      identifier :xml
+    
       def self.generate(tree_name, items)
         builder = Nokogiri::XML::Builder.new do |xml|
           xml.items {
             items.each do |item|
               xml.item {
-                %w(id type class).each{|m| item["#{m}_".to_sym] = item.delete(m.to_sym) }
-                
+                %w(id type class fork).each{|m| item["#{m}_".to_sym] = item.delete(m.to_sym) }
+              
                 item.each do |k, v|
-                  xml.send(k, v)
+                  xml.__send__(k, v)
                 end
               }
             end
           }
         end
-        
+      
         builder.to_xml
       end
+      
+      def self.parse(string)
+        ::Crack::XML.parse(string)
+      end
     end
   end
 end

data/lib/smoke/transformers/yaml.rb

@@ -0,0 +1,15 @@
+module Smoke
+  module Transformers
+    class Yaml < Transformer
+      identifier :yml, :yaml
+      
+      def self.generate(tree_name, objects)
+        YAML.dump(objects)
+      end
+      
+      def self.parse(string)
+        YAML.load(string)
+      end
+    end
+  end
+end

data/spec/smoke/origin_spec.rb

@@ -49,6 +49,10 @@ describe Smoke::Origin do
       Smoke.test.output(:xml).should include "<?xml version=\"1.0\"?>"
     end
     
+    it "should raise a UnavailableFormat error" do
+      lambda { Smoke.test.output(:xyz) }.should raise_error(Smoke::Origin::UnavailableFormat)
+    end
+    
     describe "filtering" do
       before :all do
         TestSource.source(:keep) do

data/spec/smoke/request_spec.rb

@@ -35,6 +35,13 @@ describe Smoke::Request do
     end
   end
   
+  it "should handle direct array responses" do
+    url = "http://fake.tld/canned/twitter.json"
+    FakeWeb.register_uri(:get, url, :response => File.join(SPEC_DIR, 'supports', 'twitter_timeline.json'))
+    
+    lambda { Smoke::Request.new(url) }.should_not raise_error(NoMethodError)
+  end
+  
   describe "format returns" do
     it "should have a content type of :manual" do
       request = Smoke::Request.new(@url, :type => :manual)

data/spec/smoke/{output → transformers}/xml_spec.rb

@@ -1,18 +1,18 @@
 require File.join(File.dirname(__FILE__), "..", "..", "spec_helper.rb")
 
-describe Smoke::Output::XML do
+describe Smoke::Transformers::XML do
   before do
     @tree = :tree
     @items = [
       {:id => 1, :class => "first", :type => "mammal", :animal => "monkey"}, 
       {:id => 2, :class => "second", :type => "mammal", :animal => "elephant"}
     ]
-    @xml = Smoke::Output::XML.generate(@tree, @items)
+    @xml = Smoke::Transformers::XML.generate(@tree, @items)
     @document = Nokogiri::XML(@xml)
   end
   
   it "should respond to generate" do
-    Smoke::Output::XML.should respond_to(:generate)
+    Smoke::Transformers::XML.should respond_to(:generate)
   end
   
   it "should start the tree off with a named key" do
@@ -20,9 +20,7 @@ describe Smoke::Output::XML do
   end
   
   it "should contain items" do
-    @document.css("items").each do |item|
-      item.content.should =~ /monkey/
-    end
+    @document.css("item").size.should == 2
   end
 end
 

data/spec/smoke/transformers_spec.rb

@@ -0,0 +1,35 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe Smoke::Transformer do  
+  describe "parsers" do
+    it "should respond to parse" do
+      Smoke::Transformers::Json.should respond_to(:parse)
+    end
+    
+    it "should respond to parse" do
+      Smoke::Transformers::XML.should respond_to(:parse)
+    end
+
+    it "should respond to parse" do
+      Smoke::Transformers::Yaml.should respond_to(:parse)
+    end
+  end
+  
+  describe "generators" do
+    it "should respond to generate" do
+      Smoke::Transformers::Json.should respond_to(:generate)
+    end
+    
+    it "should respond to generate" do
+      Smoke::Transformers::XML.should respond_to(:generate)
+    end
+
+    it "should respond to generate" do
+      Smoke::Transformers::Yaml.should respond_to(:generate)
+    end
+    
+    it "should respond to generate" do
+      Smoke::Transformers::Ruby.should respond_to(:generate)
+    end
+  end
+end

data/spec/smoke_spec.rb

@@ -6,6 +6,16 @@ describe Smoke do
     @source_b = TestSource.source :b
   end
   
+  it "should have a root" do
+    Smoke.should respond_to(:root)
+    Smoke.root.should be_an_instance_of(String)
+  end
+  
+  it "should have a version string" do
+    Smoke.should respond_to :version
+    Smoke.version.should be_an_instance_of(String)
+  end
+  
   describe "active sources" do
     it "should allow access to sources via an array accessor" do
       Smoke[:a].should == @source_a
@@ -17,17 +27,15 @@ describe Smoke do
     
     it "should have its name as the hash key" do
       key = Smoke.active_sources.keys.first
-      Smoke.active_sources[key].name.should == key
+      Smoke.active_sources[key].name.to_s.should == key.to_s
     end
     
-    describe "accessing via method call" do
-      it "should allow access to the sources via a method call" do
-        Smoke.a.should == @source_a 
-      end
-      
-      it "should throw an argument error when missing" do
-        Smoke.b.should raise_error(NoMethodError)
-      end
+    it "should allow access to the sources via a method call" do
+      Smoke.a.should == @source_a 
+    end
+    
+    it "should throw an error when missing" do
+      lambda { Smoke.frank }.should raise_error(Smoke::NotRegistered)
     end
     
     it "should be able to be renamed" do
@@ -40,7 +48,7 @@ describe Smoke do
       Smoke[:b].name.should == "b"
     end
   end
-  
+
   describe "configuration" do
     it "should be configurable" do
       Smoke.should respond_to(:configure)