easy-api 0.0.1 → 0.1.0

data/lib/easy/api/controller_methods.rb

@@ -5,7 +5,8 @@ module Easy::Api::ControllerMethods
     def render_format
       respond_to do |format|
         format.html { render :status => @result.status_code }
-        format.json { render :json => @result, :status => @result.status_code }
+        format.xml  { render :xml => @result.to_xml(:root => 'response', :skip_types => true), :status => @result.status_code }
+        format.json { render :json => @result, :status => (params[:callback].present? ? 200 : @result.status_code), :callback => params[:callback] }
       end
     end
 

data/lib/easy/api/error.rb

@@ -3,27 +3,31 @@ module Easy::Api
   class Error
     attr_reader :code, :message
 
-    CODES = {
-      invalid: 400,
-      unauthorized: 401,
-      not_found: 404,
-      unexpected: 500
-    }
+    def self.codes
+      {
+        invalid: 400,
+        unauthorized: 401,
+        not_found: 404,
+        unexpected: 500
+      }
+    end
 
-    MESSAGES = {
-      invalid: "Invalid request",
-      unauthorized: "This request requires a valid Private API Key",
-      not_found: "Resource not found",
-      unexpected: 'Sorry! An exception has occured. Please try again later',
-    }
+    def self.messages
+      {
+        invalid: "Invalid request",
+        unauthorized: "This request requires a valid Private API Key",
+        not_found: "Resource not found",
+        unexpected: 'Sorry! An exception has occured. Please try again later',
+      }
+    end
 
     # Initializes a new error based on the type, with an optional custom message
     #
     # @param [Symbol] type can be :invalid, :unauthorized, :not_found, or :unexpected
     # @param [optional, String] msg a custom error message (see MESSAGES for default message values)
     def initialize(type, msg=nil)
-      @code = CODES[type]
-      @message = msg || MESSAGES[type]
+      @code = self.class.codes[type]
+      @message = msg || self.class.messages[type]
     end
 
     # Returns the error as a hash
@@ -39,5 +43,12 @@ module Easy::Api
     def as_json(options={})
       to_hash
     end
+
+    # Used by Rails to parse the error as xml
+    #
+    # @return [Hash] a hash containing the error code and message
+    def to_xml(options={})
+      to_hash.to_xml(options)
+    end
   end
 end

data/lib/easy/api/result.rb

@@ -34,6 +34,20 @@ module Easy::Api
     # Will always contain 'success', the error if there is one, and any dynamic attributes.
     # @return [Hash]
     def as_json(options={})
+      convert_to_hash
+    end
+
+    # Used by Rails to parse the result as xml
+    #
+    # Will always contain 'success', the error if there is one, and any dynamic attributes.
+    # @return [Hash]
+    def to_xml(options={})
+      convert_to_hash.to_xml(options)
+    end
+
+    private
+
+    def convert_to_hash
       hash = marshal_dump.merge(success: success)
       hash[:error] = error unless error.nil?
       hash

data/lib/easy/api/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module Api
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/spec/lib/easy/api/error_spec.rb

@@ -11,7 +11,7 @@ describe Easy::Api::Error do
 
     context "when no message is passed in" do
       let(:message) { nil }
-      its(:message) { should == Easy::Api::Error::MESSAGES[:invalid] }
+      its(:message) { should == Easy::Api::Error.messages[:invalid] }
     end
   end
 
@@ -19,7 +19,7 @@ describe Easy::Api::Error do
     subject { Easy::Api::Error.new(:unexpected, msg).as_json }
     let(:msg) { 'uh, oh' }
 
-    its([:code]) { should == Easy::Api::Error::CODES[:unexpected] }
+    its([:code]) { should == Easy::Api::Error.codes[:unexpected] }
     its([:message]) { should == msg }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3062167263312735286
+      hash: -2946297048628258418
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3062167263312735286
+      hash: -2946297048628258418
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24