json_schema_tools 0.1.2 → 0.2.0

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog JSON Schema Tools
 
 
+2013-10
+
+* add option to exclude_root in to_schema hash method
+
 2013-06
 
 * *has_schema_attr :schema=>{schema as ruby hash}* allow pass a schema as hash
@@ -8,10 +12,10 @@
 * rails 4 (ActiveModel) compatibility
 * Testing with different ActiveModel Versions
 
-
 2013-02
 
 * add validations for classes generated by KlassFactory
 
 2012-12
+
 * initial version with reader, hasher, params cleaner, attributes module

data/README.md

@@ -17,9 +17,12 @@ Hook the gem into your app
 
 ## Read Schema
 
-Before the fun begins, with any of the tools, one or multiple JSON schema files
-must be available(read into a hash). So first provide a base path where the
-schema.json files are located.
+Before the fun begins, with any of the tools, one or multiple JSON schema(files)
+must be available. A schema is converted into a ruby hash and for convenience is
+cached into a registry (global or local). So you only need to initialize them
+once e.g on program start.
+
+Provide a base path where the schema json files are located.
 
 ```ruby
 SchemaTools.schema_path = '/path/to/schema-json-files'
@@ -64,29 +67,58 @@ reader.read :client, 'from/path'
 reader.registry
 ```
 
-## Object to Schema JSON
+## Object to JSON  - from Schema
+
+As you probably know such is done e.g in rails via object.to_json. While using
+this might be simple, it has a damn big drawback: There is no transparent
+contract about the data-structure, as rails simply uses all fields defined in the
+database(ActiveRecord model). One side-effect: With each migration you are f***ed
 
-A schema provides a (public) contract about an object definition. Therefore an
-internal object is converted to it's schema version on delivery(API access).
+A schema provides a public contract about an object definition. Therefore an
+internal object is converted to it's public(schema) version on delivery(API access).
 First the object is converted to a hash containing only the properties(keys)
 from its schema definition. Afterwards it is a breeze to convert this hash into
 JSON, with your favorite generator.
 
-Following uses client.json schema(same as peter.class name) inside the global
-schema_path and adds properties to the clients_hash simply calling
+Following uses client.json schema, detected from peter.class name.underscore => "client",
+inside the global schema_path and adds properties to the clients_hash by simply calling
 client.send('property-name'):
 
 ```ruby
+class Client < ActiveRecord::Base
+  include SchemaTools::Modules::AsSchema
+end
+
 peter = Client.new name: 'Peter'
-client_hash = SchemaTools::Hash.from_schema(peter)
-#=> "client"=>{"id"=>12, "name"=> "Peter", "email"=>"",..} # whatever else you have as properties
+peter.as_schema_json
+#=> "client":{"id":12, "name": "Peter", "email":"",..}
+
+peter.as_schema_hash
+#=> "client"=>{"id"=>12, "name"=> "Peter", "email"=>"",..}
+```
+
+The AsSchema module is a tiny wrapper for following low level method:
+
+```ruby
+paul = Contact.new name: 'Peter'
+contact_hash = SchemaTools::Hash.from_schema(paul)
+#=> "contact"=>{"id"=>12, "name"=> "Peter", "email"=>"",..}
 # to_json is up to you .. or your rails controller
 ```
 
-### Customise Schema Hash
+### Customise Output JSON / Hash
+
+Following examples show options to customize the resulting json or hash. Of
+course they can be combined.
 
 Only use some fields e.g. to save bandwidth
 
+```ruby
+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"}
@@ -96,15 +128,29 @@ Use a custom schema name e.g. to represent a client as contact. Assumes you also
 have a schema named contact.json
 
 ```ruby
-client_hash = SchemaTools::Hash.from_schema(peter, class_name: 'contact')
-#=> "contact"=>{"id"=>12, "name"=> "Peter"}
+peter.as_schema_json(class_name: 'contact')
 ```
 
-Use a custom schema path
+Set a custom schema path
 
 ```ruby
