prmd 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b88e4f305b59c16a0117cfb8a91f5fa890ed4431
-  data.tar.gz: a13809a6a6d33936359c7ab04248dd6d43a4b798
+  metadata.gz: f1daeca9c90d711692403468076030d0634b25e3
+  data.tar.gz: 76efedd3c3af5cbe612fb184e73e34b15bf69070
 SHA512:
-  metadata.gz: 705022feeb033937ef9c2c08257f9cd4daefd7ea369fe05dce114ced1af67305fcf2060c559ca60519e2d64ef0f0b1b5652e957c94c3e711f2cad773c3beec47
-  data.tar.gz: 2277f2883652417e4dbe0fd0064dea23997def5044622c641a1684ee537795c81f3c0ab54d6f79675006bf796f9e924d7ceec71e63150b59763c2e0c71599323
+  metadata.gz: e6eb7a54f6172d8098800ff3f61d61b7d1d139effb12ad4615a16686a2d18051fd1a0acfd492901005380a3348a73d2bdc3d402832b12618cc62c6e0a1fdb43e
+  data.tar.gz: 2ae5d2cbbecf6361f5287e1876ba7ac33f8ec72971f9897e1044e7473b33310ac67f3db3b9a2ff9490c7f6e7c979e0f6a8832297cc141290239f1f2bbf13b0a1

data/docs/schemata.md

@@ -141,6 +141,8 @@ Links that expect a custom http header MUST include the following attributes:
 }
 ```
 
+Links MAY specify a different serialization than defined in [properties](#properties) via `targetSchema`.
+
 ### `properties`
 
 Properties defines the attributes that exist in the serialization of the object.

data/lib/prmd/cli.rb

@@ -3,6 +3,7 @@ require_relative 'cli/combine'
 require_relative 'cli/doc'
 require_relative 'cli/generate'
 require_relative 'cli/render'
+require_relative 'cli/stub'
 require_relative 'cli/verify'
 
 # :nodoc:
@@ -17,6 +18,7 @@ module Prmd
         doc:     CLI::Doc.make_parser(props),
         init:    CLI::Generate.make_parser(props),
         render:  CLI::Render.make_parser(props),
+        stub:    CLI::Stub.make_parser(props),
         verify:  CLI::Verify.make_parser(props)
       }
     end
@@ -95,6 +97,8 @@ module Prmd
         CLI::Generate.run(argv, options)
       when :render
         CLI::Render.run(argv, options)
+      when :stub
+        CLI::Stub.run(argv, options)
       when :verify
         CLI::Verify.run(argv, options)
       end

data/lib/prmd/cli/generate.rb

@@ -18,6 +18,9 @@ module Prmd
 
         OptionParser.new do |opts|
           opts.banner = "#{binname} init [options] <resource name>"
+          opts.on('-t', '--template templates', String, 'Use alternate template') do |t|
+            yield :template, t
+          end
           opts.on('-y', '--yaml', 'Generate YAML') do |y|
             yield :yaml, y
           end

data/lib/prmd/cli/stub.rb

@@ -0,0 +1,45 @@
+require_relative 'base'
+
+module Prmd
+  module CLI
+    # 'stub' command module'
+    module Stub
+      extend CLI::Base
+
+      # Returns a OptionParser for parsing 'stub' command options.
+      #
+      # @param (see Prmd::CLI::Base#make_parser)
+      # @return (see Prmd::CLI::Base#make_parser)
+      def self.make_parser(options = {})
+        binname = options.fetch(:bin, 'prmd')
+
+        OptionParser.new do |opts|
+          opts.banner = "#{binname} stub [options] <combined schema>"
+        end
+      end
+
+      # Executes the 'stub' command.
+      #
+      # @example Usage
+      #   Prmd::CLI::Stub.execute(argv: ['schema/api.json'])
+      #
+      # @param (see Prmd::CLI::Base#execute)
+      # @return (see Prmd::CLI::Base#execute)
+      def self.execute(options = {})
+        require "committee"
+
+        filename = options.fetch(:argv).first
+        _, schema = try_read(filename)
+
+        app = Rack::Builder.new {
+          use Committee::Middleware::RequestValidation, schema: schema
+          use Committee::Middleware::ResponseValidation, schema: schema
+          use Committee::Middleware::Stub, schema: schema
+          run lambda { |_| [404, {}, ["Not found"]] }
+        }
+
+        Rack::Server.start(app: app)
+      end
+    end
+  end
+end

data/lib/prmd/commands/combine.rb

@@ -79,7 +79,16 @@ module Prmd
       base = Prmd::Template.load_json('combine_head.json')
       schema = base['$schema']
       meta = {}
-      meta = Prmd.load_schema_file(options[:meta]) if options[:meta]
+      filename = options[:meta]
+      meta = Prmd.load_schema_file(filename) if filename
+      if meta.nil? || meta.empty?
+        if filename
+          warn "Meta file (#{filename}) is empty, please fill it next time."
+        else
+          warn "Meta is empty, please fill it next time."
+        end
+        meta ||= {}
+      end
       combiner = Prmd::Combiner.new(meta: meta, base: base, schema: schema)
       combiner.combine(*schemata)
     end

data/lib/prmd/commands/init.rb

@@ -9,9 +9,21 @@ module Prmd
     # Creates a default Prmd::Generator using default templates
     #
     # @return [Prmd::Generator]
-    def self.make_generator
+    def self.make_generator(options)
       base = Prmd::Template.load_json('init_default.json')
-      template = Prmd::Template.load_template('init_resource.json.erb', '')
+      template_name = options.fetch(:template) do
+        abort 'render: Template was not provided'
+      end
+      if template_name && !template_name.empty?
+        template_dir = File.expand_path(template_name)
+        # to keep backward compatibility
+        template_dir = File.dirname(template_name) unless File.directory?(template_dir)
+        template_name = File.basename(template_name)
+      else
+        template_name = 'init_resource.json.erb'
+        template_dir  = ''
+      end
+      template = Prmd::Template.load_template(template_name, template_dir)
       Prmd::Generator.new(base: base, template: template)
     end
   end
@@ -22,7 +34,7 @@ module Prmd
   # @param [Hash<Symbol, Object>] options
   # @return [String] schema template in YAML (yaml option was enabled) else JSON
   def self.init(resource, options = {})
-    gen = Generate.make_generator
+    gen = Generate.make_generator(template: options[:template])
 
     generator_options = { resource: nil, parent: nil }
     if resource

data/lib/prmd/link.rb

@@ -1,3 +1,5 @@
+require 'ostruct'
+
 module Prmd
   class Link
     def initialize(link_schema)

data/lib/prmd/schema.rb

@@ -126,6 +126,8 @@ module Prmd
         else
           [schema_example(items)]
         end
+      elsif value.key?('enum')
+        value['enum'][0]
       elsif DefaultExamples.key?(value["format"])
         DefaultExamples[value["format"]]
       elsif DefaultExamples.key?(value["type"][0])

data/lib/prmd/templates/schemata/helper.erb

@@ -45,8 +45,7 @@
         end
         attributes.concat(nested)
 
-      # found an array with nested objects
-      elsif value['items'] 
+      elsif array_with_nested_objects?(value['items'])
         if value['items']['properties']
           nested = extract_attributes(schema, value['items']['properties'])
           nested.each do |attribute|
@@ -164,8 +163,8 @@
       else
         "`#{value['example'].to_json}`"
       end
