fastapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68312e62ae3797dbc5cd672cc5cbc10766390ca3
-  data.tar.gz: 021eab09bc923f07bcf54da04d012d7102c608a7
+  metadata.gz: f404875852a90f7b72255293e1ea77b775bebd50
+  data.tar.gz: 3c50ae17829b4838528e6bd199ddee967c241af4
 SHA512:
-  metadata.gz: 0901d7eed24c1d75e5fa1be3c339a065c4e7b6c5a3d0bc8b1a51a508055e7b7e99ceef0a1508db682a4702c33d5cf2db06ee5617261a016c8e2fd1fc5ebff521
-  data.tar.gz: 4c62611aa52b91a266e800bc3ffdeb803c28dca90dea3210f9b70b4db905a845216fba7f4094d85316f6c2e68197b7cb2cb05c23403c89e9c71459288fc686b1
+  metadata.gz: 0edb07fcd025e2663d52b2034dcb6167eec57c0820b915278232dc60a4822dd0bd1123e24528f4cd02795c38222fdc4133f562f31e75cddd0604f9bf9ece37f6
+  data.tar.gz: ecf66e27e516ea0847e795ef25e49e23666bd7acde5c4251245e11a630b95f6000af9e87447fab2a58b1d6bebbf35e8dcfb3e2e2ca68780bd8d61e3755c973b0

data/lib/fastapi.rb

@@ -35,6 +35,12 @@ class FastAPI
     "<#{self.class}: #{@model}>"
   end
 
+
+  # Create and execute an optimized SQL query based on specified filters
+  #
+  # @param filters [Hash] a hash containing the intended filters
+  # @param meta [Hash] a hash containing custom metadata
+  # @return [FastAPI] the current instance
   def filter(filters = {}, meta = {})
 
     result = fastapi_query(filters)
@@ -59,6 +65,12 @@ class FastAPI
 
   end
 
+  # Create and execute an optimized SQL query based on specified object id.
+  # Provides customized error response if not found.
+  #
+  # @param id [Integer] the id of the object to retrieve
+  # @param meta [Hash] a hash containing custom metadata
+  # @return [FastAPI] the current instance
   def fetch(id, meta = {})
 
     result = fastapi_query({id: id})
@@ -89,22 +101,37 @@ class FastAPI
 
   end
 
-  def data_json
-    Oj.dump(@data)
-  end
-
+  # Returns the data from the most recently executed `filter` or `fetch` call.
+  #
+  # @return [Array] available data
   def data
     @data
   end
 
-  def meta_json
-    Oj.dump(meta)
+  # Returns JSONified data from the most recently executed `filter` or `fetch` call.
+  #
+  # @return [String] available data in JSON format
+  def data_json
+    Oj.dump(@data)
   end
 
+  # Returns the metadata from the most recently executed `filter` or `fetch` call.
+  #
+  # @return [Hash] available metadata
   def meta
     @metadata
   end
 
+  # Returns JSONified metadata from the most recently executed `filter` or `fetch` call.
+  #
+  # @return [String] available metadata in JSON format
+  def meta_json
+    Oj.dump(meta)
+  end
+
+  # Returns both the data and metadata from the most recently executed `filter` or `fetch` call.
+  #
+  # @return [Hash] available data and metadata
   def to_hash
     {
       meta: @metadata,
@@ -112,10 +139,17 @@ class FastAPI
     }
   end
 
+  # Intended to return the final API response
+  #
+  # @return [String] JSON data and metadata
   def response
     Oj.dump(self.to_hash)
   end
 
+  # Returns a JSONified string representing a standardized empty API response, with a provided error message
+  #
+  # @param message [String] Error message to be used in response
+  # @return [String] JSON data and metadata, with error
   def reject(message = 'Access denied')
     Oj.dump({
       meta: {

data/lib/fastapi/active_record_extension.rb

@@ -6,14 +6,26 @@ module FastAPIExtension
 
   module ClassMethods
 
+    # Used to set the standard interface for the top level of a fastapi response
+    #
+    # @param fields [Array] a list of fields in the form of symbols
+    # @return [Array] the same array of fields
     def fastapi_standard_interface(fields)
       @fastapi_fields = fields
     end
 
-    def fastapi_standard_interface_sub(fields)
+    # Used to set the standard interface for the second level of a fastapi response (nested)
+    #
+    # @param fields [Array] a list of fields in the form of symbols
+    # @return [Array] the same array of fields
+    def fastapi_standard_interface_nested(fields)
       @fastapi_fields_sub = fields
     end
 
+    # Used to set any default filters for the top level fastapi response
+    #
+    # @param filters [Hash] a hash containing the intended filters
+    # @return [Hash] the same filters hash
     def fastapi_default_filters(filters)
       @fastapi_filters = filters
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Keith Horwood