weary 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/weary/resource.rb

@@ -1,15 +1,52 @@
 module Weary
   class Resource
-    attr_reader :name
-    attr_accessor :domain, :with, :requires, :via, :format, :url, :authenticates, :follows
+    attr_accessor :name, :domain, :with, :requires, :via, :format, :url, :authenticates, :follows
     
     def initialize(name)
-      @name = name
+      self.name = name
       self.via = :get
       self.authenticates = false
       self.follows = true
       self.with = []
-      self.requires
+      self.requires = []
+    end
+    
+    def name=(resource_name)
+      resource_name = resource_name.to_s unless resource_name.is_a?(String)
+      @name = resource_name.downcase.strip.gsub(/\s/,'_')
+    end
+    
+    def via=(http_verb)
+      @via = case http_verb
+        when *Methods[:get]
+          :get
+        when *Methods[:post]
+          :post
+        when *Methods[:put]
+          :put
+        when *Methods[:delete]
+          :delete
+        else
+          raise ArgumentError, "#{http_verb} is not a supported method"
+      end
+    end
+    
+    def format=(type)
+      type = type.downcase if type.is_a?(String)
+      @format = case type
+        when *ContentTypes[:json]
+          :json
+        when *ContentTypes[:xml]
+          :xml
+        when *ContentTypes[:html]
+          :html
+        when *ContentTypes[:yaml]
+          :yaml
+        when *ContentTypes[:plain]
+          :plain
+        else
+          raise ArgumentError, "#{type} is not a recognized format."
+      end
     end
         
     def with=(params)
@@ -36,11 +73,19 @@ module Weary
     end
     
     def authenticates?
-      @authenticates == true
+      if @authenticates
+        true
+      else
+        false
+      end
     end
     
     def follows_redirects?
-      @follows == true
+      if @follows
+        true
+      else
+        false
+      end
     end
 
     def to_hash

data/lib/weary/response.rb

@@ -1,7 +1,7 @@
 module Weary
   class Response
   
-    attr_reader :raw, :method, :code, :message, :header, :content_type, :cookie, :body
+    attr_reader :raw, :method, :code, :message, :header, :content_type, :cookie, :body, :format
     alias mime_type content_type
     
     def initialize(http_response, http_method)
@@ -42,10 +42,6 @@ module Weary
       end
     end
     
-    def format
-      @format
-    end
-    
     def follow_redirect
       if redirected?
         Request.new(@raw['location'], @method).perform

data/lib/weary.rb

@@ -24,6 +24,11 @@ module Weary
               :put    => [:put, :PUT, /\bput\b/i],
               :delete => [:delete, :del, :DELETE, :DEL, /\bdelete\b/i],
               :head   => [:head, :HEAD, /\bhead\b/i] }
+  ContentTypes = { :json  => [:json, 'json', 'application/json', 'text/json', 'application/javascript', 'text/javascript'],
+                   :xml   => [:xml, 'xml', 'text/xml', 'application/xml'],
+                   :html  => [:html, 'html', 'text/html'],
+                   :yaml  => [:yaml, 'yaml', 'application/x-yaml', 'text/yaml'],
+                   :plain => [:plain, 'plain', 'text/plain'] }
   UserAgents = { } # will be a collection of user agent strings            
   
   # Weary::Query quickly performs a GET request on a URL and parses the request.
@@ -47,8 +52,8 @@ module Weary
   
   # Sets a default format to make your Requests in.
   # Defaults to JSON.
-  def as_format(format)
-    @default_format = format.to_sym
+  def as_format(format) 
+    @default_format = format
   end
   
   # Construct a URL pattern for your resources to follow.
@@ -147,8 +152,10 @@ module Weary
       if resource.via == (:post || :put)
         code << %Q{options[:body] = params unless params.empty? \n}
       else
-        code << %Q{options[:query] = params unless params.empty? \n}
-        code << %Q{url << "?" + options[:query].to_params unless options[:query].nil? \n}
+        code << %Q{
+          options[:query] = params unless params.empty?
+          url << "?" + options[:query].to_params unless options[:query].nil?
+        }
       end
       if resource.authenticates?
         code << %Q{options[:basic_auth] = {:username => "#{@username}", :password => "#{@password}"} \n}
