lacerda 0.3.0

data/lib/lacerda/conversion/apiary_to_json_schema.rb

@@ -0,0 +1,9 @@
+require 'lacerda/conversion/data_structure'
+
+module Lacerda
+  module Conversion
+    class ApiaryToJsonSchema
+
+    end
+  end
+end

data/lib/lacerda/conversion/data_structure.rb

@@ -0,0 +1,93 @@
+require 'active_support/core_ext/string'
+
+module Lacerda
+  module Conversion
+    class DataStructure
+      PRIMITIVES = %w{boolean string number array enum object}
+
+      def self.scope(scope, string)
+        [scope, string.to_s].compact.join(Lacerda::SCOPE_SEPARATOR).underscore
+      end
+
+      def initialize(id, data, scope = nil)
+        @scope = scope
+        @data = data
+        @id = self.class.scope(@scope, id)
+        @schema = json_schema_blueprint
+        @schema['title'] = @id
+        add_description_to_json_schema
+        add_properties_to_json_schema
+      end
+
+      def to_json
+        @schema
+      end
+
+      private
+
+      def add_description_to_json_schema
+        return unless @data['sections']
+        description = @data['sections'].select{|d| d['class'] == 'blockDescription' }.first
+        return unless description
+        @schema['description'] = description['content'].strip
+      end
+
+      def add_properties_to_json_schema
+        return unless @data['sections']
+        members = @data['sections'].select{|d| d['class'] == 'memberType' }.first['content'].select{|d| d['class'] == 'property' }
+        members.each do |s|
+          content = s['content']
+          type_definition = content['valueDefinition']['typeDefinition']
+          type = type_definition['typeSpecification']['name']
+
+          spec = {}
+          name = content['name']['literal'].underscore
+
+          # This is either type: primimtive or $ref: reference_name
+          spec.merge!(primitive_or_reference(type))
+
+          # We might have a description
+          spec['description'] = s['description']
+
+          # If it's an array, we need to pluck out the item types
+          if type == 'array'
+            nestedTypes = type_definition['typeSpecification']['nestedTypes']
+            spec['items'] = nestedTypes.map{|t| primitive_or_reference(t) }
+
+          # If it's an object, we need recursion
+          elsif type == 'object'
+            spec['properties'] = {}
+            content['sections'].select{|d| d['class'] == 'memberType'}.each do |data|
+              data_structure = DataStructure.new('tmp', content, @scope).to_json
+              spec['properties'].merge!(data_structure['properties'])
+            end
+          end
+
+          @schema['properties'][name] = spec
+          if attributes = type_definition['attributes']
+            @schema['required'] << name if attributes.include?('required')
+          end
+        end
+      end
+
+      def primitive_or_reference(type)
+	return { 'type' => 'object' } if type.blank?
+
+        if PRIMITIVES.include?(type)
+          { 'type' => type }
+        else
+          { '$ref' => "#/definitions/#{self.class.scope(@scope, type['literal'])}" }
+        end
+      end
+
+      def json_schema_blueprint
+        {
+          "type" => "object",
+          "properties" => {},
+          "required" => []
+        }
+      end
+
+    end
+  end
+end

data/lib/lacerda/conversion/error.rb

@@ -0,0 +1,7 @@
+module Lacerda
+  module Conversion
+    class Error < StandardError
+
+    end
+  end
+end

data/lib/lacerda/infrastructure.rb

@@ -0,0 +1,74 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module Lacerda
+  class Infrastructure
+    attr_reader :errors, :data_dir
+
+    def initialize(data_dir:, verbose: false)
+      @verbose = !!verbose
+      @data_dir = data_dir
+      @mutex1 = Mutex.new
+      @mutex2 = Mutex.new
+    end
+
+    def reload
+      @services = nil
+    end
+
+    def contracts_fulfilled?
+      @mutex1.synchronize do
+        @errors = {}
+        publishers.each do |publisher|
+          publisher.satisfies_consumers?(verbose: @verbose)
+          next if publisher.errors.empty?
+          @errors.merge! publisher.errors
+        end
+        @errors.empty?
+      end
+    end
+
+    def publishers
+      services.values.select do |service|
+        service.published_objects.length > 0
+      end
+    end
+
+    def consumers
+      services.values.select do |service|
+        service.consumed_objects.length > 0
+      end
+    end
+
+    def convert_all!(keep_intermediary_files = false)
+      json_files.each{ |file| FileUtils.rm_f(file) }
+      mson_files.each do |file|
+        Lacerda::Conversion.mson_to_json_schema!(
+          filename: file,
+          keep_intermediary_files: keep_intermediary_files,
+          verbose: @verbose)
+      end
+      reload
+    end
+
+    def mson_files
+      Dir.glob(File.join(@data_dir, "/**/*.mson"))
+    end
+
+    def json_files
+      Dir.glob(File.join(@data_dir, "/**/*.schema.json"))
+    end
+
+    def services
+      @mutex2.synchronize do
+        return @services if @services
+        @services = {}.with_indifferent_access
+        dirs = Dir.glob(File.join(@data_dir, "*/"))
+        dirs.each do |dir|
+          service = Lacerda::Service.new(self, dir)
+          @services[service.name] = service
+        end
+        @services
+      end
+    end
+  end
+end

data/lib/lacerda/object_description.rb

@@ -0,0 +1,34 @@
+# This represents a description of an Object (as it was in MSON and later
+# JSON Schema). It can come in two flavors:
+#
+#   1) A published object
+#   2) A consumed object
+#
+# A published object only refers to one servce:
+#
+#   - its publisher
+#
+# However, a consumed object is referring to two services:
+#
+#   - its publisher
+#   - its consumer
+#
+#
+module Lacerda
+  class ObjectDescription
+    attr_reader :service, :name, :schema
+    def initialize(defined_in_service, scoped_name, schema)
+      @defined_in_service = defined_in_service
+      @scoped_name = scoped_name
+      @name = remove_service_from_scoped_name(scoped_name)
+      @schema = schema
+    end
+
+    private
+
+    def remove_service_from_scoped_name(n)
+      n[n.index(Lacerda::SCOPE_SEPARATOR)+1..-1]
+    end
+
+  end
+end

data/lib/lacerda/publish_contract.rb

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

data/lib/lacerda/published_object.rb

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

data/lib/lacerda/service.rb

@@ -0,0 +1,63 @@
+require 'active_support/core_ext/string'
+
+module Lacerda
+  # 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).uniq
+    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 = Lacerda::PublishContract.new(self, File.join(@data_dir, "publish.schema.json"))
+      @consume = Lacerda::ConsumeContract.new(self, File.join(@data_dir, "consume.schema.json"))
+    end
+  end
+end

data/lib/lacerda/tasks.rb

@@ -0,0 +1,66 @@
+require 'fileutils'
+
+module Lacerda
+  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 && Lacerda::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
+
+Lacerda::Tasks.new.install_tasks

data/lib/lacerda/version.rb

@@ -0,0 +1,3 @@
+module Lacerda
+  VERSION = '0.3.0'
+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)