flexirest 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a62022220324552e709d4f353392307b3e1cad
-  data.tar.gz: 0a31df3353a51c1f3308ffa7b2cbe3ebcb3b85a1
+  metadata.gz: 499dd67a747959e769fab4e11aa7ee9eed6599b8
+  data.tar.gz: 632be3df00eae719a6238d312d29c1dae4bef214
 SHA512:
-  metadata.gz: 5a7d7779afeb7ed595f065fc3464fbb4df653651aa4c26d73fc87c0aeed98d248a9c6aa0882f22c7c4419c0d09f0ebbcaa589712a99d40d121dd5bc8564eff0e
-  data.tar.gz: daa5bb17168731c3014f7f253c0def715101714a20ca817ea1a162d895922df6f980313b4e4266228386f3c7f246f577fc0d0ed1c42e2981775376704a081c60
+  metadata.gz: 63f8eaaa04a862b48151effef441782ac3917cb71417834cb4cfcfbe84586907c7f45c47b33846a7a22a5bdf1584d68124a6ac6a5c2fc5becfc9a00da37f622b
+  data.tar.gz: 38c540be4278f892a9bc2461c2c7b0e12b9f3074c8b90202be880aed496056c6ad258475b713ae8a86877787814f45e739739d659deed3fcb899adb00d00de9b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.5.3
+
+Feature:
+
+- Allow passing custom headers as an option to raw requests.
+
 ## 1.5.2
 
 Bugfix:

data/README.md

@@ -793,6 +793,12 @@ people = Person._request('http://api.example.com/v1/people') # Defaults to get w
 Person._request('http://api.example.com/v1/people', :post, {id:1234,name:"John"}) # Post with parameters
 ```
 
+When you need to specify custom headers (for example for authentication) you can do this with a fourth option to the `_request` method. If you are using the default paramaters you'll need to specify them. For example:
+
+```ruby
+Person._request("http://api.example.com/v1/people", :get, {}, {"X-Something": "foo/bar"})
+```
+
 If you want to use a lazy loaded request instead (so it will create an object that will only call the API if you use it), you can use `_lazy_request` instead of `_request`. If you want you can create a construct that creates and object that lazy loads itself from a given method (rather than a URL):
 
 ```ruby

data/lib/flexirest/base.rb

@@ -66,16 +66,16 @@ module Flexirest
       @attributes[:errors] || (_errors != {} ? _errors : nil)
     end
 
-    def self._request(request, method = :get, params = nil)
-      prepare_direct_request(request, method).call(params)
+    def self._request(request, method = :get, params = nil, headers = {})
+      prepare_direct_request(request, method, headers: headers).call(params)
     end
 
-    def self._plain_request(request, method = :get, params = nil)
-      prepare_direct_request(request, method, plain:true).call(params)
+    def self._plain_request(request, method = :get, params = nil, headers = {})
+      prepare_direct_request(request, method, plain:true, headers: headers).call(params)
     end
 
-    def self._lazy_request(request, method = :get, params = nil)
-      Flexirest::LazyLoader.new(prepare_direct_request(request, method), params)
+    def self._lazy_request(request, method = :get, params = nil, headers = {})
+      Flexirest::LazyLoader.new(prepare_direct_request(request, method, headers: headers), params)
     end
 
     def self.prepare_direct_request(request, method = :get, options={})

data/lib/flexirest/request.rb

@@ -21,6 +21,9 @@ module Flexirest
       @response_delegate          = Flexirest::RequestDelegator.new(nil)
       @params                     = params
       @headers                    = HeadersList.new
+      (@method[:options][:headers] || {}).each do |k,v|
+        @headers[k] = v
+      end
       @forced_url                 = nil
     end
 
@@ -463,6 +466,7 @@ module Flexirest
     def handle_response(response, cached = nil)
       @response = response
       status = @response.status || 200
+      @response.body = "{}" if @response.body.blank?
 
       if cached && response.status == 304
         Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name}" +
@@ -471,12 +475,8 @@ module Flexirest
       end
 
       if (200..399).include?(status)
-        if @response.body.blank?
-          @response.body = "{}"
-        end
-
         if @method[:options][:plain]
-          return @response = Flexirest::PlainResponse.from_response(response)
+          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.5.2"
+  VERSION = "1.5.3"
 end

data/spec/lib/base_spec.rb

@@ -57,17 +57,17 @@ describe Flexirest::Base do
   end
 
   it "should save attributes passed in constructor" do
-    client = EmptyExample.new(:test => "Something")
+    client = EmptyExample.new(test: "Something")
     expect(client._attributes[:test]).to be_a(String)
   end
 
   it "should allow attribute reading using missing method names" do