@@ -161,6 +168,7 @@ module Weary
         end
       }
       class_eval code
+      return code
     end
 
 end

data/spec/weary/resource_spec.rb

@@ -0,0 +1,61 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+require File.join(File.dirname(__FILE__), '../..', 'lib', 'weary')
+
+describe Weary::Resource do
+  before do
+    @test = Weary::Resource.new("test")
+  end
+  
+  it 'defaults to a GET request' do
+    @test.via.should == :get
+  end
+  it 'should add requirements to the "with" array' do
+    @test.requires = [:foo, :bar]
+    @test.with.should == [:foo, :bar]
+  end
+  
+  it 'with paramaters could be comma delimited strings' do
+    @test.with = "foo", "bar"
+    @test.with.should == [:foo, :bar]
+  end
+  
+  it 'authenticates? should be boolean' do
+    @test.authenticates = "foobar"
+    @test.authenticates?.should == true
+    @test.authenticates = false
+    @test.authenticates?.should == false
+  end
+  
+  it 'follows_redirects? should be boolean' do
+    @test.follows = "false"
+    @test.follows_redirects?.should == true
+    @test.follows = false
+    @test.follows_redirects?.should == false
+  end
+  
+  it 'should be intelligent about crafting names' do
+    @test.name = "foo bar \n"
+    @test.name.should == "foo_bar"
+  end
+  
+  it 'should only allow specified http methods' do
+    @test.via = "Post"
+    @test.via.should == :post
+    lambda { @test.via = :foobar }.should raise_error
+  end
+  
+    
+    it 'format should be a symbol' do
+      @test.format = "xml"
+      @test.format.class.should == Symbol
+    end
+    
+    it 'format should be an allowed format' do
+      @test.format = 'text/json'
+      @test.format.should == :json
+      lambda { @test.format = :foobar }.should raise_error
+    end
+  
+end

data/spec/weary_spec.rb

@@ -9,40 +9,41 @@ describe Weary do
     @test.instance_eval { extend Weary }
   end
   
-  describe "default domain" do
+  describe 'default domain' do
     it 'should be set with a url' do
-      @test.on_domain("http://twitter.com/")
-      @test.domain.should == "http://twitter.com/"
+      @test.on_domain 'http://twitter.com/'
+      @test.domain.should == 'http://twitter.com/'
     end
     
     it 'should raise an exception when a url is not present' do
       lambda { @test.on_domain("foobar") }.should raise_error
     end
-    
+
     it 'should only take the first url given' do
       @test.on_domain("with http://google.com/ and http://yahoo.com/")
       @test.domain.should == "http://google.com/"
     end
   end
   
-  describe "default format" do
+  describe 'default format' do
     it 'can be set' do
-      @test.as_format("xml")
-      @test.instance_variable_defined?(:@default_format).should == true
+      @test.as_format(:xml)
+      @test.instance_variable_get(:@default_format).should == :xml
     end
     
-    it 'should be a symbol' do
-      @test.as_format("xml")
-      @test.instance_variable_get(:@default_format).class.should == Symbol
+    it 'should be a recognized format' do
+      @test.as_format('text/yaml')
+      @test.on_domain('http://foobar.com/')
+      @test.get('foobar').format.should == :yaml
     end
   end
   
-  describe "default url pattern" do
+  describe 'default url pattern' do
     it 'can be set' do
       @test.construct_url("<domain><resource>.<format>")
       @test.instance_variable_defined?(:@url_pattern).should == true
     end
-    
+
     it 'should be a string' do
       @test.construct_url(123)
       @test.instance_variable_get(:@url_pattern).class.should == String
@@ -50,76 +51,44 @@ describe Weary do
   end
   
   describe "basic authentication credentials" do
+    # i want to change this to be more specific about it being
+    # basic authentication
     it "should accept a username and password" do
       @test.authenticates_with("foo","bar")
       @test.instance_variable_get(:@username).should == "foo"
       @test.instance_variable_get(:@password).should == "bar"
-    end  
+    end
   end
   
-  describe "resource declaration" do  
+  describe 'resource declaration' do
     before do
-      @test.on_domain "http://twitter.com/"
+      @test.on_domain "http://foobar.com/"
     end
     
