requisite 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0900379bbe4e112f2e983138cba06a3f4c399d8b
-  data.tar.gz: 30ee7ec731114380f827676e2e881510b860d38e
+  metadata.gz: 718f7a0ac2ca20c100cf6e5c119c4a9b4bafd5f4
+  data.tar.gz: 0da1427c7209923071d6667610ddc6473a2464fa
 SHA512:
-  metadata.gz: 3d979fd487435e6ef9b025db1d4ed6f7d09a6c897a1bf2f440bd19e4328f8b0e5ca663a2582cba8827a4bc5fcc0cfbebb959f18e3a6621ba2339228ac378bcbd
-  data.tar.gz: b4b83bf22163cc36b6dbd144cafbacf9f803e52076b9a969e001c167f608d387a394e8d124260379de44c5c27b55c5992a0acb0fe73e7d7151170a9f7d7e72e5
+  metadata.gz: c5b84bf2d04e682405cb7aac06bb6ef786b12c6976cda1bed69fa7aefbba941b4e97e6bbe8ca0c0bf3e84cab14d3ef637a65cbf5bdade19dfeac39c9e373b761
+  data.tar.gz: 5c218d74d921330a280d908bc5cf7683408ad0a32e9685b5f95a99c8961de0fba6f03f8dddbb1e7d7f4411ef5302e203de045bf7361cd5291777c8f1e886adb7

data/CHANGES.md

@@ -1,3 +1,6 @@
+### 0.3.0 (15th April 2015):
+  - Optionally allow nils to be returned
+
 ### 0.2.1 (5th March 2015):
   - Fix false in hash inputs
 

data/README.md

@@ -57,7 +57,7 @@ user.to_json
 # => "{\"id\":5,\"real_name\":\"Jamie Osler\",\"username\":\"josler\"}"
 ```
 
-`nil` values are not returned in the response.
+`nil` values are not returned in the response, unless `to_hash(show_nil: true)` or `to_json(show_nil: true)` are requested.
 
 Errors are thrown when a required attribute is not present:
 

data/lib/requisite/api_model.rb

@@ -25,32 +25,22 @@ module Requisite
       end
     end
 
-    def model_responds_to_attribute_query?(name)
-      if @model.kind_of?(Hash)
-        @model[name] != nil
-      else
-        @model.send(name) if @model.respond_to?(name)
-      end
-    end
-
-    def merge_attribute_if_exists!(to_merge, attribute_name)
-      attribute_from_model(attribute_name) ? to_merge.merge!(attribute_from_model(attribute_name)) : to_merge
-    end
-
-    def to_hash
+    def to_hash(show_nil: false)
       preprocess_model
       {}.tap do |result|
         self.class.attribute_keys_with_inheritance.each do |meth|
           value = self.send(meth)
-          result.merge!({meth => value}) unless value.nil?
+          result.merge!({meth => value}) if show_nil || !value.nil?
         end
       end
     end
 
-    def to_json
-      to_hash.to_json
+    def to_json(show_nil: false)
+      to_hash(show_nil: show_nil).to_json
     end
 
+    private
+
     def parse_typed_hash(name, hash)
       {}.tap do |result|
         passed_hash = attribute_from_model(name)
@@ -98,7 +88,18 @@ module Requisite
       nil
     end
 
-    private
+
+    def model_responds_to_attribute_query?(name)
+      if @model.kind_of?(Hash)
+        @model[name] != nil
+      else
+        @model.send(name) if @model.respond_to?(name)
+      end
+    end
+
+    def merge_attribute_if_exists!(to_merge, attribute_name)
+      attribute_from_model(attribute_name) ? to_merge.merge!(attribute_from_model(attribute_name)) : to_merge
+    end
 
     def preprocess_model
       # noop

data/lib/requisite/version.rb

@@ -1,3 +1,3 @@
 module Requisite
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/test/requisite/api_model_test.rb

@@ -63,12 +63,12 @@ module Requisite
 
     it 'with_type! helper raises on mismatched type' do
       model = DummyApiModel.new()
-      proc { model.with_type!(String) { 1 + 2 }}.must_raise(Requisite::BadTypeError)
+      proc { model.send(:with_type!, String) { 1 + 2 }}.must_raise(Requisite::BadTypeError)
     end
 
     it 'first_attribute_from_model helper finds first matching attriubute' do
       model = DummyApiModel.new(:oh => 12, :a => nil, :b => 'B', :c => 'C')
-      model.first_attribute_from_model(:a, :b, :c).must_equal('B')
+      model.send(:first_attribute_from_model, :a, :b, :c).must_equal('B')
     end
 
     it 'attribute can assert type of a boolean field' do
@@ -83,6 +83,12 @@ module Requisite
       response.to_hash.must_equal({})
     end
 
+    it 'attribute includes values of nil if permitted' do
+      DummyApiModel.serialized_attributes { attribute :num, type: String }
+      response = DummyApiModel.new({:num => nil})
+      response.to_hash(show_nil: true).must_equal({:num => nil})
+    end
+
     it 'attribute can be stringified and renamed with default fields' do
       DummyApiModel.serialized_attributes { attribute :my_num, rename: :num, stringify: true, default: 22 }
       response = DummyApiModel.new

data/test/requisite/api_user_test.rb

@@ -39,6 +39,11 @@ class InheritedApiUser < ApiUser
   end
 end
 
+class UserModel
+  attr_accessor :id, :user_id, :email, :name, :created_at, :created, :last_seen_user_agent, :last_request_at, :unsubscribed_from_emails
+  attr_accessor :update_last_request_at, :new_session, :custom_attributes, :company, :companies
+end
+
 module Requisite
   describe ApiUser do
     it 'accepts a user' do
@@ -111,5 +116,41 @@ module Requisite
         :new_attribute => 'hi'
       })
     end
+    
+    it 'accepts a user model' do
+      user_model = UserModel.new
+      user_model.user_id = 'abcdef'
+      user_model.name = 'Bob'
+      user = ApiUser.new(user_model)
+      user.to_hash.must_equal({
+        :user_id => 'abcdef',
+        :name => 'Bob',
+        :custom_data => {}
+      })
+      user.name.must_equal('Bob')
+    end
+    
+    it 'accepts a user model and renders nils if asked' do
+      user_model = UserModel.new
+      user_model.user_id = 'abcdef'
+      user_model.name = 'Bob'
+      user = ApiUser.new(user_model)
+      user.to_hash(show_nil: true).must_equal({
+        :id => nil,
+        :user_id => 'abcdef',
+        :email => nil,
+        :name => 'Bob',
+        :created_at => nil,
+        :last_seen_user_agent => nil,
+        :last_request_at => nil,
+        :unsubscribed_from_emails => nil,
+        :update_last_request_at => nil,
+        :new_session => nil,
+        :custom_data => {},
+        :company => nil,
+        :companies => nil
+      })
+      user.name.must_equal('Bob')
+    end
   end
 end

metadata

@@ -1,38 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: requisite
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - James Osler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   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: ' Requisite is an elegant way of strongly defining request and response
-  models for serialization '
+description: " Requisite is an elegant way of strongly defining request and response
+  models for serialization "
 email:
 - jamie@intercom.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGES.md
 - Gemfile
 - LICENCE.txt
@@ -60,17 +60,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Strongly defined models for HTTP APIs
@@ -79,3 +79,4 @@ test_files:
 - test/requisite/api_model_test.rb
 - test/requisite/api_user_test.rb
 - test/test_helper.rb
+has_rdoc: