tincan-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d8e6d0f6665e44b42e6a10c0874876c9fcac4f
-  data.tar.gz: 47d1993e51ca9618e0a9c95d41736a5885320d44
+  metadata.gz: c32c0ab4d57941b00135030ff38a27c64af3dc25
+  data.tar.gz: fe82042c353a55cae57feab55d020fb6e6b1ef58
 SHA512:
-  metadata.gz: 2b2fc497a67586a015b028fa3ef8d818785e8dd042051b35a9de1e68c817f63a5f9d6b729d94b23c921b04c6d7b9fbb332da74615a14dcc9e9fa6dd2f8b67616
-  data.tar.gz: 20199b6ec7dd4b73da6b4ee708da07424fa1b06f5905954c0743e3391dc7f9cd29c44f0bcde73133dfad0ed72c0f74630396868154b6f23e67dd3c17274d5ef6
+  metadata.gz: aa0d4f390dd840fbe9cf9202cecd6a853f9927ebefe9201bac056c76cfe968cadede3ad10adebed85a9193484f6bb8d763fb4859e97b63dc6698d8738b41278e
+  data.tar.gz: 768ec2bdeff8ea0ddb9004fb3d10ae8c78add47da8b8784e3a7b3d74b3ed351103cd97e736cb72e3f5d98822353bbc35326ef7fe41e07026eaec07066fa4ae76

data/lib/tincan.rb

@@ -1,20 +1,52 @@
 ["httparty", "json"].each(&method(:require))
 
+# @author Charles Hollenbeck
 class TinCan
     include HTTParty
     base_uri "apps.tincan.me"
 
+    # Initializes the starting variables to connect to the TinCan Storage API
+    #
+    # @param app_id [String] The ID for your TinCan Storage application
+    # @param app_key [String] The key for your TinCan Storage application
+    # @param app_name [String] The name for your TinCan Storage application
+    #
+    # @example TinCan.new("5e6a7e38c97b", "81aca0b3a200dd52bda8bca268ee68a8", "example")
     def initialize(app_id, app_key, app_name)
+        # Initialize the starting variables to connect to the TinCan Storage API
         @id   = app_id
         @key  = app_key
         @name = app_name
     end
 
+    # Inserts data into a TinCan Storage Application
+    # @param query [Hash] A hash of the query you wish to send to the TinCan Storage API
+    # @example var.insert({:key => "value", :sec_key => "value"})
+    # @return [Boolean, String] True or the error
     def insert(query) return read_response(req("insert", query.to_json))     end
+
+    # Finds data in a TinCan Storage Application
+    # @param query [Hash] A hash of the query you wish to send to the TinCan Storage API
+    # @example var.find({:query => {:key => "value"}, :options => {}}) Options are listed at http://apps.tincan.me/#manipulating
+    # @return [String] The returned data from the query or an error
     def find(query)   return read_response(req("find", query.to_json), true) end
+
+    # Updates data in a TinCan Storage Application
+    # @param query [Hash] A hash of the query you wish to send to the TinCan Storage API
+    # @example var.find({:query => {:key => "value"}, :data => {"$inc" => {:age => 1}}}) Options are listed at http://apps.tincan.me/#manipulating
+    # @return [Boolean, String] True or the error
     def update(query) return read_response(req("update", query.to_json))     end
+
+    # Deletes data from a TinCan Storage Application
+    # @param query [Hash] A hash of the query you wish to send to the TinCan Storage API
+    # @example var.delete({:query => {:key => "value", :sec_key => "value"}, :options => {:drop => true}})
+    # @note As a safeguard, an empty query will NOT delete all documents. To erase ALL data in your application's database, you can drop it by using the query {:options => {:drop => true}}. You don't need to supply a query attribute, as it will be ignored if this option is present.
+    # @return [Boolean, String] True or the error
     def delete(query) return read_response(req("remove", query.to_json))     end
 
+    # Validates your credentials with the TinCan Storage API
+    # @example var.validate
+    # @return [Boolean, String] True if it worked, an error otherwise. Errors can be: "NO SUCH APP" or "INVALID_CREDENTIALS"
     def validate
         return  read_response(
                     self.class.get(
@@ -26,6 +58,10 @@ class TinCan
     end
 
     private
+        # Makes requests using HTTParty to the TinCan Storage API
+        # @param type [String] The type of query being made (insert|find|update|remove)
+        # @param query [String] The JSON Document to send to the TinCan Storage API
+        # @return [String] The response's body
         def req(type, query)
             return  self.class.post(
                         "/#{@name}/#{type}",
@@ -35,6 +71,10 @@ class TinCan
                     ).body
         end
 
+        # Interprets the response from the TinCan Storage API
+        # @param res [String] The response body from the request
+        # @param has_data [Boolean] Optional parameter to tell it wether it has data being sent back in the response
+        # @return [Boolean, String] True if successful, a ruby hash of data if output has data or an error
         def read_response(res, has_data = false)
             res = JSON.parse(res)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tincan-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Charles Hollenbeck
@@ -70,3 +70,4 @@ signing_key:
 specification_version: 4
 summary: Ruby gem for the TinCan Storage API
 test_files: []
+has_rdoc: