restfulness 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8d0ae0d276f2bc7050b05eb6e5847dbdb806eb4
-  data.tar.gz: 125d361645226748911052cddd7ffd754b868e31
+  metadata.gz: 5def9b04aa7a9bc0950574e5d1c05b831efd1119
+  data.tar.gz: 159796ac977c49ae23069175b52e3e452bdb2eb1
 SHA512:
-  metadata.gz: 0f72e3f6622107325d6758bfcdc9e65706bdad87fa196800c900e8a570e16e8ed52863b3b715e7c3b45c7c53a02291eb79f5cdae7e5aafc550d50ab9d78c0757
-  data.tar.gz: b38a2f978128b3962e4fa7d8fc27fdb1b322eceeb8d76b0da32d34ade8e6075429e6d84beb66ef1066a28ac4ad02878b24beb7ee091cf2d2b2cc75923372048a
+  metadata.gz: b8264abbb1f84368c3481d1f00eb22200a7d525ad9702dd19ccce78da1c77f9d4fa5cf0daa160abf14839a7006610ab490280c5c3401821e42078a27816ee9bf
+  data.tar.gz: 8dd35a50d84c0465df049d4bf1648eb13d7ecee684528d63713ba1de0964779e8fe7c0e6940558dc3d5a680bfbce75d89d68866f3dd46a592569ad2d7f8f3324

data/README.md

@@ -698,14 +698,18 @@ The project is now awesome, thanks to contributions by:
 
 Restfulness is still a work in progress but at Cabify we are using it in production. Here is a list of things that we'd like to improve or fix:
 
- * Support for more serializers and content types, not just JSON.
+ * More generic support for custom serializers and content types.
  * Support path methods for automatic URL generation.
  * Support redirect exceptions.
  * Needs more functional testing.
- * Support for before and after filters in resources, although I'm slightly apprehensive about this.
 
 ## History
 
+### 0.3.6 - June 14, 2017
+
+ * Fixing issue for overriding response Content-Type headers (@samlown)
+ * Adding basic support for XML responses if requested in Accept headers (@samlown)
+
 ### 0.3.5 - February 21, 2017
 
  * Rewind body after reading (@pacoguzman)

data/lib/restfulness/headers/accept.rb

@@ -60,6 +60,13 @@ module Restfulness
         false
       end
 
+      def text?
+        media_types.each do |mt|
+          return true if mt.text?
+        end 
+        false
+      end
+
     end
 
   end

data/lib/restfulness/response.rb

@@ -69,21 +69,49 @@ module Restfulness
     end
 
     def payload=(body)
-      if body.nil? || body.is_a?(String)
-        @payload = body.to_s
-        update_content_headers(:text) unless @payload.empty?
+      type = content_type_from_accept_header
+      if body.nil?
+        @payload = ""
+      elsif body.is_a?(String)
+        # Implies that the body was already prepared, and we should rely on accept headers or assume text
+        @payload = body
+        update_content_headers(type || :text) unless @payload.empty?
+      elsif type && type == :xml
+        # Try to use a #to_xml if available, or just use to_s.
+        @payload = (body.respond_to?(:to_xml) ? body.to_xml : body).to_s
+        update_content_headers(:xml) unless @payload.empty?
       else
+        # DEFAULT: Assume we want JSON
         @payload = MultiJson.encode(body)
         update_content_headers(:json) unless @payload.empty?
       end
     end
     
+    def content_type_from_accept_header
+      accept = self.request.accept
+      if accept
+        if accept.json?
+          :json
+        elsif accept.xml?
+          :xml
+        elsif accept.text?
+          :text
+        end
+      else
+        nil
+      end
+    end
+
     def update_content_headers(type = :json)
-      case type
-      when :json
-        headers['Content-Type'] = 'application/json; charset=utf-8'
-      else # Assume text
-        headers['Content-Type'] = 'text/plain; charset=utf-8'
+      if headers['Content-Type'].to_s.empty?
+        case type
+        when :json
+          headers['Content-Type'] = 'application/json; charset=utf-8'
+        when :xml
+          headers['Content-Type'] = 'application/xml; charset=utf-8'
+        else # Assume text
+          headers['Content-Type'] = 'text/plain; charset=utf-8'
+        end
       end
       headers['Content-Length'] = content_length
     end

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/restfulness.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "builder"
+
 end

