casual_helper 0.0.7 → 0.0.8

data/casual_helper.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["matthewspivey"]
   gem.email         = ["spivey.mathew@gmail.com"]
   gem.description   = %q{Casual gem}
-  gem.summary       = %q{A casual gem, that probably isn't what you're looking for}
+  gem.summary       = %q{A casual gem, which probably isn't what you're looking for}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($\)

data/lib/casual_helper/version.rb

@@ -1,3 +1,3 @@
 module CasualHelper
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/casual_helper.rb

@@ -11,7 +11,7 @@ assumptions
 * model classes should define variables and set them to default values
 
 design decisions
-* log errors and return nil
+* on error: log error message and return nil
 
 todo
 * improve error handling
@@ -22,6 +22,13 @@ todo
 JSON_CONTENT = {:content_type => :json, :accept => :json}
 
 module CasualHelper
+  ##
+  # CasualHelper::Api makes it easier to use the Casual Cloud REST API
+  #
+  # == Usage
+  #
+  #   api = CasualHelper::Api.new 'http://localhost:9393'
+  #
   class Api
 
     def initialize(api_server)
@@ -44,23 +51,65 @@ module CasualHelper
       }
     end
 
-    def get_drop(tap_id, drop_id)
-      return if are_invalid tap_id, drop_id
-      get "#{@api_server.to_s}/v0/taps/#{tap_id}/drops/#{drop_id}"
-    end
-
-    def add_tap(options)
-      return if are_invalid options
-      post "#{@api_server.to_s}/v0/taps", options
+    #
+    # == Description
+    #
+    # Fetch all recent taps from the Casual Cloud API server
+    #
+    # Example:
+    #
+    #     drops = api.get_taps #=> [{"id" => "0123456789abcdef01234567", ...}, ...]
+    #
+    # Returns nil on error.
+    #
+    # TODO - add limit parameter
+    #
+    def get_taps
+      get "#{@api_server.to_s}/v0/taps"
     end
 
+    #
+    # == Description
+    #
+    # Fetch the tap with the specified ID
+    #
+    # @param tap_id If valid mongo ID string for an existing tap, the tap
+    # will be returned as a hash
+    #
+    # Example:
+    #
+    #     tap = api.get_tap('0123456789abcdef01234567') #=> {"id" => "0123456789abcdef01234567", ...}
+    #
+    # Returns nil on error.
+    #
     def get_tap(tap_id)
-      return if are_invalid tap_id
+      return if are_invalid_mongo_key tap_id
       get "#{@api_server.to_s}/v0/taps/#{tap_id}"
     end
 
-    def get_taps
-      get "#{@api_server.to_s}/v0/taps"
+    #
+    # == Description
+    #
+    # Fetch the drop with the specified IDs
+    #
+    # @param tap_id string containing the mongo ID of an existing tap
+    # @param drop_id string containing the mongo ID of an existing drop
+    #
+    # Example:
+    #
+    #     tap = api.get_tap('0123456789abcdef01234567', 5) #=> {"id" => 5, "tap_id" => "7654321fedcba9876543210", ...}
+    #
+    # Returns nil on error.
+    #
+    def get_drop(tap_id, drop_id)
+      return if are_invalid_mongo_key tap_id
+      return if are_invalid drop_id
+      get "#{@api_server.to_s}/v0/taps/#{tap_id}/drops/#{drop_id.to_i}"
+    end
+
+    def add_tap(options)
+      return if are_invalid options
+      post "#{@api_server.to_s}/v0/taps", options
     end
 
     def add_drop(tap_id, options)
@@ -80,7 +129,7 @@ module CasualHelper
     end
 
     def get_user(id)
-      return if are_invalid id
+      return if are_invalid_mongo_key id
       get "#{@api_server.to_s}/v0/users/#{id}"
     end
 
@@ -152,6 +201,16 @@ module CasualHelper
       end
     end
 
+    def are_invalid_mongo_key(*params)
+      if params.nil? || params.any? {|param| param.nil? || !param.is_a?(String) || param.count != 24}
+        calling_method = caller[1][/`.*'/][1..-2]
+        p "Error in #{calling_method} - one or more parameters is nil - #{params.to_json}"
+        true
+      else
+        false
+      end
+    end
+
     # logs error with method name of caller
     # always returns nil
     def log_error(url, message)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - matthewspivey
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-24 00:00:00 -04:00
+date: 2012-09-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,6 +86,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: A casual gem, that probably isn't what you're looking for
+summary: A casual gem, which probably isn't what you're looking for
 test_files: []