zeddb 1.1.3

data/lib/zeddb/instances/model_item.rb

@@ -0,0 +1,77 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelItem < Zedkit::Instance
+    def model
+      ZedDB::Model.new(:user_key => uk, :locale => lc, :uuid => self['model']['uuid'])
+    end
+
+    def validations
+      self.has_key?('validations') && self['validations'].is_a?(Array) ? self['validations'] : []
+    end
+    def transformers
+      self.has_key?('transformers') && self['transformers'].is_a?(Array) ? self['transformers'] : []
+    end
+    
+    def update
+    end
+    def delete
+      ZedDB::ModelItems.delete(:user_key => uk, :locale => lc, :uuid => uuid)
+    end
+    
+    def to_s
+      rs  = "\nZedDB Data Item within Model \"#{model['name']}\":\n" \
+         << "  Name           : #{self['name']}\n" \
+         << "  UUID           : #{self['uuid']}\n" \
+         << "  Type           : #{self['type']['code']}\n" \
+         << "  Validations    : #{validations.count}\n" \
+         << "  Transformers   : #{transformers.count}\n" \
+         << "  Version        : #{self['version']}\n" \
+         << "  Created        : #{time(self['created_at'])}\n" \
+         << "  Updated        : #{time(self['updated_at'])}\n"
+      if validations.empty? && transformers.empty?
+        rs << dashes(20) << "\n"
+      else
+        unless validations.empty?
+          rs << dashes(70) << "| #{'Data Item Validations'.center(66)} |\n" << dashes(70) \
+             << "| #{'UUID'.ljust(32)} | #{'Code'.center(4)} | #{'Qualifier'.center(24)} |\n" << dashes(70)
+          validations.each {|vd| rs << "| #{vd['uuid']} | #{vd['validation']['code'].center(4)} | #{qualifier(vd)} |\n" }
+          rs << dashes(70)
+        end
+        unless transformers.empty?
+          rs << dashes(70) << "| #{'Data Item Transformers'.center(66)} |\n" << dashes(70) \
+             << "| #{'UUID'.ljust(32)} | #{'Code'.center(31)} |\n" << dashes(70)
+          transformers.each {|ts| rs << "| #{ts['uuid']} | #{ts['transformer']['code'].center(31)} |\n" }
+          rs << dashes(70)
+        end
+        rs << "\n"
+      end
+      rs
+    end
+
+    protected
+    def set_with_uuid(uuid_to_use)
+      replace ZedDB::ModelItems.get(:user_key => uk, :locale => lc, :uuid => uuid_to_use)
+    end
+
+    private
+    def qualifier(vd)
+      vd.has_key?('qualifier') ? vd['qualifer'].center(24) : 'N/A'.center(24)
+    end
+  end
+end

data/lib/zeddb/instances/model_transformer.rb

@@ -0,0 +1,34 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelTransformer < Zedkit::Instance
+    def model_item
+      ZedDB::ModelItem.new(:user_key => uk, :locale => lc, :uuid => item['uuid'])
+    end
+
+    def delete
+      ZedDB::ModelTransformers.delete(:user_key => uk, :locale => lc, :item => { :uuid => item['uuid'] }, :uuid => uuid)
+    end
+
+    protected
+    def set_with_owner_and_uuid(item_uuid, transformer_uuid)
+      replace ZedDB::ModelTransformers.get(:user_key => uk, :locale => lc,
+                                          :item => { :uuid => item_uuid }, :uuid => transformer_uuid)
+    end
+  end
+end

data/lib/zeddb/instances/model_validation.rb

@@ -0,0 +1,36 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelValidation < Zedkit::Instance
+    def model_item
+      ZedDB::ModelItem.new(:user_key => uk, :locale => lc, :uuid => item['uuid'])
+    end
+
+    def update
+    end
+    def delete
+      ZedDB::ModelValidations.delete(:user_key => uk, :locale => lc, :item => { :uuid => item['uuid'] }, :uuid => uuid)
+    end
+
+    protected
+    def set_with_owner_and_uuid(item_uuid, validation_uuid)
+      replace ZedDB::ModelValidations.get(:user_key => uk, :locale => lc,
+                                          :item => { :uuid => item_uuid }, :uuid => validation_uuid)
+    end
+  end
+end

data/lib/zeddb/instances/project.rb

@@ -0,0 +1,24 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module Zedkit
+  class Project < Zedkit::Instance
+    def models
+      Zedkit::Projects::Models.get(:user_key => uk, :locale => lc, :project => { :uuid => uuid })
+    end
+  end
+end

data/lib/zeddb/resources/model_associations.rb

