rethinkdb_helper 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01cd1baa0c8ff2bc88067c0ab507364320d6eef2
-  data.tar.gz: 2c16cb84eb4de3331525b90c24afa511ad78104e
+  metadata.gz: 2c7050a7a77d22a393fcc4b88452ae20146867fc
+  data.tar.gz: 584a217453b2d1c644b206c1e7ffc6fb783edfe1
 SHA512:
-  metadata.gz: 938adb9955c1787b7183d5984dcf0e9b7ce2d046b19f28cd40184443c4567dce929634d236f49b2e207f421dd5c108f840239ced866712bd1748375b7e79b564
-  data.tar.gz: 9269ac2b91b32c96e794a58446afe2cdd319eb6f3629cdbf846c71ba87bc8e38f519c6e904d48532d8bf9e5c4c979a0d105700a21d392017612c6f659dbecc64
+  metadata.gz: 33f11b396b13dae5c7f366af664d8d6cb3c82323bb4cecca753b111a4726c2de6b9363d817c667d8ed1d0569eb97339fb03310b8ff519788a2b69dfca910b9aa
+  data.tar.gz: 76fc8386bf4c5460cbd53f00990b8b1bf67fca5ad5bb3d9e26b1cf5b4038aadfd92518625123622d58a66da3d14aceaf89ed299426f24b678281c7c037fede9e

data/README.md

@@ -1,8 +1,8 @@
 # RethinkdbHelper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rethinkdb_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+My convention as a wrapper around the rethinkdb gem.
+Under Development.
+Don't use it.
 
 ## Installation
 
