mohiam-merb_couchrest 0.1.3

data/Generators

@@ -0,0 +1,4 @@
+scope 'merb-gen' do
+  dir = File.join(File.dirname(__FILE__), 'lib', 'generators/')
+  Merb.add_generators dir + 'model', dir + 'resource_controller'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 YOUR NAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,22 @@
+merb_couchrest
+==============
+
+A plugin for the Merb framework that provides support for CouchRest Models.
+
+Currently based around CouchRest::ExtendedDocument introduced by Matt Aimonetti.
+
+
+
+= Connection options
+
+Merb CouchRest plugin uses config/database.yml for connection configuration.
+
+Options are:
+
+* host. provide a string or an array of strings to attempt connections with
+* database. 
+
+
+Uses the CouchDB client CouchRest by Chris Anderson.
+
+Hacked together by studying the merb_sequel plugin.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_couchrest"
+GEM_VERSION = "0.1.3"
+AUTHOR = "Alexander Veenendaal"
+EMAIL = "odogono@gmail.com"
+HOMEPAGE = "http://github.com/mohiam/merb_couchrest"
+SUMMARY = "Merb ORM plugin that provides support for CouchRest Models"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 1.0.9')
+  s.add_dependency("mattetti-couchrest",    ">= 0.14")
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO Generators) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb_couchrest.rb
+Add your Merb rake tasks to lib/merb_couchrest/merbtasks.rb

data/lib/generators/model.rb

@@ -0,0 +1,4 @@
+Merb::Generators::ModelGenerator.template :model_couchrest, :orm => :couchrest do |t|
+  t.source = File.dirname(__FILE__) / "templates/model/app/models/%file_name%.rb"
+  t.destination = "app/models" / base_path / "#{file_name}.rb"
+end

data/lib/generators/resource_controller.rb

@@ -0,0 +1,12 @@
+Merb::Generators::ResourceControllerGenerator.template :controller_couchrest, :orm => :couchrest do |t|
+  t.source = File.dirname(__FILE__) / "templates/resource_controller/app/controllers/%file_name%.rb"
+  t.destination = "app/controllers" / base_path / "#{file_name}.rb"
+end
+
+[:index, :show, :edit, :new].each do |view|
+  Merb::Generators::ResourceControllerGenerator.template "view_#{view}_couchrest".to_sym,
+      :orm => :couchrest, :template_engine => :erb do |t|
+    t.source = File.dirname(__FILE__) / "templates/resource_controller/app/views/%file_name%/#{view}.html.erb"
+    t.destination = "app/views" / base_path / "#{file_name}/#{view}.html.erb"
+  end
+end

data/lib/generators/templates/model/app/models/%file_name%.rb

@@ -0,0 +1,4 @@
+<% with_modules(modules) do -%>
+class <%= class_name %> < CouchRest::ExtendedDocument
+end
+<% end -%>

data/lib/generators/templates/resource_controller/app/controllers/%file_name%.rb

@@ -0,0 +1,66 @@
+<% with_modules(modules) do -%>
+class <%= class_name %> < Application
+  # provides :xml, :yaml, :js
+
+  # GET /<%= resource_path %>
+  def index
+    @<%= plural_model %> = <%= model_class_name %>.all
+    display @<%= plural_model %>
+  end
+
+  # GET /<%= resource_path %>/:id
+  def show
+    @<%= singular_model %> = <%= model_class_name %>[params[:id]]
+    raise NotFound unless @<%= singular_model %>
+    display @<%= singular_model %>
+  end
+
+  # GET /<%= resource_path %>/new
+  def new
+    only_provides :html
+    @<%= singular_model %> = <%= model_class_name %>.new(params[:<%= singular_model %>])
+    render
+  end
+
+  # POST /<%= resource_path %>
+  def create
+    @<%= singular_model %> = <%= model_class_name %>.new(params[:<%= singular_model %>])
+    if @<%= singular_model %>.save
+      redirect url(:<%= (modules.collect{|m| m.downcase} << singular_model).join("_") %>, @<%= singular_model %>)
+    else
+      render :new
+    end
+  end
+
+  # GET /<%= resource_path %>/:id/edit
+  def edit
+    only_provides :html
+    @<%= singular_model %> = <%= model_class_name %>[params[:id]]
+    raise NotFound unless @<%= singular_model %>
+    render
+  end
+
+  # PUT /<%= resource_path %>/:id
+  def update
+    @<%= singular_model %> = <%= model_class_name %>[params[:id]]
+    raise NotFound unless @<%= singular_model %>
+    if @<%= singular_model %>.update(params[:<%= singular_model %>])
+      redirect url(:<%= (modules.collect{|m| m.downcase} << singular_model).join("_") %>, @<%= singular_model %>)
+    else
+      raise BadRequest
+    end
+  end
+
+  # DELETE /<%= resource_path %>/:id
+  def destroy
+    @<%= singular_model %> = <%= model_class_name %>[params[:id]]
+    raise NotFound unless @<%= singular_model %>
+    if @<%= singular_model %>.destroy
+      redirect url(:<%= (modules.collect{|m| m.downcase} << singular_model).join("_") %>s)
+    else
+      raise BadRequest
+    end
+  end
+
+end
+<% end -%>

