apigen 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfbf6481fb12ed2ad6769d683f3fca04602dd9047f5f08f985754c2f54459db2
-  data.tar.gz: bf0079b8ff759121cb989d0e356a38807b37e18d3c614cbbd94b312a085044b1
+  metadata.gz: 006430db0df68e00b9c45b68417ba25b164037f1d66489ceec9d1cfdf7c79af8
+  data.tar.gz: ef50f03eeda9c321c5dd5edc50d73667270d4093dbe5bcfcd20ddd25f97c38e5
 SHA512:
-  metadata.gz: 180193f20b5136144f76cef36e8e920cf7cbce38c75bca0f88f728a7639a5a7148cab198ba4add60bf244d7cfa8ccbc6ecd5ddd97aca97c25459c0bd1a6e3d0d
-  data.tar.gz: ace74867bbcea6a41403a36f32705934f9182160917064e02334d5776ac9e6020e3d967b170b71709ea7ce7ff9bc3b866e59e64b04bc10645e47a61b8efbddb6
+  metadata.gz: e6feb9c9da7a4836d7346ef3b4c0d3656be2fc8889b8683c3ad0fe3aa039c141c1a9e751b8bb9117be2fc9d080b0612f6f247173a0440e76daa620c4fc6f3793
+  data.tar.gz: 8f9e6ccef15d032e15d38780ceca12b86cf49a947afdf4a431add3fa67c414bcdb6d54aa0f1dcf3a6a9246599e82d9e26a8fbf7df48a6ad4cf2fa314c94170f4

data/lib/apigen/formats/json_base.rb

@@ -18,8 +18,8 @@ module Apigen
 
       def schema(api, type, description = nil, example = nil)
         schema = schema_without_description(api, type)
-        schema['description'] = description unless description.nil?
-        schema['example'] = example unless example.nil?
+        add_description(schema, description)
+        add_example(schema, example)
         schema
       end
 
@@ -101,6 +101,14 @@ module Apigen
         end
       end
 
+      def add_description(hash, description)
+        hash['description'] = description unless description.nil?
+      end
+
+      def add_example(hash, example)
+        hash['example'] = example unless example.nil?
+      end
+
       def reference_schema(reference_type)
         { '$ref' => model_ref(reference_type.model_name) }
       end

data/lib/apigen/formats/openapi.rb

@@ -54,7 +54,7 @@ module Apigen
                 'parameters' => parameters,
                 'responses' => responses
               }
-              operation['description'] = endpoint.description unless endpoint.description.nil?
+              add_description(operation, endpoint.description)
               operation['requestBody'] = input(api, endpoint.input) if endpoint.input
               hash[endpoint.path] ||= {}
               hash[endpoint.path][endpoint.method.to_s] = operation
@@ -69,8 +69,8 @@ module Apigen
               'required' => true,
               'schema' => schema(api, property.type)
             }
-            parameter['description'] = property.description unless property.description.nil?
-            parameter['example'] = property.example unless property.example.nil?
+            add_description(parameter, property.description)
+            add_example(parameter, property.example)
             parameter
           end
 
@@ -81,8 +81,8 @@ module Apigen
               'required' => property.required?,
               'schema' => schema(api, property.type)
             }
-            parameter['description'] = property.description unless property.description.nil?
-            parameter['example'] = property.example unless property.example.nil?
+            add_description(parameter, property.description)
+            add_example(parameter, property.example)
             parameter
           end
 
@@ -95,15 +95,15 @@ module Apigen
                 }
               }
             }
-            parameter['description'] = property.description unless property.description.nil?
-            parameter['example'] = property.example unless property.example.nil?
+            add_description(parameter, property.description)
+            add_example(parameter, property.example)
             parameter
           end
 
           def response(api, output)
             response = {}