@@ -22,7 +22,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  db = RethinkdbHelper.new(
+    host:   'localhost',  # default
+    port:   28015,        # default
+    db:     'test',       # default
+    table:  'test',       # default
+    create_if_missing: true   # created db/table if they are missing
+  )
+  db.insert(json_documents) # takes array of hashes or json
+  cursor = db.search(:field_name, field_value_regex)
+  puts cursor.count
+  cursor.each {|d| ap d}
+  etc.
+```
 
 ## Development
 

data/lib/rethinkdb_helper.rb

@@ -4,46 +4,64 @@
 ##  Desc: Encapsulates some basic utility functions
 ##  By:   Dewayne VanHoozer (dvanhoozer@gmail.com)
 #
+# TODO: Review the nobrainer gem to see if this stuff is moot
+#
+
+require 'forwardable'
+
 require 'rethinkdb'
 
 class RethinkdbHelper
   include RethinkDB::Shortcuts
+  extend Forwardable
 
   DEFAULTS = {
-    host:               ENV['RETHINKDB_HOST']  || 'localhost',
-    port:              (ENV['RETHINKDB_PORT']  || '28015').to_i,
-    db:                 ENV['RETHINKDB_DB']    || 'test',
-    table:              ENV['RETHINKDB_TABLE'] || 'test',
+    host:               ENV['RDB_HOST']     || 'localhost',
+    port:              (ENV['RDB_PORT']     || '28015').to_i, # SMELL: is to_i necessary?
+    db:                 ENV['RDB_DB']       || 'test',
+    table:              ENV['RDB_TABLE']    || 'test',
+    auth_key:           ENV['RDB_AUTH_KEY'] || 'unknown',
     drop:               false,
     create_if_missing:  false
   }
 
+  # TODO: Pass some methods to r for fullfillment
+  #       connect, db, table
+  #def_delegators :r, :connect, :db, :table
+
+  # TODO: Pass some methods to @commection for fulfillment
+  #       close, reconnect, use, noreply_wait
+  def_delegators :@connection, :close, :reconnect, :use, :noreply_wait
+
+  # TODO: Pass some methods to @table for fulfillment
+  #       filter, get, get_all, between, eq_join,
+  #       inner_join, outer_join
+  def_delegators :@table, :filter, :get, :get_all, :between, :eq_join,
+                          :inner_join, :outer_join
+
   # TODO: Limited to one table per instance, consider
   #       support for multiple table per db support;
   #       consider multiple db per instance support.
   def initialize(options={})
     @options = DEFAULTS.merge(options)
 
-    @connection = r.connect(
-      host: @options[:host],
-      port: @options[:port]
-    ).repl
+    @connection = connect
 
-    r.db_drop(@options[:db]) if db_exist? && drop?
+    db_drop if db_exist? && drop?
 
     unless  db_exist?
       if create_if_missing?
-        r.db_create(@options[:db]).run
+        db_create
       else
         raise "db: '#{@options[:db]}' does not exist"
       end
     end
 
-    @connection.use(@options[:db])
+    use(@options[:db])
 
     unless table_exist?
       if create_if_missing?
-        r.table_create(@options[:table]).run
+        table_create
       else
         raise "table: '#{@options[:table]}' does not exist"
       end
@@ -52,14 +70,135 @@ class RethinkdbHelper
     @table = r.table(@options[:table])
   end # def initialize
 
-  def db_exist?
-    r.db_list.run.include?(@options[:db])
+  def table_wait(*options)
+    @table.wait(options).run
+  end
+
+  def table_status(table_name=@options[:table])
+    r.table_status(table_name).run
   end
 
-  def table_exist?
-    r.table_list.run.include?($options[:table])
+  def reconfigure(options={})
+    @taboe.reconfigure(options).run
+  end
+  alias :table_reconfigure :reconfigure
+
+  def rebalance
+    @table.rebalance.run
+  end
+  alias :table_rebalance :rebalance
+
+  def table_config
+    @table.config.run
+  end
+
+  def db_config
+    @db.config.run
+  end
+
+
+  def db_wait(*options)
+    @db.wait(options).run
   end
 
+  def server_wait(*options)
+    r.wait(options).run
+  end
+
+  def connect(options={host: @options[:host], port: @options[:port]})
+    r.connect(options).repl
+  end
+
+  def db_drop(db_name=@options[:db])
+    @db    = nil
+    @table = nil
+    r.db_drop(db_name).run
+  end
+  alias :drop_db   :db_drop
+  alias :db_delete :db_drop
+  alias :delete_db :db_drop
+
+  #def use(db_name=@options[:db])
+  #  @connection.use(db_name)
+  #end
+
+  def db(db_name=@options[:db])
+    @db = r.db(db_name)
+  end
+
+  def table(table_name=@options[:table],options={})
+    @table = r.table(table_name, options)
+  end
+
+  def get_table(table_name=@options[:table], options)
+    r.table(table_name, options).run
+  end
+
+  def sync
+    @table.sync.run
+  end
+  alias :flush :sync
+
+
+  def table_create(table_name=@ooptions[:table], options={})
+    @table = r.table_create(table_name, options).run
+  end
+  alias :create_table :table_create
+
+  def table_drop(table_name=@options[:table])
+    @table = nil
+    @db.table_drop(table_name)
+  end
+  alias :drop_table   :table_drop
+  alias :elete_table  :table_drop
+  alias :table_delete :table_drop
+
+  def changes(options={})
+    @table.changes(options).run(connect)
+  end
+
+  def db_exist?(db_name=@options[:db])
+    db_list.include?(db_name)
+  end
+
+  def db_list
+    r.db_list.run
+  end
+  alias :list_db :db_list
+
+  def table_list
+    r.table_list.run
+  end
+  alias :list_table :table_list
+
+  def table_exist?(table_name=@options[:table])
+    table_list.include?(table_name)
+  end
+
+  def index_wait(*indexes)
+    @table.index_wait(indexes).run
+  end
+  alias :wait_on_index  :index_wait
+  alias :wait_for_index :index_wait
+  alias :wait_index     :index_wait
+
+  def index_create(index_name, index_function=nil, options={})
+    @table.index_create(index_name, index_funciton, options).run
+  end
+  alias :create_index :index_create
+
+  def index_list
+    @table.index_list.run
+  end
+  alias :list_indexes :index_list
+
+  def index_drop(index_name)
+    @table.index_drop(index_name).run
+  end
+  alias :drop_inde    :index_drop
+  alias :delete_index :index_drop
+  alias :index_delete :index_drop
+
   def drop?
     @options[:drop]
   end
@@ -68,14 +207,34 @@ class RethinkdbHelper
     @options[:create_if_missing]
   end
 
+  def get_key(key)
+    @table.get(key).run
+  end
+
+  def get_all_keys(keys, options={})
+    @table.get_all([keys].flatten, options).run
+  end
+
+  def get_between_keys(lower_key, upper_key, options={})
+    @table.between(lower_key, upper_key, options).run
+  end
+  alias :between_keys :get_between_keys
+
+
+  def join(foreign_key, table_name,options={})
+    @table.eq_join(foreign_key,
+      r.table(table_name), options).without({:right => "id"}).zip().run
+  end
+
   # payloads is an array of hashes or a single
   # hash document.
-  def insert(*payloads)
+  def insert(payloads, options={})
+    payloads = [payloads].flatten
     raise 'No document provided' if payloads.empty?
     invalid_payloads = false
     payloads.map{|doc| invalid_payloads &&= !doc.is_a?(Hash)}
     raise 'Invalid document: must be Hash' if invalid_payloads
-    @table.insert(payloads).run
+    @table.insert(payloads.flatten, options).run
   end
   alias :add  :insert
   alias :load :insert
@@ -88,7 +247,7 @@ class RethinkdbHelper
   #
   # params is a hash where the key is the symbolized field_name
   # and its value is the regex by which to filter
-  def filter(params={})
+  def search(params={})
     raise 'No search terms' if params.empty?
     field_name    = params.keys.first
     search_regex  = params[field_name]
@@ -97,12 +256,11 @@ class RethinkdbHelper
               match(search_regex)}.
           run
   end
-  alias :search :filter
 
-  def close
-    @connection.close
-  end
+  #def close
+  #  @connection.close
+  #end
 
 end # class RethinkdbHelper
 
-ReDBH = RethinkdbHelper unless defined?(ReDBH)
+RDB = RethinkdbHelper unless defined?(RDB)

data/rethinkdb_helper.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rethinkdb_helper"
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ["Dewayne VanHoozer"]
   spec.email         = ["dvanhoozer@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rethinkdb_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dewayne VanHoozer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler