happypdf_json_schema 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+= Changelog for happyPDF API Schema
+
+A more detailed view of the changes can be found in the [commit messages](https://github.com/happypdf/happypdf_json_schema/commits/)
+
+
+2013-10
+
+* add pdf resources
+* refactor pdt, page resources
+
+2012-12
+
+  * initial version

data/{README.rdoc → README.md}

@@ -1,6 +1,6 @@
-= HappyPDF API Schema
+# HappyPDF API Schema
 
-{<img src="https://secure.travis-ci.org/happypdf/happypdf_json_schema.png?branch=master" alt="Build Status" />}[http://travis-ci.org/happypdf/happypdf_json_schema]
+[<img src="https://secure.travis-ci.org/happypdf/happypdf_json_schema.png?branch=master" alt="Build Status" />](http://travis-ci.org/happypdf/happypdf_json_schema)
 
 Our API (objects,resources) is described with JSON Schema (http://json-schema.org).
 Each Object has its own description, with those top-level keys:
@@ -11,36 +11,35 @@ Each Object has its own description, with those top-level keys:
     "links": [ .. ]         // CRUD actions, relationships to other resources
   }
 
-Look into the /json/ folder for the resources schema-files
+Look into the /schema/ folder for the resources schema-files
 For ruby pirates this project is available as gem. It provides some utility
 methods to read the schema files and convert objects to their schema notation.
-See {/lib/happypdf/schema.rb}[https://github.com/happypdf/happypdf_json_schema/blob/master/lib/happypdf/schema.rb]
+See [/lib/happypdf/schema.rb](https://github.com/happypdf/happypdf_json_schema/blob/master/lib/happypdf/schema.rb)
 
 Other languages should take advantage of the raw json files.
 
-== Field types & formats
+## Field types & formats
 
 Most of the fields are of type 'string'. Their format(espacially date fields)
-is casted on our side. We try to go with the {formats}[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23] and {types}[http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1] defined by JSON-Schema
+is casted on our side. We try to go with the [formats](http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23) and [types])http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1) defined by JSON-Schema
 
 All text MUST be UTF-8 encoded.
 
-*Text-Format* length varies, between ~16,000 to 65.535, with the occurence of non-ASCII Characters {see this post on stackoverflow}[http://stackoverflow.com/questions/4420164/how-much-utf-8-text-fits-in-a-mysql-text-field]
+*Text-Format* length varies, between ~16,000 to 65.535, with the occurence of non-ASCII Characters [see this post on stackoverflow](http://stackoverflow.com/questions/4420164/how-much-utf-8-text-fits-in-a-mysql-text-field)
 
 
-== Install
+## Install
 
     gem install happypdf_json_schema
 
-== Test
+## Test
 
-Tested with {travis-ci}[http://travis-ci.org/happypdf/happypdf_json_schema], but of
+Tested with [travis-ci](http://travis-ci.org/happypdf/happypdf_json_schema), but of
 course you can run them too. Install required gems with bundler and go for it:
-  # git clone
-  bundle install
-  rake spec
 
+    # git clone
+    bundle install
+    rake spec
 
-== ToDo:
 
 Copyright (c) 2012-2013 Georg Leciejewski, released under the MIT license

data/happypdf_json_schema.gemspec

@@ -12,7 +12,6 @@ Besides ruby users can use a small lib with utility methods to load and test the
   s.authors = ['Georg Leciejewski']
   s.email = %q{gl@happypdf.com}
   s.homepage = %q{http://github.com/happypdf/happypdf_json_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")
@@ -20,8 +19,8 @@ Besides ruby users can use a small lib with utility methods to load and test the
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rdoc'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'activesupport'
   s.add_development_dependency 'json_schema_tools'
   s.add_development_dependency 'rake', '>= 0.9.2'
 

data/lib/happypdf/version.rb

@@ -1,5 +1,5 @@
 module HappyPdf
   class Schema
-    VERSION='0.1.2'
+    VERSION='0.1.3'
   end
 end

data/schema/v1.0/pdf.json

@@ -19,6 +19,11 @@
       "description": "PDF Template id, used to create this PDF.",
       "type": "integer"
     },
+    "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"
+    },
     "user_id": {
       "description": "User who created the object",
       "type": "integer"
@@ -29,11 +34,6 @@
       "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"

data/schema/v1.0/pdt.json

@@ -13,12 +13,12 @@
     "name": {
       "description": "Name shown in interface",
       "type": "string",
-      "maxlength": 60
+      "maxlength": 128
     },
-    "file": {
+    "filename": {
       "description": "Filename",
       "type": "string",
-      "maxlength": 60
+      "maxlength": 128
     },
     "description": {
       "description": "A description of the template",
@@ -65,7 +65,7 @@
       "type": "integer"
     },
     "pages": {
-      "description": "Pages of the doc.",
+      "description": "Pages of the template.",
       "type": "array",
       "properties":{"$ref":"./page.json#properties"}
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: happypdf_json_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ cert_chain: []
 date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -83,14 +83,13 @@ description: ! 'happyPDF JSON Schema describes our PDF API in terms of available
 email: gl@happypdf.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - happypdf_json_schema.gemspec
 - lib/happypdf/schema.rb
@@ -119,6 +118,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1543727035472563446
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +129,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

data/CHANGELOG.rdoc

@@ -1,7 +0,0 @@
-= Changelog for happyPDF API Schema
-
-A more detailed view of the changes can be found in the {commit messages}[https://github.com/happypdf/happypdf_json_schema/commits/]
-
-2012-12
-
-  * initial version