easy-api 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d40b6123390053de3f071e4f6165a17be784a6bb
-  data.tar.gz: 83f13e03a1719a0a8dd588053a0c170f9bec1337
+  metadata.gz: e7a7b501b68e2d27078a346db4d2e9ccd369c227
+  data.tar.gz: 4c9343aac20833e366a9e62d213457f9c1e76e47
 SHA512:
-  metadata.gz: bb38bf79de2f57ccfdc344f0da6d2783fb340bca834f64104b2aa41b7a2ad6f27a4aaed8c4121c137679d18f3c9296651293015a50a5d2ee22b3c121bbf03d73
-  data.tar.gz: 2f77205504310db22339ab5b0f51d177c043ee4ad4d7e439568cbc88f60bc0cacfbc60f565faeb462a3b8e9179eb7f1d6a416a5e21ef6b2f2246135502191fe0
+  metadata.gz: 24a3a204a78387f1571f66f832c4b343b5c1b5786b3fac965449b514da09bab49ae71a9bb0d35e1c7cf56e9ebb12d2663be60545501e34bcc0a95d983a7a2f85
+  data.tar.gz: e98d3bc861219153d22ef088100079c1346e75dd7273b14ba2a5a12a9abf6de6bdb5e6971d4f53df7a1a9673e8f3d10431ec3fbdb8891799ee72ecfdc7e85842

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# EasyAPI 0.2.3 (August 28, 2015) #
+
+* Allow Easy::Api:Error.codes and Easy::Api:Error.messages to be added to
+
+# EasyAPI 0.2.2 (August 15, 2014) #
+
+* Reintroduce default formatting options when rendering xml
+
 # EasyAPI 0.2.1 (July 30, 2014) #
 
 * Auto-load without the need for a require statement
@@ -14,4 +22,4 @@
 # EasyAPI 0.1.2 (March 11, 2013) #
 
 * Genericize error messages
-* Add support for Ruby 1.8.7
+* Add support for Ruby 1.8.7

data/README.md

@@ -36,6 +36,11 @@ If you want to override the default error message, pass in a custom message, e.g
 
 Easy::Api::Error objects have a code (e.g. 404) and a message (e.g. 'Resource not found')
 
+You can also define you own error types. Add the following to `initializers/easy_api.rb`
+
+    Easy::Api::Error.codes[:rate_limited] = 429
+    Easy::Api::Error.messages[:rate_limited] = 'Rate limited'
+
 ### Using Easy::Api
 
 Add the following line to all Api Controllers:
@@ -72,7 +77,9 @@ Then render the result
 
      api.render_result(format: params[:format])
 
-If your API supports callbacks these can also be passed
+### Support for JSONP
+
+If your API supports callbacks (JSONP) these can also be passed. The returned content_type header will change to `application/javascript` in this case.
 
      api.render_result(format: params[:format], callback: params[:callback])
 

data/lib/easy/api/block_wrapper.rb

@@ -25,10 +25,16 @@ module Easy::Api::BlockWrapper
     # use the controller to render the response
     def render_result(render_params)
       format = (render_params[:format] || 'json').try(:to_sym)
+      formatted_result = if format == :xml
+        @result.to_xml(render_params[:options] || {})
+      else
+        @result
+      end
+
       if render_params[:callback].blank?
-        @controller.render(format => @result, :status => @result.status_code)
+        @controller.render(format => formatted_result, :status => @result.status_code)
       else
-        @controller.render(format => @result, :status => @result.status_code, :callback => render_params[:callback], :content_type => 'application/javascript')
+        @controller.render(format => formatted_result, :status => @result.status_code, :callback => render_params[:callback], :content_type => 'application/javascript')
       end
     end
 

data/lib/easy/api/error.rb

@@ -4,7 +4,7 @@ module Easy::Api
     attr_reader :code, :message
 
     def self.codes