-            response['description'] = output.description unless output.description.nil?
-            response['example'] = output.example unless output.example.nil?
+            add_description(response, output.description)
+            add_example(response, output.example)
             if output.type != Apigen::PrimaryType.new(:void)
               response['content'] = {
                 'application/json' => {

data/lib/apigen/formats/swagger.rb

@@ -16,18 +16,7 @@ module Apigen
             # TODO: Allow overriding any of the hardcoded elements.
             {
               'swagger' => '2.0',
-              'info' => {
-                'version' => '1.0.0',
-                'title' => 'API',
-                'description' => api.description,
-                'termsOfService' => '',
-                'contact' => {
-                  'name' => ''
-                },
-                'license' => {
-                  'name' => ''
-                }
-              },
+              'info' => info(api),
               'host' => 'localhost',
               'basePath' => '/',
               'schemes' => %w[
@@ -47,6 +36,21 @@ module Apigen
 
           private
 
+          def info(api)
+            {
+              'version' => '1.0.0',
+              'title' => 'API',
+              'description' => api.description,
+              'termsOfService' => '',
+              'contact' => {
+                'name' => ''
+              },
+              'license' => {
+                'name' => ''
+              }
+            }
+          end
+
           def paths(api)
             hash = {}
             api.endpoints.each do |endpoint|
@@ -60,7 +64,7 @@ module Apigen
                 'parameters' => parameters,
                 'responses' => responses
               }
-              hash[endpoint.path][endpoint.method.to_s]['description'] = endpoint.description unless endpoint.description.nil?
+              add_description(hash[endpoint.path][endpoint.method.to_s], endpoint.description)
             end
             hash
           end
@@ -88,15 +92,15 @@ module Apigen
               'required' => true,
               'schema' => schema(api, property.type)
             }
-            parameter['description'] = property.description unless property.description.nil?
-            parameter['example'] = property.example unless property.example.nil?
+            add_description(parameter, property.description)
+            add_example(parameter, property.example)
             parameter
           end
 
           def response(api, output)
             response = {}
-            response['description'] = output.description unless output.description.nil?
-            response['example'] = output.example unless output.example.nil?
+            add_description(response, output.description)
+            add_example(response, output.example)
             response['schema'] = schema(api, output.type) if output.type != Apigen::PrimaryType.new(:void)
             [output.status.to_s, response]
           end

data/lib/apigen/migration.rb

@@ -19,8 +19,12 @@ module Apigen
 
     def update_endpoint(name, &block)
       endpoint = @api.endpoints.find { |e| e.name == name }
-      raise "No such endpoint #{name}." unless endpoint
-      raise 'You must pass a block when calling `update_endpoint`.' unless block_given?
+      error = if !endpoint
+                "No such endpoint #{name}."
+              elsif !block_given?
+                'You must pass a block when calling `update_endpoint`.'
+              end
+      raise error unless error.nil?
       endpoint.instance_eval(&block)
     end
 
@@ -39,8 +43,12 @@ module Apigen
 
     def update_model(name, &block)
       model = @api.models[name]
-      raise "No such model :#{name}." unless model
-      raise 'You must pass a block when calling `update_model`.' unless block_given?
+      error = if !model
+                "No such model :#{name}."
+              elsif !block_given?
+                'You must pass a block when calling `update_model`.'
+              end
+      raise error unless error.nil?
       model.instance_eval(&block)
     end
 

data/lib/apigen/models/model.rb

@@ -28,7 +28,8 @@ module Apigen
       @type = Model.type shape, &block
     end
 
-    def self.type(shape, &block)
+    def self.type(shape = nil, &block)
+      return type if shape.nil?
       case shape
       when :object
         object = ObjectType.new
@@ -61,8 +62,12 @@ module Apigen
     end
 
     def validate(model_registry)
-      raise 'One of the models is missing a name.' unless @name
-      raise "Use `type :model_type [block]` to assign a type to :#{@name}." unless @type
+      error = if !@name
+                'One of the models is missing a name.'
+              elsif !@type
+                "Use `type :model_type [block]` to assign a type to :#{@name}."
+              end
+      raise error unless error.nil?
       model_registry.check_type @type
     end
 

data/lib/apigen/models/object_type.rb

@@ -25,8 +25,7 @@ module Apigen
 
     # rubocop:disable Style/MethodMissingSuper
     def method_missing(property_name, property_shape, &block)
-      raise "Property :#{property_name} is defined multiple times." if @properties.key? property_name
-      raise "Property type must be a symbol, found #{property_shape}." unless property_shape.is_a? Symbol
+      ensure_correctness(property_name, property_shape)
       if property_shape.to_s.end_with? '?'
         property_shape = property_shape[0..-2].to_sym
         required = false
@@ -64,6 +63,15 @@ module Apigen
 
     private
 
+    def ensure_correctness(property_name, property_shape)
+      error = if @properties.key? property_name
+                "Property :#{property_name} is defined multiple times."
+              elsif !property_shape.is_a? Symbol
+                "Property type must be a symbol, found #{property_shape}."
+              end
+      raise error unless error.nil?
+    end
+
     def property_repr(indent, key, property)
       type_repr = if property.type.respond_to? :repr
                     property.type.repr(indent + '  ')

data/lib/apigen/models/oneof_type.rb

@@ -24,10 +24,21 @@ module Apigen
 
     def validate(model_registry)
       @mapping.each do |key, value|
-        raise 'Mapping keys must be model names (use symbols).' unless key.is_a? Symbol
-        raise 'Mapping values must be strings.' unless value.is_a? String
-        raise "No such model :#{key} for oneof mapping." unless model_registry.models.key? key
+        validate_mapping_item(model_registry, key, value)
       end
     end
+
+    private
+
+    def validate_mapping_item(model_registry, key, value)
+      error = if !(key.is_a? Symbol)
+                'Mapping keys must be model names (use symbols).'
+              elsif !(value.is_a? String)
+                'Mapping values must be strings.'
+              elsif !(model_registry.models.key? key)
+                "No such model :#{key} for oneof mapping."
+              end
+      raise error unless error.nil?
+    end
   end
 end

data/lib/apigen/models/registry.rb

@@ -13,9 +13,13 @@ module Apigen
     end
 
     def model(name, &block)
-      raise "Model :#{name} is declared twice." if @models.key? name
+      error = if @models.key? name
+                "Model :#{name} is declared twice."
+              elsif !block_given?
+                'You must pass a block when calling `model`.'
+              end
+      raise error unless error.nil?
       model = Apigen::Model.new name
-      raise 'You must pass a block when calling `model`.' unless block_given?
       model.instance_eval(&block)
       @models[model.name] = model
     end

data/lib/apigen/rest/api.rb

@@ -33,10 +33,14 @@ module Apigen
       ##
       # Declares a specific endpoint.
       def endpoint(name, &block)
-        raise "Endpoint :#{name} is declared twice." if @endpoints.find { |e| e.name == name }
+        error = if @endpoints.find { |e| e.name == name }
+                  "Endpoint :#{name} is declared twice."
+                elsif !block_given?
+                  'You must pass a block when calling `endpoint`.'
+                end
+        raise error unless error.nil?
         endpoint = Endpoint.new name
         @endpoints << endpoint
-        raise 'You must pass a block when calling `endpoint`.' unless block_given?
         endpoint.instance_eval(&block)
       end
 

data/lib/apigen/rest/endpoint.rb

@@ -128,23 +128,34 @@ module Apigen
       end
 
       def validate_properties
-        raise 'One of the endpoints is missing a name.' unless @name
-        raise "Use `method :get/post/put/delete` to set an HTTP method for :#{@name}." unless @method
-        raise "Use `path \"/some/path\"` to assign a path to :#{@name}." unless @path
+        error = if !@name
+                  'One of the endpoints is missing a name.'
+                elsif !@method
+                  "Use `method :get/post/put/delete` to set an HTTP method for :#{@name}."
+                elsif !@path
+                  "Use `path \"/some/path\"` to assign a path to :#{@name}."
+                end
+        raise error unless error.nil?
       end
 
       def validate_input(model_registry)
         case @method
         when :put, :post
-          raise "Use `input { type :typename }` to assign an input type to :#{@name}." unless @input
-          @input.validate(model_registry)
-        when :get
-          raise "Endpoint :#{@name} with method GET cannot accept an input payload." if @input
-        when :delete
-          raise "Endpoint :#{@name} with method DELETE cannot accept an input payload." if @input
+          validate_required_input(model_registry)
+        when :get, :delete
+          validate_forbidden_input
         end
       end
 
+      def validate_required_input(model_registry)
+        raise "Use `input { type :typename }` to assign an input type to :#{@name}." unless @input
+        @input.validate(model_registry)
+      end
+
+      def validate_forbidden_input
+        raise "Endpoint :#{@name} with method #{@method.to_s.upcase} cannot accept an input payload." if @input
+      end
+
       def validate_path_parameters(model_registry)
         @path_parameters.validate model_registry
       end

data/lib/apigen/rest/output.rb

@@ -36,9 +36,14 @@ module Apigen
       private
 
       def validate_properties
-        raise 'One of the outputs is missing a name.' unless @name
-        raise "Use `status [code]` to assign a status code to :#{@name}." unless @status
-        raise "Use `type :typename` to assign a type to :#{@name}." unless @type
+        error = if !@name
+                  'One of the outputs is missing a name.'
+                elsif !@status
+                  "Use `status [code]` to assign a status code to :#{@name}."
+                elsif !@status
+                  "Use `type :typename` to assign a type to :#{@name}."
+                end
+        raise error unless error.nil?
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apigen
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Francois Wouts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies: []
 description: A simple DSL to generate OpenAPI and/or JSON Schema definitions in Ruby.
 email: f@zenc.io