tent-schemas 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+output/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tent-schema.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonathan Rudenberg
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,19 @@
+# Tent Protocol Schemas
+
+This repository contains [JSON Schemas](http://json-schema.org/) for most of the
+[Tent Protocol](http://tent.io). Currently they are used to generate
+documentation examples. In the future they will also contain specifications for
+all API endpoints in Tent so that clients can be implemented/updated
+programmtically.
+
+Tent post and profile info types should also be implemented as JSON schemas, the
+schema for these definitions has yet to be defined.
+
+## Contributions
+
+Here are some things that need to be done:
+
+- Fix errors in the schemas.
+- Implement a version of JSON hyper schemas that defines API endpoints/actions.
+- Write a schema for post type schemas.
+- Write a schema for profile info type schemas.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require File.expand_path('../lib/tent-schemas', __FILE__)
+require 'fileutils'
+require 'json'
+require 'yaml'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test
+
+desc "Generate schema json"
+task :generate do
+  FileUtils.mkdir_p('output')
+  File.open("output/schema.json", 'w') { |f| f.write(JSON.pretty_generate(TentSchemas.schema)) }
+end

data/lib/tent-schemas.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module TentSchemas
+  extend self
+
+  def schema_files
+    Dir.glob(File.expand_path('../../schemas/*', __FILE__))
+  end
+
+  def schemas
+    @schemas ||= schema_files.inject(Hash.new { |h,k| h[k.to_s] }) { |hash,schema|
+      hash.merge(File.basename(schema, '.yaml') => YAML.load(File.read(schema)))
+    }
+  end
+
+  def each(&block)
+    schemas.each(&block)
+  end
+
+  def [](k)
+    schemas[k]
+  end
+
+  def schema
+    { 'schemas' => schemas }
+  end
+end

data/schemas/app.yaml

@@ -0,0 +1,56 @@
+title: Tent App
+type: object
+properties:
+  id:
+    description: The unique identifier of the app.
+    type: string
+  name:
+    description: The short display name for the app.
+    type: string
+    required: true
+  description:
+    description: The short display description of the app.
+    type: string
+    required: true
+  url:
+    descriptioon: The URL for the home page of the app.
+    type: string
+    format: uri
+    required: true
+  icon:
+    description: The URL to the icon for the app.
+    type: string
+    format: uri
+  redirect_uris:
+    description: 
+      The exact (including parameters) uris that will be used as OAuth
+      `redirect_uri`.
+    type: array
+    required: true
+    items:
+      type: string
+      format: uri
+  scopes:
+    description:
+      All of the scopes that the application will use, and the reason why each
+      is required.
+    required: true
+    patternProperties:
+      .+:
+        type: string
+  mac_algorithm:
+    description: The MAC algorithm to use when authenticating the app.
+    type: string
+    enum:
+      - hmac-sha-1
+      - hmac-sha-256
+  mac_key_id:
+    description: The MAC key identifier to use when authenticating the app.
+    type: string
+  mac_key:
+    description: The MAC key to use when authenticating the app.
+    type: string
+dependencies:
+  mac_key:
+    - mac_algorithm
+    - mac_key_id

data/schemas/app_authorization.yaml

@@ -0,0 +1,70 @@
+title: Tent App Authorization
+type: object
+properties:
+  id:
+    description: The unique identifier of the app authorization.
+    type: string
+  scopes:
+    description: The scopes that the authorization allows the app to access.
+    type: array
+    items:
+      type: string
+  profile_info_types:
+    description: The profile info types that the app has access to.
+    type: array
+    items:
+      type: string
+      format: uri
+  post_types:
+    description:
+      The post types that the app has access to and will receive notifications
+      for.
+    type: array
+    items:
+      type: string
+      format: uri
+  notification_url:
+    description:
+      The endpoint used to send post notifications to the app. The app will not
+      receive notifications if this is not set.
+    type: string
+    format: uri
+  follow_url:
+    description:
+      The endpoint to redirect the user to when requesting a follow. Used when
+      the app has the `follow_ui` scope.
+    type: string
+    format: uri
+  app_auth_url:
+    description:
+      The endpoint to redirect the user to when requesting an app auth. Used
+      when the app has the `app_auth_ui` scope.
+    type: string
+    format: uri
+  groups:
+    description: The groups that the app is in.
+    type: array
+    items:
+      $ref: '#/schemas/group'
+  token_type:
+    description: The type of `access_token` issued.
+    type: string
+    enum:
+      - mac
+  mac_algorithm:
+    description: The MAC algorithm to use when authenticating the app.
+    type: string
+    enum:
+      - hmac-sha-1
+      - hmac-sha-256
+  mac_key_id:
+    description: The MAC key identifier to use when authenticating the app.
+    type: string
+  access_token:
+    description: The MAC key to use when authenticating the app.
+    type: string
+dependencies:
+  access_token:
+    - mac_algorithm
+    - token_type
+    - mac_key_id

data/schemas/follow.yaml

@@ -0,0 +1,46 @@
+title: Tent Follow
+type: object
+properties:
+  id:
+    description: The unique identifier of the follow.
+    type: string
+  entity:
+    description: The entity that the follow refers to.
+    type: string
+    format: uri
+    required: true
+  groups:
+    description: The groups that the follow is in.
+    type: array
+    items:
+      $ref: '#/schemas/group'
+  types:
+    description: The types the follow is subscribed to notifications for.
+    type: array
+    items:
+      type: string
+      format: uri
+  licenses:
+    description: The licenses the follow uses in it's posts.
+    type: array
+    items:
+      type: string
+      format: uri
+  mac_algorithm:
+    description: The MAC algorithm to use when authenticating the follow.
+    type: string
+    enum:
+      - hmac-sha-1
+      - hmac-sha-256
+  mac_key_id:
+    description: The MAC key identifier to use when authenticating the follow.
+    type: string
+  mac_key:
+    description: The MAC key to use when authenticating the follow.
+    type: string
+  permissions:
+    $ref: '#/schemas/permissions'
+dependencies:
+  mac_key:
+    - mac_algorithm
+    - mac_key_id

data/schemas/group.yaml

@@ -0,0 +1,10 @@
+name: Tent Group
+type: object
+properties:
+  id:
+    description: The unique identifier of the group.
+    type: string
+  name:
+    description: The name of the group.
+    type: string
+    require: true

data/schemas/permissions.yaml

@@ -0,0 +1,23 @@
+name: Tent Permissions
+description: The permissions that apply to the instance.
+type: object
+properties:
+  public:
+    description:
+      Indicates whether the instance is public, public instances are available
+      to unauthenticated requests.
+    type: boolean
+    required: true
+  groups:
+    description: The groups that are allowed to view the instance.
+    type: array
+    items:
+      $ref: '#/schemas/group'
+  entities:
+    type: object
+    patternProperties:
+      .+:
+        description:
+          An entity identifier and boolean value that indicates whether the
+          entity is allowed to view the instance.
+        type: boolean

data/schemas/post.yaml

@@ -0,0 +1,127 @@
+title: Tent Post
+type: object
+properties:
+  id:
+    description: The unique identifier of the post.
+    type: string
+  entity:
+    description: The entity that published the post.
+    type: string
+    format: uri
+    required: true
+  published_at:
+    description: The date/time when the post was published in Unix time.
+    type: integer
+    required: true
+  received_at:
+    description:
+      The date/time when the post was received from the publishing server in
+      Unix time.
+    type: integer
+  mentions:
+    description: The entities and posts that this post mentions.
+    type: array
+    items:
+      type: object
+      properties:
+        entity:
+          description: The entity that is being mentioned.
+          type: string
+          format: uri
+          required: true
+        post:
+          description:
+            The unique post identifier published by the entity that is being
+            mentioned.
+          type: string
+  licenses:
+    description: The licenses that the post is released under.
+    type: array
+    required: true
+    items:
+      type: string
+      format: uri
+  type:
+    description:
+      The post type URL. This should resolve to a JSON Schema that describes
+      the data inside `content`.
+    type: string
+    format: uri
+    required: true
+  content:
+    description: The post content.
+    type: object
+    required: true
+  attachments:
+    description: Attachments to the post.
+    type: array
+    items:
+      type: object
+      properties:
+        category:
+          description:
+            The category this attachment is in, used to determine what to
+            include in a notification based on views.
+          type: string
+          required: true
+        type:
+          description: The media type of the attachment.
+          type: string
+          required: true
+        name:
+          description:
+            The name of the attachment. The name and media type combination are
+            the unique identifier for the attachment.
+          type: string
+          required: true
+        size:
+          description: The size in bytes of the attachment.
+          type: integer
+          required: true
+  app:
+    description: The application that published the post.
+    type: object
+    properties:
+      name:
+        description: The human readable name of the application.
+        type: string
+      url:
+        description: The URL of the application.
+        type: string
+        format: uri
+  views:
+    description: The available views of the post.
+    type: object
+    patternProperties:
+      .+:
+        type: object
+        properties:
+          content:
+            description:
+              An array of JSON pointers that point to keys inside of `content`
+              that should be included in this view.
+            type: array
+            items:
+              type: string
+          attachments:
+            description:
+              The attachments that should be included when making notifications
+              about this post. The `category`, `name`, and `type` specifier in
+              each object will be combined as an `OR` condition to select
+              attachments.
+            type: array
+            items:
+              type: object
+              properties:
+                category:
+                  description: The category of attachment.
+                  type: string
+                name:
+                  description: The name of the attachment
+                  type: string
+                type:
+                  description: The media type of the attachment.
+                  type: string
+
+  permissions:
+    $ref: '#/schemas/permissions'

data/schemas/profile.yaml

@@ -0,0 +1,6 @@
+title: Tent Profile
+type: object
+patternProperties:
+  .+:
+    description: A profile info type and its contents.
+    type: object

data/tent-schemas.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = 'tent-schemas'
+  gem.version       = '0.0.1'
+  gem.authors       = ['Jonathan Rudenberg']
+  gem.email         = ['jonathan@titanous.com']
+  gem.description   = 'Tent protocol JSON schemas'
+  gem.summary       = 'Tent protocol JSON schemas'
+  gem.homepage      = 'http://tent.io'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'json-schema'
+end

data/test/schemas_test.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require File.expand_path('../../lib/tent-schemas', __FILE__)
+require 'test/unit'
+require 'json-schema'
+require 'yaml'
+require 'json'
+
+class SchemasTest < Test::Unit::TestCase
+  TentSchemas.each do |name,schema|
+    define_method "test_#{name}" do
+      validate_schema(schema)
+    end
+  end
+
+  def validate_schema(schema)
+    errors = JSON::Validator.fully_validate_schema(schema)
+    assert errors.empty?, errors.inspect
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: tent-schemas
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Rudenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tent protocol JSON schemas
+email:
+- jonathan@titanous.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tent-schemas.rb
+- schemas/app.yaml
+- schemas/app_authorization.yaml
+- schemas/follow.yaml
+- schemas/group.yaml
+- schemas/permissions.yaml
+- schemas/post.yaml
+- schemas/profile.yaml
+- tent-schemas.gemspec
+- test/schemas_test.rb
+homepage: http://tent.io
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Tent protocol JSON schemas
+test_files:
+- test/schemas_test.rb