couchbase-docstore 0.1.1 → 0.1.2

data/README.md

@@ -1,4 +1,4 @@
-# CouchbaseDocumentStore
+# CouchbaseDocStore
 
 TODO: Write a gem description
 

data/couchbase_doc_store.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'couchbase_doc_store/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "couchbase-docstore"
+  gem.version       = CouchbaseDocStore::VERSION
+  gem.authors       = ["Jasdeep Jaitla"]
+  gem.email         = ["jasdeep@scalabl3.com"]
+  gem.description   = %q{A Convenient Wrapper for the Couchbase gem, uses Map gem and adds new functionality}
+  gem.summary       = %q{You simply use the Couchbase gem, or you can use this wrapper that encapsulates the gem and adds some subjective conveniences. }
+  gem.homepage      = "https://github.com/scalabl3/couchbase-docstore"
+
+  gem.add_dependency('couchbase-settings', '>= 0.1.0')
+  gem.add_dependency('couchbase', '>= 1.2.0.z.beta3')
+  
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/couchbase_doc_store.rb

@@ -0,0 +1,190 @@
+require 'couchbase'
+require 'map'
+require 'couchbase_settings'
+require "couchbase_doc_store/version"
+
+module CouchbaseDocStore
+
+  Rails.logger.debug(CouchbaseSetting.pm)
+  
+  setting_hash = {}      
+  if (CouchbaseSetting.respond_to?("servers") && CouchbaseSetting.servers && !CouchbaseSetting.servers.empty?)
+    setting_hash[:node_list] = CouchbaseSetting.servers 
+  elsif CouchbaseSetting.respond_to?("server")
+    
+    setting_hash[:hostname] = CouchbaseSetting.server 
+  else
+    raise ArgumentError, "You didn't set a Couchbase Server in your /config/couchbase.yml file!"
+  end
+  setting_hash[:pool] = "default"
+  setting_hash[:bucket] = CouchbaseSetting.bucket
+  setting_hash[:port] = 8091
+  
+  if (CouchbaseSetting.respond_to?("password") && CouchbaseSetting.password && !CouchbaseSetting.password.blank?)
+    setting_hash[:username] = CouchbaseSetting.bucket
+    setting_hash[:password] = CouchbaseSetting.password
+  end
+  
+  CB = Couchbase.connect(setting_hash)
+  
+  #### INSTANCE METHODS
+
+  # Check if a key/document exists 
+  def document_exists?(key)
+    return nil unless key
+    CouchbaseDocStore.document_exists?(key)
+  end
+
+  # Initialize a document, if it doesn't exist, create it, if it exists, ignore the call
+  def initialize_document(key, value, args={})
+    return nil unless key
+    CouchbaseDocStore.initialize_document(key, value, args)
+  end
+
+  # Create a new document (Couchbase#add)
+  def create_document(key, value, args={})
+    return nil unless key
+    CouchbaseDocStore.create_document(key, value, args) # => if !quiet, Generates Couchbase::Error::KeyExists if key already exists
+  end
+
+  # Replace a new document (Couchbase#replace), throws Couchbase::Error:: if it doesn't exist
+  def replace_document(key, value, args = {})
+    return nil unless key
+    CouchbaseDocStore.replace_document(key, value, args)
+  end
+
+  # 
+  def get_document(key, args = {})
+    return nil unless key
+    CouchbaseDocStore.get_document(key, args)
+  end
+
+  def get_documents(keys = [], args = {})
+    return nil unless keys || keys.empty?
+    CouchbaseDocStore.get_documents(keys, args)
+  end
+
+  def delete_document(key, args={})
+    return nil unless key
+    CouchbaseDocStore.delete_document(key, args)
+  end
+
+  # @param args :amount => Fixnum||Integer, increases by that
+  def increase_atomic_count(key, args={})
+    return nil unless key
+    CouchbaseDocStore.increase_atomic_count(key, args)
+  end
+
+  def decrease_atomic_count(key, args={})
+    return nil unless key
+    CouchbaseDocStore.decrease_atomic_count(key, args)
+  end
+
+  # preferred way is to use create/replace to make sure there are no collisions
+  def force_set_document(key, value, args={})
+    return nil unless key
+    CouchbaseDocStore.force_set_document(key, value, args)
+  end
+
+
+
+  # end Instance Methods
+  #####################################################################
+  #### CLASS METHODS
+
+  class << self
+
+    def delete_all_documents!
+      CB.flush
+    end
+
+    def document_exists?(key)
+      return nil unless key
+
+      # Save quiet setting
+      tmp = CB.quiet
+
+      # Set quiet to be sure
+      CB.quiet = true
+
+      doc = CB.get(key)
+
+      # Restore quiet setting
+      CB.quiet = tmp
+
+      !doc.nil?
+    end
+
+    def initialize_document(key, value, args={})
+      return nil unless key
+      CB.quiet = true
+      doc = CouchbaseDocStore.get_document( key )
+      (value.is_a?(Fixnum) || value.is_a?(Integer) ? CB.set( key, value ) : CB.add( key, value )) unless doc
+    end
+
+    def create_document(key, value, args={})
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      CB.add(key, value, args) # => if !quiet, Generates Couchbase::Error::KeyExists if key already exists
+    end
+
+    def replace_document(key, value, args = {})
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      CB.replace(key, value) # => if !quiet, Generates Couchbase::Error::NotFound if key doesn't exist
+    end
+
+    def get_document(key, args = {})
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      doc = CB.get(key, args)
+      doc.is_a?(Hash) ? Map.new(doc) : doc
+    end
+
+    def get_documents(keys = [], args = {})
+      return nil unless keys || keys.empty?
+      values = CB.get(keys, args)
+
+      if values.is_a? Hash
+        tmp = []
+        tmp[0] = values
+        values = tmp
+      end
+      # convert hashes to Map (subclass of Hash with *better* indifferent access)
+      values.each_with_index do |v, i|
+        values[i] = Map.new(v) if v.is_a? Hash
+      end
+
+      values
+    end
+
+    def delete_document(key, args={})
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      CB.delete(key)
+    end
+
+    def increase_atomic_count(key, args={} )
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      CB.incr(key, args[:amount] || 1)
+    end
+
+    def decrease_atomic_count(key, args={})
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      CB.decr(key, args[:amount] || 1)
+    end
+
+    # preferred way is to use create/replace instead of this to make sure there are no collisions
+    def force_set_document(key, value, args={})
+      return nil unless key
+      CB.quiet = args[:quiet] || true
+      CB.set(key, value, args)
+    end
+
+  end# end ClassMethods
+
+  #####################################################################
+
+end

data/lib/couchbase_doc_store/version.rb

@@ -0,0 +1,3 @@
+module CouchbaseDocStore
+  VERSION = "0.1.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: couchbase-docstore
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -56,7 +56,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-homepage: ''
+- couchbase_doc_store.gemspec
+- lib/couchbase_doc_store.rb
+- lib/couchbase_doc_store/version.rb
+homepage: https://github.com/scalabl3/couchbase-docstore
 licenses: []
 post_install_message: 
 rdoc_options: []