flexirest 1.3.15 → 1.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0704471f0511508955b73ff6c1a9f4490d6d2953
-  data.tar.gz: 2edada3ba600208f0df0f13aa06d2d91a4eb1a38
+  metadata.gz: a05916ea9c0a9dff55d6d260df70ab263b4cb51f
+  data.tar.gz: b8f74642b6c7ee86a8819f6ca2077cfc153be34c
 SHA512:
-  metadata.gz: 4cd56fe8131e1dd4e835a6ca77c90896283f0441cadaaf7f4e844d51907dc8ddcbcdd39d260c12e9d95d18a12adcd3688bdf1e880c3f719b81068ecc4a4f52f7
-  data.tar.gz: e0901b4f1796580a9eb229609e8f43c5f6500bdef5819857a22d1a3279fc19669cbd49d6069fbd65627d3352c420026e98b272aa980d9f22b209561e71d833cf
+  metadata.gz: 9e92347d9e7654e6296827a40ace68a536f39204b6fec78ece3955efba329768c5522e65715dc8ea3f7fb6bff739f639892fec26e06627a2b67a356375cf3bf9
+  data.tar.gz: d9582c21066db41a975ffe5f4c76ffcff27c85ea11af012f38acc267d71a7791ebc83dfc6b6951c6857527f7fc2b5c9e3d2e1ec163f577225c89bdb31e10d94a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.3.16
+
+Feature:
+
+- Allows disabling of the automatic date parsing with the `Flexirest::Base.disable_automatic_date_parsing` setting and/or specifying it per mapped method with the `:parse_fields` option (thanks to Michael Mealling for the request).
+
 ## 1.3.15
 
 Feature:

data/README.md

@@ -646,12 +646,29 @@ class Person < Flexirest::Base
   get :all, '/people', params_encoder: :flat
 end
 ```
+
 would output the following url
 
 ```
 ?param=1&param=2&param=3
 ```
 
+### Automatic Conversion of Fields to Date/DateTime
+
+By default Flexirest will attempt to convert all fields to a Date or DateTime object if it's a string and the value matches a pair of regular expressions. However, on large responses this can be computationally expensive.  So, you can either disable this automatic conversion completely with:
+
+```ruby
+Flexirest::Base.disable_automatic_date_parsing = true
+```
+
+Additionally, you can specify when mapping the methods which fields should be parsed (so you can disable it in general, then apply it to particular known fields):
+
+```ruby
+class Person < Flexirest::Base
+  get :all, '/people', parse_fields: [:created_at, :updated_at]
+end
+```
+
 ### Raw Requests
 
 Sometimes you have have a URL that you just want to force through, but have the response handled in the same way as normal objects or you want to have the filters run (say for authentication).  The easiest way to do that is to call `_request` on the class:

data/lib/flexirest/configuration.rb

@@ -7,6 +7,7 @@ module Flexirest
       @@username = nil
       @@password = nil
       @@request_body_type = :form_encoded
+      @@disable_automatic_date_parsing = nil
       @lazy_load = false
       @api_auth_access_id = nil
       @api_auth_secret_key = nil
@@ -107,6 +108,28 @@ module Flexirest
         @@request_body_type = value
       end
 
+      def disable_automatic_date_parsing(value = nil)
+        @disable_automatic_date_parsing ||= nil
+        if value.nil?
+          if @disable_automatic_date_parsing.nil?
+            if value.nil? && superclass.respond_to?(:disable_automatic_date_parsing)
+              superclass.disable_automatic_date_parsing
+            else
+              @@disable_automatic_date_parsing || false
+            end
+          else
+            @disable_automatic_date_parsing
+          end
+        else
+          @disable_automatic_date_parsing = value
+        end
+      end
+
+      def disable_automatic_date_parsing=(value)
+        Flexirest::Logger.info "\033[1;4;32m#{name}\033[0m Request Body Type set to be #{value}"
+        @@disable_automatic_date_parsing = value
+      end
+
       def adapter=(adapter)
         Flexirest::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}"
         @adapter = adapter

data/lib/flexirest/request.rb

@@ -473,7 +473,15 @@ module Flexirest
             end
           end
         else
-          object._attributes[k] = parse_attribute_value(v)
+          if @method[:options][:parse_fields] && @method[:options][:parse_fields].include?(k)
+            object._attributes[k] = parse_attribute_value(v)
+          elsif @method[:options][:parse_fields]
+            object._attributes[k] = v
+          elsif Flexirest::Base.disable_automatic_date_parsing
+            object._attributes[k] = v
+          else
+            object._attributes[k] = parse_attribute_value(v)
+          end
         end
       end
       object.clean! unless object_is_class?

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.15"
+  VERSION = "1.3.16"
 end

data/spec/lib/request_spec.rb

@@ -35,6 +35,7 @@ describe Flexirest::Request do
       post :create, "/create"
       post :test_encoding, "/encoding", request_body_type: :json
       put :update, "/put/:id"
+      put :conversion, "/put/:id", parse_fields: [:converted]
       delete :remove, "/remove/:id"
       get :hal, "/hal", fake:"{\"_links\":{\"child\": {\"href\": \"/child/1\"}, \"other\": {\"href\": \"/other/1\"}, \"cars\":[{\"href\": \"/car/1\", \"name\":\"car1\"}, {\"href\": \"/car/2\", \"name\":\"car2\"}, {\"href\": \"/car/not-embed\", \"name\":\"car_not_embed\"} ], \"lazy\": {\"href\": \"/lazy/load\"}, \"invalid\": [{\"href\": \"/invalid/1\"}]}, \"_embedded\":{\"other\":{\"name\":\"Jane\"},\"child\":{\"name\":\"Billy\"}, \"cars\":[{\"_links\": {\"self\": {\"href\": \"/car/1\"} }, \"make\": \"Bugatti\", \"model\": \"Veyron\"}, {\"_links\": {\"self\": {\"href\": \"/car/2\"} }, \"make\": \"Ferrari\", \"model\": \"F458 Italia\"} ], \"invalid\": [{\"present\":true, \"_links\": {} } ] } }", has_many:{other:ExampleOtherClient}
       get :fake, "/fake", fake:"{\"result\":true, \"list\":[1,2,3,{\"test\":true}], \"child\":{\"grandchild\":{\"test\":true}}}"
@@ -248,6 +249,24 @@ describe Flexirest::Request do
     expect(object.child.grandchild.test).to eq(true)
   end
 
+  it "should not convert date times in JSON if automatic parsing is disabled" do
+    begin
+      Flexirest::Base.disable_automatic_date_parsing = true
+      expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", "debug=true", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"created_at\":\"2012-03-04T01:02:03Z\"}", response_headers:{})))
+      object = ExampleClient.update id:1234, debug:true
+      expect(object.created_at).to be_an_instance_of(String)
+    ensure
+      Flexirest::Base.disable_automatic_date_parsing = false
+    end
+  end
+
+  it "should only convert date times in JSON if specified" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:put).with("/put/1234", "debug=true", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"converted\":\"2012-03-04T01:02:03Z\", \"not_converted\":\"2012-03-04T01:02:03Z\"}", response_headers:{})))
+    object = ExampleClient.conversion id:1234, debug:true
+    expect(object.converted).to be_an_instance_of(DateTime)
+    expect(object.not_converted).to be_an_instance_of(String)
+  end
+
   it "should parse JSON and return a nice object for faked responses" do
     object = ExampleClient.fake id:1234, debug:true
     expect(object.result).to eq(true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.15
+  version: 1.3.16
 platform: ruby
 authors:
 - Andy Jeffries