-    it "should adds a new resource" do
-      @test.declare_resource("resource")
+    it 'should add a new resource' do
+      @test.get "resource"
       @test.resources[0].has_key?(:resource).should == true
     end
     
-    it "should default to a GET request" do
-      @test.declare_resource("resource")[:resource][:via].should == :get
-    end
-    
-    it "should default to JSON if no format is defined" do
-      @test.declare_resource("resource")[:resource][:format].should == :json
+    it 'should instantiate a Resource object' do
+      @test.get("resource").class.should == Weary::Resource
     end
     
-    it "should use the declared format, if a specific format is not defined" do
-      @test.as_format :xml
-      @test.declare_resource("resource")[:resource][:format].should == :xml
+    it 'should craft code to be evaluated' do
+      r = @test.get("resource")
+      @test.send(:craft_methods, r).class.should == String
     end
     
-    it "should override the default format with it's own format" do
-      @test.as_format :xml
-      @test.declare_resource("resource",{:format => :yaml})[:resource][:format].should == :yaml
-    end
-    
-    it "should form a url if there is a default pattern" do
-      @test.declare_resource("resource")[:resource][:url].should == "http://twitter.com/resource.json"
-    end
-    
-    it "should override the default pattern with it's own url" do
-      @test.declare_resource("resource",{:url => "http://foobar.com/<resource>"})[:resource][:url].should == "http://foobar.com/resource"
-    end
-    
-    it "should be able to contain a set of allowed parameters" do
-      @test.declare_resource("resource",{:with => [:id]})[:resource][:with].empty?.should == false
-    end
-    
-    it "should be able to contain a set of required parameters" do
-      @test.declare_resource("resource",{:requires => [:id]})[:resource][:requires].empty?.should == false
-    end
-    
-    it "should merge required parameters into allowed parameters" do
-      @test.declare_resource("resource",{:requires => [:id]})[:resource][:with].empty?.should == false
-    end
-    
-    it "should authenticate with username and password" do
-      @test.authenticates_with("foo","bar")
-      @test.declare_resource("resource",{:authenticates => true})[:resource][:authenticates].should == true      
-    end
-    
-    it "should raise an exception if authentication is required but no credentials are supplied" do
-      lambda do
-        @test.declare_resource("resource",{:authenticates => true})
-      end.should raise_error
-    end
-    
-    it "should create a method for an instantiated object" do
-      @test.declare_resource("resource")
+    it 'should define new instance methods' do
+      @test.get("resource")
       @test.public_method_defined?(:resource).should == true
     end
     
-  end 
+    it 'should use sensible default formats' do
+      @test.get("resource").format.should == :json
+      @test.as_format(:xml)
+      @test.post("foo").format.should == :xml
+    end
+  end
+  
 end

data/weary.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{weary}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Wunsch"]
-  s.date = %q{2009-06-11}
+  s.date = %q{2009-06-12}
   s.description = %q{The Weary need REST: a tiny DSL that makes the consumption of RESTful web services simple.}
   s.email = %q{mark@markwunsch.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/weary/resource.rb",
      "lib/weary/response.rb",
      "spec/weary/request_spec.rb",
+     "spec/weary/resource_spec.rb",
      "spec/weary_spec.rb",
      "weary.gemspec"
   ]
@@ -38,6 +39,7 @@ Gem::Specification.new do |s|
   s.summary = %q{A little DSL for consuming RESTful web services}
   s.test_files = [
     "spec/weary/request_spec.rb",
+     "spec/weary/resource_spec.rb",
      "spec/weary_spec.rb",
      "examples/repo.rb",
      "examples/status.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: weary
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Mark Wunsch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-11 00:00:00 -04:00
+date: 2009-06-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ files:
 - lib/weary/resource.rb
 - lib/weary/response.rb
 - spec/weary/request_spec.rb
+- spec/weary/resource_spec.rb
 - spec/weary_spec.rb
 - weary.gemspec
 has_rdoc: true
@@ -77,6 +78,7 @@ specification_version: 3
 summary: A little DSL for consuming RESTful web services
 test_files: 
 - spec/weary/request_spec.rb
+- spec/weary/resource_spec.rb
 - spec/weary_spec.rb
 - examples/repo.rb
 - examples/status.rb