ropen_pi 0.1.1 → 0.4.0

data/lib/ropen_pi/config_helper.rb

@@ -35,6 +35,15 @@ module RopenPi
         .merge(opts)
     end
 
+    def self.param_in_header(name, schema_type, fmt: nil, desc: 'tba', opts: {})
+      param(name, schema_type, fmt: fmt, desc: desc, opts: opts)
+        .merge(
+          in: 'header',
+          required: false
+        )
+        .merge(opts)
+    end
+
     def self.param(name, schema_type, fmt: nil, desc: 'tba', opts: {})
       {
         name: name.to_s,
@@ -57,51 +66,60 @@ module RopenPi
         enum: values
       }
     end
+
+    class << self
+      alias boolean_param bool_param
+      alias integer_param int_param
+    end
   end
 
   module Type
-    def self.date_time_type(opts = {})
-      string_type(opts).merge(format: 'date-time', example: '2020-02-02')
+    def self.date_time_type(opts = { example: '2020-02-02' })
+      string_type(opts).merge(format: 'date-time')
     end
 
-    def self.email_type(opts = {})
-      string_type(opts).merge(format: 'email', example: 'han.solo@example.com')
+    def self.email_type(opts = { example: 'han.solo@example.com' })
+      string_type(opts).merge(format: 'email')
     end
 
-    def self.uuid_type(opts = {})
-      string_type(opts).merge(format: 'uuid', example: 'abcd12-1234ab-abcdef123')
+    def self.uuid_type(opts = { example: 'abcd12-1234ab-abcdef123' })
+      string_type(opts).merge(format: 'uuid')
     end
 
-    def self.string_type(opts = {})
-      type('string', opts).merge(example: 'Example string')
+    def self.string_type(opts = { example: 'Example string' })
+      type('string', opts)
     end
 
-    def self.integer_type(opts = {})
-      type('integer', opts).merge(example: 1)
+    def self.integer_type(opts = { example: 1 })
+      type('integer', opts)
     end
 
-    def self.bool_type(opts = {})
-      type('boolean', opts).merge(example: true)
+    def self.bool_type(opts = { example: true })
+      type('boolean', opts)
     end
 
     def self.type(thing, opts = {})
-      { type: thing.to_s }.merge(opts)
+      { type: thing }.merge(opts)
     end
 
     def self.string_array_type(opts = {})
       {
         type: 'array',
         items: { type: 'string', example: 'Example string' }
-       }.merge(opts)
+      }.merge(opts)
     end
 
     def self.ref_type(ref)
       { '$ref': ref }
     end
+
+    class << self
+      alias boolean_type bool_type
+      alias int_type integer_type
+    end
   end
 
   module Response
-    # rubocop:disable Metrics/MethodLength
     def self.collection(ref, desc: 'tba', type: RopenPi::APP_JSON)
       {
         description: desc,
@@ -109,7 +127,7 @@ module RopenPi
           type => {
             schema: {
               type: 'object',
-              properties: { data: { type: 'array', items: { '$ref': ref } } }
+              properties: { data: { type: :array, items: { '$ref': ref } } }
             }
           }
         }
@@ -129,6 +147,5 @@ module RopenPi
         }
       }
     end
-    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/ropen_pi/specs/configuration.rb

@@ -1,41 +1,45 @@
 # frozen_string_literal: true
+module RopenPi
+  module Specs
+    class Configuration
+      def initialize(rspec_config)
+        @rspec_config = rspec_config
+      end
 
-class RopenPi::Specs::Configuration
-  def initialize(rspec_config)
-    @rspec_config = rspec_config
-  end
+      def root_dir
+        @root_dir ||= begin
+          raise ConfigurationError, 'No root_dir provided. See open_api_helper.rb' if @rspec_config.root_dir.nil?
 
-  def root_dir
-    @root_dir ||= begin
-      raise ConfigurationError, 'No root_dir provided. See open_api_helper.rb' if @rspec_config.root_dir.nil?
+          @rspec_config.root_dir
+        end
+      end
 
-      @rspec_config.root_dir
-    end
-  end
+      def open_api_output_format
+        @open_api_output_format ||= begin
+          @rspec_config.open_api_output_format || :json
+        end
+      end
 
-  def open_api_output_format
-    @open_api_output_format ||= begin
-      @rspec_config.open_api_output_format || :json
-    end
-  end
+      def open_api_docs
+        @open_api_docs ||= begin
+          if @rspec_config.open_api_docs.nil? || @rspec_config.open_api_docs.empty?
+            raise ConfigurationError, 'No open_api_docs defined. See open_api_helper.rb'
+          end
 