data/lib/generators/templates/resource_controller/app/views/%file_name%/edit.html.erb

@@ -0,0 +1,3 @@
+<h1><%= class_name %> controller, edit action</h1>
+
+<p>Edit this file in <tt>app/views/<%= file_name %>/edit.html.erb</tt></p>

data/lib/generators/templates/resource_controller/app/views/%file_name%/index.html.erb

@@ -0,0 +1,3 @@
+<h1><%= class_name %> controller, index action</h1>
+
+<p>Edit this file in <tt>app/views/<%= file_name %>/index.html.erb</tt></p>

data/lib/generators/templates/resource_controller/app/views/%file_name%/new.html.erb

@@ -0,0 +1,3 @@
+<h1><%= class_name %> controller, new action</h1>
+
+<p>Edit this file in <tt>app/views/<%= file_name %>/new.html.erb</tt></p>

data/lib/generators/templates/resource_controller/app/views/%file_name%/show.html.erb

@@ -0,0 +1,3 @@
+<h1><%= class_name %> controller, show action</h1>
+
+<p>Edit this file in <tt>app/views/<%= file_name %>/show.html.erb</tt></p>

data/lib/merb/orms/couchrest/connection.rb

@@ -0,0 +1,105 @@
+require "fileutils"
+require "couchrest"
+
+
+module Merb
+  module Orms
+    module CouchRest
+      
+      
+      class << self
+        
+        def config_file() Merb.dir_for(:config) / "database.yml" end
+        def sample_dest() Merb.dir_for(:config) / "database.yml.sample" end
+        def sample_source() File.dirname(__FILE__) / "database.yml.sample" end
+      
+        def copy_sample_config
+          FileUtils.cp sample_source, sample_dest unless File.exists?(sample_dest)
+        end
+        
+        
+        def config
+          @config ||= begin
+            # Convert string keys to symbols
+            full_config = Erubis.load_yaml_file(config_file)
+            config = (Merb::Plugins.config[:merb_couchrest] = {})
+            (full_config[Merb.environment.to_sym] || full_config[Merb.environment] || full_config[:development]).each do |key, value|
+              config[key.to_sym] = value
+            end
+            config
+          end
+        end
+        
+        def connect
+          if File.exists?(config_file)
+            
+            # it is possible that we have been passed an array of hosts - attempt each in turn until one is found
+            
+            config[:host].each do |host|
+              
+              begin
+                
+                Merb.logger.info!("Attempting connection to the '#{config[:database]}' database on '#{host}' ...")
+                
+                # Merb.logger.info!("using string #{host}/#{config[:database]}")
+                
+                server = ::CouchRest.new(host)
+                
+                # calling this will cause an exception if the host is invalid
+                info = server.info()
+                
+                Merb.logger.info!("Connected to '#{host}' - version #{info['version']}")
+                
+                begin
+                  if config[:create_db_if_absent]
+                    database_connection = server.database!( config[:database] )
+                  else
+                    database_connection = server.database( config[:database] )
+                  end
+                
+                  # this will test the connection and raise a ResourceNotFound exception
+                  # if it is not valid
+                  database_connection.info()
+                
+                  # set the default database
+                  ::CouchRest::Document.use_database( database_connection )
+
+                  # we are done - return with the result
+                  return database_connection
+                  
+                rescue  RestClient::ResourceNotFound
+                  Merb.logger.info!("#{config[:database]} is not available on #{host}")
+                end
+                
+              rescue Errno::ECONNREFUSED
+                Merb.logger.info!("#{host} not available")
+              rescue => e
+                Merb.logger.info!("Connection Error: #{e}")
+                Merb.print_colorized_backtrace(e)
+                exit(1)
+              end
+              
+            end
+            
+            # if we have reached this point, then a connection wasn't found
+            
+            Merb.logger.info!("Unable to connect")
+            exit(1)
+            
+            
+          else
+            copy_sample_config
+            Merb.logger.set_log(STDERR)
+            Merb.logger.error! "No database.yml file found at #{config_file}."
+            Merb.logger.error! "A sample file was created called #{sample_dest} for you to copy and edit."
+            exit(1)
+          end  
+        end        
+
+        
+        
+      end
+
+    end
+  end
+end

data/lib/merb/orms/couchrest/database.yml.sample

@@ -0,0 +1,14 @@
+---
+# This is a sample database file for the CouchRest ORM
+:development: &defaults
+  :database: sample_development
+  :host: localhost:5984
+  :create_db_if_absent: true
+
+:test:
+  <<: *defaults
+  :database: sample_test
+
+:production:
+  <<: *defaults
+  :database: sample_production

data/lib/merb/session/couchrest_session.rb

