json_schema_tools 0.2.0 → 0.2.1

data/CHANGELOG.md

@@ -2,7 +2,8 @@
 
 
 2013-10
-
+* add base_url option to schema hash creation. Prepends an url to all links of a rendered object
+* add to_schema_json for simpler model to json conversion
 * add option to exclude_root in to_schema hash method
 
 2013-06

data/README.md

@@ -100,9 +100,9 @@ peter.as_schema_hash
 The AsSchema module is a tiny wrapper for following low level method:
 
 ```ruby
-paul = Contact.new name: 'Peter'
+paul = Contact.new name: 'Paul'
 contact_hash = SchemaTools::Hash.from_schema(paul)
-#=> "contact"=>{"id"=>12, "name"=> "Peter", "email"=>"",..}
+#=> "contact"=>{"id"=>12, "name"=> "Paul",..}
 # to_json is up to you .. or your rails controller
 ```
 
@@ -117,12 +117,6 @@ Only use some fields e.g. to save bandwidth
 peter.as_schema_json(fields:['id', 'name'])
 #=> "client":{"id":12, "name": "Peter"}
 ```
-Of course the low level hash method also supports all of these options:
-
-```ruby
-client_hash = SchemaTools::Hash.from_schema(peter, fields:['id', 'name'])
-#=> "client"=>{"id"=>12, "name"=> "Peter"}
-```
 
 Use a custom schema name e.g. to represent a client as contact. Assumes you also
 have a schema named contact.json
@@ -148,11 +142,17 @@ inline:
 
 peter.as_schema_json( exclude_root: true )
 
-client_hash = SchemaTools::Hash.from_schema(peter, exclude_root: true)
-#=> {"id"=>12, "name"=> "Peter",
-#    "_class_name":"client", "_links":[ .. are inlined .. ]}
+#=> {"id":12, "name"=> "Peter",
+#    "_class_name":"client",
+#    "_links":[ .. ] }
 ```
 
+Of course the low level hash method also supports all of these options:
+
+```ruby
+client_hash = SchemaTools::Hash.from_schema(peter, fields:['id', 'name'])
+#=> "client"=>{"id"=>12, "name"=> "Peter"}
+```
 ## Parameter cleaning
 
 Hate people spamming your api with wrong object fields? Use the Cleaner to

data/lib/schema_tools/modules/hash.rb

@@ -32,6 +32,7 @@ module SchemaTools
       # @options opts [Array<String>] :fields to return. If not set all schema
       # properties are used.
       # @options opts [String] :path of the schema files overriding global one
+      # @options opts [String] :base_url used in all links
       # @options opts [Boolean] :exclude_root if set objects are not nested under
       # their class name and the object hash gets _links and _class_name inline.
       #
@@ -39,27 +40,17 @@ module SchemaTools
       #   { 'invoice' => {'title'=>'hello world', 'number'=>'4711' } }
       #
       def from_schema(obj, opts={})
-        fields = opts[:fields]
+
         # get objects class name without inheritance
         real_class_name = obj.class.name.split('::').last.underscore
         class_name = opts[:class_name] || real_class_name
 
-        data = {}
         # get schema
         schema = SchemaTools::Reader.read(class_name, opts[:path])
         # iterate over the defined schema fields
-        schema['properties'].each do |field, prop|
-          next if fields && !fields.include?(field)
-          if prop['type'] == 'array'
-            data[field] = parse_list(obj, field, prop, opts)
-          elsif prop['type'] == 'object' # a singular related object
-            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
-        end
+        data = parse_properties(obj, schema, opts)
         #get links if present
-        links = parse_links(obj, schema)
+        links = parse_links(obj, schema, opts)
 
         if opts[:exclude_root]
           hsh = data
@@ -74,12 +65,37 @@ module SchemaTools
 
       private
 
+      def parse_properties(obj, schema, opts)
+        fields = opts[:fields]
+        data = {}
+        schema['properties'].each do |field, prop|
+          next if fields && !fields.include?(field)
+          if prop['type'] == 'array'
+            data[field] = parse_list(obj, field, prop, opts)
+          elsif prop['type'] == 'object' # a singular related object
+            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
+        end
+        data
+      end
+
       # Parse the link section of the schema by replacing {id} in urls
+      # @param [Object] obj object being parsed
+      # @param [Hash] schema
+      # @param [Hash] opts
+      # @options opts [String] :base_url prepended to link href, WATCH possible double //
       # @return [Array<Hash{String=>String}> | Nil]
-      def parse_links(obj, schema)
+      def parse_links(obj, schema, opts={})
         links = []
         schema['links'] && schema['links'].each do |link|
-          links << { 'rel' => link['rel'], 'href' => link['href'].gsub(/\{id\}/, "#{obj.id}") }
+          # substitute placeholders
+          href = link['href'].gsub(/\{id\}/, "#{obj.id}")
+          href = "#{opts[:base_url]}/#{href}" if opts[:base_url]
+
+          links << { 'rel' => link['rel'],
+                     'href' => href }
         end
         links.uniq
         # return links only if not empty

data/lib/schema_tools/version.rb

@@ -1,3 +1,3 @@
 module SchemaTools
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/schema_tools/hash_spec.rb

@@ -51,8 +51,8 @@ describe SchemaTools::Hash do
     end
 
     it 'should use custom schema' do
-      hash = SchemaTools::Hash.from_schema(contact, class_name: :contact)
-      hash['contact']['last_name'].should == 'Paul'
+      hash = SchemaTools::Hash.from_schema(contact, class_name: :client)
+      hash['client']['last_name'].should == 'Paul'
     end
 
     it 'should use only give fields' do
@@ -157,5 +157,27 @@ describe SchemaTools::Hash do
     end
 
   end
+
+  context 'with links' do
+    let(:client){Client.new}
+    before :each do
+      client.first_name = 'Peter'
+      client.id = 'SomeID'
+    end
+    after :each do
+      SchemaTools::Reader.registry_reset
+    end
+
+    it 'should have links' do
+      hash = SchemaTools::Hash.from_schema(client)
+      hash['links'].length.should == 8
+    end
+
+    it 'should prepend base_url' do
+      hash = SchemaTools::Hash.from_schema(client, base_url: 'http://json-hell.com')
+      hash['links'].first['href'].should == 'http://json-hell.com/clients/SomeID'
+    end
+
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -128,18 +128,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1056530391654598731
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1056530391654598731
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24