sk_api_schema 0.3.2 → 0.3.3

data/.gitignore

@@ -0,0 +1,4 @@
+coverage/*
+rdoc/*
+pkg/*
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+gemfile:
+  - Gemfile

data/CHANGELOG.rdoc

@@ -2,6 +2,16 @@
 
 A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
 
+2012-06
+* add due_date and due_days to order
+* test with travis-ci.org
+
+2012-05
+* fix date type definitions
+* add empty links sections for address, line_item
+* add payment_method to order
+* deprecate gross_total for payment reminder
+
 2012-01
 * add notes field for client
 

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.rdoc

@@ -1,12 +1,11 @@
 = SalesKing API Schema
 
-Our API is described with JSON Schema's (http://json-schema.org). A schema
-describes a resource(object) in a readable JSON format:
+Our API is described with JSON Schema's (http://json-schema.org), describing our objects(resources) in a readable JSON format:
 
-  { 
+  {
     "title": "client",
     "properties": { ...},
-    "links": [ .. ]    
+    "links": [ .. ]
   }
 The properties-section defines the fields. CRUD actions and
 relationships with other resources are found in the link-section.
@@ -38,8 +37,8 @@ The schema main version(NOT the gem version) can be set with the "v" url paramet
 in any call, but is pretty useless as long as we are in v1.0
   my.salesking.eu/api/clients?v='1.0'
 
-The gem has its own version number. A new gem version indicates a change, but 
-we first try it on our staging environment before any live instances are 
+The gem has its own version number. A new gem version indicates a change, but
+we first try it on our staging environment before any live instances are
 updated and the schema becomes public available. The gem is used by SalesKing
 to deliver it's data BUT changes might not be directly reflected as stated.
 To see the current gem version use:
@@ -57,7 +56,7 @@ parameter:
 
 Please try to only request the fields you really need, to save computing power!
 
-== Object Structure Basic's
+== Object Basic's
 
 Primary object types in SK are:
 * Documents
@@ -76,7 +75,7 @@ The third kind are supportive objects
 * Exports
 * Templates
 
-== Enpoints & Links
+== Endpoints & Links
 
 Following list gives you a quick overview of relations with nested urls an how
 parameters work. You can find those in detail when looking at the link section
@@ -100,22 +99,24 @@ of each schema.
     # all invoices of a client
     /clients/:id/invoices
 
-
-== ToDo:
-
-Those relative urls in the link sections, need some love, so please don't rely on
-them to much right now.
-
 == Install
 
     gem install sk_api_schema
 
 == Test
 
-Before you run the tests use bundler to install all required gems:
+{<img src="https://secure.travis-ci.org/salesking/sk_api_schema.png?branch=master" alt="Build Status" />}[http://travis-ci.org/salesking/sk_api_schema]
+
+Install required gems with bundler and go for it:
   # git clone
   # cd into sk_api_schema dir
-  BUNDLE_GEMFILE=ci/Gemfile bundle install
-  BUNDLE_GEMFILE=ci/Gemfile bundle exec rake spec
+  bundle install
+  rake spec
+
+
+== ToDo:
+
+Those relative urls in the link sections, need some love, so please don't rely on
+them to much right now.
 
-Copyright (c) 2010-2011 Georg Leciejewski, released under the MIT license
+Copyright (c) 2010-2012 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -1,42 +1,13 @@
-require 'rubygems'
 require 'rake'
-require 'rdoc/task'
 require 'rspec'
 require 'rspec/core/rake_task'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "sk_api_schema"
-    gem.summary = %Q{SalesKing API JSON Schema}
-    gem.description = %Q{The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files.}
-    gem.email = "gl@salesking.eu"
-    gem.homepage = "http://github.com/salesking/sk_api_schema"
-    gem.authors = ["Georg Leciejewski"]
-    gem.add_dependency 'activesupport'
-    gem.add_development_dependency "rspec"
-    gem.add_development_dependency "rcov"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-desc 'Default: run specs.'
-task :default => :spec
+require 'rdoc/task'
+require 'bundler/gem_helper'
+Bundler::GemHelper.install_tasks
 
 desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  # Put spec opts in a file named .rspec in root
-end
-
-desc "Generate code coverage"
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
+RSpec::Core::RakeTask.new
+task :default => :spec
 
 desc 'Generate documentation.'
 Rake::RDocTask.new(:rdoc) do |rdoc|

data/json/v1.0/credit_note.json

@@ -104,11 +104,11 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented by SK to prevent concurrent updateing. First save wins.",
+      "description": "Auto-incremented to prevent concurrent updates. First save wins.",
       "type":"integer"
     },
     "price_total":{
-      "description": "Deprecated use net_total_base_raw",
+      "description": "Deprecated use net_total_base",
       "readonly":true,
       "type":"number"
     },
@@ -133,7 +133,7 @@
       "type":"number"
     },
     "net_total_base":{
-      "description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
+      "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
     }

data/json/v1.0/document.json

@@ -87,12 +87,7 @@
       "type":"number"
     },
     "net_total_base":{
-      "description": "Net total, decimals places as set in precision, default 2",
-      "readonly":true,
-      "type":"number"
-    },
-    "net_total_base_raw":{
-      "description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
+      "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
     }

data/json/v1.0/estimate.json

@@ -99,7 +99,7 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version.",
+      "description": "Auto-incremented to prevent concurrent updates. First save wins and increments version.",
       "type":"integer"
     },
     "gross_total":{
@@ -118,12 +118,7 @@
       "type":"number"
     },
     "net_total_base":{
-      "description": "Net total, decimals places as set in precision, default 2",
-      "readonly":true,
-      "type":"number"
-    },
-    "net_total_base_raw":{
-      "description": "Net total unrounded, 6 decimal places. Summed items net_total_base_raw (incl discount)",
+      "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
     }
@@ -231,7 +226,8 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source document(excl. number,date) and returns a new draft document."
+          "description": "Copies the source document(excl. number,date) and returns a new draft document.",
+          "type" : "string"
         }
       }
     },

data/json/v1.0/invoice.json

@@ -22,11 +22,11 @@
       "type":"string"
     },
     "due_days":{
-      "description": "Used to calculate the due date of the invoice. Useless if date and due date are present.",
+      "description": "Used to calculate the due date of the document. Useless if date and due date are present.",
       "type":"integer"
     },
     "due_date":{
-      "description": "Auto-calculated from date + due days if empty and the invoice is opened.",
+      "description": "Auto-calculated from date + due days if empty and the document is opened.",
       "format":"date",
       "type":"string"
     },
@@ -104,7 +104,7 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
+      "description": "Auto-incremented to prevent concurrent updates. First save wins and increments version. ",
       "type":"integer"
     },
     "price_total":{
@@ -133,7 +133,7 @@
       "type":"number"
     },
     "net_total_base":{
-      "description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
+      "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
     }
@@ -229,12 +229,14 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source document(excl. number,date) and returns a new draft document. If the source is an Estimate or Order only line_items, client & tags are copied, so you can pass in additional fields."
+          "description": "Copies the source document(excl. number,date) and returns a new draft document. If the source is an Estimate or Order only line_items, client & tags are copied, so you can pass in additional fields.",
+          "type" : "string"
         },
         "cancel" : {
           "title" : "Cancel an invoice",
-          "description": "Cancelling a document negates its line item values. A source id must be set.",
-          "dependencies": ["source"]
+          "description": "Cancelling a document copies the source and negates its line item values. A source id must be set.",
+          "dependencies": ["source"],
+          "type":"boolean"
         }
       }
     },

data/json/v1.0/order.json

@@ -21,6 +21,15 @@
       "format":"date",
       "type":"string"
     },
+    "due_days":{
+      "description": "Used to calculate the due date for the document. Useless if date and due date are present.",
+      "type":"integer"
+    },
+    "due_date":{
+      "description": "Auto-calculated from date + due days if empty and the document is opened.",
+      "format":"date",
+      "type":"string"
+    },
     "status":{
       "description": "Defaults to draft for new documents, unless otherwise stated. For new documents with status 'open' or 'closed' or doc where the status changes away from draft, following fields are set if empty: number(next in number schema), date(today), due date(due_days must be given). Only draft documents can be deleted.",
       "default":"draft",
@@ -95,7 +104,7 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version.",
+      "description": "Auto-incremented to prevent concurrent updates. First save wins and increments version.",
       "type":"integer"
     },
     "gross_total":{
@@ -114,7 +123,7 @@
       "type":"number"
     },
     "net_total_base":{
-      "description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
+      "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
     }
@@ -222,7 +231,8 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source document(excl. number,date) and returns a new draft document."
+          "description": "Copies the source document(excl. number,date) and returns a new draft document.",
+          "type" : "string"
         }
       }
     },

data/json/v1.0/payment_reminder.json

@@ -95,7 +95,7 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
+      "description": "Auto-incremented to prevent concurrent updates. First save wins and increments version. ",
       "type":"integer"
     },
     "gross_total":{

data/json/v1.0/recurring.json

@@ -101,7 +101,7 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
+      "description": "Auto-incremented to prevent concurrent updates. First save wins and increments version. ",
       "type":"integer"
     },
     "gross_total":{
@@ -120,7 +120,7 @@
       "type":"number"
     },
     "net_total_base":{
-      "description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
+      "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
     }
@@ -223,12 +223,8 @@
       "properties" : {
         "source" : {
           "title" : "Source document id",
-          "description": "Copies the source document(excl. number,date) and returns a new draft document."
-        },
-        "cancel" : {
-          "title" : "Cancel an recurring",
-          "description": "Cancelling a document negates its line item values. A source id must be set.",
-          "dependencies": ["source"]
+          "description": "Copies the source document(excl. number,date) and returns a new draft document.",
+          "type" : "string"
         }
       }
     },

data/lib/sk_api_schema/version.rb

@@ -0,0 +1,7 @@
+module SK
+  module Api
+    class Schema
+      VERSION='0.3.3'
+    end
+  end
+end

data/lib/sk_api_schema.rb

@@ -2,6 +2,7 @@
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/string/inflections'
+
 module SK
   module Api
     class Schema

data/sk_api_schema.gemspec

@@ -1,77 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sk_api_schema/version'
 
 Gem::Specification.new do |s|
-  s.name = "sk_api_schema"
-  s.version = "0.3.2"
+  s.version = SK::Api::Schema::VERSION
+  s.date = %q{2012-06-02}
+  s.name = %q{sk_api_schema}
+  s.summary = "SalesKing API - JSON Schema"
+  s.description = %q{The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects.
+Besides ruby users can use a small lib with utility methods to load and test the schema files.}
+  s.authors = ["Georg Leciejewski"]
+  s.email = %q{gl@salesking.eu}
+  s.homepage = %q{http://github.com/salesking/sk_api_schema}
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.executables   = nil
+  s.files         = `git ls-files`.split("\n").reject{|i| i[/^docs\//] }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Georg Leciejewski"]
-  s.date = "2012-06-02"
-  s.description = "The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files."
-  s.email = "gl@salesking.eu"
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    "CHANGELOG.rdoc",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "ci/Gemfile",
-    "json/v1.0/address.json",
-    "json/v1.0/attachment.json",
-    "json/v1.0/auth_permission.json",
-    "json/v1.0/client.json",
-    "json/v1.0/comment.json",
-    "json/v1.0/company.json",
-    "json/v1.0/credit_note.json",
-    "json/v1.0/document.json",
-    "json/v1.0/email.json",
-    "json/v1.0/email_template.json",
-    "json/v1.0/estimate.json",
-    "json/v1.0/export.json",
-    "json/v1.0/export_template.json",
-    "json/v1.0/invoice.json",
-    "json/v1.0/language.json",
-    "json/v1.0/line_item.json",
-    "json/v1.0/order.json",
-    "json/v1.0/payment.json",
-    "json/v1.0/payment_reminder.json",
-    "json/v1.0/product.json",
-    "json/v1.0/recurring.json",
-    "json/v1.0/sub.json",
-    "json/v1.0/tag.json",
-    "json/v1.0/text_template.json",
-    "json/v1.0/user.json",
-    "lib/sk_api_schema.rb",
-    "sk_api_schema.gemspec",
-    "spec/sk_api_schema_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/salesking/sk_api_schema"
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
-  s.summary = "SalesKing API JSON Schema"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end
+  s.add_runtime_dependency 'activesupport'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rake', '>= 0.9.2'
 
+end

data/spec/sk_api_schema_spec.rb

@@ -1,142 +1,144 @@
 require 'spec_helper'
 
-describe SK::Api::Schema, 'reading' do
+describe SK::Api::Schema do
+  context 'reading' do
+
+    before :each do
+      SK::Api::Schema.registry_reset
+    end
+
+    it "should read json schema file" do
+      schema = SK::Api::Schema.read(:invoice, 'v1.0')
+      schema[:title].should == 'invoice'
+      schema[:type].should == 'object'
+      schema['properties'].should be_a Hash
+      schema['properties']['id']['identity'].should be_true
+    end
+
+    it "should read json schema file with simple version" do
+      schema = SK::Api::Schema.read(:invoice, '1.0')
+      schema[:title].should == 'invoice'
+      schema[:type].should == 'object'
+      schema['properties'].should be_a Hash
+      schema['properties']['id']['identity'].should be_true
+    end
+
+    it "should read all json schemas" do
+      schemas = SK::Api::Schema.read_all('1.0')
+
+      file_path = File.join(File.dirname(__FILE__), '../json', 'v1.0', '*.json')
+      # just check file count
+      schemas.length.should == Dir.glob( file_path ).length
+    end
+
+    it "should raise error if version folder does not exist" do
+      lambda{
+        SK::Api::Schema.read(:invoice, 'v3.0')
+      }.should raise_error
+    end
+
+    it "should raise error if schema file does not exist" do
+      lambda{
+        SK::Api::Schema.read(:nope, 'v1.0')
+      }.should raise_error
+    end
+
+    it "should add schema to registry" do
+      SK::Api::Schema.read(:credit_note, 'v1.0')
+      File.should_not_receive(:open)
+      SK::Api::Schema.read(:credit_note, 'v1.0')
+    end
 
-  before :each do
-    SK::Api::Schema.registry_reset
   end
 
-  it "should read json schema file" do
-    schema = SK::Api::Schema.read(:invoice, 'v1.0')
-    schema[:title].should == 'invoice'
-    schema[:type].should == 'object'
-    schema['properties'].should be_a Hash
-    schema['properties']['id']['identity'].should be_true
+  context 'object parsing' do
+
+    before :each do
+      @invoice =  Invoice.new
+      @invoice.id = 'some-uuid'
+      @invoice.title = 'Your Invoice'
+      @invoice.number = '911'
+
+      @client =  Client.new
+      @client.id = 'some-uuid'
+      @client.organisation = 'Dirty Food Inc.'
+      @client.number = '911'
+
+      @item =  LineItem.new
+      @item.id = 'some-uuid'
+      @item.name = 'Pork Chops'
+      @item.description = 'Yummi Pork chopped by mexian emigrants'
+      @item.position = 1
+      @item.price_single = 0.99
+    end
+
+    it "should parse object with empty relations from schema" do
+      obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
+      #   {"invoice"=>{"number"=>"911", "line_items"=>[], "archived_pdf"=>nil, "title"=>"Your Invoice", "date"=>nil, "id"=>"some-uuid", "client"=>nil, "due_date"=>nil}}
+      obj_hash.keys.sort.should == ["invoice", "links"]
+      obj_hash['invoice'].should include( "number"=>"911","line_items"=>[],"archived_pdf"=>nil,"id"=>"some-uuid", "title"=>"Your Invoice" )
+      client_obj_hash = SK::Api::Schema.to_hash_from_schema(@client, 'v1.0')
+      client_obj_hash.keys.sort.should == ["client", "links"]
+      client_obj_hash['client'].should include("number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil)
+    end
+
+    it "should parse object with relations from schema" do
+      @invoice.line_items = [@item]
+      @invoice.client = @client
+      obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
+      obj_hash["invoice"]['client']['client'].should == {"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}
+      obj_hash["invoice"]["client"]['links'].should_not be_nil
+      obj_hash["invoice"]["line_items"].should == [ {"line_item"=>{"name"=>"Pork Chops", "position"=>1, \
+                                         "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}]
+    end
+
+    it "should parse object given fields" do
+      @invoice.line_items = [@item]
+      @invoice.client = @client
+      fields = %w(id title client)
+      obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0', :fields=>fields)
+      obj_hash["invoice"]['client']['client'].should == {"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}
+      obj_hash["invoice"]["client"]['links'].should_not be_nil
+      obj_hash["invoice"].keys.sort.should == fields.sort
+    end
+
+    it "should use different class name as object hash key" do
+      @invoice.line_items = [@item]
+      @invoice.client = @client
+      obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0', :class_name=>:document)
+      schema = SK::Api::Schema.read(:document, 'v1.0')
+      # check included fields, which should not be all fields from schema since our dummy invoice object does not responds_to all
+      intersect_keys = schema['properties'].keys & obj_hash["document"].keys
+      intersect_keys.sort.should == obj_hash["document"].keys.sort
+    end
   end
 
-  it "should read json schema file with simple version" do
-    schema = SK::Api::Schema.read(:invoice, '1.0')
-    schema[:title].should == 'invoice'
-    schema[:type].should == 'object'
-    schema['properties'].should be_a Hash
-    schema['properties']['id']['identity'].should be_true
-  end
-
-  it "should read all json schemas" do
-    schemas = SK::Api::Schema.read_all('1.0')
-
-    file_path = File.join(File.dirname(__FILE__), '../json', 'v1.0', '*.json')
-    # just check file count
-    schemas.length.should == Dir.glob( file_path ).length
-  end
-
-  it "should raise error if version folder does not exist" do
-    lambda{
-      SK::Api::Schema.read(:invoice, 'v3.0')
-    }.should raise_error
-  end
-
-  it "should raise error if schema file does not exist" do
-    lambda{
-      SK::Api::Schema.read(:nope, 'v1.0')
-    }.should raise_error
-  end
-
-  it "should add schema to registry" do
-    SK::Api::Schema.read(:credit_note, 'v1.0')
-    File.should_not_receive(:open)
-    SK::Api::Schema.read(:credit_note, 'v1.0')
-  end
-
-end
-
-describe SK::Api::Schema, 'object parsing' do
-
-  before :each do
-    @invoice =  Invoice.new
-    @invoice.id = 'some-uuid'
-    @invoice.title = 'Your Invoice'
-    @invoice.number = '911'
-
-    @client =  Client.new
-    @client.id = 'some-uuid'
-    @client.organisation = 'Dirty Food Inc.'
-    @client.number = '911'
-
-    @item =  LineItem.new
-    @item.id = 'some-uuid'
-    @item.name = 'Pork Chops'
-    @item.description = 'Yummi Pork chopped by mexian emigrants'
-    @item.position = 1
-    @item.price_single = 0.99
-  end
+  context 'hash cleaning' do
 
-  it "should parse object with empty relations from schema" do
-    obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
-    #   {"invoice"=>{"number"=>"911", "line_items"=>[], "archived_pdf"=>nil, "title"=>"Your Invoice", "date"=>nil, "id"=>"some-uuid", "client"=>nil, "due_date"=>nil}}
-    obj_hash.keys.sort.should == ["invoice", "links"]
-    obj_hash['invoice'].should include( "number"=>"911","line_items"=>[],"archived_pdf"=>nil,"id"=>"some-uuid", "title"=>"Your Invoice" )
-    client_obj_hash = SK::Api::Schema.to_hash_from_schema(@client, 'v1.0')
-    client_obj_hash.keys.sort.should == ["client", "links"]
-    client_obj_hash['client'].should include("number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil)
-  end
+    it "should kick readonly properties" do
+      props = {'id'=>'some id', 'archived_pdf'=>'some val', 'number'=>'1234' }
+      SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0')
+      props.keys.should == ['number']
 
-  it "should parse object with relations from schema" do
-    @invoice.line_items = [@item]
-    @invoice.client = @client
-    obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
-    obj_hash["invoice"]['client']['client'].should == {"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}
-    obj_hash["invoice"]["client"]['links'].should_not be_nil
-    obj_hash["invoice"]["line_items"].should == [ {"line_item"=>{"name"=>"Pork Chops", "position"=>1, \
-                                       "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}]
-  end
+      props1 = {:id =>'some id', :archived_pdf =>'some val', :number =>'1234' }
+      SK::Api::Schema.clean_hash!(:invoice, props1, 'v1.0')
+      props1.keys.should == [:number]
+    end
 
-  it "should parse object given fields" do
-    @invoice.line_items = [@item]
-    @invoice.client = @client
-    fields = %w(id title client)
-    obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0', :fields=>fields)
-    obj_hash["invoice"]['client']['client'].should == {"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}
-    obj_hash["invoice"]["client"]['links'].should_not be_nil
-    obj_hash["invoice"].keys.sort.should == fields.sort
-  end
-
-  it "should use different class name as object hash key" do
-    @invoice.line_items = [@item]
-    @invoice.client = @client
-    obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0', :class_name=>:document)
-    schema = SK::Api::Schema.read(:document, 'v1.0')
-    # check included fields, which should not be all fields from schema since our dummy invoice object does not responds_to all
-    intersect_keys = schema['properties'].keys & obj_hash["document"].keys
-    intersect_keys.sort.should == obj_hash["document"].keys.sort
-  end
-end
+    it "should convert string properties" do
+      props = {'title'=>4711, 'number'=>1234 }
+      SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0')
+      props['title'].should == "4711"
+      props['number'].should == "1234"
+    end
 
-describe SK::Api::Schema, 'hash cleaning' do
+    it "should keep some properties" do
+      props = {'id'=>'some id', 'number'=>1234 }
+      SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0', :keep=>['id'])
+      props['id'].should == "some id"
+    end
 
-  it "should kick readonly properties" do
-    props = {'id'=>'some id', 'archived_pdf'=>'some val', 'number'=>'1234' }
-    SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0')
-    props.keys.should == ['number']
-
-    props1 = {:id =>'some id', :archived_pdf =>'some val', :number =>'1234' }
-    SK::Api::Schema.clean_hash!(:invoice, props1, 'v1.0')
-    props1.keys.should == [:number]
-  end
-
-  it "should convert string properties" do
-    props = {'title'=>4711, 'number'=>1234 }
-    SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0')
-    props['title'].should == "4711"
-    props['number'].should == "1234"
   end
-
-  it "should keep some properties" do
-    props = {'id'=>'some id', 'number'=>1234 }
-    SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0', :keep=>['id'])
-    props['id'].should == "some id"
-  end
-
 end
 
 ################################################################################

data/spec/spec_helper.rb

@@ -1,4 +1,18 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/json/"
+end
+SimpleCov.coverage_dir 'coverage'
+
 require 'rubygems'
 require 'rspec'
-require "#{File.dirname(__FILE__)}/../lib/sk_api_schema"
-#require File.dirname(__FILE__) + '/../vendor/jsonschema-1.0.0/lib/jsonschema'
+require "sk_api_schema"
+
+
+
+RSpec.configure do |config|
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -18,6 +18,7 @@ cert_chain: []
 date: 2012-06-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -27,11 +28,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id001
   prerelease: false
   name: activesupport
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -41,11 +42,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
-  name: rspec
-  type: :development
   version_requirements: *id002
+  prerelease: false
+  name: rdoc
 - !ruby/object:Gem::Dependency 
+  type: :development
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -55,11 +56,42 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  version_requirements: *id003
   prerelease: false
-  name: rcov
+  name: rspec
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id003
-description: The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files.
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  prerelease: false
+  name: simplecov
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  version_requirements: *id005
+  prerelease: false
+  name: rake
+description: |-
+  The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects.
+  Besides ruby users can use a small lib with utility methods to load and test the schema files.
 email: gl@salesking.eu
 executables: []
 
@@ -68,11 +100,12 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
+- .travis.yml
 - CHANGELOG.rdoc
+- Gemfile
 - README.rdoc
 - Rakefile
-- VERSION
-- ci/Gemfile
 - json/v1.0/address.json
 - json/v1.0/attachment.json
 - json/v1.0/auth_permission.json
@@ -99,6 +132,7 @@ files:
 - json/v1.0/text_template.json
 - json/v1.0/user.json
 - lib/sk_api_schema.rb
+- lib/sk_api_schema/version.rb
 - sk_api_schema.gemspec
 - spec/sk_api_schema_spec.rb
 - spec/spec_helper.rb
@@ -134,6 +168,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: SalesKing API JSON Schema
+summary: SalesKing API - JSON Schema
 test_files: []
 

data/VERSION

@@ -1 +0,0 @@
-0.3.2

data/ci/Gemfile

@@ -1,8 +0,0 @@
-source :gemcutter
-gem "rake"
-gem "rdoc"
-gem "rcov"
-gem "active_support"
-group :test do
-  gem "rspec"
-end