couchmodel 0.1.1 → 0.1.2

data/README.rdoc

@@ -6,7 +6,7 @@ implementation to integrate into an Rails 3 application.
 
 The current version is under development and open for everyone to find bugs and post them into the issue tracker.
 
-The code has been tested Ruby 1.8.7 and 1.9.1, CouchDB 0.10.0 and Rails 3.0.0.beta3.
+The code has been tested Ruby 1.8.7 and 1.9.1, CouchDB 0.10.0 and Rails 3.0.0.beta4.
 
 == Dependencies
 

data/Rakefile

@@ -9,8 +9,8 @@ task :default => :spec
 
 specification = Gem::Specification.new do |specification|
   specification.name              = "couchmodel"
-  specification.version           = "0.1.1"
-  specification.date              = "2010-05-05"
+  specification.version           = "0.1.2"
+  specification.date              = "2010-06-12"
 
   specification.authors           = [ "Philipp Bruell" ]
   specification.email             = "b.phifty@gmail.com"
@@ -27,7 +27,7 @@ specification = Gem::Specification.new do |specification|
 
   specification.test_files        = Dir["spec/**/*_spec.rb"]
 
-  specification.add_development_dependency "rspec"
+  specification.add_development_dependency "rspec", ">= 1.3.0"
 end
 
 Rake::GemPackageTask.new(specification) do |package|
@@ -47,10 +47,10 @@ Spec::Rake::SpecTask.new do |task|
 end
 
 namespace :spec do
-  
+
   desc "Run all integration specs in spec/integration directory"
   Spec::Rake::SpecTask.new(:integration) do |task|
     task.spec_files = FileList["spec/integration/**/*_spec.rb"]
   end
 
-end
+end

data/lib/core_extension/string.rb

@@ -3,13 +3,7 @@ class String # :nodoc:
 
   # This method converts a CamelCaseString into an underscore_string.
   def underscore
-    word = self.to_s.dup
-    word.gsub!(/::/, '/')
-    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-    word.tr!("-", "_")
-    word.downcase!
-    word
+    self.class.underscore self.to_s.dup
   end
 
   # This method converts an underscore_string into a CamelCaseString.
@@ -25,4 +19,13 @@ class String # :nodoc:
     self.gsub(/(?:^|_)(.)/) { $1.upcase }
   end
 
+  def self.underscore(word)
+    word.gsub!(/::/, '/')
+    word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+
 end

data/lib/couch_model/base.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "core_extension", "string"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "transport", "json"))
 require File.join(File.dirname(__FILE__), "configuration")
-require File.join(File.dirname(__FILE__), "transport")
 require File.join(File.dirname(__FILE__), "server")
 require File.join(File.dirname(__FILE__), "database")
 require File.join(File.dirname(__FILE__), "design")
@@ -63,9 +63,9 @@ module CouchModel
     end
 
     def load
-      load_response ExtendedTransport.request(:get, url, :expected_status_code => 200)
+      load_response Transport::JSON.request(:get, url, :expected_status_code => 200)
       true
-    rescue ExtendedTransport::UnexpectedStatusCodeError => error
+    rescue Transport::UnexpectedStatusCodeError => error
       upgrade_unexpected_status_error error
     end
 
@@ -77,10 +77,10 @@ module CouchModel
 
     def destroy
       return false if new?
-      ExtendedTransport.request :delete, self.url, :headers => { "If-Match" => self.rev }, :expected_status_code => 200
+      Transport::JSON.request :delete, self.url, :headers => { "If-Match" => self.rev }, :expected_status_code => 200
       clear_rev
       true
-    rescue ExtendedTransport::UnexpectedStatusCodeError => error
+    rescue Transport::UnexpectedStatusCodeError => error
       upgrade_unexpected_status_error error
     end
 
@@ -105,19 +105,19 @@ module CouchModel
     end
 
     def create
-      response = ExtendedTransport.request :post, self.database.url, :body => self.attributes, :expected_status_code => 201
+      response = Transport::JSON.request :post, self.database.url, :body => self.attributes, :expected_status_code => 201
       self.id  = response["id"]
       self.rev = response["rev"]
       true
-    rescue ExtendedTransport::UnexpectedStatusCodeError
+    rescue Transport::UnexpectedStatusCodeError
       false
     end
 
     def update
-      response = ExtendedTransport.request :put, self.url, :body => self.attributes, :expected_status_code => 201
+      response = Transport::JSON.request :put, self.url, :body => self.attributes, :expected_status_code => 201
       self.rev = response["rev"]
       true
-    rescue ExtendedTransport::UnexpectedStatusCodeError
+    rescue Transport::UnexpectedStatusCodeError
       false
     end
 

data/lib/couch_model/base/accessor.rb

@@ -15,6 +15,7 @@ module CouchModel
       module ClassMethods
 
         def key_reader(key, options = { })
+          raise ArgumentError, "method #{key} is already defined" if method_defined?(:"#{key}")
           set_default key, options[:default] if options.has_key?(:default)
           define_method :"#{key}" do
             @attributes[key.to_s]
@@ -22,6 +23,7 @@ module CouchModel
         end
 
         def key_writer(key, options = { })