-client_hash = SchemaTools::Hash.from_schema(peter, path: 'path-to/json-files/')
-#=> "client"=>{"id"=>12, "name"=> "Peter"}
+peter.as_schema_json( path: 'path-to/json-files/')
+```
+
+By default the object hash has the class name (client) and the link-section on
+root level. This divides the data from the available methods and makes a clear
+statement about the object type(it's class).
+If you don't want to traverse that one extra level you can exclude the root
+and move the data one level up. See how class name and links are available
+inline:
+
+```ruby
+
+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 .. ]}
 ```
 
 ## Parameter cleaning
@@ -125,7 +171,7 @@ end
 ## Object attributes from Schema
 
 Add methods, defined in schema properties, to an existing class.
-Very usefull if you are building a API client and don't want to manually add
+Very useful if you are building a API client and don't want to manually add
 methods to you local classes .. like people NOT using JSON schema
 
 ```ruby
@@ -138,6 +184,8 @@ contact = Client.new
 contact.last_name = 'Rambo'
 # raw access
 contact.schema_attrs
+# to json
+contact.as_schema_json
 ```
 
 ## Classes from Schema - KlassFactory
@@ -194,8 +242,7 @@ Testing with different ActiveModel / ActiveSupport Versions:
     RAILS_VERSION=4 rake spec
 
 The RAILS_VERSION switch sets the version of the gems in the Gemfile and is only
-usefull in test env.
-
+useful in test env.
 
 # Credits
 

data/lib/schema_tools.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'schema_tools/version'
 require 'schema_tools/modules/read'
 require 'schema_tools/modules/hash'
+require 'schema_tools/modules/as_schema'
 require 'schema_tools/modules/attributes'
 require 'schema_tools/modules/validations'
 require 'schema_tools/reader'

data/lib/schema_tools/klass_factory.rb

@@ -5,25 +5,29 @@ module SchemaTools
 
     class << self
 
-      # Build classes from schema inside the given namespace. Uses all classes
-      # found in schema path:
+      # Build ruby classes from a schema with getter/setter methods for all
+      # properties and validation. Uses all classes(json files) found in global
+      # schema path or you can add a custom path.
+      # A namespace can be given under which the classes will be created.
       # @example
       #
-      # First set a global schema path:
+      # First set a(global) schema path:
       #     SchemaTools.schema_path = File.expand_path('../fixtures', __FILE__)
       #
-      # Bake classes from all schema.json found
+      # Build classes from all json files in schema path
       #     SchemaTools::KlassFactory.build
       #
-      # Go use it
+      # Go use them
       #     client = Client.new organisation: 'SalesKing'
       #     client.valid?
       #     client.errors.should be_blank
-      #
+      # With custom options:
+      #     SchemaTools::KlassFactory.build namespace: MyModule,
+      #                                     path: 'custom/path/to_json_schema'
       # @param [Hash] opts
       # @options opts [SchemaTools::Reader] :reader to use instead of global one
-      # @options opts [SchemaTools::Reader] :path to schema files instead of global one
-      # @options opts [SchemaTools::Reader] :namespace of the new classes e.g. MyCustomNamespace::MySchemaClass
+      # @options opts [String] :path to schema files instead of global one
+      # @options opts [String|Symbol|Module] :namespace of the new classes e.g. MyCustomNamespace::MySchemaClass
       def build(opts={})
         reader = opts[:reader] || SchemaTools::Reader
         schemata = reader.read_all( opts[:path] || SchemaTools.schema_path )

data/lib/schema_tools/modules/as_schema.rb

@@ -0,0 +1,40 @@
+require 'active_support/concern'
+module SchemaTools
+  module Modules
+    # Extend a class so it can be rendered as json from a named schema
+    module AsSchema
+      extend ActiveSupport::Concern
+
+      # convert this class to a schema markup.
+      # @param [Hash{Symbol=>Mixed}] opts passed on to #SchemaTools::Hash.from_schema
+      # @return [String] json
+      def as_schema_json(opts={})
+        ActiveSupport::JSON.encode(as_schema_hash(opts))
+      end
+
+      # Get the object as hash with fields detected from its schema.
+      # The schema is derived from
+      # * from options[:class_name]
+      # * has_schema_attrs definition(if used)
+      # * the underscored class name
+      # @param [Hash{Symbol=>Mixed}] opts passed on to #SchemaTools::Hash.from_schema
+      # @return [Hash]
+      def as_schema_hash(opts={})
+        # detect schema name from class method, else class name or opts is used.
+        if self.class.schema_name
+          opts[:class_name] ||= self.class.schema_name
+        end
+        SchemaTools::Hash.from_schema(self, opts)
+      end
+
+      module ClassMethods
+        # Get or set the schema name used
+        def schema_name(name=nil)
+          @schema_name = name if name
+          @schema_name
+        end
+      end
+
+    end
+  end
+end

data/lib/schema_tools/modules/attributes.rb

@@ -1,10 +1,11 @@
 require 'active_support/concern'
 module SchemaTools
   module Modules
-    # Add schema properties to a class by including this module and defining from
+    # Add schema properties to a class by using has_schema_attrs to define from
     # which schema to inherit attributes.
     module Attributes
       extend ActiveSupport::Concern
+      include SchemaTools::Modules::AsSchema
 
       def schema_attrs
         @schema_attrs ||= {}
@@ -16,10 +17,12 @@ module SchemaTools
         # @param [Hash<Symbol|String>] opts
         # @options opts [String] :path schema path
         # @options opts [SchemaTools::Reader] :reader instance, instead of global reader/registry
-        def has_schema_attrs(schema, opts={})
+        def has_schema_attrs(schema_name, opts={})
           reader          = opts[:reader] || SchemaTools::Reader
           schema_location = opts[:path]   || opts[:schema]
-          schema          = reader.read(schema, schema_location)
+          schema          = reader.read(schema_name, schema_location)
+          # remember name on class level
+          self.schema_name(schema_name)
           # make getter / setter
           schema[:properties].each do |key, val|
             # getter
@@ -36,7 +39,7 @@ module SchemaTools
           end
         end
 
-      end # ClassMethods
+      end
 
     end
   end

data/lib/schema_tools/modules/hash.rb

@@ -24,7 +24,7 @@ module SchemaTools
       #  obj_hash = Schema.to_hash_from_schema(obj, class_name: :document)
       #   => { 'document' =>{'title'=>'hello world' } }
       #
-      # @param [Object] obj which is returned as hash
+      # @param [Object] obj returned as hash
       # @param [Hash{Symbol=>Mixed}] opts additional options
       # @options opts [String|Symbol] :class_name used as hash key. Should be
       # a lowercase underscored name and it MUST have an existing schema file.
@@ -32,6 +32,8 @@ 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 [Boolean] :exclude_root if set objects are not nested under
+      # their class name and the object hash gets _links and _class_name inline.
       #
       # @return [Hash{String=>{String=>Mixed}}] The object as hash:
       #   { 'invoice' => {'title'=>'hello world', 'number'=>'4711' } }
@@ -56,10 +58,17 @@ module SchemaTools
             data[field] = obj.send(field) if obj.respond_to?(field)
           end
         end
-        hsh = { "#{class_name}" => data }
-        #add links if present
+        #get links if present
         links = parse_links(obj, schema)
-        links && hsh['links'] = links
+
+        if opts[:exclude_root]
+          hsh = data
+          hsh['_class_name'] = "#{class_name}"
+          links && hsh['_links'] = links
+        else
+          hsh = { "#{class_name}" => data }
+          links && hsh['links'] = links
+        end
         hsh
       end
 
@@ -88,11 +97,11 @@ module SchemaTools
         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
+                      #got schema describing the objects
+                      from_schema(rel_obj, opts)
+                    else
+                      rel_obj
+                    end
           end
         end
         res

data/lib/schema_tools/modules/read.rb

@@ -25,8 +25,8 @@ module SchemaTools
 
       # Read a schema and return it as hash. You can supply a path or the
       # global path defined in #SchemaTools.schema_path is used.
-      # Schemata returned from cache in #registry to prevent filesystem
-      # round-trips. The cache can be resented with #registry_reset
+      # Schemata are returned from cache(#registry) if present to prevent
+      # filesystem round-trips. The cache can be reset with #registry_reset
       #
       # @param [String|Symbol] schema name to be read from schema path directory
       # @param [String|Hash] either the path to retrieve schema_name from,
@@ -36,14 +36,14 @@ module SchemaTools
         schema_name = schema_name.to_sym
         return registry[schema_name] if registry[schema_name]
 
-        if path_or_schema.is_a? ::Hash
+        if path_or_schema.is_a?(::Hash)
           path       = nil
           plain_data = path_or_schema.to_json
         elsif path_or_schema.is_a?(::String) || path_or_schema.nil?
           path       = path_or_schema
           file_path  = File.join(path || SchemaTools.schema_path, "#{schema_name}.json")
         else
-          raise ArgumentError, "Second parameter must be a path or a schema!"
+          raise ArgumentError, 'Second parameter must be a path or a schema!'
         end
 
         plain_data ||= File.open(file_path, 'r'){|f| f.read}

data/lib/schema_tools/version.rb

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

data/spec/fixtures/client.json

@@ -1,7 +1,7 @@
 {"type":"object",
   "title": "client",
   "name": "client",
-  "description": "A client in SalesKing",
+  "description": "A example client.",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
@@ -12,7 +12,7 @@
       "minLength":22
     },
     "number":{
-      "description": "Unique number, auto-created by SK for new client without number.",
+      "description": "Unique number, auto-created for new client without number.",
       "type":"string",
       "maxLength": 50
     },
@@ -32,54 +32,11 @@
       "type":"string",
       "maxLength": 50
     },
-    "gender":{
-      "description": "Can be empty for a company. Is used in salutation",
-      "enum":["male", "female"],
-      "type":"string"
-    },
-    "notes":{
-      "description": "Notes for a contact. For day to day information you should use comments instead.",
-      "type":"string",
-      "format": "text"
-    },
-    "position":{
-      "description": "Position of a person in a company.",
-      "type":"string",
-      "maxLength": 50
-    },
-    "title":{
-      "description": "Academical title of a person e.g. Dr., Prof",
-      "type":"string",
-      "maxLength": 50
-    },
-    "tax_number":{
-      "description": "Tax number, normally applies to a private person",
-      "type":"string",
-      "maxLength": 30
-    },
-    "vat_number":{
-      "description": "VAT number, for a company or person paying value added taxes.",
-      "type":"string",
-      "maxLength": 30
-    },
     "email":{
       "description": "Email address of the contact.",
       "type":"string",
       "maxLength": 100
     },
-    "url":{
-      "description": "An url associated with the person, e.g its company website.",
-      "type":"string",
-      "maxLength": 255
-    },
-    "birthday":{
-      "format":"date",
-      "type":"string"
-    },
-    "tag_list":{
-      "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
-      "type":"string"
-    },
     "created_at":{
       "description": "Date the record was created in SK. Never changes afterwards.",
       "format":"date-time",
@@ -92,101 +49,26 @@
       "readonly":true,
       "type":"string"
     },
-    "language":{
-      "description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the client is emailed, a localized version of a multi-language template(email, pdf) will be used if available. The language will also be set for new documents.",
-      "type":"string",
-      "maxLength": 10
-    },
-    "currency":{
-      "description": "Currency code as defined by the ISO 4217 standard(3-letter UPCASE: EUR, USD). If set the currency is taken for new documents.",
-      "type":"string",
-      "maxLength": 3,
-      "minLength": 3
-    },
-    "payment_method":{
-      "description": "Default payment method for used for new documemts",
-      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
-      "type":"string"
-    },
-    "bank_name":{
-      "description": "Bank name",
-      "type":"string",
-      "maxLength": 70
-    },
-    "bank_number":{
-      "description": "Bank number",
-      "type":"string",
-      "maxLength": 35
-    },
-    "bank_account_number":{
-      "description": "Bank account number.",
-      "type":"string",
-      "maxLength": 35
-    },
-    "bank_iban":{
-      "description": "IBAN Number of the bank account. Is validated",
-      "type":"string",
-      "maxLength": 35
-    },
-    "bank_swift":{
-      "description": "SWIFT BIC-  Bank Identifier Code",
-      "type":"string",
-      "maxLength": 11
-    },
-    "bank_owner":{
-      "description": "Bank account owner",
-      "type":"string",
-      "maxLength": 70
-    },
-    "phone_fax":{
-      "description": "Fax number",
-      "type":"string",
-      "maxLength": 30
-    },
-    "phone_office":{
-      "description": "Office phone number",
-      "type":"string",
-      "maxLength": 30
-    },
-    "phone_home":{
-      "description": "Private phone number",
-      "type":"string",
-      "maxLength": 30
-    },
     "phone_mobile":{
       "description": "Mobile phone number",
       "type":"string",
       "maxLength": 30
     },
-    "lock_version":{
-      "description": "Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.",
-      "type":"integer"
-    },
     "cash_discount":{
       "description": "Default cash discount for new invoices.",
       "maximum": 100,
       "minimum": 0,
       "type":"number"
     },
-    "due_days":{
-      "description": "Default due days for new invoices.",
-      "type":"integer"
-    },
-    "address_field":{
-      "description": "Returns the address field used on new docs. Consist of Organisation name and default(first) address",
-      "readonly":true,
-      "type":"string"
-    },
     "addresses":{
       "description": "A client can have many addresses, sorted by date descending(new first). Default address is the most recent one.",
       "type":"array",
       "properties" : {"$ref":"./address.json#properties"}
     },
-    "team_id":{
-      "description": "A team uuid. If set only the team and its parent teams can see the record.",
-      "type":"string",
-      "maxLength": 22,
-      "minLength":22
+    "work_address":{
+      "description": "The work address as an example for a single nested/related object",
+      "type":"object",
+      "properties" : {"$ref":"./address.json#properties"}
     }
   },
   "links":[
@@ -211,55 +93,6 @@
           "description": "Wildcard search in first, last_name, organisation, email, number",
           "type":"string"
         },
-        "filter[tags]":{
-          "title" : "Tags",
-          "description": "Filter by a space delimited list of tags",
-          "type":"string"
-        },
-        "filter[ids]":{
-          "title" : "Clients",
-          "description": "A single or a list of client uuids, comma separated",
-          "type" : "string"
-        },
-        "filter[created_at_from]":{
-          "title" : "From date",
-          "description": "Objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "format" : "date-time",
-          "type" : "string"
-        },
-        "filter[created_at_to]":{
-          "title" : "To date",
-          "description": "Objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
-          "format" : "date-time",
-          "type" : "string"
-        },
-        "filter[birthday_from]":{
-          "title" : "From birthday date",
-          "description": "Contacts with a birthday after and on the date. Leave the birthday-to date blank to only search on this day.",
-          "format" : "date",
-          "type" : "string"
-        },
-        "filter[birthday_to]":{
-          "title" : "To birthday date",
-          "description": "Contacts with a birthday date before and on the date.",
-          "format" : "date",
-          "type" : "string"
-        },
-        "filter[creator_ids]":{
-          "title" : "Creator",
-          "description": "Objects created by the given users uuids, comma separated",
-          "type" : "string"
-        },
-        "filter[number]":{
-          "title" : "By number",
-          "description": "Search by number where the number is matched from the start: number%",
-          "type" : "string"
-        },
-        "filter[languages]":{
-          "title" : "Languages",
-          "description": "A single or a list of language codes, comma separated",
-          "type" : "string"
-        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",
@@ -293,27 +126,6 @@
     },
     { "rel": "invoices",
       "href": "clients/{id}/invoices"
-    },
-    { "rel": "estimates",
-      "href": "clients/{id}/estimates"
-    },
-    { "rel": "orders",
-      "href": "clients/{id}/orders"
-    },
-    { "rel": "credit_notes",
-      "href": "clients/{id}/credit_notes"
-    },
-    { "rel": "recurrings",
-      "href": "clients/{id}/recurrings"
-    },
-    { "rel": "payment_reminders",
-      "href": "clients/{id}/payment_reminders"
-    },
-    { "rel": "comments",
-      "href": "clients/{id}/comments"
-    },
-    { "rel": "emails",
-      "href": "clients/{id}/emails"
     }
   ]
 }

data/spec/schema_tools/cleaner_spec.rb

@@ -6,7 +6,8 @@ describe SchemaTools::Cleaner do
     let(:params){
       { id: 'some id',
         last_name: 'Clean',
-        first_name: 'Paul'
+        first_name: 'Paul',
+        phone_mobile: 110
       }
     }
 
@@ -19,6 +20,11 @@ describe SchemaTools::Cleaner do
       params[:last_name].should == 'Clean'
       params[:id].should be_nil
     end
+
+    it 'should convert values for string fields' do
+      SchemaTools::Cleaner.clean_params!(:client, params)
+      params[:phone_mobile].should == '110'
+    end
   end
 end
 

data/spec/schema_tools/hash_spec.rb

@@ -1,12 +1,34 @@
 require 'spec_helper'
 
+################################################################################
+# classes used in tests their naming is important because the respecting
+# json schema is derived from it
+################################################################################
+class Client
+  attr_accessor :first_name, :id, :addresses,  :work_address
+end
+class Address
+  attr_accessor :city, :zip
+end
+
 class Contact
   attr_accessor :first_name, :last_name, :addresses, :id
 end
 
+# see fixtures/lead.json
+class Lead < Contact
+  attr_accessor :links_clicked, :conversion
+end
+
+class Conversion
+  attr_accessor :from, :to
+end
+
+
 describe SchemaTools::Hash do
 
-  context 'from_schema' do
+  context 'from_schema to hash conversion' do
+
     let(:contact){Contact.new}
     before :each do
       contact.first_name = 'Peter'
@@ -40,23 +62,38 @@ describe SchemaTools::Hash do
       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
+    it 'should exclude root' do
+      hash = SchemaTools::Hash.from_schema(contact, exclude_root: true)
+      hash['last_name'].should == 'Paul'
+      hash['_class_name'].should == 'contact'
     end
-    class Address
-      attr_accessor :city, :zip
+
+    it 'should have _links on object if exclude root' do
+      hash = SchemaTools::Hash.from_schema(contact, exclude_root: true, class_name: :client)
+      hash['_links'].length.should == 8
+    end
+
+    it 'should have _class_name on object if exclude root' do
+      hash = SchemaTools::Hash.from_schema(contact, exclude_root: true, class_name: :client)
+      hash['_class_name'].should == 'client'
     end
+  end
+
+  context 'with nested values referencing a schema' do
 
     let(:client){Client.new}
 
-    it 'should have empty nested array values' do
+    it 'should have an empty array if values are missing' do
       hash = SchemaTools::Hash.from_schema(client)
       hash['client']['addresses'].should == []
     end
 
+    it 'should have nil if nested object is missing' do
+      hash = SchemaTools::Hash.from_schema(client)
+      hash['client']['work_address'].should be_nil
+    end
+
     it 'should have nested array values' do
       a1 = Address.new
       a1.city = 'Cologne'
@@ -66,19 +103,37 @@ describe SchemaTools::Hash do
       hash['client']['addresses'].should == [{"address"=>{"city"=>"Cologne", "zip"=>50733}}]
     end
 
-  end
-
-
-  context 'with plain nested values' do
+    it 'should have nested array values without root' do
+      a1 = Address.new
+      a1.city = 'Cologne'
+      a1.zip = 50733
+      client.addresses = [a1]
+      hash = SchemaTools::Hash.from_schema(client, exclude_root: true)
+      hash['addresses'].should == [{"city"=>"Cologne", "zip"=>50733, "_class_name"=>"address"}]
+    end
 
-    class Lead < Contact
-      attr_accessor :links_clicked, :conversion
+    it 'should have nested object value' do
+      a1 = Address.new
+      a1.city = 'Cologne'
+      a1.zip = 50733
+      client.work_address = a1
+      hash = SchemaTools::Hash.from_schema(client)
+      hash['client']['work_address'].should == {"address"=>{"city"=>"Cologne", "zip"=>50733}}
     end
 
-    class Conversion
-      attr_accessor :from, :to
+    it 'should have nested object value without root' do
+      a1 = Address.new
+      a1.city = 'Cologne'
+      a1.zip = 50733
+      client.work_address = a1
+      hash = SchemaTools::Hash.from_schema(client, exclude_root: true)
+      hash['work_address'].should == {"city"=>"Cologne", "zip"=>50733, "_class_name"=>"address"}
     end
 
+  end
+
+  context 'with plain nested values' do
+
     let(:lead){Lead.new}
     before :each do
       lead.links_clicked = ['2012-12-12', '2012-12-15', '2012-12-16']

data/spec/schema_tools/klass_factory_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
 
 class TestNamespaceKlass
-  # namepsace for schema classes
+  # namespace for schema classes
 end
 
-module TestNamespaceModule
-
-end
+module TestNamespaceModule; end
 
 describe SchemaTools::KlassFactory do
 

data/spec/schema_tools/modules/as_schema_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+class ClassWithSchemaAttrs
+  include SchemaTools::Modules::Attributes
+  has_schema_attrs :client
+end
+
+class ClassWithSchemaName
+  include SchemaTools::Modules::AsSchema
+  schema_name :lead
+end
+
+# namespaced to not interfere with classes used in other tests
+module Test
+  class Address
+    include SchemaTools::Modules::AsSchema
+  end
+end
+
+
+describe SchemaTools::Modules::AsSchema do
+
+  describe 'included' do
+    subject { ClassWithSchemaAttrs.new }
+
+    it 'should add as_schema_hash method' do
+      subject.should respond_to(:as_schema_hash)
+    end
+
+    it 'should add as_schema_json method' do
+      subject.should respond_to(:as_schema_json)
+    end
+
+    it 'should return hash' do
+      subject.last_name = 'Hogan'
+      hsh = subject.as_schema_hash
+      hsh['client']['last_name'].should == 'Hogan'
+    end
+
+    it 'should return json' do
+      subject.last_name = 'Hogan'
+      json_str = subject.as_schema_json
+      hsh = ActiveSupport::JSON.decode(json_str)
+      hsh['client']['last_name'].should == 'Hogan'
+    end
+
+  end
+
+  describe 'schema name detection' do
+
+    it 'should use name from has_schema_attrs' do
+      ClassWithSchemaAttrs.new.as_schema_hash.keys.should include('client', 'links')
+    end
+
+    it 'should use schema_name defined in class' do
+      ClassWithSchemaName.new.as_schema_hash.keys.should include('lead')
+    end
+
+    it 'should use class name ' do
+      Test::Address.new.as_schema_hash.keys.should include('address')
+    end
+  end
+
+  describe 'schema options' do
+    subject { ClassWithSchemaAttrs.new }
+
+    it 'should override schema name from' do
+      subject.as_schema_hash(class_name:'contact').keys.should include('contact')
+    end
+
+    it 'should use fields' do
+      subject.as_schema_hash(fields:['id'])['client'].keys.should == ['id']
+    end
+
+    it 'should exclude root' do
+      subject.as_schema_hash(exclude_root: true).keys.should include('id')
+    end
+
+    it 'should use class name ' do
+      Test::Address.new.as_schema_hash.keys.should include('address')
+    end
+  end
+
+end
+

data/spec/schema_tools/modules/attributes_spec.rb

@@ -27,6 +27,10 @@ describe SchemaTools::Modules::Attributes do
       subject.should_not respond_to('id=')
       subject.should_not respond_to('created_at=')
     end
+
+    it 'should add schema_name to class' do
+      subject.class.schema_name.should == :client
+    end
   end
 
   context 'attributes from dynamic schema' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_tools
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -96,6 +96,7 @@ files:
 - lib/schema_tools/cleaner.rb
 - lib/schema_tools/hash.rb
 - lib/schema_tools/klass_factory.rb
+- lib/schema_tools/modules/as_schema.rb
 - lib/schema_tools/modules/attributes.rb
 - lib/schema_tools/modules/hash.rb
 - lib/schema_tools/modules/read.rb
@@ -110,6 +111,7 @@ files:
 - spec/schema_tools/cleaner_spec.rb
 - spec/schema_tools/hash_spec.rb
 - spec/schema_tools/klass_factory_spec.rb
+- spec/schema_tools/modules/as_schema_spec.rb
 - spec/schema_tools/modules/attributes_spec.rb
 - spec/schema_tools/reader_spec.rb
 - spec/spec_helper.rb
@@ -128,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2491825896483527088
+      hash: -1056530391654598731
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2491825896483527088
+      hash: -1056530391654598731
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24