json_schema_tools 0.4.0 → 0.4.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzY3ZTE3OTFiYzg5OTY5MDQ4ZmRjNTE2MjIzNmE3ZjA5MDg0MTA3YQ==
+    ZWI2NjlkM2IyMjgxZGYyODJkNzk5NmY0MjQxMjA0YWQ4ZTNiYTk3Nw==
   data.tar.gz: !binary |-
-    MGQ4NjQ2MmQ3NWY0NGI1MWM3MjFjMjY0YjQxMWM1ODc1YmNiZGY2OQ==
+    MDhlNWEwMTY5ZjY2ZGJiYjViMjdhZWI5Nzg5NGI4MTM3ZmZmODk0OQ==
 SHA512:
   metadata.gz: !binary |-
-    NjMwMGI3ZTY4YzdiZDFmMzA2NzQ2MWRjZjIzN2E4NDNjMzM1ODljZGFhNDM4
-    NjU0MjM2YjM0NWE3NTg0MmQ5MWI2OGI1OGFhMDNjMjA2ODQ4M2I5NjIzYWZj
-    MTUyY2Y5N2ZkOWUzZTZlNzY5MGI2MGZjNzI0YTY1YWVmNTAwMWY=
+    YmVlMDY3ZTBkOTJkNzA2OWExNWRiYjM3ZDhhNGNkMTJkZDE2MGQ0YWM1OTIz
+    Y2NiNDQwNzA0YzljODUzNTM4YmU1MGRmOWVkZDI1MGVhYzg1MWJkNWUzZDY3
+    ZGQ2MzA5NTBjZTZjZjJkZTRmODdjOGExOTE2NDVmY2IxZjVmOWM=
   data.tar.gz: !binary |-
-    ZDE5YTA5NmE1NWQwNWNmOWRkN2FjNmJhODI3MGFhMWZkNDY2NzhjYzliM2E3
-    MmVhY2FlMDg0NTczYzgzZjE2OTlmNmZjMWU3NDExYzU5M2RmMzBlY2ZlYjY4
-    ZjQyYzk0NmM0ZmM5N2M5Y2Y1ZDI2MDFjY2M4NzM4YWM0MWQwZWQ=
+    NTFjZjdkMjAzNDgxOWIxYjdiYmEyYTI3ZGMxNWM2YWViMDJlZmZlNzA3Yzc2
+    YWEwMzNlZmVjOTIxNjQ5M2JmYzE0YTRjMjhmOGFmZmUxZThlMWQ5NWQwZDFi
+    ODIyMzY3NDY2Zjc1Y2NkM2JhMGE0YThlNDJiZWMyN2ViNWJiOTU=

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 2014-11
 
+* add from_json method to attributes module, to create new objects from a json string
 * remove as_json method(alias of as_schema_json) conflicting with active_resource/active_record. Nothing stops one from using/aliasing it in his own code.
 
 2014-10

data/README.md

