RubyGems - sk_api_schema - Versions diffs - 0.0.4 → 0.0.5 - Mend

sk_api_schema 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

data/VERSION +1 -1
data/json/v1.0/credit_note.json +31 -2
data/json/v1.0/estimate.json +204 -0
data/json/v1.0/invoice.json +64 -25
data/json/v1.0/order.json +194 -0
data/json/v1.0/payment_reminder.json +179 -0
data/lib/sk_api_schema.rb +91 -53
data/sk_api_schema.gemspec +23 -22
data/spec/sk_api_schema_spec.rb +26 -4
metadata +10 -8
data/.gitignore +0 -4

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.4
1	+ 0.0.5

data/json/v1.0/credit_note.json CHANGED Viewed

@@ -67,6 +67,10 @@
       "description": "The clients uuid, must be set for a new document. New documents take the clients address field, due days and cash discount if those fields are not set.",
       "type":"string"
     },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
     "line_items":{
       "description": "Line items for the document",
       "type":"array",
@@ -89,12 +93,37 @@
       "type":"integer"
     },
     "price_total":{
-      "description": "Net total sum of all line items, 6 decimals places",
+      "description": "Deprecated use net_total_base_raw",
       "readonly":true,
       "type":"number"
     },
     "price_tax":{
-      "description": "Summed up tax total of all line items, 2 decimals places",
+      "description": "Deprecated: use tax_total",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total":{
+      "description": "Gross total of all line items, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "tax_total":{
+      "description": "Tax total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total":{
+      "description": "Net total, 2 decimals places",
+      "readonly":true,
+      "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)",
       "readonly":true,
       "type":"number"
     }

data/json/v1.0/estimate.json ADDED Viewed

@@ -0,0 +1,204 @@
+{ "type":"object",
+  "title": "estimate",
+  "description": "An estimate",
+  "properties":{
+    "id":{
+      "description": "UUID assigned by SK",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "number":{
+      "description": "Unique number assigned by SK estimate number schema. Auto-assigned when estimate is opened. Required unless doc status is draft.",
+      "type":"string"
+    },
+    "address_field":{
+      "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id present.",
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the estimate is issued. Automatically set when estimate is opened. Required for non-draft documents.",
+      "format":"date",
+      "type":"string"
+    },
+    "due_days":{
+      "description": "Used to calculate the valid-until date of the estimate. Useless if date and due date are present.",
+      "type":"integer"
+    },
+    "due_date":{
+      "description": "Auto-calculated from date + due days if empty and the estimate is opened.",
+      "format":"date",
+      "type":"string"
+    },
+    "status":{
+      "description": "Defaults to draft for new documents, if empty. For new documents with status 'open', the following fields are set if empty: number(next in number schema), date(today), due date(today unless due_days given). Only drafts can be deleted.",
+      "default":"draft",
+      "enum":["draft","open","closed"],
+      "type":"string"
+    },
+    "title":{
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your estimate [number]'",
+      "type":"string"
+    },
+    "notes_before":{
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "type":"string"
+    },
+    "notes_after":{
+      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
+      "type":"string"
+    },
+    "tag_list": {
+      "description": "Space separated list of tags.",
+      "type":"string"
+    },
+    "precision":{
+      "description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
+      "type":"number",
+      "enum": [2,3,4],
+      "default":2
+    },
+    "archived_pdf":{
+      "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./attachment.json#properties"}
+    },
+    "client":{
+      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.json#properties"}
+    },
+    "client_id":{
+      "description": "The clients uuid, must be set for a new document. New estimates take the clients address field, due days and cash discount if those fields are not set.",
+      "type":"string",
+      "required":true
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
+    "line_items":{
+      "description": "Line items for the document",
+      "type":"array",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "lock_version":{
+      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version.",
+      "optional":true,
+      "type":"integer"
+    },
+    "gross_total":{
+      "description": "Gross total of all line items, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "tax_total":{
+      "description": "Tax total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total":{
+      "description": "Net total, 2 decimals places",
+      "readonly":true,
+      "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)",
+      "readonly":true,
+      "type":"number"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "estimates/{id}"
+    },
+    { "rel": "instances",
+      "href": "estimates",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
+        },
+        "filter[tags]":{
+          "title" : "Tags",
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['title', 'number', 'created_at', 'updated_at', 'client_id', 'price_total', 'price_tax', 'date', 'due_date'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "estimates/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "estimates/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "estimates",
+      "method": "POST"
+    },
+    { "rel": "attachments",
+      "href": "estimates/{id}/attachments"
+    },
+    { "rel": "print",
+      "href": "estimates/{id}/print",
+      "method": "POST",
+      "properties" : {
+        "template_id" : {
+          "title" : "PDF template used for printing",
+          "description": "UUID of a pdf template used to print the document. MUST be present",
+          "required":true
+        },
+        "base64" : {
+          "title" : "Return the created pdf base64 encoded",
+          "description": "If set the new pdf is returned inside the attachment JSON within 'base64' key. Leave empty to save traffic."
+        }
+      }
+    }
+  ]
+}

data/json/v1.0/invoice.json CHANGED Viewed

@@ -1,7 +1,6 @@
 { "type":"object",
   "title": "invoice",
-  "description": "An invoice",
+  "description": "An invoice",
   "properties":{
     "id":{
       "description": "UUID assigned by SK",
@@ -14,7 +13,7 @@
       "type":"string"
     },
     "address_field":{
-      "description": "Address field with the receiver. Shown in envelope window.",
+      "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.",
       "type":"string"
     },
     "date":{
@@ -32,7 +31,7 @@
       "type":"string"
     },
     "status":{
-      "description": "Defaults to draft for new documents, if empty. For new documents with status 'open',the following fields are set if empty: number(next in number schema), date(today), due date(today unless due_days given). Only draft invoices can be deleted.",
+      "description": "Defaults to draft for new documents, if empty. For new documents with status 'open',the following fields are set if empty: number(next in number schema), date(today), due date(today unless due_days given). Only drafts can be deleted.",
       "default":"draft",
       "enum":["draft","open","closed"],
       "type":"string"
@@ -55,14 +54,14 @@
       "type":"string"
     },
     "tag_list": {
-      "description": "Space seperated list of tags.",
+      "description": "Space separated list of tags.",
       "type":"string"
     },
-    "client":{
-      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
-      "readonly":true,
-      "type":"object",
-      "properties":{"$ref":"./client.json#properties"}
+    "precision":{
+      "description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
+      "type":"number",
+      "enum": [2,3,4],
+      "default":2
     },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
@@ -70,11 +69,21 @@
       "type":"object",
       "properties":{"$ref":"./attachment.json#properties"}
     },
+    "client":{
+      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.json#properties"}
+    },
     "client_id":{
       "description": "The clients uuid, must be set for a new document. New invoices take the clients address field, due days and cash discount if those fields are not set.",
       "type":"string",
       "required":true
     },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
     "line_items":{
       "description": "Line items for the document",
       "type":"array",
@@ -93,17 +102,42 @@
       "type":"string"
     },
     "lock_version":{
-      "description": "Auto-incremented by SK to prevent concurrent updateing. First save wins.",
+      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
       "optional":true,
       "type":"integer"
     },
     "price_total":{
-      "description": "Net total sum of all line items, 6 decimals places",
+      "description": "Deprecated use net_total_base_raw",
       "readonly":true,
       "type":"number"
     },
     "price_tax":{
-      "description": "Summed up tax total of all line items, 2 decimals places",
+      "description": "Deprecated: use tax_total",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_total":{
+      "description": "Gross total of all line items, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "tax_total":{
+      "description": "Tax total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total":{
+      "description": "Net total, 2 decimals places",
+      "readonly":true,
+      "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)",
       "readonly":true,
       "type":"number"
     }
@@ -114,19 +148,21 @@
     },
     { "rel": "instances",
       "href": "invoices",
-      // Params /invoices?page=1&sort_by
       "properties" : {
-        "q":{
-          "title" : "Search",
-          "description": "Search parameter."
-        },
         "page":{
           "title" : "Page",
-          "description": "In paginated results set the page to look for"
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
         },
         "filter[tags]":{
           "title" : "Tags",
-          "description": "Filter by a space delimited list of tags"
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
         },
         "filter[from]":{
           "title" : "From date",
@@ -138,10 +174,13 @@
         },
         "sort_by":{
           "title" : "Sort by",
-          "description": "Sort the results by the given field => invoice.number"
+          "description": "Sort the results by the given field => number",
+          "enum":['title', 'number', 'created_at', 'updated_at', 'client_id', 'price_total', 'price_tax', 'date', 'due_date'],
+          "type": 'string'
         },
         "sort":{
           "title" : "Sort",
+          "enum":["ASC","DESC"],
           "description": "Sort the results in ASC or DESC"
         }
       }
@@ -152,15 +191,15 @@
     },
     { "rel": "update",
       "href": "invoices/{id}",
-      "method": "PUT",
-      "properties" : {
-        "invoice" : {"$ref":"./invoice.json#properties"}
-      }
+      "method": "PUT"
     },
     { "rel": "create",
       "href": "invoices",
       "method": "POST"
     },
+    { "rel": "attachments",
+      "href": "invoices/{id}/attachments"
+    },
     { "rel": "print",
       "href": "invoices/{id}/print",
       "method": "POST",

data/json/v1.0/order.json ADDED Viewed

@@ -0,0 +1,194 @@
+{ "type":"object",
+  "title": "order",
+  "description": "An order",
+  "properties":{
+    "id":{
+      "description": "UUID assigned by SK",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "number":{
+      "description": "Unique number assigned by SK order number schema. Auto-assigned when order is opened. Required unless doc status is draft.",
+      "type":"string"
+    },
+    "address_field":{
+      "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id present.",
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the order is issued. Automatically set when order is opened. Required for non-draft documents.",
+      "format":"date",
+      "type":"string"
+    },
+    "status":{
+      "description": "Defaults to draft for new documents, if empty. For new documents with status 'open', the following fields are set if empty: number(next in number schema), date(today). Only drafts can be deleted.",
+      "default":"draft",
+      "enum":["draft","open","closed"],
+      "type":"string"
+    },
+    "title":{
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your order [number]'",
+      "type":"string"
+    },
+    "notes_before":{
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "type":"string"
+    },
+    "notes_after":{
+      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
+      "type":"string"
+    },
+    "tag_list": {
+      "description": "Space separated list of tags.",
+      "type":"string"
+    },
+    "precision":{
+      "description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
+      "type":"number",
+      "enum": [2,3,4],
+      "default":2
+    },
+    "archived_pdf":{
+      "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./attachment.json#properties"}
+    },
+    "client":{
+      "description": "The associated client. New documents cannot create a client, use client_id to set it.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.json#properties"}
+    },
+    "client_id":{
+      "description": "The clients uuid, must not be set for a new document. New docuents take the clients address field, due days and cash discount if client is present abd those fields are not set.",
+      "type":"string"
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
+    "line_items":{
+      "description": "Line items for the document",
+      "type":"array",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "lock_version":{
+      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version.",
+      "optional":true,
+      "type":"integer"
+    },
+    "gross_total":{
+      "description": "Gross total of all line items, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "tax_total":{
+      "description": "Tax total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total":{
+      "description": "Net total, 2 decimals places",
+      "readonly":true,
+      "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)",
+      "readonly":true,
+      "type":"number"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "orders/{id}"
+    },
+    { "rel": "instances",
+      "href": "orders",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
+        },
+        "filter[tags]":{
+          "title" : "Tags",
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['title', 'number', 'created_at', 'updated_at', 'client_id', 'price_total', 'price_tax', 'date', 'due_date'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "orders/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "orders/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "orders",
+      "method": "POST"
+    },
+    { "rel": "attachments",
+      "href": "orders/{id}/attachments"
+    },
+    { "rel": "print",
+      "href": "orders/{id}/print",
+      "method": "POST",
+      "properties" : {
+        "template_id" : {
+          "title" : "PDF template used for printing",
+          "description": "UUID of a pdf template used to print the document. MUST be present",
+          "required":true
+        },
+        "base64" : {
+          "title" : "Return the created pdf base64 encoded",
+          "description": "If set the new pdf is returned inside the attachment JSON within 'base64' key. Leave empty to save traffic."
+        }
+      }
+    }
+  ]
+}

data/json/v1.0/payment_reminder.json ADDED Viewed

@@ -0,0 +1,179 @@
+{ "type":"object",
+  "title": "payment_reminder",
+  "description": "An payment_reminder",
+  "properties":{
+    "id":{
+      "description": "UUID assigned by SK",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "address_field":{
+      "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.",
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the payment_reminder is issued. Automatically set when payment_reminder is opened. Required for non-draft documents.",
+      "format":"date",
+      "type":"string"
+    },
+    "due_days":{
+      "description": "Used to calculate the due date of the payment_reminder. Useless if date and due date are present.",
+      "type":"integer"
+    },
+    "due_date":{
+      "description": "Auto-calculated from date + due days if empty and the payment_reminder is opened.",
+      "format":"date",
+      "type":"string"
+    },
+    "title":{
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your payment_reminder [number]'",
+      "type":"string"
+    },
+    "notes_before":{
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "type":"string"
+    },
+    "notes_after":{
+      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
+      "type":"string"
+    },
+    "tag_list": {
+      "description": "Space separated list of tags.",
+      "type":"string"
+    },
+    "precision":{
+      "description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
+      "type":"number",
+      "enum": [2,3,4],
+      "default":2
+    },
+    "archived_pdf":{
+      "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./attachment.json#properties"}
+    },
+    "client":{
+      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.json#properties"}
+    },
+    "client_id":{
+      "description": "The clients uuid. New payment_reminders take the clients address field, due days and cash discount if those fields are not set.",
+      "type":"string",
+      "required":true
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
+    "line_items":{
+      "description": "Line items for the document",
+      "type":"array",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "lock_version":{
+      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
+      "optional":true,
+      "type":"integer"
+    },
+    "gross_total":{
+      "description": "Gross total of all line items, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total":{
+      "description": "Net total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "payment_reminders/{id}"
+    },
+    { "rel": "instances",
+      "href": "payment_reminders",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
+        },
+        "filter[tags]":{
+          "title" : "Tags",
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['title', 'number', 'created_at', 'updated_at', 'client_id', 'price_total', 'price_tax', 'date', 'due_date'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "payment_reminders/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "payment_reminders/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "payment_reminders",
+      "method": "POST"
+    },
+    { "rel": "attachments",
+      "href": "payment_reminders/{id}/attachments"
+    },
+    { "rel": "print",
+      "href": "payment_reminders/{id}/print",
+      "method": "POST",
+      "properties" : {
+        "template_id" : {
+          "title" : "PDF template used for printing",
+          "description": "UUID of a pdf template used to print the document. MUST be present",
+          "required":true
+        },
+        "base64" : {
+          "title" : "Return the created pdf base64 encoded",
+          "description": "If set the new pdf is returned inside the attachment JSON within 'base64' key. Leave empty to save traffic."
+        }
+      }
+    }
+  ]
+}

data/lib/sk_api_schema.rb CHANGED Viewed

@@ -4,64 +4,102 @@ module SK
   module Api
     class Schema
-      # Read a schema with a given version and return it as hash
-      # See ../json folder for available schema's and versions
-      # === Parameter
-      # schema<String|Symbol>::name of the schema, available ones are in json directory
-      # version<String>:: version to read, this is the folder name where the schema is in.
-      # === Return
-      # <HashWithIndifferentAccess>:: schema as hash
-      def self.read(schema, version)
-        file_path = File.join(File.dirname(__FILE__), '../json', version, "#{schema}.json")
-        plain_data = File.open(file_path, 'r'){|f| f.read}
-        ActiveSupport::JSON.decode(plain_data).with_indifferent_access
-      end
+      class << self
+        # Read a schema with a given version and return it as hash
+        # See ../json folder for available schema's and versions
+        # === Parameter
+        # schema<String|Symbol>::name of the schema, available ones are in json directory
+        # version<String>:: version to read, this is the folder name where the schema is in.
+        # === Return
+        # <HashWithIndifferentAccess>:: schema as hash
+        def read(schema, version)
+          # prefix version with v1.0 of v is not present
+          v = (version =~ /^v/) ? version : "v#{version}"
+          file_path = File.join(File.dirname(__FILE__), '../json', v, "#{schema}.json")
+          plain_data = File.open(file_path, 'r'){|f| f.read}
+          ActiveSupport::JSON.decode(plain_data).with_indifferent_access
+        end
-      # Create a Hash with the available (api)object attributes defined in
-      # schema properties.
-      #
-      # === Example
-      #  obj = Invoice.new(:title =>'hello world', :number=>'4711')
-      #  obj_hash = Sk::Api::Schema.to_hash_from_schema(obj, 'v1.0')
-      #
-      #  obj_hash => { invoice =>{'title'=>'hello world', 'number'=>'4711' } }
-      #
-      # === Parameter
-      # obj<Object>:. An ruby object which is returned as hash
-      # version<String>:. An ruby object which is returned as hash
-      # === Return
-      # <Hash{String=>{String=>Mixed}}>:: The object as hash:
-      # { invoice =>{'title'=>'hello world', 'number'=>''4711 } }
-      def self.to_hash_from_schema(obj, version)
-        # get objects class name without inheritance
-        obj_class_name =  obj.class.name.split('::').last.underscore
-        # init data hash
-        data = {}
-        # get schema
-        schema = self.read(obj_class_name, version)
-        # iterate over the defined schema fields
-        schema['properties'].each do |field, prop|
-          if prop['type'] == 'array'
-            data[field] = [] # always set an empty array
-            if rel_objects = obj.send( field )
-              rel_objects.each do |rel_obj|
-                # call related objects to_hash_from_schema method ex:
-                # data[:client][:addresses] << SKApi::Models::Address.to_hash_from_schema(object)
-                data[field] << self.to_hash_from_schema(rel_obj, version)
+        # Read all available schemas from a given version(folder) and return
+        # them as array
+        # See ../json folder for available schema's and versions
+        # === Parameter
+        # schema<String|Symbol>::name of the schema, available ones are in json directory
+        # === Return
+        # Array[<HashWithIndifferentAccess>]:: array of schemas as hash
+        def read_all(version)
+          schemas = []
+          v = (version =~ /^v/) ? version : "v#{version}"
+          file_path = File.join(File.dirname(__FILE__), '../json', v, '*.json')
+          Dir.glob( file_path ).each do |file|
+            schema = File.open(file, 'r'){|f| f.read}
+            schemas << ActiveSupport::JSON.decode(schema).with_indifferent_access
+          end
+          schemas
+        end
+        # Create a Hash with the available (api)object attributes defined in
+        # schema properties.
+        #
+        # === Example
+        #  obj = Invoice.new(:title =>'hello world', :number=>'4711')
+        #  obj_hash = Sk::Api::Schema.to_hash_from_schema(obj, 'v1.0')
+        #
+        #  obj_hash => { invoice =>{'title'=>'hello world', 'number'=>'4711' } }
+        #
+        # === Parameter
+        # obj<Object>:: An ruby object which is returned as hash
+        # version<String>:: the schema version, must be a valid folder name see #self.read
+        #
+        # === Return
+        # <Hash{String=>{String=>Mixed}}>:: The object as hash:
+        # { invoice =>{'title'=>'hello world', 'number'=>''4711 } }
+        def to_hash_from_schema(obj, version)
+          # get objects class name without inheritance
+          obj_class_name =  obj.class.name.split('::').last.underscore
+          # init data hash
+          data = {}
+          # get schema
+          schema = read(obj_class_name, version)
+          # iterate over the defined schema fields
+          schema['properties'].each do |field, prop|
+            if prop['type'] == 'array'
+              data[field] = [] # always set an empty array
+              if rel_objects = obj.send( field )
+                rel_objects.each do |rel_obj|
+                  # call related objects to_hash_from_schema method ex:
+                  # data[:client][:addresses] << SKApi::Models::Address.to_hash_from_schema(object)
+                  data[field] << to_hash_from_schema(rel_obj, version)
+                end
               end
+            elsif prop['type'] == 'object' # a singular related object
+              data[field] = nil # always set empty val
+              if rel_obj = obj.send( field )
+                #dont nest field to prevent => client=>{client=>{data} }
+                data[field] = to_hash_from_schema(rel_obj, version)
+              end
+            else # a simple field is only added if the object knows it
+              data[field] = obj.send(field) if obj.respond_to?(field.to_sym)
             end
-          elsif prop['type'] == 'object'     # a singular related object
-            data[field] = nil # always set empty val
-            if rel_obj = obj.send( field )
-              data[field] = self.to_hash_from_schema(rel_obj, version)
-            end
-          else # a simple field is only added if objects know its
-            data[field] = obj.send(field) if obj.respond_to?(field.to_sym)
           end
-        end
-        { obj_class_name => data }
-      end
+          #add links
+          { obj_class_name => data,
+            'links' =>  parse_links(obj, schema)
+          }
+        end
+        # Parse the link section of the schema by replacing {id} in urls
+        # === Returns
+        # <Array[Hash{String=>String}]>::
+        def parse_links(obj, schema)
+          links = []
+          schema['links'] && schema['links'].each do |link|
+            links << { 'rel' => link['rel'], 'href' => link['href'].gsub(/\{id\}/, obj.id) }
+          end
+          links.uniq
+        end
+      end # class methods
     end
   end
 end

data/sk_api_schema.gemspec CHANGED Viewed

@@ -1,46 +1,47 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2010-12-03}
+  s.date = %q{2011-01-16}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "json/v1.0/address.json",
-     "json/v1.0/attachment.json",
-     "json/v1.0/client.json",
-     "json/v1.0/credit_note.json",
-     "json/v1.0/invoice.json",
-     "json/v1.0/line_item.json",
-     "json/v1.0/product.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"
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "json/v1.0/address.json",
+    "json/v1.0/attachment.json",
+    "json/v1.0/client.json",
+    "json/v1.0/credit_note.json",
+    "json/v1.0/estimate.json",
+    "json/v1.0/invoice.json",
+    "json/v1.0/line_item.json",
+    "json/v1.0/order.json",
+    "json/v1.0/payment_reminder.json",
+    "json/v1.0/product.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 = %q{http://github.com/salesking/sk_api_schema}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{SalesKing API JSON Schema}
   s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/sk_api_schema_spec.rb"
+    "spec/sk_api_schema_spec.rb",
+    "spec/spec_helper.rb"
   ]
   if s.respond_to? :specification_version then

data/spec/sk_api_schema_spec.rb CHANGED Viewed

@@ -10,6 +10,22 @@ describe SK::Api::Schema do
     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')
@@ -45,18 +61,24 @@ describe SK::Api::Schema, 'object parsing' do
     @item.price_single = 0.99
   end
-  it "should parse object without relations from schema" do
+  it "should parse object with empty relations from schema" do
     obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
-    obj_hash.should == {"invoice"=>{"number"=>"911", "line_items"=>[], "archived_pdf"=>nil, "title"=>"Your Invoice", "date"=>nil, "id"=>"some-uuid", "client"=>nil, "due_date"=>nil}}
+    #   {"invoice"=>{"number"=>"911", "line_items"=>[], "archived_pdf"=>nil, "title"=>"Your Invoice", "date"=>nil, "id"=>"some-uuid", "client"=>nil, "due_date"=>nil}}
+    obj_hash.keys.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.should == {"client"=>{"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}}
+    client_obj_hash.keys.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.should == {"invoice"=>{"number"=>"911", "line_items"=>[{"line_item"=>{"name"=>"Pork Chops", "position"=>1, "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}], "archived_pdf"=>nil, "title"=>"Your Invoice", "date"=>nil, "id"=>"some-uuid", "client"=>{"client"=>{"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}}, "due_date"=>nil}}
+    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 == []
+    obj_hash["invoice"]["line_items"].should == [ {'links'=>[], "line_item"=>{"name"=>"Pork Chops", "position"=>1, \
+                                       "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}]
   end
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sk_api_schema
 version: !ruby/object:Gem::Version
-  hash: 23
+  hash: 21
   prerelease: false
   segments:
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors:
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-12-03 00:00:00 +01:00
+date: 2011-01-16 00:00:00 +01:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -55,7 +55,6 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- .gitignore
 - README.rdoc
 - Rakefile
 - VERSION
@@ -63,8 +62,11 @@ files:
 - json/v1.0/attachment.json
 - json/v1.0/client.json
 - json/v1.0/credit_note.json
+- json/v1.0/estimate.json
 - json/v1.0/invoice.json
 - json/v1.0/line_item.json
+- json/v1.0/order.json
+- json/v1.0/payment_reminder.json
 - json/v1.0/product.json
 - json/v1.0/user.json
 - lib/sk_api_schema.rb
@@ -76,8 +78,8 @@ homepage: http://github.com/salesking/sk_api_schema
 licenses: []
 post_install_message:
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -106,5 +108,5 @@ signing_key:
 specification_version: 3
 summary: SalesKing API JSON Schema
 test_files:
-- spec/spec_helper.rb
 - spec/sk_api_schema_spec.rb
+- spec/spec_helper.rb

data/.gitignore DELETED Viewed

@@ -1,4 +0,0 @@
-nbproject/*
-coverage/*
-rdoc/*
-pkg/*