sk_api_schema 0.10.6 → 0.11.0

data/json/v2.0/tag.json

@@ -1,25 +1,33 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "tag",
-  "name": "tag",
   "description":"A tag",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "name":{
       "description": "The tag itself",
-      "readonly":true,
+      "readOnly":true,
       "type":"string",
       "maxLength": 50
     },
     "taggings_count":{
       "description": "Usage count of this tag, for all objects in whole company scope.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     }
   },

data/json/v2.0/task.json

@@ -1,24 +1,32 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "task",
-  "name": "task",
-  "description":"An Task in SK.",
+  "description":"An Task",
+  "required" : ["name", "description"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "name":{
       "description": "The task title.",
-      "required":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 255
     },
     "description":{
       "description": "Notes, explanations for the task.",
-      "required":true,
       "type":"string"
     },
     "status":{
@@ -35,20 +43,27 @@
     },
     "contact":{
       "description": "The contact for the task. Use contact_id field to set a contact.",
-      "readonly":true,
+      "readOnly":true,
       "type":"object",
-      "properties":{"$ref":"./contact.json#properties"}
+      "$ref":"./contact.json#"
     },
     "documents":{
-      "description": "A tasks can have many related documents.",
+      "description": "A task can have many related documents.",
+      "readOnly":true,
       "type":"array",
-      "properties" : {"$ref":"./document.json#properties"}
+      "items": {
+        "type": "object",
+        "$ref" : "./document.json#"
+      }
     },
     "attachments":{
       "description": "Attached files, uploads.",
-      "readonly":true,
+      "readOnly":true,
       "type":"array",
-      "properties":{"$ref":"./attachment.json#properties"}
+      "items": {
+        "type": "object",
+        "$ref" : "./attachment.json#"
+      }
     },
     "assignee_id":{
       "description": "User who should do the tasks.",
@@ -65,19 +80,19 @@
     "closed_at":{
       "description": "Date the task was completed.",
       "format":"date",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited in SK.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     }
   },

data/json/v2.0/text_template.json

@@ -1,44 +1,50 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "text_template",
-  "name": "text_template",
-  "description":"An text_template in SK",
+  "description":"A text snippet template to be used in documents and emails",
+  "required" : ["name", "text", "kind"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "name":{
       "description": "A meaningful name.",
-      "required":true,
       "type":"string",
       "maxLength": 50
     },
     "text":{
       "description": "Text which may contain placeholders, replaced when the template is used.",
-      "required":true,
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "kind":{
       "description": "Kind of object the template can be used for. If empty the snippet can be used global. In this case watch not all placeholders are available: a client has different fields than an invoice.",
-      "required":true,
       "enum": ["","invoice", "estimate", "credit_note", "payment_reminder", "order", "contact", "email"],
       "type":"string"
     },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited in SK.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "team_id":{

data/json/v2.0/user.json

@@ -1,12 +1,14 @@
-{"type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "user",
-  "name": "user",
-  "description": "A user as seen by SalesKing",
+  "description": "A SalesKing user",
+  "required" : ["email", "language"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -38,7 +40,6 @@
     },
     "language":{
       "description": "The users language, reflected in the interface.",
-      "required":true,
       "type":"string",
       "maxLength": 10
     },
@@ -48,7 +49,6 @@
     },
     "email":{
       "description": "Email address of the user. Unique in SK",
-      "required":true,
       "type":"string",
       "maxLength": 100
     },
@@ -84,13 +84,13 @@
     "created_at":{
       "description": "Date the record was created in SK. Never changes afterwards.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Last date when the record was edited.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     }
   },

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.10.6'
+      VERSION='0.11.0'
     end
   end
 end

data/sk_api_schema.gemspec

@@ -19,9 +19,9 @@ Besides ruby users can use a small lib with utility methods to load and test the
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'activesupport'
-  s.add_development_dependency 'rdoc'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'json_schema_validator'
   s.add_development_dependency 'rake', '>= 0.9.2'
 
 end

data/spec/sk_api_schema_spec.rb

@@ -7,44 +7,51 @@ describe SK::Api::Schema do
       SK::Api::Schema.registry_reset
     end
 
-    it "should provide schema path" do
-      File.exists?(SK::Api::Schema.path).should be
+    it "provides schema path" do
+      expect(File.exists?(SK::Api::Schema.path)).to be true
     end
 
-    it "should read json schema file" do
+    it "reads 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 == true
+      expect(schema[:title]).to eq 'invoice'
+      expect(schema[:type]).to eq 'object'
+      expect(schema['properties']).to be_a Hash
+      expect(schema['properties']['id']['identity']).to be true
     end
 
-    it "should read json schema file with simple version" do
+    it "reads 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 == true
+      expect(schema[:title]).to eq 'invoice'
+      expect(schema[:type]).to eq 'object'
+      expect(schema['properties']).to be_a Hash
+      expect(schema['properties']['id']['identity']).to be true
     end
 
-    it "should read all json schemas" do
+    it "reads 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
+      expect(schemas.length).to eq Dir.glob( file_path ).length
+    end
+
+    it "reads v2 json schemas" do
+      schemas = SK::Api::Schema.read_all('2.0')
+
+      file_path = File.join(File.dirname(__FILE__), '../json', 'v2.0', '*.json')
+      expect(schemas.length).to eq Dir.glob( file_path ).length
     end
 
     it "should raise error if version folder does not exist" do
-      lambda{
+      expect{
         SK::Api::Schema.read(:invoice, 'v3.0')
-      }.should raise_error
+      }.to raise_error(Errno::ENOENT)
     end
 
     it "should raise error if schema file does not exist" do
-      lambda{
+      expect{
         SK::Api::Schema.read(:nope, 'v1.0')
-      }.should raise_error
+      }.to raise_error(Errno::ENOENT)
     end
 
     it "should add schema to registry" do
@@ -52,7 +59,6 @@ describe SK::Api::Schema do
       File.should_not_receive(:open)
       SK::Api::Schema.read(:credit_note, 'v1.0')
     end
-
   end
 
   context 'object parsing' do
@@ -144,6 +150,16 @@ describe SK::Api::Schema do
     end
 
   end
+
+  context 'validate v2 schemata' do
+    it 'should validate all' do
+      schema_path = File.join(SK::Api::Schema.path, 'v2.0')
+      errors = JsonSchemaValidator.validate_schemas(schema_path)
+      errors.each do |name, error|
+        expect(error).to be_empty
+      end
+    end
+  end
 end
 
 ################################################################################

data/spec/spec_helper.rb

@@ -11,8 +11,7 @@ SimpleCov.coverage_dir 'coverage'
 require 'rubygems'
 require 'rspec'
 require 'sk_api_schema'
-
-
+require 'json_schema_validator'
 
 RSpec.configure do |config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sk_api_schema
 version: !ruby/object:Gem::Version
-  version: 0.10.6
+  version: 0.11.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: json_schema_validator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -128,13 +128,13 @@ files:
 - json/v1.0/task.json
 - json/v1.0/text_template.json
 - json/v1.0/user.json
+- json/v2.0/README.md
 - json/v2.0/account.json
 - json/v2.0/account_billing.json
 - json/v2.0/account_entry.json
 - json/v2.0/address.json
 - json/v2.0/attachment.json
 - json/v2.0/auth_permission.json
-- json/v2.0/client.json
 - json/v2.0/comment.json
 - json/v2.0/company.json
 - json/v2.0/contact.json
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: SalesKing API - JSON Schema

data/json/v2.0/client.json

@@ -1,318 +0,0 @@
-{"type":"object",
-  "title": "client",
-  "name": "client",
-  "description": "A client as seen by SalesKing. This resource is DEPRECATED please use contacts instead with type-field set 'Client'",
-  "properties":{
-    "id":{
-      "description":"Unique identifier - UUID",
-      "identity":true,
-      "readonly":true,
-      "type":"string",
-      "maxLength": 22,
-      "minLength":22
-    },
-    "number":{
-      "description": "Unique number, auto-created by SK for new client without number.",
-      "type":"string",
-      "maxLength": 50
-    },
-    "organisation":{
-      "description": "Name of a company. This or lastname must be present",
-      "required" : true,
-      "type":"string",
-      "maxLength": 100
-    },
-    "last_name":{
-      "description": "Last name of a person. At least this or the organisation field must be filled for new records",
-      "type":"string",
-      "maxLength": 50
-    },
-    "first_name":{
-      "description": "First name of a person.",
-      "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":{
-      "description": "The birthday. YYYY-MM-DD",
-      "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",
-      "readonly":true,
-      "type":"string"
-    },
-    "updated_at":{
-      "description": "Last date when the record was edited.",
-      "format":"date-time",
-      "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.",
-      "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
-    }
-  },
-  "links":[
-    { "rel": "self",
-      "href": "clients/{id}"
-    },
-    { "rel": "instances",
-      "href": "clients",
-      "properties" : {
-        "page":{
-          "title" : "Page",
-          "description": "In paginated results set the page to look for",
-          "type":"number"
-        },
-        "per_page":{
-          "title" : "Per page",
-          "description": "Results per page. Default is 50, max is 200",
-          "type":"number"
-        },
-        "filter[q]":{
-          "title" : "Search",
-          "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 on/after the date(>=). ISO 8601 format YYY-MM-DDThh:mm:ss+z or just a date YYY-MM-DD. If date is given the time is set to the start of the day(00:00:00) so all objects created on this day are included. A time should be already utc time",
-          "format" : "date-time",
-          "type" : "string"
-        },
-        "filter[created_at_to]":{
-          "title" : "To date",
-          "description": "Objects with a creation until the date(<=). ISO 8601 format YYY-MM-DDThh:mm:ss+z or just a date YYY-MM-DD. If date is given the time is set to the end of the day(23:59:59) so all objects created on that day are included. A time should be already utc time.",
-          "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. YYYY-MM-DD",
-          "format" : "date",
-          "type" : "string"
-        },
-        "filter[birthday_to]":{
-          "title" : "To birthday date",
-          "description": "Contacts with a birthday date before and on the date. YYYY-MM-DD",
-          "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",
-          "enum":["organisation", "number","email","first_name","last_name", "created_at", "updated_at"],
-          "type": "string"
-        },
-        "sort":{
-          "title" : "Sort",
-          "enum":["ASC","DESC"],
-          "description": "Sort the results in ASC or DESC"
-        }
-      }
-    },
-    { "rel": "destroy",
-      "href": "clients/{id}",
-      "method": "DELETE"
-    },
-    { "rel": "update",
-      "href": "clients/{id}",
-      "method": "PUT"
-    },
-    { "rel": "create",
-      "href": "clients",
-      "method": "POST"
-    },
-    { "rel": "documents",
-      "href": "clients/{id}/documents"
-    },
-    { "rel": "attachments",
-      "href": "clients/{id}/attachments"
-    },
-    { "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"
-    }
-  ]
-}