doctag_json_schema 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+# DocTag JSON Schema
+[![Build Status](https://secure.travis-ci.org/docTag/doctag_json_schema.png?branch=master)](http://travis-ci.org/docTag/doctag_json_schema)
+
+This is the formal description of the docTag(working title) document exchange
+format. With docTag we(see Supporters) aim to simplify the exchange of documents
+e.g. invoices, between services.
+
+Our goal is to provide a small common subset of objects and fields, which can
+be extended by everybody. As a starting point we tackle invoice documents.
+
+## About JSON Schema
+
+[JSON-Schema](json-schema.org) is formal way to describe JSON structures.
+
+> JSON Schema provides a contract for what JSON data is required for a given
+application and how to interact with it. JSON Schema is intended to define
+validation, documentation, hyperlink navigation, and interaction control of JSON
+data.
+Quoted: http://tools.ietf.org/html/draft-zyp-json-schema-03
+
+Compared to its evil twin: XML Schema (WSDL), json-schema is lightweight, easier
+to read(also for humans) and to parse.
+
+## Other formats
+
+The idea to exchange documents in a structured, machine readable format isn't
+new. We could not find any existing solution which could fit small businesses
+needs and where easy to implement.
+
+Formats like [EDI](http://en.wikipedia.org/wiki/Electronic_Data_Interchange#See_also)
+and it's xml-based subsets rather fit big enterprises and are way too bloated.
+
+## Test
+
+A tiny test-suite in /test ensures that all schema files contain valid json.
+The test are run after each commit by travis-ci(see batch above)
+
+To run the test locally you need ruby. First install the ruby-gem dependencies
+and then run it:
+
+    bundle install
+    rake spec
+
+
+## Initiative Supporters a-z
+
+* Billomat
+* CentralStation CRM
+* Doctape
+* Easybill
+* FastBill
+* Fileee
+* FreeFibu
+* Fortrabbit
+* Mein Tagwerk
+* Salesking
+* Smarchive
+* Skippr
+
+## License

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new
+task :default => :spec

data/doctag_json_schema.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'doc_tag/version'
+
+Gem::Specification.new do |s|
+  s.version = DocTag::Schema::VERSION
+  s.date = %q{2013-01-01}
+  s.name = %q{doctag_json_schema}
+  s.summary = 'DocTag API - JSON Schema'
+  s.description = %q{This is the formal description of the docTag document exchange format. With docTag we(see Supporters) aim to simplify the exchange of documents e.g. invoices, between services. Ruby users can use this gem with utility methods to load and test the schema files.}
+  s.authors = ['Georg Leciejewski']
+  s.email = %q{gl@salesking.eu}
+  s.homepage = %q{https://github.com/docTag/doctag_json_schema}
+  s.extra_rdoc_files = ['README.md']
+  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")
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'json_schema_tools'
+  s.add_development_dependency 'rake', '>= 0.9.2'
+end

data/lib/doc_tag/schema.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module DocTag
+  class Schema
+    # Get the path to schema files. So it can be used f.ex. with
+    # gem json_schema_tools
+    def self.path
+      File.expand_path( '../../schema', File.dirname(__FILE__))
+    end
+  end
+end

data/lib/doc_tag/version.rb

@@ -0,0 +1,6 @@
+module DocTag
+  class Schema
+    # gem version
+    VERSION='1.0.0'
+  end
+end

data/lib/doctag_json_schema.rb

@@ -0,0 +1 @@
+require 'doc_tag/schema'

data/schema/address.json

@@ -0,0 +1,39 @@
+{ "type":"object",
+  "title": "address",
+  "description": "An address of a contact for a document",
+  "properties":{
+    "name":{
+      "description": "tax name",
+      "type":"string",
+      "required": true
+    },
+    "contact":{
+      "description": "contact name",
+      "type":"string"
+    },
+    "street":{
+      "description": "street name",
+      "type":"string"
+    },
+    "zip_code":{
+      "description": "ZIP code",
+      "type":"string"
+    },
+    "city":{
+      "description": "City",
+      "type":"string"
+    },
+    "state":{
+      "description": "State",
+      "type":"string"
+    },
+    "country":{
+      "description": "Country code ISO 3166-1",
+      "type":"string"
+    },
+    "tax_number":{
+      "description": "Tax number",
+      "type":"string"
+    }
+  }
+}

data/schema/amount.json

@@ -0,0 +1,16 @@
+{ "type":"object",
+  "title": "amount",
+  "description": "Gross and net total values for a total",
+  "properties":{
+    "gross":{
+      "description": "Gross total",
+      "type":"number",
+      "required": true
+    },
+    "net":{
+      "description": "Net total",
+      "type":"number",
+      "required": true
+    }
+  }
+}

data/schema/discount.json

@@ -0,0 +1,22 @@
+{ "type":"object",
+  "title": "amount",
+  "description": "Gross and net total values for a total",
+  "properties":{
+    "date":{
+      "description": "Date the discount expires. ISO-8601 format: YYYY-MM-DD",
+      "format":"date",
+      "type":"string",
+      "required": true
+    },
+    "rate":{
+      "description": "Discount percent value",
+      "type":"string",
+      "required": true
+    },
+    "amount":{
+      "description": "Discounted value",
+      "type":"number",
+      "required": true
+    }
+  }
+}

data/schema/document.json

@@ -0,0 +1,95 @@
+{ "type":"object",
+  "title": "Document",
+  "description": "A document of the defined doctype",
+  "properties":{
+    "doctype":{
+      "description": "Type of the document",
+      "type":"string",
+      "required": true,
+      "enum": ["invoice", "offer"]
+    },
+    "doctag_version":{
+      "description": "Doctag Version used e.g.: 1.0.0",
+      "type":"string",
+      "required": true
+    },
+    "id":{
+      "description": "Unique ID",
+      "type":"string",
+      "required": true
+    },
+    "number":{
+      "description": "Unique number",
+      "type":"string"
+    },
+    "customer_number":{
+      "description": "Unique number of the contact related to this doc",
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the document is issued. ISO-8601 format: YYYY-MM-DD",
+      "format":"date",
+      "type":"string",
+      "required": true
+    },
+    "delivery_date":{
+      "description": "Date ?? delivered. ISO-8601 format: YYYY-MM-DD",
+      "format":"date",
+      "type":"string",
+      "required": true
+    },
+    "due_date":{
+      "description": "Date the invoice is due. ISO-8601 format: YYYY-MM-DD",
+      "format":"date",
+      "type":"string"
+    },
+    "discount_date":{
+      "description": "Date until which a cash discount can be applied. ISO-8601 format: YYYY-MM-DD",
+      "format":"date",
+      "type":"string"
+    },
+    "intro":{
+      "description": "Intro text",
+      "type":"string"
+    },
+    "note":{
+      "description": "Notes text",
+      "type":"string"
+    },
+    "items":{
+      "description": "Line items for the document. The order matters.",
+      "type":"array",
+      "properties":{"$ref":"./item.json#properties"}
+    },
+    "sender":{
+      "description": "Document issuer",
+      "type":"object",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "recipient":{
+      "description": "Document receiver",
+      "type":"object",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "currency": {
+      "description": "ISO 4217 Currency Code",
+      "maxLength": 3,
+      "type":"string",
+      "required": true
+    },
+    "total":{
+      "description": "Gross and net total for all line items",
+      "type":"object",
+      "properties":{"$ref":"./amount.json#properties"}
+    },
+    "taxes":{
+      "description": "All taxes applied to all items",
+      "type":"array",
+      "properties":{"$ref":"./tax.json#properties"}
+    },
+    "discounts":{
+      "type":"array",
+      "properties":{"$ref":"./discount.json#properties"}
+    }
+  }
+}

data/schema/item.json

@@ -0,0 +1,41 @@
+{ "type":"object",
+  "title": "item",
+  "description": "An item belonging to a document",
+  "properties":{
+    "title":{
+      "description": "Product name or item title",
+      "type":"string",
+      "required": true
+    },
+    "description":{
+      "description": "Item or product description",
+      "type":"string"
+    },
+    "unit":{
+      "description": "Unit name",
+      "type":"string"
+    },
+    "quantity":{
+      "description": "Quantity for this item",
+      "type":"number",
+      "required": true
+    },
+    "unit_price":{
+      "description": "Single price for one item",
+      "type":"array",
+      "properties":{"$ref":"./amount.json#properties"},
+      "required": true
+    },
+    "total":{
+      "description": "Totals net and gross prices for the item",
+      "type":"object",
+      "properties":{"$ref":"./amount.json#properties"},
+      "required": true
+    },
+    "taxes":{
+      "description": "Taxes applied to the item",
+      "type":"array",
+      "properties":{"$ref":"./tax.json#properties"}
+    }
+  }
+}

data/schema/tax.json

@@ -0,0 +1,21 @@
+{ "type":"object",
+  "title": "tax",
+  "description": "An tax for an item of a document",
+  "properties":{
+    "name":{
+      "description": "tax name",
+      "type":"string",
+      "required": true
+    },
+    "rate":{
+      "description": "Tax rate in percent",
+      "type":"number",
+      "required": true
+    },
+    "amount":{
+      "description": "Tax total",
+      "type":"number",
+      "required": true
+    }
+  }
+}

data/spec/doctag_schema_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe DocTag::Schema do
+
+  context 'path' do
+    it 'should provide path to schema files' do
+      DocTag::Schema.path.should == File.expand_path( File.join('../schema'), File.dirname(__FILE__))
+    end
+  end
+
+  context 'read schemata' do
+
+    it 'should read all json files' do
+      SchemaTools.schema_path = DocTag::Schema.path
+      SchemaTools::Reader.read_all
+      SchemaTools::Reader.registry.should_not be_empty
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'json_schema_tools'
+require 'doctag_json_schema'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: doctag_json_schema
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schema_tools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: This is the formal description of the docTag document exchange format.
+  With docTag we(see Supporters) aim to simplify the exchange of documents e.g. invoices,
+  between services. Ruby users can use this gem with utility methods to load and test
+  the schema files.
+email: gl@salesking.eu
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- doctag_json_schema.gemspec
+- lib/doc_tag/schema.rb
+- lib/doc_tag/version.rb
+- lib/doctag_json_schema.rb
+- schema/address.json
+- schema/amount.json
+- schema/discount.json
+- schema/document.json
+- schema/item.json
+- schema/tax.json
+- spec/doctag_schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/docTag/doctag_json_schema
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -181409995259960853
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: DocTag API - JSON Schema
+test_files: []