@@ -0,0 +1,76 @@
+require 'couchrest'
+require 'merb-core/dispatch/session'
+
+
+module Merb
+  
+  class CouchRestSessionStore  < CouchRest::ExtendedDocument
+    
+    class << self
+      
+      # ==== Parameters
+      # session_id<String>:: ID of the session to retrieve.
+      #
+      # ==== Returns
+      # ContainerSession:: The session corresponding to the ID.
+      def retrieve_session(session_id)
+
+        begin
+          doc = get( session_id )
+          return Marshal.load(doc[:data])
+        rescue
+        end
+        
+      end
+    
+      # ==== Parameters
+      # session_id<String>:: ID of the session to set.
+      # data<ContainerSession>:: The session to set.
+      # 
+      # :api: private
+      def store_session(session_id, data)
+        
+        marshaled = Marshal.dump(data)
+        
+        begin
+          doc = get( session_id )
+          doc[:data] = marshaled
+          doc[:updated_at] = Time.now
+          doc.save
+        rescue
+          doc = self.new( '_id' => session_id, :data => marshaled, :created_at => Time.now )
+          doc.save
+        end
+      
+      end
+    
+      # ==== Parameters
+      # session_id<String>:: ID of the session to delete.
+      #
+      # :api: private
+      def delete_session(session_id)
+        begin
+          doc = get(session_id) 
+          doc.destroy()
+        rescue
+        end
+      end
+    
+    end
+    
+  end
+  
+  
+  class CouchdbSession < SessionStoreContainer
+    
+    # The session store type
+    self.session_store_type = :couchrest
+    
+    # The store object is the model class itself
+    self.store = CouchRestSessionStore
+    
+  end
+  
+  
+end
+

data/lib/merb_couchrest/merbtasks.rb

@@ -0,0 +1,23 @@
+namespace :couchrest do
+
+  
+  task :merb_start do
+    Merb.start :adapter => 'runner',
+               :environment => ENV['MERB_ENV'] || 'development'
+  end
+  
+  namespace :sessions do
+    
+    desc "Clears sessions"
+    task :clear => :merb_start do
+      
+      Merb::CouchRestSessionStore.all.each{ |doc| doc.database.delete_doc(doc,true) }
+      Merb::CouchRestSessionStore.bulk_save()
+      
+    end
+    
+  end
+  
+  
+  
+end

data/lib/merb_couchrest.rb

@@ -0,0 +1,27 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_couchrest] = {}
+  require File.join(File.dirname(__FILE__) / "merb" / "orms" / "couchrest" / "connection" )
+  
+  Merb::BootLoader.before_app_loads do
+    
+    Merb::Orms::CouchRest.connect
+    
+    if Merb::Config.session_stores.include?(:couchrest)
+      Merb.logger.debug "Using CouchRest sessions"
+      require File.join(File.dirname(__FILE__) / "merb" / "session" / "couchrest_session")
+    end
+    
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    
+    # TODO - How do we disconnect if, in fact, we need to ?
+    
+  end
+  
+  Merb::Plugins.add_rakefiles "merb_couchrest/merbtasks"
+  
+end

data/spec/merb_couchrest_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_couchrest" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: mohiam-merb_couchrest
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Alexander Veenendaal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mattetti-couchrest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.14"
+    version: 
+description: Merb ORM plugin that provides support for CouchRest Models
+email: odogono@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- Generators
+- lib/generators
+- lib/generators/model.rb
+- lib/generators/resource_controller.rb
+- lib/generators/templates
+- lib/generators/templates/model
+- lib/generators/templates/model/app
+- lib/generators/templates/model/app/models
+- lib/generators/templates/model/app/models/%file_name%.rb
+- lib/generators/templates/resource_controller
+- lib/generators/templates/resource_controller/app
+- lib/generators/templates/resource_controller/app/controllers
+- lib/generators/templates/resource_controller/app/controllers/%file_name%.rb
+- lib/generators/templates/resource_controller/app/views
+- lib/generators/templates/resource_controller/app/views/%file_name%
+- lib/generators/templates/resource_controller/app/views/%file_name%/edit.html.erb
+- lib/generators/templates/resource_controller/app/views/%file_name%/index.html.erb
+- lib/generators/templates/resource_controller/app/views/%file_name%/new.html.erb
+- lib/generators/templates/resource_controller/app/views/%file_name%/show.html.erb
+- lib/merb
+- lib/merb/orms
+- lib/merb/orms/couchrest
+- lib/merb/orms/couchrest/connection.rb
+- lib/merb/orms/couchrest/database.yml.sample
+- lib/merb/session
+- lib/merb/session/couchrest_session.rb
+- lib/merb_couchrest
+- lib/merb_couchrest/merbtasks.rb
+- lib/merb_couchrest.rb
+- spec/merb_couchrest_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mohiam/merb_couchrest
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Merb ORM plugin that provides support for CouchRest Models
+test_files: []
+