crud-service 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTJkYTAyY2I2NDNjMGFmMGEwYTIwMDZlNDcxYTEzMTdmNTBmYjI0Nw==
+    YjI2NzcwMzlkODRmMGFmMzg3Mzc4MWQ3YjBkNWIxMjcyZGEyZDM4Mg==
   data.tar.gz: !binary |-
-    NjU1MzQwMzU4NTNmOGNmYzEyMmZlNjdkODNlYTQ4MDk1MGQ3YmE0Mg==
+    YjI5YThmMDI1ODMxODU2NzlkNzU1NTg0ODk4YzhiNzk4YTUxNzg0Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjIyMjBiYTJmYmI0MzBlZjEwYWM1OWVkMmI4ZmQyMzM3NzRmOTNlMzEyOGIx
-    YTFmMGM4NTFlNTIwNzYzM2JlNDhjZjVmNzEwOTcxM2U2OTM1YWE5YWIxNDFj
-    ZjFiNGNhZGM3ZThjMGExZGFlMzllZTE0ZTg2MWRkODY5ODhiOGM=
+    YjhlZjM4MTAyYzk5YmQ1NTlkMGRjNmFjYjkzYjQ4N2FkYmFmNWU4NGE1YjVl
+    Y2JhNzIwNGM5NGFkYjllM2JhNjlkM2Q2ZDg3YjNkYTZjMGEzZjk5ZThkNWUy
+    NjBjZjMyNGRiODRkNWFmZTZiNTIyODk2ODM2ZDUxOThkMzUzYzg=
   data.tar.gz: !binary |-
-    OWU1NTE2Mjk5ZTNmMWVjODBjMWJkMjUzMDhkOTBhZTQ0NzI5MTA5MWIzNjI2
-    OTMxMjQ1Mjg3ZWNiYmJiMWNhNGY0ZTU0ZmU5OGQ3YWNiNjY1YTNlZTc1N2Ux
-    YzQ5MWNmNjdmNDQ1N2QxNGFlZGQ3NTkyZTE3NWI3NDg3M2U1M2E=
+    ZjM0N2JiYWYxZjAxZTVhODk3YzQ4M2UzZWRhZWIyY2ZmNDhmZjYzZTMwMzNm
+    MTFmN2I1OTZiNDQ0Mjg5OTRlY2Q5YWMzN2M0NzgwY2Q1YmM2ZGNkNDk2MjQ5
+    OGY2YTBjYWM4ODUyZDdiZWE1ZjY0ZDcyZTY4ZGI2OGM0N2U2YjU=

data/lib/crud-service.rb

@@ -1,3 +1,10 @@
+# The crud-service gem provides a set of classes to quickly produce a basic CRUD API, from
+# a MySQL database with optional memcached caching.
+#
+# Author::    Tom Cully (mailto:tomhughcully@gmail.com)
+# Copyright:: Copyright (c) Tom Cully
+# License::   Apache 2
+
 base = File.expand_path('../', __FILE__)
 
 require "#{base}/generic_dal.rb"

data/lib/generic_api.rb

@@ -1,4 +1,7 @@
 module CrudService
+
+  # This class provides a static method, crud_api, to configure a sinatra class with the
+  # provided service, resource and primary key.
   class GenericApi
 
     def self.crud_api(sinatra, service_name, name, primary_key_name)

data/lib/generic_dal.rb

@@ -2,11 +2,17 @@ require 'json'
 require 'mysql2'
 
 module CrudService
+
+  # This class creates an instance of a generic DAL (Data Access Layer) with cache 
+  # capability from the provided mysql client, logger and optionally memcache client. 
+  # Your should extend this class to provide configuration for your dal, please see 
+  # the README file at http://github.com/tomcully/crud-service
 	class GenericDal
 
     attr_accessor :mysql, :memcache, :log, :table_name, :fields, :relations, :primary_key
 
-    def initialize(mysql, memcache, log) 
+    # Create an instance.
+    def initialize(mysql, memcache = nil, log) 
       @mysql = mysql
       @memcache = memcache
       @log = log

data/lib/generic_log.rb

@@ -1,17 +1,23 @@
 module CrudService
+
+  # This class provides a Generic Logger.
   class GenericLog
+    # Log a debug message
     def debug(str)
       puts "DEBUG: #{str}"
     end
 
+    # Log an info message
     def info(str)
       puts "INFO: #{str}"
     end
 
+    # Log a warning message
     def warn(str)
       puts "WARN: #{str}"
     end
 
+    # Log an error message
     def error(str)
       puts "ERROR: #{str}"
     end

data/lib/generic_service.rb

@@ -1,57 +1,62 @@
 module CrudService
-  class GenericService
 
+  # This class provides a generic service instance for the provided DAL and logger.
+  class GenericService
     attr_accessor :dal, :log
 
+    # Instantiate a service with the specified DAL and logger.
     def initialize(dal, log)
       @dal = dal
       @log = log
     end
 
-    # CRUD
-
-    def insert(body)
-      @dal.insert(body)
+    # Insert a record with the supplied data record
+    def insert(data)
+      @dal.insert(data)
     end
 
+    # Get all records matching the specified query
     def get_all_by_query(query)
       res = @dal.get_all_by_query(query)
       @dal.map_in_included_relations!(res,query)
       res
     end
 
+    # Get one records matching the specified query
     def get_one_by_query(query)
       res = get_all_by_query(query)
       return nil if res.length == 0
       res[0]
     end
 
-    def update_by_primary_key(primary_key,body)
-      @dal.update_by_primary_key(primary_key,body)
+    # Update one record matching the specified primary key with data
+    def update_by_primary_key(primary_key, data)
+      @dal.update_by_primary_key(primary_key,data)
     end
 
+    # Delete one record matching the specified primary key
     def delete_by_primary_key(primary_key)
       @dal.delete_by_primary_key(primary_key)
     end
 
-    # Existence
-
+    # Return true if a record matching the specified primary key exists
     def exists_by_primary_key?(primary_key)
       @dal.exists_by_primary_key?(primary_key)
     end
 
-    # Validation
-
-    def valid_insert?(body)
-      @dal.valid_insert?(body)
+    # Return true if the specified data is valid for insert
+    def valid_insert?(data)
+      @dal.valid_insert?(data)
     end
 
+    # Return true if the specified query is valid
     def valid_query?(query)
       @dal.valid_query?(query)
     end
 
-    def valid_update?(body)
-      @dal.valid_update?(body)
+    # Return true if the specified data is valid for update
+    def valid_update?(data)
+      @dal.valid_update?(data)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crud-service
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tom Cully
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies: []
 description: A basic gem for automatic CRUD services using only Sinatra, MySQL and
   Memcache
@@ -22,7 +22,7 @@ files:
 - lib/generic_dal.rb
 - lib/generic_log.rb
 - lib/generic_service.rb
-homepage: http://rubygems.org/gems/crud-service
+homepage: http://github.com/tomcully/crud-service
 licenses:
 - Apache2
 metadata: {}