api_response 1.0.0

data/lib/api_response.rb

@@ -0,0 +1,31 @@
+class ApiResponse
+  class << self
+    # Example:
+    #   >> ApiResponse.success(:num_items => 3)
+    #   => {:status => "success", :data => {:num_items => 3}}
+    #
+    def success(data={})
+      {:status => "success", :data => data}
+    end
+
+    # Used an API call is rejected due to invalid data or call conditions.
+    #
+    # Example:
+    #   >> ApiResponse.fail("bad ID")
+    #   => {:status => "fail", :data => "bad ID"}
+    #
+    def fail(data={})
+      {:status => "fail", :data => data}
+    end
+
+    # Failure due to server error.
+    #
+    # Example:
+    #   >> ApiResponse.error("service down")
+    #   => {:status => "success", :message => "service down"}
+    #
+    def error(message)
+      {:status => "error", :message => message}
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: api_response
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Elben Shira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-12 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: An API response style.
+email: elbenshira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/api_response.rb
+has_rdoc: true
+homepage: http://github.com/MassRelevance/api_response
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An API response style.
+test_files: []
+