-    elsif value['type'] == ['array'] && value.has_key?('items')
-      example = "`#{schema.schema_value_example(value)}`"
+    elsif (value['type'] == ['array'] && value.has_key?('items')) || value.has_key?('enum')
+      example = "`#{schema.schema_value_example(value).to_json}`"
     elsif value['type'].include?('null')
       example = "`null`"
     end
@@ -192,4 +191,9 @@
       end
     end
   end
+
+  def array_with_nested_objects?(items)
+    return unless items
+    items['properties'] || items['oneOf']
+  end
 %>

data/lib/prmd/version.rb

@@ -2,7 +2,7 @@
 module Prmd
   # Well, duh, its a Version module, what did you expect?
   module Version
-    MAJOR, MINOR, TEENY, PATCH = 0, 8, 0, nil
+    MAJOR, MINOR, TEENY, PATCH = 0, 9, 0, nil
     # version string
     # @return [String]
     STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.').freeze

data/schemas/interagent-hyper-schema.json

@@ -66,7 +66,7 @@
                 },
                 "properties": {
                     "patternProperties": {
-                        "^[a-z][a-z_]*[a-z]$": {
+                        "^[a-z][a-zA-Z_]*[a-zA-Z]$": {
                             "$ref": "#/definitions/resourceProperty"
                         }
                     },
@@ -107,18 +107,23 @@
         "resourceLink": {
             "properties": {
                 "href": {
-                    "pattern": "^(/([a-z0-9][a-z0-9_\\-]*[a-z0-9]|\\{\\(.*\\)\\}))+$"
+                    "pattern": "^(\/((?!-|_)[a-z0-9_\\-]+(?<!-|_)|\\{\\(.*\\)\\}))+$"
                 },
                 "schema": {
                     "anyOf": [
                         {
-                            "required": ["properties"]
+                            "$ref": "#/definitions/ref"
+                        },
+                        {
+                            "required": ["items", "type"]
+                        },
+                        {
+                            "required": ["properties", "type"]
                         },
                         {
-                            "required": ["patternProperties"]
+                            "required": ["patternProperties", "type"]
                         }
-                    ],
-                    "required": ["type"]
+                    ]
                 }
             },
             "required": ["description", "href", "method", "rel", "title"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prmd
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - geemus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -111,6 +111,7 @@ files:
 - lib/prmd/cli/doc.rb
 - lib/prmd/cli/generate.rb
 - lib/prmd/cli/render.rb
+- lib/prmd/cli/stub.rb
 - lib/prmd/cli/verify.rb
 - lib/prmd/commands.rb
 - lib/prmd/commands/combine.rb
@@ -207,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: JSON Schema tooling