+          raise ArgumentError, "method #{key}= is already defined" if method_defined?(:"#{key}=")
           set_default key, options[:default] if options.has_key?(:default)
           define_method :"#{key}=" do |value|
             @attributes[key.to_s] = value

data/lib/couch_model/collection.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "transport")
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "transport", "json"))
 require File.join(File.dirname(__FILE__), "row")
 
 module CouchModel
@@ -64,7 +64,7 @@ module CouchModel
     end
 
     def fetch_response
-      @response = ExtendedTransport.request(
+      @response = Transport::JSON.request(
         :get, url,
         :parameters            => request_parameters,
         :expected_status_code  => 200
@@ -72,7 +72,7 @@ module CouchModel
     end
 
     def fetch_meta_response
-      @response = ExtendedTransport.request(
+      @response = Transport::JSON.request(
         :get, url,
         :parameters            => request_parameters.merge(:limit => 0),
         :expected_status_code  => 200

data/lib/couch_model/database.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "transport")
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "transport", "json"))
 require File.join(File.dirname(__FILE__), "server")
 require File.join(File.dirname(__FILE__), "collection")
 
@@ -25,7 +25,7 @@ module CouchModel
     end
 
     def create!
-      ExtendedTransport.request :put, url, :expected_status_code => 201
+      Transport::JSON.request :put, url, :expected_status_code => 201
     end
 
     def create_if_missing!
@@ -33,7 +33,7 @@ module CouchModel
     end
 
     def delete!
-      ExtendedTransport.request :delete, url, :expected_status_code => 200
+      Transport::JSON.request :delete, url, :expected_status_code => 200
     end
 
     def delete_if_exists!
@@ -41,7 +41,7 @@ module CouchModel
     end
 
     def informations
-      ExtendedTransport.request :get, url, :expected_status_code => 200
+      Transport::JSON.request :get, url, :expected_status_code => 200
     end
 
     def exists?

data/lib/couch_model/design.rb

@@ -1,5 +1,5 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "transport", "json"))
 require File.join(File.dirname(__FILE__), "configuration")
-require File.join(File.dirname(__FILE__), "transport")
 require File.join(File.dirname(__FILE__), "base")
 require File.join(File.dirname(__FILE__), "view")
 require 'yaml'
@@ -34,7 +34,7 @@ module CouchModel
 
     def load_file
       hash = YAML::load_file self.filename
-      symbolize_hash_keys hash
+      self.class.symbolize_hash_keys hash
       self.id, self.language, self.views = hash.values_at(:id, :language, :views)
       true
     rescue Errno::ENOENT
@@ -67,17 +67,17 @@ module CouchModel
     end
 
     def exists?
-      ExtendedTransport.request :get, self.url, :expected_status_code => 200
+      Transport::JSON.request :get, self.url, :expected_status_code => 200
       true
-    rescue Transport::UnexpectedStatusCodeError
+    rescue Transport::JSON::UnexpectedStatusCodeError
       false
     end
 
     def push
       url = self.url
-      evaluate ExtendedTransport.request(:get, url)
+      evaluate Transport::JSON.request(:get, url)
 
-      ExtendedTransport.request :put, url, :body => self.to_hash, :expected_status_code => 201
+      Transport::JSON.request :put, url, :body => self.to_hash, :expected_status_code => 201
       true
     end
 
@@ -89,7 +89,11 @@ module CouchModel
 
     attr_writer :rev
 
-    def symbolize_hash_keys(hash)
+    def evaluate(response)
+      self.rev = response["_rev"] if response.has_key?("_rev")
+    end
+
+    def self.symbolize_hash_keys(hash)
       hash.keys.each do |key|
         value = hash.delete key
         symbolize_hash_keys value if value.is_a?(Hash)
@@ -97,10 +101,6 @@ module CouchModel
       end
     end
 
-    def evaluate(response)
-      self.rev = response["_rev"] if response.has_key?("_rev")
-    end
-
   end
 
 end

data/lib/couch_model/server.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "transport")
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "transport", "json"))
 
 module CouchModel
 
@@ -19,19 +19,19 @@ module CouchModel
     end
 
     def informations
-      ExtendedTransport.request :get, url + "/", :expected_status_code => 200
+      Transport::JSON.request :get, url + "/", :expected_status_code => 200
     end
 
     def statistics
-      ExtendedTransport.request :get, url + "/_stats", :expected_status_code => 200
+      Transport::JSON.request :get, url + "/_stats", :expected_status_code => 200
     end
 
     def database_names
-      ExtendedTransport.request :get, url + "/_all_dbs", :expected_status_code => 200
+      Transport::JSON.request :get, url + "/_all_dbs", :expected_status_code => 200
     end
 
     def uuids(count = 1)
-      response = ExtendedTransport.request :get, url + "/_uuids", :expected_status_code => 200, :parameters => { :count => count }
+      response = Transport::JSON.request :get, url + "/_uuids", :expected_status_code => 200, :parameters => { :count => count }
       response["uuids"]
     end
 