data/spec/unit/headers/accept_spec.rb

@@ -61,10 +61,21 @@ describe Restfulness::Headers::Accept do
       obj = klass.new("text/plain, application/xml; version=1, text/*")
       expect(obj.xml?).to be true
     end
-    it "should confirm if json not accepted" do
+    it "should confirm if xml not accepted" do
       obj = klass.new("text/plain, application/json, text/*")
       expect(obj.xml?).to be false
     end
   end
 
+  describe "#text?" do
+    it "should confirm if content includes text" do
+      obj = klass.new("text/plain, text/*")
+      expect(obj.text?).to be true
+    end
+    it "should confirm if text not accepted" do
+      obj = klass.new("application/json")
+      expect(obj.text?).to be false
+    end
+  end
+
 end

data/spec/unit/response_spec.rb

@@ -4,6 +4,9 @@ require 'spec_helper'
 describe Restfulness::Response do
 
   class ResponseResource < Restfulness::Resource
+    def get
+      ""
+    end
   end
 
   let :klass do
@@ -170,4 +173,81 @@ describe Restfulness::Response do
 
   end
 
+  describe "content type handling" do
+    before :each do
+      request.uri = "http://localhost:3000/project"
+      request.action = :get
+    end
+    context "nil content" do
+      it "should not set content headers" do
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return(nil)
+        obj.run
+        expect(obj.headers['Content-Type']).to be_nil
+      end
+    end
+    context "empty content" do
+      it "should not set content headers" do
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return("")
+        obj.run
+        expect(obj.headers['Content-Type']).to be_nil
+      end
+    end
+    context "json requested with content" do
+      let :accept do
+        Restfulness::Headers::Accept.new("application/json")
+      end
+      it "should set json content headers" do
+        allow(request).to receive(:accept).and_return(accept)
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return({foo: "bar"})
+        obj.run
+        expect(obj.headers['Content-Type']).to match(/application\/json/)
+      end
+    end
+    context "xml requested with content" do
+      let :accept do
+        Restfulness::Headers::Accept.new("application/xml")
+      end
+      it "should set xml content headers" do
+        allow(request).to receive(:accept).and_return(accept)
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return({foo: "bar"})
+        obj.run
+        expect(obj.headers['Content-Type']).to match(/application\/xml/)
+        expect(obj.payload).to match("<?xml version=\"1.0\"")
+      end
+      it "should set xml content headers even if string provided by resource" do
+        allow(request).to receive(:accept).and_return(accept)
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return({foo: "bar"}.to_xml.to_s)
+        obj.run
+        expect(obj.headers['Content-Type']).to match(/application\/xml/)
+        expect(obj.payload).to match("<?xml version=\"1.0\"")
+      end
+    end
+    context "string requested with content" do
+      let :accept do
+        Restfulness::Headers::Accept.new("text/plain")
+      end
+      it "should set xml content headers" do
+        allow(request).to receive(:accept).and_return(accept)
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return({foo: "bar"}.to_s)
+        obj.run
+        expect(obj.headers['Content-Type']).to match("text/plain")
+      end
+    end
+    context "default with content" do
+      it "should set json content headers" do
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return({foo: "bar"})
+        obj.run
+        expect(obj.headers['Content-Type']).to match(/application\/json/)
+      end
+    end
+    context "overriding" do
+      it "should allow the content type to be overriden" do
+        obj.headers['Content-Type'] = 'application/foo'
+        allow_any_instance_of(ResponseResource).to receive(:get).and_return({foo: "bar"})
+        obj.run
+        expect(obj.headers['Content-Type']).to match("application/foo")
+      end
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -120,6 +120,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple REST server that focuses on resources instead of routes.
 email:
 - me@samlown.com