-    client = EmptyExample.new(:test => "Something")
+    client = EmptyExample.new(test: "Something")
     expect(client.test).to eq("Something")
   end
 
   it "should allow attribute reading using [] array notation" do
-    client = EmptyExample.new(:test => "Something")
+    client = EmptyExample.new(test: "Something")
     expect(client["test"]).to eq("Something")
   end
 
@@ -85,37 +85,37 @@ describe Flexirest::Base do
 
   it "should automatically parse ISO 8601 format date and time" do
     t = Time.now
-    client = EmptyExample.new(:test => t.iso8601)
+    client = EmptyExample.new(test: t.iso8601)
     expect(client["test"]).to be_an_instance_of(DateTime)
     expect(client["test"].to_s).to eq(t.to_datetime.to_s)
   end
 
   it "should automatically parse ISO 8601 format date and time with milliseconds" do
     t = Time.now
-    client = EmptyExample.new(:test => t.iso8601(3))
+    client = EmptyExample.new(test: t.iso8601(3))
     expect(client["test"]).to be_an_instance_of(DateTime)
     expect(client["test"].to_s).to eq(t.to_datetime.to_s)
   end
 
   it "should automatically parse ISO 8601 format dates" do
     d = Date.today
-    client = EmptyExample.new(:test => d.iso8601)
+    client = EmptyExample.new(test: d.iso8601)
     expect(client["test"]).to be_an_instance_of(Date)
     expect(client["test"]).to eq(d)
   end
 
   it "should automatically parse date/time strings regardless if the date portion has no delimiters" do
-    client = EmptyExample.new(:test => "20151230T09:48:50-05:00")
+    client = EmptyExample.new(test: "20151230T09:48:50-05:00")
     expect(client["test"]).to be_an_instance_of(DateTime)
   end
 
   it "should allow strings of 4 digits and not intepret them as dates" do
-    client = EmptyExample.new(:test => "2015")
+    client = EmptyExample.new(test: "2015")
     expect(client["test"]).to be_an_instance_of(String)
   end
 
   it "should allow strings of 8 digits and not intepret them as dates" do
-    client = EmptyExample.new(:test => "1266129")
+    client = EmptyExample.new(test: "1266129")
     expect(client["test"]).to be_an_instance_of(String)
   end
 
@@ -163,7 +163,7 @@ describe Flexirest::Base do
   end
 
   it "should overwrite attributes already set and mark them as dirty" do
-    client = EmptyExample.new(:hello => "World")
+    client = EmptyExample.new(hello: "World")
     client._clean!
     expect(client).to_not be_dirty
 
@@ -172,7 +172,7 @@ describe Flexirest::Base do
   end
 
   it 'should respond_to? attributes defined in the response' do
-    client = EmptyExample.new(:hello => "World")
+    client = EmptyExample.new(hello: "World")
     expect(client.respond_to?(:hello)).to be_truthy
     expect(client.respond_to?(:world)).to be_falsey
   end
@@ -311,6 +311,13 @@ describe Flexirest::Base do
       EmptyExample._request("http://api.example.com/")
     end
 
+    it "passes headers" do
+      stub_request(:get, "http://api.example.com/v1").
+        with(headers: {'Accept'=>'application/hal+json, application/json;q=0.5', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Connection'=>'Keep-Alive', 'X-Something'=>'foo/bar', 'User-Agent'=>'Flexirest/1.5.2'}).
+        to_return(status: 200, body: "", headers: {})
+      EmptyExample._request("http://api.example.com/v1", :get, {}, {"X-Something": "foo/bar"})
+    end
+
     it "runs callbacks as usual" do
       expect_any_instance_of(Flexirest::Request).to receive(:do_request).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:"{\"first_name\":\"Billy\"}")))
       expect(EmptyExample).to receive(:_callback_request).with(any_args).exactly(2).times
@@ -418,7 +425,7 @@ describe Flexirest::Base do
 
     it "should be able to use mapped methods to create a request to pass in to _lazy_request" do
       expect_any_instance_of(Flexirest::Connection).to receive(:get).with('/find/1', anything).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:"{\"first_name\":\"Billy\"}")))
-      request = AlteringClientExample._request_for(:find, :id => 1)
+      request = AlteringClientExample._request_for(:find, id: 1)
       example = AlteringClientExample._lazy_request(request)
       expect(example.first_name).to eq("Billy")
     end

data/spec/lib/request_spec.rb

@@ -361,6 +361,16 @@ describe Flexirest::Request do
     expect(ExampleClient.all).to be_truthy
   end
 
+  it "should return true from 202 with empty bodies" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:202, response_headers:{}, body: nil)))
+    expect(ExampleClient.all).to be_truthy
+  end
+
+  it "should return true from 200 with empty bodies" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body: nil)))
+    expect(ExampleClient.all).to be_truthy
+  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.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler