auser-butterfly 0.0.2 → 0.0.3

data/Manifest.txt

@@ -9,8 +9,11 @@ examples/example.json
 examples/example.yml
 lib/butterfly.rb
 lib/butterfly/adaptor_base.rb
+lib/butterfly/adaptors/favicon_adaptor.rb
 lib/butterfly/adaptors/json_file_adaptor.rb
 lib/butterfly/adaptors/yaml_file_adaptor.rb
+lib/butterfly/client.rb
+lib/butterfly/core/hash.rb
 lib/butterfly/core/string.rb
 lib/butterfly/default.rb
 lib/butterfly/request.rb
@@ -19,6 +22,9 @@ lib/butterfly/server.rb
 script/console
 script/destroy
 script/generate
+test/test_adapter_base.rb
 test/test_butterfly_request.rb
+test/test_butterfly_response.rb
 test/test_butterfly_server.rb
+test/test_default.rb
 test/test_helper.rb

data/butterfly.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{butterfly}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ari Lerner"]
-  s.date = %q{2009-04-03}
+  s.date = %q{2009-04-06}
   s.default_executable = %q{flutter}
   s.description = %q{An HTTP mini server to query against modular adaptors}
   s.email = ["arilerner@mac.com"]
   s.executables = ["flutter"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
-  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "bin/flutter", "butterfly.gemspec", "examples/example.json", "examples/example.yml", "lib/butterfly.rb", "lib/butterfly/adaptor_base.rb", "lib/butterfly/adaptors/json_file_adaptor.rb", "lib/butterfly/adaptors/yaml_file_adaptor.rb", "lib/butterfly/core/string.rb", "lib/butterfly/default.rb", "lib/butterfly/request.rb", "lib/butterfly/response.rb", "lib/butterfly/server.rb", "script/console", "script/destroy", "script/generate", "test/test_butterfly_request.rb", "test/test_butterfly_server.rb", "test/test_helper.rb"]
+  s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "bin/flutter", "butterfly.gemspec", "examples/example.json", "examples/example.yml", "lib/butterfly.rb", "lib/butterfly/adaptor_base.rb", "lib/butterfly/adaptors/favicon_adaptor.rb", "lib/butterfly/adaptors/json_file_adaptor.rb", "lib/butterfly/adaptors/yaml_file_adaptor.rb", "lib/butterfly/client.rb", "lib/butterfly/core/hash.rb", "lib/butterfly/core/string.rb", "lib/butterfly/default.rb", "lib/butterfly/request.rb", "lib/butterfly/response.rb", "lib/butterfly/server.rb", "script/console", "script/destroy", "script/generate", "test/test_adapter_base.rb", "test/test_butterfly_request.rb", "test/test_butterfly_response.rb", "test/test_butterfly_server.rb", "test/test_default.rb", "test/test_helper.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://blog.xnot.org}
   s.post_install_message = %q{PostInstall.txt}
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{butterfly}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{An HTTP mini server to query against modular adaptors}
-  s.test_files = ["test/test_butterfly_request.rb", "test/test_butterfly_server.rb", "test/test_helper.rb"]
+  s.test_files = ["test/test_adapter_base.rb", "test/test_butterfly_request.rb", "test/test_butterfly_response.rb", "test/test_butterfly_server.rb", "test/test_default.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/examples/example.json

@@ -1 +1 @@
-{"server" : {"name" : "maggie", "winner" : "false", "poolparty" : {"the":"boss"}}}
+{"server" : {"name" : "maggie", "winner" : "false", "poolparty" : {"the":"popsd"}}}

data/lib/butterfly.rb

@@ -1,34 +1,27 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-module Butterfly
-  VERSION = '0.0.2' unless Butterfly.const_defined?("VERSION")
-  
-  def self.reload!
-    @reloading = true
-    butterfly_file = __FILE__
-    $LOADED_FEATURES.delete(butterfly_file)
-    ::Kernel.load butterfly_file
-    @reloading = false    
-  end
-end
-
-class Hash
-  def method_missing(m,*a,&block)
-    if has_key?(m)
-      self[m]
-    else
-      super
-    end
-  end
-end
-
-%w(rubygems thin dslify).each do |lib|
+%w(rubygems thin dslify rack/cache).each do |lib|
   require lib
 end
 
-%w(string).each {|lib| require "#{File.dirname(__FILE__)}/butterfly/core/#{lib}" }
+LOADED_FILES = []
 
-%w(default adaptor_base response request server).each do |lib|
-  require "#{File.dirname(__FILE__)}/butterfly/#{lib}"
+[
+    "core/string", "core/hash", "reloadable",
+    "default", "adaptor_base", "response", "request", "server"
+].map {|lib| require "#{File.dirname(__FILE__)}/butterfly/#{lib}" }
+  
+module Butterfly
+  include Reloadable
+  
+  VERSION = '0.0.3' unless Butterfly.const_defined?("VERSION")
+  
+  def self.register_adaptor *files
+    files.each {|f| require_reloadable_files f }
+  end
+  
+  def self.reload!
+    Butterfly.reload_files!
+  end
 end

data/lib/butterfly/adaptor_base.rb

@@ -1,5 +1,14 @@
+=begin rdoc
+  Base AdaptorBase. 
+  
+  This is the base that adaptors subclass. It contains the 4 methods (get, put, post, delete) that adaptors
+  can receive. It also handles the calling for the adaptors. Before it calls, however, it will call update_request!
+  which will call reload_data! to give basic caching, which is inherited on data. To gain access to the reload method,
+  simply overwrite reload_data! (but be sure to call super)
+=end
 module Butterfly
   class AdaptorBase
+    attr_reader :data
     
     def get(req, resp)
       raise Exception.new("Your adaptor does not support get")
@@ -31,14 +40,17 @@ module Butterfly
       env["REQUEST_URI"].gsub(/\//, '')
     end
     def update_request!
-      reload! if (Time.now.to_i - last_loaded_at >= @time_til_stale)
+      reload_data! if (Time.now.to_i - last_loaded_at >= @time_til_stale)
     end
     def last_loaded_at
       @last_loaded_at ||= Time.now.to_i
     end
-    def reload!
+    def reload_data!
       @last_loaded_at = Time.now.to_i
     end
+    def data
+      @data ||= reload_data!
+    end
   end
 end
 

data/lib/butterfly/adaptors/favicon_adaptor.rb

@@ -0,0 +1,15 @@
+=begin rdoc
+  Just a favicon adaptor so we can handle favicon requests. Not that we'll ever need to
+=end
+module Butterfly
+  class FaviconAdaptor < AdaptorBase
+
+    def initialize(o={})      
+      super
+    end
+    def get(req, resp)
+      ""
+    end
+
+  end
+end

data/lib/butterfly/adaptors/json_file_adaptor.rb

@@ -8,24 +8,36 @@ module Butterfly
       super
     end
     def get(req, resp)
-      if data.has_key?(req.params[0].to_s)
-        body = "", current_data = data  
-        req.params.each do |param|
-          current_data = current_data[param.to_s]
+      if req.params
+        if data.has_key?(req.params[0].to_s)
+          body = "", current_data = data  
+          req.params.each do |param|
+            current_data = current_data[param.to_s]
+          end
+          current_data
+        else
+          resp.fail!
+          "Not found"
         end
-        current_data
       else
-        resp.fail!
-        "Not found"
+        data
       end
     end
     
+    def post(req, resp)
+      # @data = req.post_content
+      # File.open(@file, "w+") do |f|
+      #   
+      # end
+      req.post_content
+    end
+    
     private
     
     def data
-      @data ||= reload!
+      @data ||= reload_data!
     end
-    def reload!
+    def reload_data!
       super 
       @data = JSON.parse(open(@file).read)
     end

data/lib/butterfly/adaptors/yaml_file_adaptor.rb

@@ -23,9 +23,9 @@ module Butterfly
     private
     
     def data
-      @data ||= reload!
+      @data ||= reload_data!
     end
-    def reload!
+    def reload_data!
       super 
       @data = YAML::load(open(@file).read)
     end

data/lib/butterfly/client.rb

@@ -0,0 +1,21 @@
+require "net/http"
+
+module Butterfly
+  class Client
+    
+    def self.get_from(host, port, uri)
+      resp, data = Net::HTTP.new(host, port).get(uri)
+      data
+    end
+    
+    def self.post_to(host, port, uri, data={})
+    end
+    
+    def self.put_to(host, port, uri, data={})
+    end
+    
+    def self.delete_from(host, port, uri, data={})      
+    end
+    
+  end  
+end

data/lib/butterfly/core/hash.rb

@@ -0,0 +1,11 @@
+# So we can call methods directory on the hash object
+# rather than having to call [] on it.
+class Hash
+  def method_missing(m,*a,&block)
+    if has_key?(m)
+      self[m]
+    else
+      super
+    end
+  end
+end

data/lib/butterfly/default.rb

@@ -1,19 +1,21 @@
 module Butterfly
   class Default
-    include Dslify
     
-    default_options(
-      :host => "localhost",
-      :port => 8081,
-      :time_til_stale => 10, # 10 seconds between cache updates
-      :adaptor => "JsonFile",
-      :adaptor_opts => {
-        :file => "#{File.dirname(__FILE__)}/../../examples/example"
+    def self.default_options
+      @default_options ||= {
+        :host => "0.0.0.0",
+        :port => 8081,
+        :time_til_stale => 10, # 10 seconds between cache updates
+        :adaptor => "JsonFile",
+        :env => :development,
+        :adaptor_opts => {
+          :file => "#{File.dirname(__FILE__)}/../../examples/example"
+        }
       }
-    )
+    end
     
-    def self.method_missing(m,*a,&block)
-      default_options.include?(m) ? default_options[m] : super
+    def self.method_missing m, *a, &block
+      default_options.has_key?(m) ? default_options[m] : super
     end
     
   end

data/lib/butterfly/request.rb

@@ -5,7 +5,13 @@ module Butterfly
       @env = env
     end
     def route_param
-      @route_param ||= params.shift
+      @route_param ||= params.empty? ? nil : params.shift
+    end
+    def post_data
+      @post_data ||= env["rack.input"]
+    end
+    def post_content
+      @post_content ||= post_data.read
     end
     def params
       @params ||= env["REQUEST_URI"].split("?")[0].split(".")[0].split("/").reject {|a| a.empty? }.map {|a| a.to_sym }
@@ -14,7 +20,7 @@ module Butterfly
       env["REQUEST_METHOD"].downcase.to_sym
     end
     def request_type
-      env["REQUEST_URI"].split(".")[-1]
+      env["REQUEST_URI"].split(".")[-1] rescue env["CONTENT_TYPE"] || nil
     end
   end
 end

data/lib/butterfly/server.rb

@@ -1,16 +1,17 @@
 module Butterfly
   class Server
-    attr_reader :app, :host, :port
+    attr_reader :app, :host, :port, :env
     attr_accessor :adaptor_name
     def initialize(opts={})
       @host = opts.delete(:host) || Default.host
       @port = opts.delete(:port) || Default.port
+      @env = opts.delete(:env) || Default.env
       @adaptor_opts = Default.default_options[:adaptor_opts].merge(opts)
       @app = self
     end
 
     def start!
-      Thin::Server.start(@host, @port, app)
+      at_exit {Thin::Server.start(@host, @port, app)}
     end
 
     def reload!
@@ -22,22 +23,29 @@ module Butterfly
     end
     
     def should_reload?
-      true
+      @env == :development
     end
     
     def call(env)
       reload! if should_reload?
-      
       @request = Request.new env
       @response = Response.new @request
       
-      body = get_adaptor(@request.route_param).send(:handle_call, @request, @response) rescue "Error"
-      
+      body = begin
+        get_adaptor(@request.route_param).send(:handle_call, @request, @response)
+      rescue Exception => e
+        @response.fail!
+        "Boom"        
+      end
       @response.return!(body)
     end
     
     def get_adaptor(p=Default.adaptor)
-      @adaptor ||= Butterfly.const_get("#{p.to_s.camel_case}Adaptor").new(@adaptor_opts)
+      adaptors[p] ||= Butterfly.const_get("#{p.to_s.camel_case}Adaptor").new(@adaptor_opts) #rescue raise "Error: undefined adaptor for #{@request.route_param}"
+    end
+    
+    def adaptors
+      @adaptors ||= {}
     end
   end
 end

data/test/test_adapter_base.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestAdapterBase < Test::Unit::TestCase
+  context "adaptor_base" do
+    before do
+      @ab = Butterfly::AdaptorBase.new
+      @env = {"REQUEST_URL" => "/"}
+      @response = Object.new
+    end
+    it "should raise an exception if there is no get defined" do
+      assert_raise Exception do; @ab.get(@env, @response) end
+    end
+    it "should raise an exception if there is no post defined" do
+      assert_raise Exception do; @ab.post(@env, @response) end
+    end
+    it "should raise an exception if there is no delete defined" do
+      assert_raise Exception do; @ab.delete(@env, @response) end
+    end
+    it "should raise an exception if there is no put defined" do
+      assert_raise Exception do; @ab.put(@env, @response) end
+    end
+  end
+end

data/test/test_butterfly_request.rb

@@ -20,5 +20,27 @@ class TestButterflyRequest < Test::Unit::TestCase
     it "should not explode with a ?" do
       Butterfly::Request.new(@env.merge("REQUEST_URI" => "/server/item/two?pop=dance")).params.should == [:server, :item, :two]
     end
+    it "should pull out the post data when post_data is sent" do
+      Butterfly::Request.new(@env.merge("rack.input" => "fly away")).post_data.should == "fly away"
+    end
+    it "should pull out the post data param to map the response" do
+      @req = Butterfly::Request.new(@env.merge("REQUEST_URI" => "/server/item"))
+      @req.route_param.should == :server
+      @req.params.include?(:server).should == false
+    end
+    context "request type" do
+      it "should be :get when REQUEST_METHOD == GET" do
+        Butterfly::Request.new(@env.merge("REQUEST_METHOD" => "GET")).request_method.should == :get
+      end
+      it "should be :get when REQUEST_METHOD == POST" do
+        Butterfly::Request.new(@env.merge("REQUEST_METHOD" => "POST")).request_method.should == :post
+      end
+      it "should be :get when REQUEST_METHOD == PUT" do
+        Butterfly::Request.new(@env.merge("REQUEST_METHOD" => "PUT")).request_method.should == :put
+      end
+      it "should be :get when REQUEST_METHOD == DELETE" do
+        Butterfly::Request.new(@env.merge("REQUEST_METHOD" => "DELETE")).request_method.should == :delete
+      end
+    end
   end
 end

data/test/test_butterfly_response.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestButterflyResponse < Test::Unit::TestCase
+  context "response" do
+    before do
+      @env = {
+        "REQUEST_URI" => "/.json",
+        "REQUEST_METHOD" => "get"
+      }
+      @request = Butterfly::Request.new @env
+      @response = Butterfly::Response.new  @request
+    end
+    it "should have headers, status and a body" do
+      @response.headers.should == {}
+      @response.status.should == 200
+      @response.body.should == nil
+    end
+    it "should add the response header on a json request" do
+      @response.prepare_headers.should == {"ContentType" => "application/json"}
+    end
+    it "should return an Array on to the response to return to Rack" do
+      @response.return!("hi").class.should == Array
+    end
+    it "should return a rack request (json)" do
+      req = Butterfly::Request.new(@env.merge("REQUEST_URI" => "/index.json"))
+      resp = Butterfly::Response.new req
+      resp.return!("hi").should == [200, {"ContentType" => "application/json"}, "\"hi\""]
+    end
+    it "should return a rack request (text)" do
+      req = Butterfly::Request.new(@env.merge("REQUEST_URI" => "/"))
+      resp = Butterfly::Response.new req
+      resp.return!("hi").should == [200, {"ContentType" => "text/plain"}, "hi"]
+    end
+    it "should be able to add headers" do
+      @response.add_header("foo", "bar")
+      @response.headers.should === {"foo" => "bar"}
+    end
+    it "should return a 404 when there is a fail!" do
+      @response.fail!
+      @response.return!("hi").should == [404, {"ContentType" => "application/json"}, "\"hi\""]
+    end
+  end
+end

data/test/test_default.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestDefault < Test::Unit::TestCase
+  include Butterfly
+  context "Default" do
+    
+    should "be able to have a port on the class" do
+      Default.port.should == 8081
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auser-butterfly
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ari Lerner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-03 00:00:00 -07:00
+date: 2009-04-06 00:00:00 -07:00
 default_executable: flutter
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,8 +56,11 @@ files:
 - examples/example.yml
 - lib/butterfly.rb
 - lib/butterfly/adaptor_base.rb
+- lib/butterfly/adaptors/favicon_adaptor.rb
 - lib/butterfly/adaptors/json_file_adaptor.rb
 - lib/butterfly/adaptors/yaml_file_adaptor.rb
+- lib/butterfly/client.rb
+- lib/butterfly/core/hash.rb
 - lib/butterfly/core/string.rb
 - lib/butterfly/default.rb
 - lib/butterfly/request.rb
@@ -66,8 +69,11 @@ files:
 - script/console
 - script/destroy
 - script/generate
+- test/test_adapter_base.rb
 - test/test_butterfly_request.rb
+- test/test_butterfly_response.rb
 - test/test_butterfly_server.rb
+- test/test_default.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://blog.xnot.org
@@ -97,6 +103,9 @@ signing_key:
 specification_version: 2
 summary: An HTTP mini server to query against modular adaptors
 test_files: 
+- test/test_adapter_base.rb
 - test/test_butterfly_request.rb
+- test/test_butterfly_response.rb
 - test/test_butterfly_server.rb
+- test/test_default.rb
 - test/test_helper.rb