json_schema_tools 0.1.1 → 0.1.2

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec
 
 # allow testing with rails 4

data/README.md

@@ -160,11 +160,12 @@ Rather like a namespace? Good idea, but don't forget the class or module must
 be defined.
 
 ```ruby
+module SalesKing; end
 SchemaTools::KlassFactory.build namespace: SalesKing
 client = SalesKing::Client.new
 ```
 
-Add a custom schema reader most likely usefull in conjunction with a custom path
+Add a custom schema reader most likely useful in conjunction with a custom path
 
 ```ruby
 reader = SchemaTools::Reader.new
@@ -173,9 +174,9 @@ SchemaTools::KlassFactory.build reader: reader, path: HappyPdf::Schema.path
 
 ## Real world examples
 
-* [HappyPdf json schema](https://github.com/happyPDF/happypdf_json_schema) .. api gem will follow
 * [DocTag ruby gem](https://github.com/docTag/doctag_rb) and [DocTag json-schema](https://github.com/docTag/doctag_json_schema)
 * [SalesKing json schema](https://github.com/salesking/sk_api_schema)
+* [HappyPdf json schema](https://github.com/happyPDF/happypdf_json_schema) .. api gem will follow
 * .. Your UseCase here
 
 ## Test

data/lib/schema_tools/modules/hash.rb

@@ -48,37 +48,10 @@ module SchemaTools
         # iterate over the defined schema fields
         schema['properties'].each do |field, prop|
           next if fields && !fields.include?(field)
-
           if prop['type'] == 'array'
-
-            data[field] = [] # always set an empty array
-            if obj.respond_to?( field ) && rel_objects = obj.send( field )
-              rel_objects.each do |rel_obj|
-                data[field] << if prop['properties'] && prop['properties']['$ref']
-                                  #got schema describing the objects
-                                  from_schema(rel_obj, opts)
-                                else
-                                  rel_obj
-                                end
-              end
-            end
-
+            data[field] = parse_list(obj, field, prop, opts)
           elsif prop['type'] == 'object' # a singular related object
-
-            data[field] = nil # always set empty val
-            if obj.respond_to?( field ) && rel_obj = obj.send( field )
-              if prop['properties'] && prop['properties']['$ref']
-                data[field] = from_schema(rel_obj, opts)
-              else
-                # NO recursion directly get values from related object. Does
-                # NOT allow deeper nesting so you MUST define an own schema to be save
-                data[field] = {}
-                prop['properties'].each do |fld, prp|
-                  data[field][fld] = rel_obj.send(fld) if obj.respond_to?(field)
-                end
-              end
-            end
-
+            data[field] = parse_object(obj, field, prop, opts)
           else # a simple field is only added if the object knows it
             data[field] = obj.send(field) if obj.respond_to?(field)
           end
@@ -90,10 +63,10 @@ module SchemaTools
         hsh
       end
 
+      private
+
       # Parse the link section of the schema by replacing {id} in urls
-      # === Returns
-      # <Array[Hash{String=>String}]>::
-      # <nil>:: no links present
+      # @return [Array<Hash{String=>String}> | Nil]
       def parse_links(obj, schema)
         links = []
         schema['links'] && schema['links'].each do |link|
@@ -104,6 +77,50 @@ module SchemaTools
         links.empty? ? nil : links
       end
 
+      # Parse a nested array property.
+      # @param [Object] obj the object in question
+      # @param [String] field name
+      # @param [Hash] prop fields schema properties
+      # @param [Hash] opts to_schema options
+      # @return [Array<Hash{String=>String}>]
+      def parse_list(obj, field, prop, opts)
+        res = []
+        if obj.respond_to?( field ) && rel_objects = obj.send( field )
+          rel_objects.each do |rel_obj|
+            res << if prop['properties'] && prop['properties']['$ref']
+                              #got schema describing the objects
+                              from_schema(rel_obj, opts)
+                            else
+                              rel_obj
+                            end
+          end
+        end
+        res
+      end
+
+      # Parse a nested object property.
+      # @param [Object] obj the object in question
+      # @param [String] field name
+      # @param [Hash] prop fields schema properties
+      # @param [Hash] opts to_schema options
+      # @return [Array<Hash{String=>String}>]
+      def parse_object(obj, field, prop, opts)
+        res = nil
+        if obj.respond_to?( field ) && rel_obj = obj.send( field )
+          if prop['properties'] && prop['properties']['$ref']
+            res = from_schema(rel_obj, opts)
+          else
+            # NO recursion directly get values from related object. Does
+            # NOT allow deeper nesting so you MUST define an own schema to be save
+            res = { }
+            prop['properties'].each do |fld, prp|
+              res[fld] = rel_obj.send(fld) if rel_obj.respond_to?(fld)
+            end
+          end
+        end
+        res
+      end
+
     end
   end
 end

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/schema_tools/hash_spec.rb

@@ -1,50 +1,77 @@
 require 'spec_helper'
 
-class Client
+class Contact
   attr_accessor :first_name, :last_name, :addresses, :id
-  end
+end
 
 describe SchemaTools::Hash do
 
   context 'from_schema' do
-    let(:client){Client.new}
+    let(:contact){Contact.new}
     before :each do
-      client.first_name = 'Peter'
-      client.last_name = 'Paul'
-      client.id = 'SomeID'
+      contact.first_name = 'Peter'
+      contact.last_name = 'Paul'
+      contact.id = 'SomeID'
     end
     after :each do
       SchemaTools::Reader.registry_reset
     end
 
     it 'should return hash' do
-      hash = SchemaTools::Hash.from_schema(client)
-      hash['client']['last_name'].should == 'Paul'
+      hash = SchemaTools::Hash.from_schema(contact)
+      hash['contact']['last_name'].should == 'Paul'
     end
 
     it 'should use custom schema path' do
       custom_path = File.expand_path('../../fixtures', __FILE__)
-      hash = SchemaTools::Hash.from_schema(client, path: custom_path)
-      hash['client']['last_name'].should == 'Paul'
+      hash = SchemaTools::Hash.from_schema(contact, path: custom_path)
+      hash['contact']['last_name'].should == 'Paul'
     end
 
     it 'should use custom schema' do
-      hash = SchemaTools::Hash.from_schema(client, class_name: :contact)
+      hash = SchemaTools::Hash.from_schema(contact, class_name: :contact)
       hash['contact']['last_name'].should == 'Paul'
     end
 
     it 'should use only give fields' do
-      hash = SchemaTools::Hash.from_schema(client, fields: ['id', 'last_name'])
-      hash['client'].keys.length.should == 2
-      hash['client']['last_name'].should == client.last_name
-      hash['client']['id'].should == client.id
-      hash['client']['first_name'].should be_nil
+      hash = SchemaTools::Hash.from_schema(contact, fields: ['id', 'last_name'])
+      hash['contact'].keys.length.should == 2
+      hash['contact']['last_name'].should == contact.last_name
+      hash['contact']['id'].should == contact.id
+      hash['contact']['first_name'].should be_nil
     end
   end
 
+  context 'with nested object values' do
+    class Client
+      attr_accessor :first_name, :last_name, :addresses, :id
+    end
+    class Address
+      attr_accessor :city, :zip
+    end
+
+    let(:client){Client.new}
+
+    it 'should have empty nested array values' do
+      hash = SchemaTools::Hash.from_schema(client)
+      hash['client']['addresses'].should == []
+    end
+
+    it 'should have nested array values' do
+      a1 = Address.new
+      a1.city = 'Cologne'
+      a1.zip = 50733
+      client.addresses = [a1]
+      hash = SchemaTools::Hash.from_schema(client)
+      hash['client']['addresses'].should == [{"address"=>{"city"=>"Cologne", "zip"=>50733}}]
+    end
+
+  end
+
+
   context 'with plain nested values' do
 
-    class Lead < Client
+    class Lead < Contact
       attr_accessor :links_clicked, :conversion
     end
 
@@ -52,7 +79,6 @@ describe SchemaTools::Hash do
       attr_accessor :from, :to
     end
 
-
     let(:lead){Lead.new}
     before :each do
       lead.links_clicked = ['2012-12-12', '2012-12-15', '2012-12-16']

data/spec/schema_tools/modules/attributes_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-class Contact
+class TestContact
   include SchemaTools::Modules::Attributes
   has_schema_attrs :client
 end
@@ -13,7 +13,7 @@ end
 describe SchemaTools::Modules::Attributes do
 
   context 'included' do
-    subject { Contact.new }
+    subject { TestContact.new }
 
     it 'should add getter methods' do
       subject.should respond_to(:last_name)
@@ -25,6 +25,7 @@ describe SchemaTools::Modules::Attributes do
 
     it 'should not add setter for readonly properties' do
       subject.should_not respond_to('id=')
+      subject.should_not respond_to('created_at=')
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2544977169694822683
+      hash: 2491825896483527088
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2544977169694822683
+      hash: 2491825896483527088
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24