active_rest_client 0.9.73 → 0.9.75

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 460632a3d6da332f38436d8c4d578253dc3a0f2e
-  data.tar.gz: a44d3ca33dcca47286b5fc69f420d72028062616
+  metadata.gz: 38b0f0e4a23d6db8a525a38e0ee49e6514dffc50
+  data.tar.gz: 2df46c685aba909268ba5aad7c0c99491c997e90
 SHA512:
-  metadata.gz: 4ccb4c9ad92d157a9996be9d79824f03d143156707b2526761df89dbc08666c173ae0fda3865ab471c5355f107d8b08ceaf981942b560ea0babbd0fd1994c0c5
-  data.tar.gz: d42484ef26ea1c377db1bee2dd6977c6e9bf82d9b4618e646765a1a8f8b417f2dd28aa09390734a4e4bd275fa0e00a219d20283528c56756bc1fd60a004c8f82
+  metadata.gz: 7cf6e65cf69fa56b970ed6223fdb5b485e0c2977a6d8f33455d1cc9ddb0c908b4b2d74b776d3447379fb35c87bf741d4d547b9460724dd0a0a224fca50f9266e
+  data.tar.gz: ca5f1b7c7957b877a0fd20563dc6c5182cf567d9d388f7f213983645941203a2053f23e3eae4e997e6586576a4c55a34d360bda0d2c1c3a0feec1880472187b9

data/README.md

@@ -382,6 +382,23 @@ class Person < ActiveRestClient::Base
 end
 ```
 
+### Body Types
+
+By default ActiveRestClient puts the body in to normal CGI parameters in K=V&K2=V2 format.  However, if you want to use JSON for your PUT/POST requests, you can use either (the other option, the default, is `:form_encoded`):
+
+```ruby
+class Person < ActiveRestClient::Base
+  request_body_type :json
+  # ...
+end
+```
+
+or
+
+```ruby
+ActiveRestClient::Base.request_body_type = :json
+```
+
 ### Faking Calls
 
 There are times when an API hasn't been developed yet, so you want to fake the API call response.  To do this, you can simply pass a `fake` option when mapping the call containing the response.

data/lib/active_rest_client/configuration.rb

@@ -2,6 +2,7 @@ module ActiveRestClient
   module Configuration
     module ClassMethods
       @@base_url = nil
+      @@request_body_type = :form_encoded
       @lazy_load = false
 
       def base_url(value = nil)
@@ -23,6 +24,23 @@ module ActiveRestClient
         @@base_url = value
       end
 
+      def request_body_type(value = nil)
+        if value.nil?
+          if @request_body_type.nil?
+            @@request_body_type
+          else
+            @request_body_type
+          end
+        else
+          @request_body_type = value
+        end
+      end
+
+      def request_body_type=(value)
+        ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Request Body Type set to be #{value}"
+        @@request_body_type = value
+      end
+
       def adapter=(adapter)
         ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}"
         @adapter = adapter
@@ -70,12 +88,14 @@ module ActiveRestClient
       end
 
       def _reset_configuration!
-        @base_url         = nil
-        @@base_url        = nil
-        @whiny_missing    = nil
-        @lazy_load        = false
-        @faraday_config   = default_faraday_config
-        @adapter          = :patron
+        @base_url           = nil
+        @@base_url          = nil
+        @request_body_type  = nil
+        @@request_body_type = :form_encoded
+        @whiny_missing      = nil
+        @lazy_load          = false
+        @faraday_config     = default_faraday_config
+        @adapter            = :patron
       end
 
       private

data/lib/active_rest_client/request.rb

@@ -44,6 +44,14 @@ module ActiveRestClient
       end
     end
 
+    def request_body_type
+      if object_is_class?
+        @object.request_body_type
+      else
+        @object.class.request_body_type
+      end
+    end
+
     def verbose?
       if object_is_class?
         @object.verbose
@@ -171,7 +179,11 @@ module ActiveRestClient
     end
 
     def prepare_request_body(params = nil)
-      @body ||= (params || @post_params || {}).map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.sort * "&"
+      if request_body_type == :form_encoded
+        @body ||= (params || @post_params || {}).map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.sort * "&"
+      elsif request_body_type == :json
+        @body ||= (params || @post_params || {}).to_json
+      end
     end
 
     def do_request(etag)
@@ -183,7 +195,7 @@ module ActiveRestClient
         http_headers[key] = value
       end
       if @method[:options][:url] || @forced_url
-        @url = @method[:options][:url]
+        @url = @method[:options][:url] || @method[:url]
         @url = @forced_url if @forced_url
         if connection = ActiveRestClient::ConnectionManager.find_connection_for_url(@url)
           @url = @url.slice(connection.base_url.length, 255)
@@ -192,12 +204,20 @@ module ActiveRestClient
           if (parts.empty?) # Not a full URL, so use hostname/protocol from existing base_url
             uri = URI.parse(base_url)
             @base_url = "#{uri.scheme}://#{uri.host}#{":#{uri.port}" if uri.port != 80 && uri.port != 443}"
+            @url = "#{base_url}#{@url}".gsub(@base_url, "")
           else
             _, @base_url, @url = parts
           end
           connection = ActiveRestClient::ConnectionManager.get_connection(@base_url)
         end
       else
+        parts = @url.match(%r{^(https?://[a-z\d\.:-]+?)(/.*)}).to_a
+        if (parts.empty?) # Not a full URL, so use hostname/protocol from existing base_url
+          uri = URI.parse(base_url)
+          @base_url = "#{uri.scheme}://#{uri.host}#{":#{uri.port}" if uri.port != 80 && uri.port != 443}"
+          @url = "#{base_url}#{@url}".gsub(@base_url, "")
+          base_url = @base_url
+        end
         connection = ActiveRestClient::ConnectionManager.get_connection(base_url)
       end
       ActiveRestClient::Logger.info "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}"

data/lib/active_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ActiveRestClient
-  VERSION = "0.9.73"
+  VERSION = "0.9.75"
 end

data/spec/lib/base_spec.rb

@@ -32,6 +32,11 @@ class RecordResponseExample < ActiveRestClient::Base
   get :all, "/all"
 end
 
+class NonHostnameBaseUrlExample < ActiveRestClient::Base
+  base_url "http://www.example.com/v1/"
+  get :all, "/all"
+end
+
 describe ActiveRestClient::Base do
   it 'should instantiate a new descendant' do
     expect{EmptyExample.new}.to_not raise_error(Exception)
@@ -208,6 +213,11 @@ describe ActiveRestClient::Base do
       EmptyExample._request("http://api.example.com/")
     end
 
+    it "should make an HTTP request including the path in the base_url" do
+      ActiveRestClient::Connection.any_instance.should_receive(:get).with('/v1/all', anything).and_return(OpenStruct.new(status:200, headers:{}, body:"{\"first_name\":\"Billy\"}"))
+      NonHostnameBaseUrlExample.all
+    end
+
     it "should map the response from the directly called URL in the normal way" do
       ActiveRestClient::Request.any_instance.should_receive(:do_request).with(any_args).and_return(OpenStruct.new(status:200, headers:{}, body:"{\"first_name\":\"Billy\"}"))
       example = EmptyExample._request("http://api.example.com/")

data/spec/lib/configuration_spec.rb

@@ -8,6 +8,7 @@ describe ActiveRestClient::Configuration do
     class ConfigurationExample
       include ActiveRestClient::Configuration
       base_url "http://www.example.com"
+      request_body_type :json
     end
 
     class ConfigurationExampleBare
@@ -54,6 +55,20 @@ describe ActiveRestClient::Configuration do
     expect(ConfigurationExample2.base_url).to eq("http://specific.example.com")
   end
 
+  it "should default to a form_encoded request_body_type" do
+    expect(ActiveRestClient::Base.request_body_type).to eq(:form_encoded)
+  end
+
+  it "should remember the request_body_type" do
+    expect(ConfigurationExample.request_body_type).to eq(:json)
+  end
+
+  it "should remember the set base_url on a class, overriding a general one" do
+    ActiveRestClient::Base.request_body_type = :unknown
+    expect(ActiveRestClient::Base.request_body_type).to eq(:unknown)
+    expect(ConfigurationExample.request_body_type).to eq(:json)
+  end
+
   it "should default to non-lazy loading" do
     class LazyLoadingConfigurationExample1
       include ActiveRestClient::Configuration

data/spec/lib/request_spec.rb

@@ -5,6 +5,7 @@ describe ActiveRestClient::Request do
     class ExampleOtherClient < ActiveRestClient::Base ; end
     class ExampleClient < ActiveRestClient::Base
       base_url "http://www.example.com"
+      request_body_type :form_encoded
 
       before_request do |name, request|
         if request.method[:name] == :headers
@@ -26,12 +27,14 @@ describe ActiveRestClient::Request do
     end
 
     class LazyLoadedExampleClient < ExampleClient
+      base_url "http://www.example.com"
       lazy_load!
       get :fake, "/fake", fake:"{\"result\":true, \"list\":[1,2,3,{\"test\":true}], \"child\":{\"grandchild\":{\"test\":true}}}"
       get :lazy_test, "/does-not-matter", fake:"{\"people\":[\"http://www.example.com/some/url\"]}", :lazy => [:people]
     end
 
     class VerboseExampleClient < ExampleClient
+      base_url "http://www.example.com"
       verbose!
       get :all, "/all"
     end
@@ -100,6 +103,17 @@ describe ActiveRestClient::Request do
     ExampleClient.update id:1234, debug:true
   end
 
+  it "should encode the body in a form-encoded format by default" do
+    ActiveRestClient::Connection.any_instance.should_receive(:put).with("/put/1234", "debug=true&test=foo", an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"result\":true}", headers:{}))
+    ExampleClient.update id:1234, debug:true, test:'foo'
+  end
+
+  it "should encode the body in a JSON format if specified" do
+    ActiveRestClient::Connection.any_instance.should_receive(:put).with("/put/1234", %q({"debug":true,"test":"foo"}), an_instance_of(Hash)).and_return(OpenStruct.new(body:"{\"result\":true}", headers:{}))
+    ExampleClient.request_body_type :json
+    ExampleClient.update id:1234, debug:true, test:'foo'
+  end
+
   it "should pass through custom headers" do
     ActiveRestClient::Connection.any_instance.should_receive(:get).with("/headers", hash_including("X-My-Header" => "myvalue")).and_return(OpenStruct.new(body:'{"result":true}', headers:{}))
     ExampleClient.headers
@@ -331,6 +345,10 @@ describe ActiveRestClient::Request do
   it "should raise an exception if you try to pass in an unsupport method" do
     method = {:method => :wiggle, url:"/"}
     class RequestFakeObject
+      def request_body_type
+        :form_encoded
+      end
+      
       def base_url
         "http://www.example.com/"
       end
@@ -397,11 +415,12 @@ describe ActiveRestClient::Request do
 
     it "should allow requests to partial URLs using the current base_url" do
       ActiveRestClient::ConnectionManager.reset!
-      connection = double("Connection").as_null_object
+      connection = double("Connection")
+      allow(connection).to receive(:base_url).and_return("http://www.example.com")
       ActiveRestClient::ConnectionManager.should_receive(:get_connection).with("http://www.example.com").and_return(connection)
       connection.
         should_receive(:get).
-        with("/people", an_instance_of(Hash)).
+        with("/v1/people", an_instance_of(Hash)).
         and_return(OpenStruct.new(body:"{\"first_name\":\"John\", \"id\":1234}", headers:{}, status:200))
       @obj = SameServerExampleClient._request('/people')
     end

data/spec/lib/result_iterator_spec.rb

@@ -98,7 +98,7 @@ describe ActiveRestClient::ResultIterator do
       item*2
     end
     end_time = Time.now
-    expect(end_time-start_time).to be < (4*delay)
+    expect(end_time-start_time).to be < (6*delay)
     expect(response).to eq([6,4,2])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.9.73
+  version: 0.9.75
 platform: ruby
 authors:
 - Which Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler