minimum-term 0.2.0

data/lib/minimum-term/publish_contract.rb

@@ -0,0 +1,22 @@
+require 'minimum-term/contract'
+
+module MinimumTerm
+  class PublishContract < MinimumTerm::Contract
+
+    def errors
+      return [] unless @comparator
+      @comparator.errors
+    end
+
+    def satisfies?(consumer)
+      @comparator = Compare::JsonSchema.new(@schema)
+      @comparator.contains?(consumer.consume.schema)
+    end
+
+    private
+
+    def object_description_class
+      MinimumTerm::PublishedObject
+    end
+  end
+end

data/lib/minimum-term/published_object.rb

@@ -0,0 +1,14 @@
+require 'minimum-term/object_description'
+
+module MinimumTerm
+  class PublishedObject < MinimumTerm::ObjectDescription
+
+    def publisher
+      @defined_in_service
+    end
+
+    def consumer
+      @defined_in_service
+    end
+  end
+end

data/lib/minimum-term/service.rb

@@ -0,0 +1,63 @@
+require 'active_support/core_ext/string'
+
+module MinimumTerm
+  # Models a service and its published objects as well as consumed
+  # objects. The app itself is part of an Infrastructure
+  class Service
+    attr_reader :infrastructure, :publish, :consume, :name, :errors
+
+    def initialize(infrastructure, data_dir)
+      @infrastructure = infrastructure
+      @data_dir = data_dir
+      @name = File.basename(data_dir).underscore
+      load_contracts
+    end
+
+    def consuming_from
+      consumed_objects.map(&:publisher)
+    end
+
+    def consumers
+      infrastructure.services.values.select do |service|
+        service.consuming_from.include?(self)
+      end
+    end
+
+    def consumed_objects(publisher = nil)
+      @consume.objects.select do |o|
+        publisher.blank? or o.publisher == publisher
+      end
+    end
+
+    def published_objects
+      @publish.objects
+    end
+
+    def satisfies?(service)
+      @publish.satisfies?(service)
+    end
+
+    def satisfies_consumers?(verbose: false)
+      @errors = {}
+      print "#{name.camelize} satisfies: " if verbose
+      consumers.each do |consumer|
+        @publish.satisfies?(consumer)
+        if @publish.errors.empty?
+          print "#{consumer.name.camelize}".green if verbose
+          next
+        end
+          print "#{consumer.name.camelize}".red if verbose
+        @errors["#{name} -> #{consumer.name}"] = @publish.errors
+      end
+      print "\n" if verbose
+      @errors.empty?
+    end
+
+    private
+
+    def load_contracts
+      @publish = MinimumTerm::PublishContract.new(self, File.join(@data_dir, "publish.schema.json"))
+      @consume = MinimumTerm::ConsumeContract.new(self, File.join(@data_dir, "consume.schema.json"))
+    end
+  end
+end

data/lib/minimum-term/tasks.rb

@@ -0,0 +1,66 @@
+require 'fileutils'
+
+module MinimumTerm
+  class Tasks
+    include Rake::DSL if defined? Rake::DSL
+
+    def install_tasks
+      namespace :minimum_term do
+        desc "Clean up intermediary json files"
+        task :cleanup do
+          path = File.expand_path("../contracts")
+          files = Dir.glob(File.join(path, "/**/*.schema.json")) +
+                  Dir.glob(File.join(path, "/**/*.blueprint-ast.json"))
+          files.each do |file|
+            FileUtils.rm_f(file)
+          end
+        end
+
+        desc "Transform all MSON files in DATA_DIR to JSON Schema using drafter"
+        task :mson_to_json_schema, [:keep_intermediary_files] => :cleanup do |t, args|
+          if ENV['DATA_DIR'].blank?
+            puts "Please set DATA_DIR for me to work in"
+            exit(-1)
+          end
+
+          data_dir = File.expand_path(ENV['DATA_DIR'])
+          unless Dir.exist?(data_dir)
+            puts "Not such directory: #{data_dir}"
+            exit(-1)
+          end
+
+          # For debugging it can be helpful to not clean up the
+          # intermediary blueprint ast files.
+          keep_intermediary_files = args.to_hash.values.include?('keep_intermediary_files')
+
+          # If we were given files, just convert those
+          files = ENV['FILES'].to_s.split(',')
+
+          # OK then, we'll just convert all we find
+          files = Dir.glob(File.join(data_dir, '**/*.mson')) if files.empty?
+
+          # That can't be right
+          if files.empty?
+            puts "No FILES given and nothing found in #{data_dir}"
+            exit(-1)
+          end
+
+          # Let's go
+          puts "Converting #{files.length} files:"
+
+          ok = true
+          files.each do |file|
+            ok = ok && MinimumTerm::Conversion.mson_to_json_schema(
+              filename: file,
+              keep_intermediary_files: keep_intermediary_files,
+              verbose: true)
+          end
+
+          exit(-1) unless ok
+        end
+      end
+    end
+  end
+ end
+
+MinimumTerm::Tasks.new.install_tasks

data/lib/minimum-term/version.rb

@@ -0,0 +1,3 @@
+module MinimumTerm
+  VERSION = '0.2.0'
+end

data/lib/minimum-term.rb

@@ -0,0 +1,10 @@
+require "minimum-term/conversion"
+require "minimum-term/publish_contract"
+require "minimum-term/consume_contract"
+require "minimum-term/service"
+require "minimum-term/infrastructure"
+require "minimum-term/compare/json_schema"
+
+module MinimumTerm
+  SCOPE_SEPARATOR = ':'
+end

data/minimum-term.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minimum-term/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minimum-term"
+  spec.version       = MinimumTerm::VERSION
+  spec.authors       = ["Jannis Hermanns"]
+  spec.email         = ["jannis@gmail.com"]
+
+  spec.summary       = 'Markdown publish/consume contract parser and validator'
+  spec.description   = 'Specify which objects your services publish or consume in MSON (markdown) and let this gem validate these contracts.'
+  spec.homepage      = "https://github.com/moviepilot/minimum-term"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = 'MIT'
+
+  spec.add_runtime_dependency "activesupport", ["~> 4.2"]
+  spec.add_runtime_dependency "rake",          ["~> 10.2"]
+  spec.add_runtime_dependency "json-schema",   ["~> 2.5"]
+  spec.add_runtime_dependency "colorize"
+
+  spec.add_development_dependency "bundler",             ["~> 1"]
+  spec.add_development_dependency "guard-bundler",       ["~> 2.1"]
+  spec.add_development_dependency "guard-ctags-bundler", ["~> 1.4"]
+  spec.add_development_dependency "guard-rspec",         ["~> 4.6"]
+  spec.add_development_dependency "rspec",               ["~> 3.3"]
+  spec.add_development_dependency "simplecov-rcov",      ["~> 0.2"]
+end

data/stuff/contracts/author/publish.mson

@@ -0,0 +1,20 @@
+# Data Structures
+
+Foo
+
+# Tag
+
+Guten Tag
+
+## Properties
+- id: 1 (number, required) - Foobar
+
+# Post
+
+Explanation for a post
+
+## Properties
+- id: 1 (number, required) - The unique identifier for a post
+- title: Work from home (string, required) - Title of the product
+- author: 2 (number, optional) - External user id of author
+- tags: (array[Tag])

data/stuff/contracts/edward/consume.mson

@@ -0,0 +1,7 @@
+# Data Structures
+
+## Author:Post
+
+- title: (string)
+- tag: (object)
+  - tagname: (string)

data/stuff/explore/blueprint.apib

@@ -0,0 +1,239 @@
+FORMAT: 1A
+HOST: http://api.moviepilot.com/
+
+# Edward
+
+# Status [/v2]
+
+We'll forward you to the v2 status resource
+
+## Retrieve the Entry Point [GET]
+
++ Response 200 (application/json; charset=utf-8)
+  + Body
+    + Attributes
+      - version: 5.2.1 (string, required) - Version number of currently deployed Edward
+      - server_time: `2015-08-11T08:19:41.556-07:00` (string, required) - Server's time
+      - user_id: 888448 (number, optional) - Requesting user's id
+
+## Group Posts
+
+Resources related to posts in the API.
+
+## Post [/v4/posts/{id}]
+
++ Parameters
+    + id: `3461151` (number, required) - External id
+
+### View a post [GET]
+
++ Response 200 (application/json; charset=utf-8)
+
+  + Body
+
+            {
+                "id": 3461151,
+                "slug": "it-would-not-have-cost-marketing-any-more-money-to-add-black-widow-on",
+                "title": "It would not have cost marketing any more money to add Black Widow on...",
+                "html_body": "<p>... the cover (or Hawkeye, for that matter). And would it not have been better to take the chance at one more sale by having her on than to lose a sale by not having her on?And don't say that the main characters would then have been smaller because they could have placed Black Widow to the left and behind or above the main characters without changing their relative size.</p>",
+                "total_comments_count": 0,
+                "created_at": "2015-08-11T06:23:50.000-07:00",
+                "questionnaire_id": null,
+                "template": null,
+                "abstract": null,
+                "keywords": null,
+                "cover_image_url": null,
+                "cover_image_caption": null,
+                "seo_title": null,
+                "social_title": null,
+                "social_abstract": null,
+                "suggested_facebook_page_id": "1525889887653500",
+                "comments_disabled": false,
+                "is_mobile_post": false,
+                "legacy_type": "post",
+                "og_image_url": "http://images-cdn.moviepilot.com/image/upload/v1431953404/pocket_post_big2_ct9cex.png",
+                "published_at": "2015-08-11T06:23:50.000-07:00",
+                "first_published_at": "2015-08-11T06:23:50.000-07:00",
+                "last_published_at": "2015-08-11T06:23:50.000-07:00",
+                "promoted": null,
+                "cover_video": {},
+                "view_count": 0,
+                "comment_count": 0,
+                "author": {
+                  "id": 1394326,
+                  "name": "Richard Lemay",
+                  "first_name": "Richard",
+                  "last_name": "Lemay",
+                  "user_name": null,
+                  "image_url": "https://graph.facebook.com/695180451/picture",
+                  "description": null,
+                  "followers_count": 1,
+                  "verified": "contributor",
+                  "user_subscription_count": 3,
+                  "weekly_readers": 0,
+                  "contributions_count": 1,
+                  "contribution_view_count": 0,
+                  "contribution_comments_count": 0,
+                  "facebook_id": "695180451",
+                  "twitter_handle": null,
+                  "location": null,
+                  "avatar_image_url": null,
+                  "cover_image_url": null,
+                  "provider_image_url": "https://graph.facebook.com/695180451/picture",
+                  "flags": [],
+                  "roles": [
+                    "contributor"
+                    ],
+                  "profile_public": true,
+                  "auto_promote_posts": true
+                },
+                "in_reply_to": {
+                  "id": 3457913,
+                  "type": "post",
+                  "first_published_at": "2015-08-10T07:02:09.000-07:00",
+                  "last_published_at": "2015-08-10T07:17:08.000-07:00",
+                  "slug": "black-widow-was-just-snubbed-by-marvel-again",
+                  "title": "Black Widow Was Just Snubbed by Marvel...AGAIN",
+                  "author": {
+                    "id": 1311215,
+                    "name": "Kit Simpson Browne",
+                    "user_name": "Kitsb"
+                  }
+                },
+                "related_objects": [
+                {
+                  "id": 205406,
+                  "type": "tag",
+                  "slug": "superheroes",
+                  "name": "Superheroes",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_237,t_mp_quality,w_600/-14cf0c53-33e1-41be-abb6-4490542ec6db.gif",
+                  "subscriber_count": 45802
+                },
+                {
+                  "id": 932254,
+                  "type": "tag",
+                  "slug": "marvel",
+                  "name": "Marvel",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_211,t_mp_quality,w_500/-76cc31d4-897f-486c-9dbb-8e22fd30cf1b.gif",
+                  "subscriber_count": 8627
+                },
+                {
+                  "id": 958506,
+                  "type": "tag",
+                  "slug": "casting",
+                  "name": "Casting",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_400,t_mp_quality,w_960/-364bed3a-81c7-4e44-8735-3500b536e23d.jpg",
+                  "subscriber_count": 668
+                },
+                {
+                  "id": 958518,
+                  "type": "tag",
+                  "slug": "opinion",
+                  "name": "Opinion",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_205,t_mp_quality,w_400/-f08c141c-387b-4dc2-a399-8aadd4084155.gif",
+                  "subscriber_count": 236
+                },
+                {
+                  "id": 958527,
+                  "type": "tag",
+                  "slug": "industry",
+                  "name": "Industry",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_235,t_mp_quality,w_416/-71298c11-8adb-4db0-8375-7d921f732dc2.gif",
+                  "subscriber_count": 9
+                },
+                {
+                  "id": 958545,
+                  "type": "tag",
+                  "slug": "rumors",
+                  "name": "Rumors",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_433,t_mp_quality,w_580/-b44f55e3-0f23-4192-bf77-de110b2f7f9a.gif",
+                  "subscriber_count": 178
+                },
+                {
+                  "id": 959395,
+                  "type": "tag",
+                  "slug": "creators",
+                  "name": "Creators",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_600,t_mp_quality,w_600/-10293491-38f3-4d79-a119-1897cd86c90a.jpg",
+                  "subscriber_count": 657
+                },
+                {
+                  "id": 959428,
+                  "type": "tag",
+                  "slug": "news",
+                  "name": "News",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_450,t_mp_quality,w_960/-e837b84b-712a-4c9a-8663-3117601c7856.jpg",
+                  "subscriber_count": 665
+                },
+                {
+                  "id": 960923,
+                  "type": "tag",
+                  "slug": "editorial",
+                  "name": "Editorial",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_300,t_mp_quality,w_500/-daff61f2-3d14-4c50-ac51-1ece761e6c71.gif",
+                  "subscriber_count": 60
+                },
+                {
+                  "id": 978148,
+                  "type": "tag",
+                  "slug": "dvd-blu-ray",
+                  "name": "DVD & Blu-ray",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_235,t_mp_quality,w_500/-c6dfb789-4d04-4810-a627-5cce20d77e19.gif",
+                  "subscriber_count": 27
+                },
+                {
+                  "id": 1070824,
+                  "type": "tag",
+                  "slug": "black-widow",
+                  "name": "Black Widow",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_380,t_mp_quality,w_920/-ee6baf50-8e27-491a-b2a5-4fbea6edfa2a.jpg",
+                  "subscriber_count": 1573
+                },
+                {
+                  "id": 1096390,
+                  "type": "tag",
+                  "slug": "mcu",
+                  "name": "Marvel Cinematic Universe",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_250,t_mp_quality,w_500/-f71691fc-3123-40ce-8b56-bc14a69f1527.gif",
+                  "subscriber_count": 2076
+                },
+                {
+                  "id": 1327911,
+                  "type": "tag",
+                  "slug": "plot",
+                  "name": "Plot",
+                  "image_url": "http://images-cdn.moviepilot.com/image/upload/c_fill,h_463,t_mp_quality,w_850/-ee8b3c7a-6017-4208-8753-0eeee8ba2c6c.png",
+                  "subscriber_count": 3
+                }
+              ]
+            }
+
+
+    + Attributes
+      - id: 3461151 (number, required) - Post's id
+      - slug: `it-would-not-have-cost-marketing-any-more-money-to-add-black-widow-on` (string, required) - Url slug
+      - title: `It would not have cost marketing any more money to add Black Widow on...` (string, required) - Title
+      - html_body: <p>foo</p> (string, required) - Full HTML Body
+      - total_comments_count: 0 (number, required) - Amount of comments
+      - created_at: 2015-08-11T06:23:50.000-07:00 (string, required) - ActiveRecord creation date
+      - questionnaire_id: null (number, optional) - Attached questionaire
+      - template: null (string, optional) - Not sure, perhaps a legacy type?
+      - abstract: null (string, optional) - Not used at the moment, this is from tarantula days
+      - keywords: null (string, optional)
+      - cover_image_url: null (string, optional)
+      - cover_image_caption: null (string, optional)
+      - seo_title: null (string, optional)
+      - social_title: null (string, optional)
+      - social_abstract: null (string, optional)
+      - suggested_facebook_page_id: "1525889887653500" (string, optional)
+      - comments_disabled: false (boolean, optional)
+      - is_mobile_post: false (boolean, optional)
+      - legacy_type: "post" (string, required)
+      - og_image_url: "http://images-cdn.moviepilot.com/image/upload/v1431953404/pocket_post_big2_ct9cex.png" (string, required)
+      - published_at: "2015-08-11T06:23:50.000-07:00" (string, required)
+      - first_published_at: "2015-08-11T06:23:50.000-07:00" (string, required)
+      - last_published_at: "2015-08-11T06:23:50.000-07:00" (string, required)
+      - promoted: null (string, optional)
+      - cover_video: {} (object, optional)
+      - view_count: 0 (number, required)
+      - comment_count: 0 (number, required)

data/stuff/explore/swagger.yaml

@@ -0,0 +1,139 @@
+# this is an example of the Uber API
+# as a demonstration of an API spec in YAML
+swagger: '2.0'
+info:
+  title: Moviepilot.com
+  description: Edward
+  version: "5.2.1"
+# the domain of the service
+host: api.moviepilot.com
+# array of all schemes that your API supports
+schemes:
+  - http
+# will be prefixed to all paths
+basePath: /v4
+produces:
+  - application/json
+paths:
+  /posts/{id}:
+    get:
+      summary: Post
+      description: |
+        Post including author information and so forth
+      parameters:
+        - name: id
+          in: path
+          description: External id.
+          required: true
+          type: number
+          format: integer
+      tags:
+        - Posts
+      responses:
+        200:
+          description: A post
+          schema:
+            type: object
+            properties:
+              id:
+                type: number
+              slug:
+                type: string
+              title:
+                type: string
+              html_body:
+                type: string
+              total_comments_count:
+                type: number
+              created_at:
+                type: string
+              questionnaire_id:
+                type: number
+              template:
+                type: string
+              abstract:
+                type: string
+              keywords:
+                type: array
+                items:
+                  type: string
+              cover_image_url:
+                type: string
+              cover_image_caption:
+                type: string
+              seo_title:
+                type: string
+              social_title:
+                type: string
+              social_abstract:
+                type: string
+              suggested_facebook_page_id:
+                type: string
+              comments_disabled:
+                type: boolean
+              is_mobile_post:
+                type: boolean
+              legacy_type:
+                type: string
+              og_image_url:
+                type: string
+              published_at:
+                type: string
+              first_published_at:
+                type: string
+              last_published_at:
+                type: string
+              promoted:
+                type: boolean
+              cover_video:
+                type: string
+              view_count:
+                type: number
+              comment_count:
+                type: number
+              author:
+                type: object
+              in_reply_to:
+                type: object
+                properties:
+                  id:
+                    type: number
+                  type:
+                    type: string
+                  first_published_at:
+                    type: string
+                  last_published_at:
+                    type: string
+                  slug:
+                    type: string
+                  title:
+                    type: string
+                  author:
+                    type: object
+                    properties:
+                      id:
+                        type: number
+                      name:
+                        type: string
+                      user_name:
+                        type: string
+              related_objects:
+                type: array
+                items:
+                  properties:
+                    id:
+                      type: number
+                    type:
+                      type: string
+                    slug:
+                      type: string
+                    name:
+                      type: string
+                    image_url:
+                      type: string
+                    subscriber_count:
+                      type: number
+            required:
+              - id
+              - title
+              - html_body

data/stuff/explore/test.apib

@@ -0,0 +1,14 @@
+FORMAT: 1A
+HOST: http://api.moviepilot.com/
+
+# Edward
+
+# Status [/v2]
+
+## GET
+
++ Response 200 (application/json)
+  + Body
+    + Attributes
+      - name: Mila (string, required) - Given name
+      - email: hello@max-and-mila.com (string, optional) - User's email