happypdf_json_schema 0.0.3 → 0.1.0

data/.travis.yml

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

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/happypdf_json_schema.gemspec

@@ -4,7 +4,7 @@ require 'happypdf/version'
 
 Gem::Specification.new do |s|
   s.version = HappyPdf::Schema::VERSION
-  s.date = %q{2012-12-23}
+  s.date = %q{2013-10-27}
   s.name = %q{happypdf_json_schema}
   s.summary = 'happyPDF API - JSON Schema'
   s.description = %q{happyPDF JSON Schema describes our PDF API in terms of available objects, their fields and links to url endpoints with related objects.

data/lib/happypdf/version.rb

@@ -1,5 +1,5 @@
 module HappyPdf
   class Schema
-    VERSION='0.0.3'
+    VERSION='0.1.0'
   end
 end

data/schema/v1.0/block.json

@@ -5,7 +5,7 @@
   "type":"object",
   "properties":{
     "name": {
-      "description": "Name of the block. Must unique within each page. [ ] / are not allowed.",
+      "description": "Name of the block. Must unique within each page. [ ] / are not allowed. To render content twice append #[1-9] to the blockname e.g. firstname#12",
       "type": "string",
       "maxLength": 125,
       "required": true

data/schema/v1.0/page.json

@@ -2,7 +2,7 @@
   "type": "object",
   "title": "Page",
   "name": "page",
-  "description": "A page of a PDF which can either belong to a PDF template or archived PDF.",
+  "description": "A page of a PDF which can either belong to a PDF template or archived PDF. ",
   "properties": {
     "id": {
       "description": "The object identifier.",
@@ -15,59 +15,26 @@
       "readonly": true,
       "type": "integer"
     },
-    "related_object_id": {
-      "description": "ID  of the PDF object the page belongs to.",
-      "readonly": true,
-      "type": "integer"
-    },
-    "related_object_type": {
-      "description": "Type of the related object Pdf or Pdt (camelCased class name)",
-      "readonly": true,
-      "type": "string",
-      "maxlength": 20
-    },
     "width": {
       "description": "Page width",
       "type": "number"
     },
-    "created_at": {
-      "description": "Creation date.",
-      "readonly": true,
-      "type": "string",
-      "format": "date-time"
-    },
-    "updated_at": {
-      "description": "Update date.",
-      "readonly": true,
-      "type": "string",
-      "format": "date-time"
-    },
-    "user_id": {
-      "description": "User who created the object.",
-      "readonly": true,
-      "type": "integer"
-    },
-    "screenshot": {
-      "description": "Screenshot file url png",
-      "type": "string",
-      "maxlength": 128
-    },
-    "account_id": {
-      "description": "Account this objects belongs to.",
-      "type": "integer"
-    },
     "blocks": {
-      "description": "Placeholder blocks on this page,, if it belongs to a PDF Template",
+      "description": "Placeholder blocks on this page, if it belongs to a PDF Template",
       "type": "array",
       "properties": {"$ref":"./block.json#properties"}
+    },
+    "public_id": {
+      "description": "Unique ID to be used in public URL e.g to get  the screenshot image of a page.",
+      "readonly": true,
+      "type": "string"
     }
-
   },
   "links": [
     {
-      "rel": "self",
+      "rel": "public screenshot",
       "method": "GET",
-      "href": "/pages/{id}"
+      "href": "/public/pages/{public_id}/screenshot"
     }
   ]
 }

data/schema/v1.0/pdf.json

@@ -0,0 +1,75 @@
+{
+  "type": "object",
+  "title": "PDF",
+  "name": "pdf",
+  "description": "A PDF created from a template.",
+  "properties": {
+    "id": {
+      "description": "The object identifier.",
+      "identity": true,
+      "readonly": true,
+      "type": "integer"
+    },
+    "filename": {
+      "description": "Filename",
+      "type": "string",
+      "maxlength": 128
+    },
+    "pdt_id": {
+      "description": "PDF Template id, used to create this PDF.",
+      "type": "integer"
+    },
+    "user_id": {
+      "description": "User who created the object",
+      "type": "integer"
+    },
+    "created_at": {
+      "description": "Creation date",
+      "readonly": true,
+      "type": "string",
+      "format": "date-time"
+    },
+    "md5": {
+      "description": "MD5 hash created from pdf string.",
+      "type": "string",
+      "maxlength": 40
+    },
+    "account_id": {
+      "description": "Account this objects belongs to.",
+      "type": "integer"
+    },
+    "pages": {
+      "description": "Pages of the pdf, sorted by page number.",
+      "type": "array",
+      "properties":{"$ref":"./page.json#properties"}
+    }
+  },
+  "links": [
+    {
+      "rel": "self",
+      "href": "/pdfs/{id}"
+    },
+    {
+      "rel": "instances",
+      "method": "GET",
+      "href": "/pdfs"
+    },
+    {
+      "rel": "create",
+      "method": "POST",
+      "href": "/pdfs",
+      "properties": {
+        "pdt_id":{
+          "title" : "Template",
+          "description": "ID of an PDF template to use.",
+          "required": true
+        }
+      }
+    },
+    {
+      "rel": "destroy",
+      "method": "DELETE",
+      "href": "/pdfs/{id}"
+    }
+  ]
+}

data/spec/happypdf_schema_spec.rb

@@ -17,6 +17,4 @@ describe HappyPdf::Schema do
     end
 
   end
-
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happypdf_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -99,6 +99,7 @@ files:
 - schema/v1.0/block.json
 - schema/v1.0/image_block.json
 - schema/v1.0/page.json
+- schema/v1.0/pdf.json
 - schema/v1.0/pdt.json
 - schema/v1.0/table.json
 - schema/v1.0/table_cell.json
@@ -120,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4509264459645895034
+      hash: -1329503588929183214
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -129,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: happyPDF API - JSON Schema