data/lib/transport/base.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), "request", "builder")
+require 'uri'
+require 'net/http'
+
+module Transport
+
+  # Common transport layer for http transfers.
+  class Base
+
+    attr_reader :response
+
+    def initialize(http_method, url, options = { })
+      @request_builder = Request::Builder.new http_method, url, options
+      @uri             = @request_builder.uri
+      @request         = @request_builder.request
+
+      @expected_status_code = options[:expected_status_code]
+    end
+
+    def perform
+      perform_request
+      check_status_code
+    end
+
+    def self.request(http_method, url, options = { })
+      transport = new http_method, url, options
+      transport.perform
+      transport.response
+    end
+
+    private
+
+    def perform_request
+      @response = Net::HTTP.start(@uri.host, @uri.port) do |connection|
+        connection.request @request
+      end
+    end
+
+    def check_status_code
+      return unless @expected_status_code
+      response_code = @response.code
+      response_body = @response.body
+      raise UnexpectedStatusCodeError.new(response_code.to_i, response_body) if @expected_status_code.to_s != response_code
+    end
+
+  end
+
+  # The UnexpectedStatusCodeError is raised if the :expected_status_code option is given to
+  # the :request method and the responded status code is different from the expected one.
+  class UnexpectedStatusCodeError < StandardError
+
+    attr_reader :status_code
+    attr_reader :message
+
+    def initialize(status_code, message = nil)
+      @status_code, @message = status_code, message
+    end
+
+    def to_s
+      "#{super} received status code #{self.status_code}" + (@message ? " [#{@message}]" : "")
+    end
+
+  end
+
+end

data/lib/transport/json.rb

@@ -0,0 +1,69 @@
+require 'json'
+require File.join(File.dirname(__FILE__), "base")
+
+module Transport
+
+  # Extended transport layer for http transfers. Basic authorization and JSON transfers are supported.
+  class JSON < Base
+
+    attr_reader :expected_status_code
+    attr_reader :auth_type
+    attr_reader :username
+    attr_reader :password
+
+    def initialize(http_method, url, options = { })
+      @options = options
+      modify_headers
+      modify_parameters
+      modify_body
+      super http_method, url, @options
+      initialize_authentication
+    end
+
+    def perform
+      super
+      parse_response
+    end
+
+    private
+
+    def modify_headers
+      headers = (@options[:headers] || { }).merge("Accept" => "application/json")
+      headers.merge! "Content-Type" => "application/json" if @options[:body]
+      @options[:headers] = headers
+    end
+
+    def modify_parameters
+      parameters = @options[:parameters]
+      if parameters
+        parameters.each do |key, value|
+          parameters[key] = value.to_json if value.respond_to?(:to_json)
+        end
+        @options[:parameters] = parameters
+      end
+    end
+
+    def modify_body
+      body = @options[:body]
+      @options[:body] = body.to_json if body
+    end
+
+    def initialize_authentication
+      auth_type = @options[:auth_type]
+      if auth_type == :basic
+        @request.basic_auth @options[:username], @options[:password]
+      elsif auth_type
+        raise NotImplementedError, "the given auth_type [#{auth_type}] is not implemented"
+      end
+    end
+
+    def parse_response
+      body = @response.body
+      @response = body.nil? ? nil : ::JSON.parse(body)
+    rescue ::JSON::ParserError
+      @response = body.to_s
+    end
+
+  end
+
+end

data/lib/transport/request/builder.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__), "parameter", "serializer")
+
+module Transport
+
+  module Request
+
+    # Builder for the transport layer requests
+    class Builder
+
+      HTTP_METHODS_WITH_PARAMETERS = [ :get, :delete ].freeze unless defined?(HTTP_METHODS_WITH_PARAMETERS)
+      HTTP_METHODS_WITH_BODY       = [ :post, :put ].freeze unless defined?(HTTP_METHODS_WITH_BODY)
+
+      def initialize(http_method, url, options = { })
+        @http_method          = http_method
+        @uri                  = URI.parse url
+        @headers              = options[:headers] || { }
+        @parameter_serializer = Parameter::Serializer.new options[:parameters]
+        @body                 = options[:body]
+      end
+
+      def uri
+        @uri
+      end
+
+      def request
+        initialize_request_class
+        initialize_request_path
+        initialize_request
+        initialize_request_body
+        @request
+      end
+
+      private
+
+      def initialize_request_class
+        request_class_name = @http_method.to_s.capitalize
+        raise NotImplementedError, "the request method #{http_method} is not implemented" unless Net::HTTP.const_defined?(request_class_name)
+        @request_class = Net::HTTP.const_get request_class_name
+      end
+
+      def initialize_request_path
+        query = HTTP_METHODS_WITH_PARAMETERS.include?(@http_method.to_sym) ? @parameter_serializer.query : nil
+        @request_path = @uri.path + (query ? "?" + query : "")
+      end
+
+      def initialize_request
+        @request = @request_class.new @request_path, @headers
+      end
+
+      def initialize_request_body
+        return unless HTTP_METHODS_WITH_BODY.include?(@http_method.to_sym)
+        @request.body = @body ? @body : @parameter_serializer.query
+      end
+
+    end
+
+  end
+
+end