-      {
+      @_codes ||= {
         :invalid      => 400,
         :unauthorized => 401,
         :not_found    => 404,
@@ -13,7 +13,7 @@ module Easy::Api
     end
 
     def self.messages
-      {
+      @_messages ||= {
         :invalid      => "Invalid request",
         :unauthorized => "Unauthorized request",
         :not_found    => "Resource not found",

data/lib/easy/api/result.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require "active_support/core_ext/hash/conversions"
 
 module Easy::Api
   # Encapsulates the response data of an API call
@@ -42,6 +43,9 @@ module Easy::Api
     # Will always contain 'success', the error if there is one, and any dynamic attributes.
     # @return [Hash]
     def to_xml(options={})
+      options = options.dup
+      options[:root]        ||= 'response'
+      options[:skip_types]  ||= true
       convert_to_hash.to_xml(options)
     end
 

data/lib/easy/api/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module Api
-    VERSION = "0.2.1"
+    VERSION = "0.2.3"
   end
 end

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

@@ -28,7 +28,7 @@ RSpec.describe CustomersController, :type => :controller do
 
     it "gets the index in xml format" do
       get :index, :format => 'xml'
-      expect(response.body).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <customers type=\"array\">\n    <customer>\n      <name>fred</name>\n      <age>19</age>\n    </customer>\n    <customer>\n      <name>jackie</name>\n      <age>21</age>\n    </customer>\n  </customers>\n  <success type=\"boolean\">true</success>\n</hash>\n")
+      expect(response.body).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <customers>\n    <customer>\n      <name>fred</name>\n      <age>19</age>\n    </customer>\n    <customer>\n      <name>jackie</name>\n      <age>21</age>\n    </customer>\n  </customers>\n  <success>true</success>\n</response>\n")
     end
 
   end
@@ -47,7 +47,7 @@ RSpec.describe CustomersController, :type => :controller do
 
     it "gets show in xml format" do
       get :show, :format => 'xml', id: 1
-      expect(response.body).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <customer>\n    <name>fred</name>\n    <age>21</age>\n  </customer>\n  <success type=\"boolean\">true</success>\n</hash>\n")
+      expect(response.body).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <customer>\n    <name>fred</name>\n    <age>21</age>\n  </customer>\n  <success>true</success>\n</response>\n")
     end
 
   end

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

@@ -33,4 +33,18 @@ describe Easy::Api::Error do
       expect(subject[:message]).to eql message
     end
   end
+
+  describe "#errors" do
+    it "should allow the Easy::Api:Error.codes to be altered" do
+      Easy::Api::Error.codes[:new_error] = 1010
+      expect(Easy::Api::Error.codes[:new_error]).to eq(1010)
+    end
+  end
+
+  describe "#messages" do
+    it "should allow the Easy::Api:Error.messages to be altered" do
+      Easy::Api::Error.messages[:new_error] = 'I am new'
+      expect(Easy::Api::Error.messages[:new_error]).to eq('I am new')
+    end
+  end
 end

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

@@ -93,4 +93,38 @@ describe Easy::Api::Result do
       end
     end
   end
+
+  describe "#to_xml" do
+
+    let(:result) { Easy::Api::Result.new }
+    subject { result.to_xml }
+
+    context "when result is unsuccessful" do
+      let(:api_error) { Easy::Api::Error.new(:unauthorized) }
+
+      before do
+        result.error = api_error
+      end
+
+      it "renders the object as " do
+        expect(subject).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <success>false</success>\n  <error>\n    <code>401</code>\n    <message>Unauthorized request</message>\n  </error>\n</response>\n")
+      end
+
+    end
+
+    context "when result is successful" do
+
+      before do
+        result.success = true
+        result.customer =  "Bob Loblaw"
+      end
+
+      it "renders the object as " do
+       expect(subject).to eql("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<response>\n  <customer>Bob Loblaw</customer>\n  <success>true</success>\n</response>\n")
+      end
+
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Shevaun Coker
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Facilitates standard success and error behaviour in API responses