sk_api_schema 0.2.2 → 0.2.3

data/README.rdoc

@@ -58,7 +58,7 @@ them to much right now.
 Before you run the tests use bundler to install all required gems:
   # git clone
   # cd into sk_api_schema dir
-  bundle install
-  bundle exec rake spec
+  BUNDLE_GEMFILE=ci/Gemfile bundle install
+  BUNDLE_GEMFILE=ci/Gemfile bundle exec rake spec
 
 Copyright (c) 2010-2011 Georg Leciejewski, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/ci/Gemfile

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

data/json/v1.0/address.json

@@ -1,6 +1,6 @@
 { "type":"object",
   "title": "address",
-  "description":"An address in SK must always be related to an object.",
+  "description":"An address in SK is maintained within it's parent object(client, company). The first address(default_address) is used inside the address field of new documents. With multiple addresses sorting(first) is done by date, newest first. So if you add a new adddress it will be the new default one. See order and type property for details about ordering and accessing parcel work or home addresses.",
   "properties": {
     "id": {
       "description": "uuid of the adress.",
@@ -50,10 +50,14 @@
       "type":"string"
     },   
     "address_type": {
-      "description": "Type of the address, as seen by vCard definition.",
-      "enum":["work","home"],
+      "description": "Type of the address, as seen by vCard definition. There can only be one type. Inside of SK you can use placeholders like client.parcel_address.city to access the first parcel adr(Same for work_ / home_). <br/>Besides the placeholder default_address, always returns the first address found. Sorting is done by the order(if set) else by date, newest first.",
+      "enum":["work","home", "parcel"],
       "type":"string"
     },
+    "order": {
+      "description": "Addresses are normally sorted by date, newest first. If you need to strongly rely on their sorting e.g. default_address (always first) or have multiple addresses of one type(3 parcel), use this field for all adrs. <br/>Single adrs are used in placeholders like: addresses.2.city, returning the second adr found(not necessarily one with order=2).",
+      "type":"integer"
+    },
     "lat": {
       "description": "Geolocation latitude",      
       "type":"string"

data/json/v1.0/document.json

@@ -13,7 +13,7 @@
       "type":"string"
     },
     "number":{
-      "description": "Unique number assigned by SK user or object number schema.",
+      "description": "Unique number assigned by a user or automatic by the object's number schema.",
       "type":"string"
     },
     "address_field":{
@@ -21,7 +21,7 @@
       "type":"string"
     },
     "date":{
-      "description": "Date the docuent is issued. Automatically set when document is opened. Required for non-draft documents.",
+      "description": "Date the document is issued. Automatically set when document is opened. Required for non-draft documents.",
       "format":"date",
       "type":"string"
     },

data/json/v1.0/sub.json

@@ -1,6 +1,6 @@
 {"type":"object",
   "title": "sub",
-  "description": "Subscribe to push notifications(webhooks) about object livecycle events like new, update or delete. Only returns subscription for the current app, so you MUST be using oAuth. When a user removes your app its subs are also deleted. <br/>To register you must supply <br/>- callback_url: receives the object in it's latest state, the user_id & subdomain, company_id, hmac-signed with your app secret.<br/>- channel: defining the event, made up of the SINGULAR object name and the action: invoice.delete, payment.new<br/> - register auth_permissions: An app MUST request non-api permissions f.ex.: clients:create. Perms(on company,app,user,team) are checked before any publishing, so if a user cannot create clients in the interface, his apps will not receive any callbacks.",
+  "description": "Subscribe to push notifications(webhooks) about object livecycle events like new, update or delete. Only returns subscription for the current app, so you MUST be using oAuth. When a user removes your app its subs are also deleted. <br/>To register you must supply <br/>- callback_url: receives a base64 encode string containing a JSON object with the object in it's latest state, the user_id & subdomain, company_id, hmac-signed with your app secret.<br/>- channel: defining the event, made up of the SINGULAR object name and the action: invoice.delete, payment.new<br/> - register auth_permissions: An app MUST request non-api permissions f.ex.: clients:create. Perms(on company,app,user,team) are checked before any publishing, so if a user cannot create clients in the interface, his apps will not receive any callbacks.",
   "properties": {
     "id": {
       "identity":true,
@@ -13,15 +13,9 @@
       "type":"string"
     },
     "callback_url": {
-      "description": "An url receiving the notification. The url MUST be within the url of the current app",
+      "description": "An url receiving the notification. The url MUST be within the url of the current app and receives a POST with a single signed_request parameter containing an base64 encoded JSON object.",
       "type":"string",
       "required":true
-    },   
-    "http_method": {
-      "description": "HTTP method used for the request, defaults to POST",
-      "type":"string",
-      "default":"POST",
-      "enum":["POST","GET", "DELETE", "PUT"]
     },
     "created_at": {
       "description": "Date the record was created in SK. Never changes afterwards.",

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-06-27}
+  s.date = %q{2011-07-21}
   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 smal lib with utility methods to load and test the schema files.}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "ci/Gemfile",
     "json/v1.0/address.json",
     "json/v1.0/attachment.json",
     "json/v1.0/auth_permission.json",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 +02:00
+date: 2011-07-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- ci/Gemfile
 - json/v1.0/address.json
 - json/v1.0/attachment.json
 - json/v1.0/auth_permission.json