@@ -186,6 +186,27 @@ Of course the low level hash method also supports all of these options:
 client_hash = SchemaTools::Hash.from_schema(peter, fields:['id', 'name'])
 #=> "client"=>{"id"=>12, "name"=> "Peter"}
 ```
+
+## Object from JSON
+
+On any remote site you'll need to instantiate new objects from an incoming json
+string. Let's assume a contact class which you need for incoming contact json
+data.  (Example taken from attributes_spec.rb)
+
+```ruby
+SchemaTools.schema_path = '/path/to/schema-json-files-with-contact-def'
+class Contact
+  include SchemaTools::Modules::Attributes
+  has_schema_attrs :contact
+end
+
+json_str = '{"id": "123456", "last_name": "Meier","first_name": "Peter"}
+c = Contact.from_json(json_str)
+c.id #=> 123456
+
+```
+
+
 ## Parameter cleaning
 
 Hate people spamming your api with wrong object fields? Use the Cleaner to

data/lib/schema_tools/modules/attributes.rb

@@ -8,10 +8,10 @@ module SchemaTools
     #   class Contact
     #     has_schema_attrs :contact
     #   end
-    #   Contact.schema_name #=> contact
-    #   Contact.as_json
-    #   Contact.as_hash
-    #   Contact.schema  #=> json schema hash
+    #   Contact.schema_name     #=> contact
+    #   Contact.as_schema_json  #=> json string
+    #   Contact.as_hash         #=> ruby hash
+    #   Contact.schema          #=> json schema hash
     module Attributes
       extend ActiveSupport::Concern
       include SchemaTools::Modules::AsSchema
@@ -37,12 +37,41 @@ module SchemaTools
 
           self.schema= reader.read(schema_name, schema_location)
           self.schema_name(schema_name)
-          # make getter / setter
+          # make getter / setter methods
           self.schema[:properties].each do |key, prop|
             define_method(key) { schema_attrs[key] }
             define_method("#{key}=") { |value| schema_attrs[key] = value } unless prop[:readonly]
           end
-          #TODO parse links ?? or do it in resource module
+        end
+
+        # Create a new object from a json string. Auto-detects nesting by
+        # checking for a hash key with the same name as the schema_name:
+        #
+        #     class Contact
+        #       include SchemaTools::Modules::Attributes
+        #       has_schema_attrs :contact
+        #     end
+        #     c = Contact.from_json('{ "id": "123456",  "last_name": "Meier" }')
+        #     c.id #=>123456
+        #     c = Contact.from_json('{"contact:{ "id": "123456",  "last_name": "Meier" }}')
+        #
+        # @param [String] json
+        def from_json(json)
+          hash = JSON.parse(json)
+          # test if hash is nested and shift up
+          if hash.length == 1 && hash["#{schema_name}"]
+            hash = hash["#{schema_name}"]
+          end
+          obj = new
+          hash.each do |key, val|
+            next unless obj.respond_to?(key)
+            # set values to raw schema attributes, even if there are no setters
+            # assuming this objects comes from a remote site
+            # TODO type conversion string/integer/number/date/datetime?
+            obj.schema_attrs[key] = val
+            # TODO if val is a hash / array => look for nested class
+          end
+          obj
         end
 
         # @param [Hash] schema_hash

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/spec/fixtures/data/contact_nested.json

@@ -0,0 +1,9 @@
+{
+  "contact" : {
+    "id": "123456",
+    "contact_source": "website",
+    "organisation": "My super-company",
+    "last_name": "Meier",
+    "first_name": "Peter"
+  }
+}

data/spec/fixtures/data/contact_plain.json

@@ -0,0 +1,10 @@
+{
+  "id": "123456",
+  "contact_source": "website",
+  "organisation": "My super-company",
+  "last_name": "Meier",
+  "first_name": "Peter"
+}
+
+
+

data/spec/schema_tools/circuluar_ref_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe SchemaTools::Reader do
-  BROKEN_SCHEMA_PATH = File.expand_path('../../fixtures_broken', __FILE__)
+  BROKEN_SCHEMA_PATH = File.join(fixture_path, 'schemata_broken')
   context 'circular references' do
     it 'should raise exception for circular $refs' do
       expect{

data/spec/schema_tools/hash_spec.rb

@@ -49,7 +49,7 @@ describe SchemaTools::Hash do
     end
 
     it 'should use custom schema path' do
-      custom_path = File.expand_path('../../fixtures', __FILE__)
+      custom_path = File.expand_path('../../fixtures/schemata', __FILE__)
       hash = SchemaTools::Hash.from_schema(contact, path: custom_path)
       hash['last_name'].should == 'Paul'
     end

data/spec/schema_tools/modules/attributes_spec.rb

@@ -1,8 +1,13 @@
 require 'spec_helper'
 
-class TestContact
+class TestClient
   include SchemaTools::Modules::Attributes
   has_schema_attrs :client
+  end
+
+class TestContact
+  include SchemaTools::Modules::Attributes
+  has_schema_attrs :contact
 end
 
 class Numbers
@@ -13,7 +18,7 @@ end
 describe SchemaTools::Modules::Attributes do
 
   context 'included' do
-    subject { TestContact.new }
+    subject { TestClient.new }
 
     it 'should add getter methods' do
       subject.should respond_to(:last_name)
@@ -41,6 +46,33 @@ describe SchemaTools::Modules::Attributes do
     end
   end
 
+  context 'new from_json' do
+
+    it 'creates new object' do
+      str = load_fixture_data('contact_plain.json')
+      hash = JSON.parse(str)
+      obj = TestContact.from_json(str)
+      expect(obj.id).to eq hash['id']
+      expect(obj.organisation).to eq hash['organisation']
+      expect(obj.contact_source).to eq hash['contact_source']
+      expect(obj.first_name).to eq hash['first_name']
+      expect(obj.last_name).to eq hash['last_name']
+    end
+
+    it 'creates new object from nested response' do
+      str = load_fixture_data('contact_nested.json')
+      hash = JSON.parse(str)['contact']
+      obj = TestContact.from_json(str)
+      expect(obj.id).to eq hash['id']
+      expect(obj.organisation).to eq hash['organisation']
+      expect(obj.contact_source).to eq hash['contact_source']
+      expect(obj.first_name).to eq hash['first_name']
+      expect(obj.last_name).to eq hash['last_name']
+   end
+
+  end
+
+
   context 'attributes from dynamic schema' do
     subject { Numbers.new }
 

data/spec/spec_helper.rb

@@ -18,6 +18,6 @@ end
 
 I18n.enforce_available_locales = false if I18n.respond_to?('enforce_available_locales=')
 # set global json schema path for examples
-SchemaTools.schema_path = File.expand_path('../fixtures', __FILE__)
+SchemaTools.schema_path = File.join(fixture_path,'schemata')
 
 puts "Testing with ActiveModel Version: #{ActiveModel.version rescue ActiveModel::VERSION::STRING}"

data/spec/test_helpers.rb

@@ -1,3 +1,13 @@
+# Set global fixtures path
+def fixture_path
+  File.expand_path('../fixtures/', __FILE__)
+end
+# load a json data object file returns the json string
+# @return[String] file contents
+def load_fixture_data(name)
+   File.open(File.join(fixture_path,'data', name ), 'r') { |f| f.read }
+end
+
 def schema_as_ruby_object
   {
     "type" => "object",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -96,22 +96,24 @@ files:
 - lib/schema_tools/ref_resolver.rb
 - lib/schema_tools/schema.rb
 - lib/schema_tools/version.rb
-- spec/fixtures/address.json
-- spec/fixtures/basic_definitions.json
-- spec/fixtures/circular_references_twice.json
-- spec/fixtures/client.json
-- spec/fixtures/contact.json
-- spec/fixtures/includes_basic_definitions.json
-- spec/fixtures/includes_deep_nested_refs.json
-- spec/fixtures/lead.json
-- spec/fixtures/nested_schemas/person.json
-- spec/fixtures/one_of_definition.json
-- spec/fixtures/page.json
-- spec/fixtures/relative_paths/includes_relative_path.json
-- spec/fixtures_broken/circular_references.json
-- spec/fixtures_broken/circular_references_multi.json
-- spec/fixtures_broken/circular_references_multi_file_one.json
-- spec/fixtures_broken/circular_references_multi_file_two.json
+- spec/fixtures/data/contact_nested.json
+- spec/fixtures/data/contact_plain.json
+- spec/fixtures/schemata/address.json
+- spec/fixtures/schemata/basic_definitions.json
+- spec/fixtures/schemata/circular_references_twice.json
+- spec/fixtures/schemata/client.json
+- spec/fixtures/schemata/contact.json
+- spec/fixtures/schemata/includes_basic_definitions.json
+- spec/fixtures/schemata/includes_deep_nested_refs.json
+- spec/fixtures/schemata/lead.json
+- spec/fixtures/schemata/nested_schemas/person.json
+- spec/fixtures/schemata/one_of_definition.json
+- spec/fixtures/schemata/page.json
+- spec/fixtures/schemata/relative_paths/includes_relative_path.json
+- spec/fixtures/schemata_broken/circular_references.json
+- spec/fixtures/schemata_broken/circular_references_multi.json
+- spec/fixtures/schemata_broken/circular_references_multi_file_one.json
+- spec/fixtures/schemata_broken/circular_references_multi_file_two.json
 - spec/schema_tools/circuluar_ref_spec.rb
 - spec/schema_tools/cleaner_spec.rb
 - spec/schema_tools/hash_spec.rb