flexirest 1.3.13 → 1.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc2dd846c4d1cab6b3bc1fc2a1d162bfbb5419e9
-  data.tar.gz: fb4672356cf5e7fec571ebe73ff381d89a47f1ce
+  metadata.gz: fb527b4e0686f41868c0c0074ca60f38c890367b
+  data.tar.gz: d61137bb423545b4f30a915beff69184988eb8f1
 SHA512:
-  metadata.gz: 293a96596ed43f163a15614597913ddcf6682432176fd6d8fa32a31ca5db1adad77543e3384ab0f231ca97da7b62b5d392a03bca7b0d9f6073bc5863fc064919
-  data.tar.gz: a851723f3928d483b287b63744146aa28865a5148cbc74e0ad889d3bf4d1dec31f2bbe941b87bcc603c3dcdf7bdbfe5391e5aa4cf98bac16a2f1cd91b3f27197
+  metadata.gz: 344f2accd4f6446496d370879be78d0e2412dd77ee2cec427846503031a626afc1d0f73961ce2a26dca452a15a50c5cc3ec9d5620addda6936b90eced45b8049
+  data.tar.gz: 9cf9485402e1bbcab606f3cbe59be7c1dc07987935f14706e7385aa26e3f46155926599dbcc3109ee2e91c61efe2757c763413780fa5cb7e1b372b2152a9ef8c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.14
+
+Feature:
+
+- Plain Requests (both using the `plain: true` option to mapped methods and using `_plain_request`) return a `Flexirest::PlainResponse` which is string-like for all intents and purposes (it's comparable with strings using the body of the response) and also has `_status` and `_headers` methods (thanks to Rui Ribeiro for the request/inspiration).
+
 ## 1.3.13
 
 Feature:

data/README.md

@@ -696,6 +696,8 @@ class Person < Flexirest::Base
 end
 ```
 
+The response of a plain request (from either source) is a `Flexirest::PlainResponse` which acts like a string containing the response's body, but it also has a `_headers` method that returns the HTTP response headers and a `_status` method containing the response's HTTP method.
+
 ### Proxying APIs
 
 Sometimes you may be working with an old API that returns JSON in a less than ideal format or the URL or parameters required have changed.  In this case you can define a descendent of `Flexirest::ProxyBase`, pass it to your model as the proxy and have it rework URLs/parameters on the way out and the response on the way back in (already converted to a Ruby hash/array). By default any non-proxied URLs are just passed through to the underlying connection layer. For example:

data/lib/flexirest/plain_response.rb

@@ -0,0 +1,13 @@
+module Flexirest
+  class PlainResponse < ::String
+    attr_accessor :_status
+    attr_accessor :_headers
+
+    def self.from_response(response)
+      plain = self.new(response.body)
+      plain._status = response.status
+      plain._headers = response.response_headers
+      plain
+    end
+  end
+end

data/lib/flexirest/request.rb

@@ -388,7 +388,7 @@ module Flexirest
 
       if (200..399).include?(status)
         if @method[:options][:plain]
-          return @response = response.body
+          return @response = Flexirest::PlainResponse.from_response(response)
         elsif is_json_response? || is_xml_response?
           if @response.respond_to?(:proxied) && @response.proxied
             Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.13"
+  VERSION = "1.3.14"
 end

data/lib/flexirest.rb

@@ -21,6 +21,7 @@ require "flexirest/proxy_base"
 require "flexirest/recording"
 require "flexirest/base"
 require "flexirest/monkey_patching"
+require "flexirest/plain_response"
 
 module Flexirest
   @@name = "Flexirest"

data/spec/lib/base_spec.rb

@@ -300,6 +300,12 @@ describe Flexirest::Base do
       expect(EmptyExample._plain_request("http://api.example.com/", :post, {id:1234})).to eq(response_body)
     end
 
+    it "should return a PlainResponse from the directly called URL bypassing JSON loading" do
+      response_body = "This is another non-JSON string"
+      expect_any_instance_of(Flexirest::Connection).to receive(:post).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:response_body)))
+      expect(EmptyExample._plain_request("http://api.example.com/", :post, {id:1234})).to be_a(Flexirest::PlainResponse)
+    end
+
     context "Simulating Faraday connection in_parallel" do
       it "should be able to pass the plain response from the directly called URL bypassing JSON loading" do
         response_body = "This is another non-JSON string"

data/spec/lib/plain_response_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Flexirest::PlainResponse do
+  let(:response) { OpenStruct.new(status:200, body:"fake response", response_headers:{"X-ARC-Faked-Response" => "true", "Content-Type" => "application/json"}) }
+
+  it "is comparable to a string" do
+    expect(Flexirest::PlainResponse.new("test")).to eq "test"
+  end
+
+  it "can be instantiated from a response" do
+    expect(Flexirest::PlainResponse.from_response(response)).to eq "fake response"
+  end
+
+  it "returns the response's status" do
+    expect(Flexirest::PlainResponse.from_response(response)._status).to eq 200
+  end
+
+  it "returns the response's headers" do
+    expect(Flexirest::PlainResponse.from_response(response)._headers["Content-Type"]).to eq "application/json"
+  end
+end

data/spec/lib/request_spec.rb

@@ -267,6 +267,12 @@ describe Flexirest::Request do
     expect(ExampleClient.plain(id:1234)).to eq(response_body)
   end
 
+  it "should return a PlainResponse from a plain request" do
+    response_body = "This is another non-JSON string"
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:response_body)))
+    expect(ExampleClient.plain(id:1234)).to be_a(Flexirest::PlainResponse)
+  end
+
   it "should return a lazy loader object if lazy loading is enabled" do
     object = LazyLoadedExampleClient.fake id:1234, debug:true
     expect(object).to be_an_instance_of(Flexirest::LazyLoader)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.13
+  version: 1.3.14
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -243,6 +243,7 @@ files:
 - lib/flexirest/logger.rb
 - lib/flexirest/mapping.rb
 - lib/flexirest/monkey_patching.rb
+- lib/flexirest/plain_response.rb
 - lib/flexirest/proxy_base.rb
 - lib/flexirest/recording.rb
 - lib/flexirest/request.rb
@@ -265,6 +266,7 @@ files:
 - spec/lib/lazy_loader_spec.rb
 - spec/lib/logger_spec.rb
 - spec/lib/mapping_spec.rb
+- spec/lib/plain_response_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/lib/recording_spec.rb
 - spec/lib/request_filtering_spec.rb
@@ -315,6 +317,7 @@ test_files:
 - spec/lib/lazy_loader_spec.rb
 - spec/lib/logger_spec.rb
 - spec/lib/mapping_spec.rb
+- spec/lib/plain_response_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/lib/recording_spec.rb
 - spec/lib/request_filtering_spec.rb