-  def open_api_docs
-    @open_api_docs ||= begin
-      if @rspec_config.open_api_docs.nil? || @rspec_config.open_api_docs.empty?
-        raise ConfigurationError, 'No open_api_docs defined. See open_api_helper.rb'
+          @rspec_config.open_api_docs
+        end
       end
 
-      @rspec_config.open_api_docs
-    end
-  end
-
-  def get_doc(name)
-    return open_api_docs.values.first if name.nil?
+      def get_doc(name)
+        return open_api_docs.values.first if name.nil?
 
-    raise ConfigurationError, "Unknown doc '#{name}'" unless open_api_docs[name]
+        raise ConfigurationError, "Unknown doc '#{name}'" unless open_api_docs[name]
 
-    open_api_docs[name]
+        open_api_docs[name]
+      end
+    end
+    
+    class ConfigurationError < StandardError; end
   end
 end
 
-class ConfigurationError < StandardError; end

data/lib/ropen_pi/specs/example_group_helpers.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # @TODO: replace hashie!
 require 'hashie'
 
@@ -105,18 +106,19 @@ module RopenPi
       # rubocop:enable Metrics/MethodLength
 
       def request_body_text_plain(required: false, description: nil, examples: nil)
-        content_hash = { 'test/plain' => { schema: {type: :string}, examples: examples }.compact! || {} }
+        content_hash = { 'test/plain' => { schema: { type: :string }, examples: examples }.compact! || {} }
         request_body(description: description, required: required, content: content_hash)
       end
 
       # TODO: add examples to this like we can for json, might be large lift
       # as many assumptions are made on content-type
-      def request_body_xml(schema:,required: false, description: nil, examples: nil)
-        passed_examples = Array(examples)
+      def request_body_xml(schema:, required: false, description: nil, examples: nil)
+        # passed_examples = Array(examples)
         content_hash = { 'application/xml' => { schema: schema, examples: examples }.compact! || {} }
         request_body(description: description, required: required, content: content_hash)
       end
 
+      # rubocop:disable Metrics/MethodLength
       def request_body_multipart(schema:, description: nil)
         content_hash = { 'multipart/form-data' => { schema: schema } }
         request_body(description: description, content: content_hash)
@@ -145,6 +147,7 @@ module RopenPi
           end
         end
       end
+      # rubocop:enable Metrics/MethodLength
 
       def parameter(attributes)
         attributes[:required] = true if attributes[:in] && attributes[:in].to_sym == :path
@@ -165,7 +168,7 @@ module RopenPi
       end
 
       def schema(value, content_type: 'application/json')
-        content_hash = {content_type => {schema: value}}
+        content_hash = { content_type => { schema: value } }
         metadata[:response][:content] = content_hash
       end
 
@@ -173,7 +176,7 @@ module RopenPi
         metadata[:response][:headers] ||= {}
 
         if attributes[:type] && attributes[:schema].nil?
-          attributes[:schema] = {type: attributes[:type]}
+          attributes[:schema] = { type: attributes[:type] }
           attributes.delete(:type)
         end
 

data/lib/ropen_pi/specs/request_factory.rb

@@ -77,8 +77,8 @@ class RopenPi::Specs::RequestFactory
   def add_path(request, metadata, open_api_doc, parameters, example)
     template = (open_api_doc[:basePath] || '') + metadata[:path_item][:template]
 
-    in_path = parameters.select { |p| p[:in] == :path }
-    in_query = parameters.select { |p| p[:in] == :query }
+    in_path = parameters.select { |p| p[:in].to_sym == :path }
+    in_query = parameters.select { |p| p[:in].to_sym == :query }
 
     request[:path] = template.tap do |inner_template|
       in_path.each do |p|
@@ -161,7 +161,7 @@ class RopenPi::Specs::RequestFactory
     # Rails test infrastructure allows us to send the values directly as a hash
     # PROS: simple to implement, CONS: serialization/deserialization is bypassed in test
     tuples = parameters.select { |p| p[:in] == :formData }
-                        .map { |p| [p[:name], example.send(p[:name])] }
+                       .map { |p| [p[:name], example.send(p[:name])] }
     Hash[tuples]
   end
 

data/lib/ropen_pi/specs/writer.rb

@@ -9,10 +9,8 @@ module RopenPi::Specs
     end
 
     module Yml
-      require 'active_support/core_ext/hash/keys'
-
       def self.convert(doc)
-        doc.deep_stringify_keys.to_yaml
+        JSON.parse(Json.convert(doc)).to_yaml
       end
     end
 

data/lib/ropen_pi/version.rb

@@ -1,4 +1,4 @@
 module RopenPi
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.4.0'.freeze
   APP_JSON = 'application/json'.freeze
 end