@@ -0,0 +1,66 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelAssociations
+    class << self
+      #
+      # = ZedDB Model Associations
+      #
+      # ZedDB models can be associated with each other in predetermined ways. You can create or delete model associations.
+      # A model's associations are listed within its response data set.
+      #
+      # To create a new Model Assocation you submit the required parameters of the association type with the model UUIDs that
+      # you are creating an association between. Whatever items you send within the :association Hash are passed through to
+      # the ZedAPI untouched. There is no client side validation within this gem.
+      #
+      # Associations can be confusing to create, given that the order is arbitary. But you would read an association as
+      # Model B belongs to Model A. So, to create a belongs_to association. You would be using the resource location based
+      # on Model B, creating an association to Model A, with "first" and "second" labels as you read the association aloud.
+      #
+      #   ZedDB::ModelAssociations.create(:user_key => user['user_key'],
+      #                                   :association => { :first => model_b['uuid'],
+      #                                                     :code => 'BT', :inverse => 'HM', :second => model_b['uuid] })
+      #
+      # To delete a Model Association:
+      #
+      #   ZedDB::ModelAssociations.delete(:user_key => user['user_key'], :uuid => association['uuid])
+      #
+      # From each of these requests the Zedkit::Client class will return a response hash for your reference, if needed,
+      # or as applicable to the request. If there was a HTTP 401 or 404 you will get a nil response. This indicates a
+      # security failure or that an UUID is incorrect, not attached the user's account, or non-existent.
+      #
+      # For each request you can also pass a block to process the response directly:
+      #
+      #   ZedDB::ModelAssociations.delete(:user_key => user['user_key'], :uuid => association['uuid]) do |result|
+      #   end
+      #
+
+      def get(zks = {}, &block)
+        Zedkit::Client.crud(:get, "db/associations/#{zks[:uuid]}", zks, [], &block)
+      end
+
+      def create(zks = {}, &block)
+       Zedkit::Client.crud(:create, 'db/associations', zks, [], &block)
+      end
+
+      def delete(zks = {}, &block)
+       Zedkit::Client.crud(:delete, "db/associations/#{zks[:uuid]}", zks, [], &block)
+      end
+    end
+  end
+end

data/lib/zeddb/resources/model_items.rb

@@ -0,0 +1,73 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelItems
+    class << self
+      #
+      # = ZedDB Models Data Items
+      #
+      # All ZedDB models need data items. You can create, read, update, or delete model data items. To perform an 
+      # operation on a specific model item you need its UUID, as available from the Models.get() method.
+      #
+      # To get a Model Item:
+      #
+      #   ZedDB::ModelItems.get(:user_key => user['user_key'], :uuid => item['uuid'])
+      #
+      # To update a Model Item:
+      #
+      #   ZedDB::ModelItems.update(:user_key => user['user_key'], :uuid => item['uuid'], :item => { :name => 'newname' })
+      #
+      # To delete a Model Item:
+      #
+      #   ZedDB::ModelItems.delete(:user_key => user['user_key'], :uuid => item['uuid])
+      #
+      # To create a new Model Item you submit the required parameters with the model UUID that you are creating the 
+      # model item within. Whatever items you send within the :item Hash are passed through to the ZedAPI untouched.
+      # There is no client side validation within this gem.
+      #
+      #   ZedDB::ModelItems.create(:user_key => user['user_key'],
+      #                            :model => { :uuid => model['uuid'] }, :item => { :name => 'whatever' })
+      #
+      # From each of these requests the Zedkit::Client class will return a response hash for your reference, if needed,
+      # or as applicable to the request. If there was a HTTP 401 or 404 you will get a nil response. This indicates a
+      # security failure or that an UUID is incorrect, not attached the user's account, or non-existent.
+      #
+      # For each request you can also pass a block to process the response directly:
+      #
+      #   ZedDB::ModelItems.get(:user_key => user['user_key'], :uuid => model['uuid']) do |result|
+      #   end
+      #
+
+      def get(zks = {}, &block)
+        Zedkit::Client.crud(:get, "db/items/#{zks[:uuid]}", zks, [], &block)
+      end
+
+      def create(zks = {}, &block)
+        Zedkit::Client.crud(:create, 'db/items', zks, [], &block)
+      end
+
+      def update(zks = {}, &block)
+        Zedkit::Client.crud(:update, "db/items/#{zks[:uuid]}", zks, [], &block)
+      end
+
+      def delete(zks = {}, &block)
+        Zedkit::Client.crud(:delete, "db/items/#{zks[:uuid]}", zks, [], &block)
+      end
+    end
+  end
+end

data/lib/zeddb/resources/model_transformers.rb

