leanmodel 0.1.3 → 0.1.4

data/Gemfile

@@ -3,6 +3,8 @@ source "http://rubygems.org"
 # Example:
  gem "activesupport"
  gem "activemodel"
+ gem "uuidtools"
+ 
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -26,6 +26,7 @@ GEM
       shoulda-matchers (~> 1.0.0)
     shoulda-context (1.0.0)
     shoulda-matchers (1.0.0)
+    uuidtools (2.1.2)
 
 PLATFORMS
   ruby
@@ -38,3 +39,4 @@ DEPENDENCIES
   rcov
   rdoc (~> 3.12)
   shoulda
+  uuidtools

data/README.rdoc

@@ -1,16 +1,73 @@
-= leanmodel
+= Leanmodel
 
-Description goes here.
+Simple ORM for CouchDB. This a work in progress...
+
+==Installation
+ gem install leanmodel
+
+==Usage
+ 
+ require 'leanback'
+ require 'leanmodel'
+
+Name of the class must be singular to a Couchdb database name .
+The class below represents a document in the database called movies
+ class Movie < LeanModel::Base  
+  attributes  :title, :year, :story
+ end
+
+ movie = Movie.new({:title => 'Jurassic Park',:year => '1993', :story => 'Raptors brought back in time'})
+
+ movie.attributes
+ #=> {"title"=>"Jurassic Park", "year"=>"1993", "story"=>"Raptors brought back in time"}
+
+Configure couchDB
+ @couchdb_username = "obi"
+ @couchdb_password = "trusted"
+ 
+ token = lambda {
+                  hash = Couchdb.login(@couchdb_username,@couchdb_password) 
+                  hash["AuthSession"]
+                    }
+ movie.config(token)
+
+CouchDB Authsession token
+ movie.token
+ #=> b2JpOjRGQTIxODA4Oq42xHwvvoK9ASvtB55ODSdEpEgB
+
+Database name 
+ movie.database
+ #=> movies
+
+Write this model to the database
+ movie.save
+ #=> true
+Returns true if the model was written successfully.
+This method creates a new couchDB document with the model's attribute values 
+
+Delete this model from database
+ movie.destroy
+ #=>{"ok"=>true, "id"=>"eb9ecefa-afdd-426a-a21d-f8307fa2b156", "rev"=>"2-98bc85346eff4a663e39395163aaa194"}
+This deletes the document that represents this model from the database
+
+Find a movie using it's document id
+ movie.service.find('9da82f5a-0ce4-46a0-863c-7d8f2ed84439')
+ #=> {"_id"=>"9da82f5a-0ce4-46a0-863c-7d8f2ed84439", "_rev"=>"6-6367dc24342f1590935a99087a57d8c5", 
+                      "title"=>"Jurassic Park", "year"=>"1996", "story"=>"Raptors brought back in time"}
 
-== Contributing to leanmodel
  
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+Update a model on the database, 
+ data = {:id => '9da82f5a-0ce4-46a0-863c-7d8f2ed84439', :year => '1993' }
+ movie.service.update_attributes(data)
+ #=> true
+Returns true if successful, requires that the document ID is included in the data
+
+Retrieve all movies from database
+ movie.service.all
+ #=> [{"_id"=>"0fb32571-44c4-48c4-9423-55ea7c95c192", "_rev"=>"1-f76f5d4f431cafbdb3f4d43388a03c89", 
+         "title"=>"Hugo", "year"=>"2011", "story"=>"Film history"}, 
+      {"_id"=>"9da82f5a-0ce4-46a0-863c-7d8f2ed84439", "_rev"=>"10-60e258f605801a31e64b928bb81f7ea6", 
+             "title"=>"Jurassic Park", "year"=>"1993", "story"=>"Raptors brought back in time"}]
 
 == Copyright
 

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "leanmodel"
   gem.homepage = "http://github.com/obi-a/leanmodel"
   gem.license = "MIT"