@@ -0,0 +1,62 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelTransformers
+    class << self
+      #
+      # = ZedDB Model Transformers
+      #
+      # ZedDB model data items can have standard "transformers" attached to them -- actions to be performed on the data item
+      # just before it is saved to the underlying storage system. You can create or delete model item transformers.
+      # A model item's transformers are listed within its response data set.
+      #
+      # To create a new Model Transformer you submit the required parameters of the transformer type with the model item
+      # UUID that you are attaching a transformer to. Whatever items you send within the :transformer Hash are passed through
+      # to the ZedAPI untouched. There is no client side validation within this gem.
+      #
+      #   ZedDB::ModelTransformers.create(:user_key => user['user_key'], :item => { :uuid => item['uuid'] },
+      #                                   :transformer => { :code => 'UP' })
+      #
+      # To delete a Model Transformer:
+      #
+      #   ZedDB::ModelTransformers.delete(:user_key => user['user_key'], :uuid => transformer['uuid])
+      #
+      # From each of these requests the Zedkit::Client class will return a response hash for your reference, if needed,
+      # or as applicable to the request. If there was a HTTP 401 or 404 you will get a nil response. This indicates a
+      # security failure or that an UUID is incorrect, not attached the user's account, or non-existent.
+      #
+      # For each request you can also pass a block to process the response directly:
+      #
+      #   ZedDB::ModelTransformers.delete(:user_key => user['user_key'], :uuid => transformer['uuid]) do |result|
+      #   end
+      #
+
+      def get(zks = {}, &block)
+        Zedkit::Client.crud(:get, "db/items/#{zks[:item][:uuid]}/transformers/#{zks[:uuid]}", zks, %w(item), &block)
+      end
+
+      def create(zks = {}, &block)
+        Zedkit::Client.crud(:create, "db/items/#{zks[:item][:uuid]}/transformers", zks, %w(item), &block)
+      end
+
+      def delete(zks = {}, &block)
+        Zedkit::Client.crud(:delete, "db/items/#{zks[:item][:uuid]}/transformers/#{zks[:uuid]}", zks, [], &block)
+      end
+    end
+  end
+end

data/lib/zeddb/resources/model_validations.rb

@@ -0,0 +1,66 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class ModelValidations
+    class << self
+      #
+      # = ZedDB Model Validations
+      #
+      # ZedDB model data items can have standard validations attached to them. You can create, update (if applicable to
+      # the validation type) or delete model item validations. A model item's validations are listed within its API 
+      # response data set.
+      #
+      # To create a new model item validation you submit the required parameters of the validation type with the model item
+      # UUID that you are attaching a valiation to. Whatever items you send within the :validation Hash are passed through
+      # to the ZedAPI untouched. There is no client side validation within this gem.
+      #
+      #   ZedDB::ModelValidations.create(:user_key => user['user_key'], :item => { :uuid => item['uuid'] },
+      #                                  :validation => { :code => "SB" })
+      #
+      # To delete a model item validation:
+      #
+      #   ZedDB::ModelValidations.delete(:user_key => user['user_key'], :uuid => validation['uuid])
+      #
+      # From each of these requests the Zedkit::Client class will return a response hash for your reference, if needed,
+      # or as applicable to the request. If there was a HTTP 401 or 404 you will get a nil response. This indicates a
+      # security failure or that an UUID is incorrect, not attached the user's account, or non-existent.
+      #
+      # For each request you can also pass a block to process the response directly:
+      #
+      #   ZedDB::ModelValidations.delete(:user_key => user['user_key'], :uuid => validation['uuid]) do |result|
+      #   end
+      #
+
+      def get(zks = {}, &block)
+        Zedkit::Client.crud(:get, "db/items/#{zks[:item][:uuid]}/validations/#{zks[:uuid]}", zks, %w(item), &block)
+      end
+
+      def create(zks = {}, &block)
+        Zedkit::Client.crud(:create, "db/items/#{zks[:item][:uuid]}/validations", zks, %w(item), &block)
+      end
+
+      def update(zks = {}, &block)
+        Zedkit::Client.crud(:update, "db/items/#{zks[:item][:uuid]}/validations/#{zks[:uuid]}", zks, %w(item), &block)
+      end
+
+      def delete(zks = {}, &block)
+        Zedkit::Client.crud(:delete, "db/items/#{zks[:item][:uuid]}/validations/#{zks[:uuid]}", zks, [], &block)
+      end
+    end
+  end
+end

data/lib/zeddb/resources/models.rb

@@ -0,0 +1,73 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module ZedDB
+  class Models
+    class << self
+      #
+      # = ZedDB Database Models
+      #
+      # All ZedDB application databases have models. You can create, read, update, or delete models. To perform an 
+      # operation on a specific model you need its UUID, as available from the Websites.models method.
+      #
+      # To get a Model:
+      #
+      #   ZedDB::Models.get(:user_key => user['user_key'], :uuid => model['uuid'])
+      #
+      # To update a Model:
+      # 
+      #   ZedDB::Models.update(:user_key => user['user_key'], :uuid => model['uuid'])
+      #
+      # To delete a Model:
+      #
+      #   ZedDB::Models.delete(:user_key => user['user_key'], :uuid => model['uuid'])
+      #
+      # To create a new Model you submit the required parameters with the project UUID that you are creating the 
+      # model for. Whatever items you send within the :model Hash are passed through to the ZedAPI untouched.
+      # There is no client side validation within this gem.
+      #
+      #   ZedDB::Models.create(:user_key => user['user_key'],
+      #                        :project => { :uuid => project['uuid'] }, :model => { :name => 'whatever' })
+      #
+      # From each of these requests the Zedkit::Client class will return a response hash for your reference, if needed,
+      # or as applicable to the request. If there was a HTTP 401 or 404 you will get a nil response. This indicates a
+      # security failure or that an UUID is incorrect, not attached the user's account, or non-existent.
+      #
+      # For each request you can also pass a block to process the response directly:
+      #
+      #   ZedDB::Models.get(:user_key => user['user_key'], :uuid => model['uuid']) do |result|
+      #   end
+      #
+
+      def get(zks = {}, &block)
+        Zedkit::Client.crud(:get, "db/models/#{zks[:uuid]}", zks, [], &block)
+      end
+
+      def create(zks = {}, &block)
+        Zedkit::Client.crud(:create, 'db/models', zks, [], &block)
+      end
+
+      def update(zks = {}, &block)
+        Zedkit::Client.crud(:update, "db/models/#{zks[:uuid]}", zks, [], &block)
+      end
+      
+      def delete(zks = {}, &block)
+        Zedkit::Client.crud(:delete, "db/models/#{zks[:uuid]}", zks, [], &block)
+      end
+    end
+  end
+end

data/lib/zeddb/resources/projects.rb

@@ -0,0 +1,40 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+module Zedkit
+  class Projects
+    class Models
+      class << self
+        #
+        # = ZedDB Application Databases
+        #
+        # All projects/applications have an assigned database whether they use it or not. We just bypass the concept of a
+        # separate database API resource. You ask the project/application directly for the models setup within its database:
+        #
+        #   Zedkit::Projects.Models.get(:user_key => user['user_key'], :project => { :uuid => project['uuid'] })
+        #
+        # Each Zedkit project/application has an unique UUID available within the user's projects list, which you can then use
+        # here, and with all methods that collect objects attached to a project/application.
+        #
+
+        def get(zks = {}, &block)
+          Zedkit::Client.crud(:get, 'db/models', zks, [], &block)
+        end
+      end
+    end
+  end
+end

data/lib/zeddb.rb

@@ -0,0 +1,34 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+require 'rubygems'
+require 'zedkit'
+
+module ZedDB
+  class << self
+    def entities(user_key)
+      rs = Zedkit::Client.get('entities/zeddb', user_key)
+      if rs && block_given?
+        rs.is_a?(Array) ? rs.each {|i| yield(i) } : yield(rs)
+      end
+      rs
+    end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/zeddb/instances/*.rb"].each {|ci| require ci }
+Dir["#{File.dirname(__FILE__)}/zeddb/resources/*.rb"].each {|ci| require ci }

data/test/helper.rb

@@ -0,0 +1,47 @@
+##
+# Copyright (c) Zedkit.
+#
+# 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.
+##
+
+require 'test/unit'
+require 'rubygems'
+require 'zeddb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+class Test::Unit::TestCase
+  TEST_GEMS_PROJECT_KEY = 'BE1OZog8gJogtQTosh'
+  TEST_GEMS_LOGIN = 'gems@zedkit.com'
+  TEST_GEMS_PASSWORD = 'NGIaDhr5vDlXo1tDs6bW3Gd'
+
+  def setup
+    Zedkit.configure do |zb|
+      zb.project_key = TEST_GEMS_PROJECT_KEY
+      # zb.exceptions = true
+      # zb.api_host = '0.0.0.0'
+      # zb.api_port = 5010
+    end
+    @uu = Zedkit::Users.verify(:username => TEST_GEMS_LOGIN, :password => TEST_GEMS_PASSWORD)
+  end
+  
+  protected
+  def pmodels
+    Zedkit::Projects::Models.get(:user_key => @uu['user_key'], :project => { :uuid => @uu['projects'][0] })
+  end
+  def item_model
+    pmodels.find {|i| i['name'] == 'item' }
+  end
+end