-  gem.summary = %Q{Basic ActiveModel, does nothing}
-  gem.description = %Q{Basic ActiveModel, does nothing}
+  gem.summary = %Q{Simple ORM for couchDB}
+  gem.description = %Q{Simple ORM for couchDB}
   gem.email = "obioraakubue@yahoo.com"
   gem.authors = ["obi-a"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/leanmodel.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "leanmodel"
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["obi-a"]
-  s.date = "2012-04-15"
-  s.description = "Basic ActiveModel, does nothing"
+  s.date = "2012-05-05"
+  s.description = "Simple ORM for couchDB"
   s.email = "obioraakubue@yahoo.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.21"
-  s.summary = "Basic ActiveModel, does nothing"
+  s.summary = "Simple ORM for couchDB"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<activemodel>, [">= 0"])
+      s.add_runtime_dependency(%q<uuidtools>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
@@ -51,6 +52,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<activemodel>, [">= 0"])
+      s.add_dependency(%q<uuidtools>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, [">= 0"])
@@ -60,6 +62,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<activemodel>, [">= 0"])
+    s.add_dependency(%q<uuidtools>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 0"])

data/lib/lean_model/base.rb

@@ -5,6 +5,9 @@ module LeanModel
   extend ActiveModel::Translation
   include ActiveModel::Validations
   include ActiveModel::AttributeMethods
+
+  attr_accessor :database_token
+  attr_accessor :doc_id
   
   class_attribute :_attributes
   self._attributes = []
@@ -14,6 +17,12 @@ module LeanModel
   
   attribute_method_suffix '?' 
 
+  def initialize(attributes = {})
+    attributes.each do |attr, value|
+      self.send("#{attr}=",value)
+    end unless attributes.blank?
+  end
+
   def self.attributes(*names)
     attr_accessor *names
 
@@ -32,6 +41,68 @@ module LeanModel
    false
  end
 
+#database functions
+ def config(token)
+   @database_token = token
+ end
+
+ def token
+  if @database_token.lambda?
+     @database_token.call
+  end
+ end
+
+  def database
+    self.class.name.split('::').last.downcase + 's'
+  end
+
+ def all
+  #returns hash of all key/values in the database
+  docs = Couchdb.docs_from database,token
+ end
+
+ def find(id)
+  #returns a model object with the given ID
+  doc = {:database => database, :doc_id => id}
+  hash = Couchdb.view doc,token
+ end
+
+ def save
+   #save this model object to database
+   if self.valid?
+    @doc_id = UUIDTools::UUID.random_create.to_s
+    doc = { :database => database, :doc_id => @doc_id, :data => attributes}   
+    Couchdb.create_doc doc,token
+    true
+   else
+    false
+   end
+ end
+
+ def service
+  self
+ end
+
+ def update_attributes(hash)
+   #update this model on database
+   if self.valid?
+    id = hash[:id]
+    hash.delete(:id)
+    doc = { :database => database, :doc_id => id, :data => hash}   
+    Couchdb.update_doc doc,token
+    true
+   else
+    false
+   end
+ end
+
+ def destroy
+   #delete this model from database
+   doc = {:database => database, :doc_id => @doc_id}
+   Couchdb.delete_doc doc,token
+ end
+
+ #end of database functions
  protected 
   def clear_attribute(attribute)
     send("#{attribute}=",nil)

data/lib/leanmodel.rb

@@ -1,4 +1,5 @@
 require 'active_support'
 require 'active_model'
+require 'uuidtools'
 
 require 'lean_model/base'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leanmodel
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-15 00:00:00.000000000 Z
+date: 2012-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +139,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Basic ActiveModel, does nothing
+description: Simple ORM for couchDB
 email: obioraakubue@yahoo.com
 executables: []
 extensions: []
@@ -159,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -296849791
+      hash: 610187215
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -171,5 +187,5 @@ rubyforge_project:
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Basic ActiveModel, does nothing
+summary: Simple ORM for couchDB
 test_files: []