fictium 0.2.0 → 0.3.0

data/lib/fictium/exporters/postman/v2_exporter/action_formatter.rb

@@ -0,0 +1,40 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class ActionFormatter
+        def format(action)
+          metadata_formatter.format(action, build_base(action))
+        end
+
+        private
+
+        def build_base(action)
+          {
+            id: "#{action.method} - #{action.full_path}",
+            name: action.summary,
+            description: action.description,
+            request: request_formatter.format(action.default_example),
+            response: format_responses(action)
+          }
+        end
+
+        def format_responses(action)
+          result = action.examples.map { |example| response_formatter.format(example) }
+          result.reject(&:blank?)
+        end
+
+        def request_formatter
+          @request_formatter ||= RequestFormatter.new
+        end
+
+        def response_formatter
+          @response_formatter ||= ResponseFormatter.new
+        end
+
+        def metadata_formatter
+          @metadata_formatter ||= MetadataFormatter.new
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/body_formatter.rb

@@ -0,0 +1,15 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class BodyFormatter
+        def format(http_subject, response: false)
+          body = http_subject[:body]
+          return if body.blank?
+          return body if response
+
+          { mode: 'raw', raw: body }
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/folder_formatter.rb

@@ -0,0 +1,27 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class FolderFormatter
+        def format(item_formatter, resource)
+          { name: resource.name }.tap do |result|
+            result[:description] = format_description(resource)
+            result[:item] = item_formatter.from_resource(resource)
+            metadata_formatter.format(resource, result)
+          end
+        end
+
+        private
+
+        def format_description(resource)
+          return resource.description if resource.description.present?
+
+          resource.summary
+        end
+
+        def metadata_formatter
+          @metadata_formatter ||= MetadataFormatter.new
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/header_formatter.rb

@@ -0,0 +1,15 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class HeaderFormatter
+        def format(http_subject)
+          [].tap do |header|
+            content = http_subject[:content_type]
+            header << { key: 'Content-Type', value: content } if content.present?
+            # TODO: Add the rest of the headers
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/info_formatter.rb

@@ -0,0 +1,26 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class InfoFormatter
+        POSTMAN_SCHEMA_URL = 'https://schema.getpostman.com/json/collection/v2.1.0/collection.json'.freeze
+
+        delegate :configuration, to: :Fictium
+        delegate :info, :postman, to: :configuration
+
+        def format(_document)
+          base_info.tap do |result|
+            result[:_postman_id] = postman.id if postman.id.present?
+            result[:description] = info.description if info.description.present?
+            result[:schema] = POSTMAN_SCHEMA_URL
+          end
+        end
+
+        private
+
+        def base_info
+          { name: info.title, version: info.version }
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/item_formatter.rb

@@ -0,0 +1,29 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class ItemFormatter
+        def format(document)
+          document.resources.map do |resource|
+            folder_formatter.format(self, resource)
+          end
+        end
+
+        def from_resource(resource)
+          resource.actions.map do |action|
+            action_formatter.format(action)
+          end
+        end
+
+        private
+
+        def folder_formatter
+          @folder_formatter ||= FolderFormatter.new
+        end
+
+        def action_formatter
+          @action_formatter ||= ActionFormatter.new
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/metadata_formatter.rb

@@ -0,0 +1,17 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class MetadataFormatter
+        FIELDS = %i[event variable auth].freeze
+
+        def format(subject, result)
+          FIELDS.each do |field|
+            value = subject.postman.public_send(field)
+            result[field] = value if value.present?
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/request_formatter.rb

@@ -0,0 +1,89 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class RequestFormatter
+        PATH_VARIABLE = /{(?<var>[A-Z_\-][A-Z0-9_\-]*)}/i.freeze
+
+        def format(example)
+          {}.tap do |result|
+            result.merge!(
+              url: format_url(example),
+              method: example.action.method.to_s.downcase,
+              description: example.action.description,
+              header: header_formatter.format(example.request)
+            )
+            add_optional_values(example, result)
+          end
+        end
+
+        private
+
+        def format_url(example)
+          {
+            raw: full_path(example),
+            host: [api_url],
+            path: format_path(example),
+            query: format_query(example),
+            variable: format_variable(example)
+          }
+        end
+
+        def full_path(example)
+          "#{api_url}#{convert_path(example.action)}#{query_params_for(example)}"
+        end
+
+        def convert_path(action)
+          action.full_path.gsub(PATH_VARIABLE, ':\k<var>')
+        end
+
+        def format_path(example)
+          path = convert_path(example.action).split('/')
+          path.shift
+          path
+        end
+
+        def query_params_for(example)
+          params = example.request[:query_parameters]
+          params.present? ? "?#{params.to_query}" : ''
+        end
+
+        def api_url
+          Fictium.configuration.postman.api_url
+        end
+
+        def format_query(example)
+          example.request[:query_parameters].map do |key, value|
+            result = { key: key, value: value }
+            description = example.action[:query][key] && example.action[:query][key][:description]
+            result[:description] = description if description.present?
+            result
+          end
+        end
+
+        def format_variable(example)
+          [].tap do |result|
+            example.action[:path].each do |name, _|
+              data = { id: name, key: name }
+              value = example.request[:path_parameters][name.to_sym]
+              data[:value] = value if value.present?
+              result << data
+            end
+          end
+        end
+
+        def add_optional_values(example, result)
+          body = body_formatter.format(example.request)
+          result[:body] = body if body.present?
+        end
+
+        def body_formatter
+          @body_formatter ||= BodyFormatter.new
+        end
+
+        def header_formatter
+          @header_formatter ||= HeaderFormatter.new
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter/response_formatter.rb

@@ -0,0 +1,50 @@
+module Fictium
+  module Postman
+    class V2Exporter
+      class ResponseFormatter
+        def format(example)
+          base_info_for(example).tap do |result|
+            body = body_formatter.format(example.response, response: true)
+            header = header_formatter.format(example.response)
+            result[:body] = body if body.present?
+            result[:header] = header if header.present?
+          end
+        end
+
+        private
+
+        def base_info_for(example)
+          status = example.response[:status]
+          formatted_status = format_status(status, example)
+          {
+            originalRequest: request_formatter.format(example),
+            responseTime: nil,
+            status: format_status(status, example),
+            name: formatted_status,
+            code: status
+          }
+        end
+
+        def request_formatter
+          @request_formatter ||= RequestFormatter.new
+        end
+
+        def body_formatter
+          @body_formatter ||= BodyFormatter.new
+        end
+
+        def header_formatter
+          @header_formatter ||= HeaderFormatter.new
+        end
+
+        def format_status(status, example)
+          postman.example_formatter.call(status, example)
+        end
+
+        def postman
+          Fictium.configuration.postman
+        end
+      end
+    end
+  end
+end

data/lib/fictium/exporters/postman/v2_exporter.rb

@@ -0,0 +1,61 @@
+require_relative 'v2_exporter/action_formatter'
+
+require_relative 'v2_exporter/info_formatter'
+require_relative 'v2_exporter/item_formatter'
+require_relative 'v2_exporter/metadata_formatter'
+
+require_relative 'v2_exporter/folder_formatter'
+
+require_relative 'v2_exporter/request_formatter'
+require_relative 'v2_exporter/response_formatter'
+require_relative 'v2_exporter/header_formatter'
+require_relative 'v2_exporter/body_formatter'
+
+module Fictium
+  module Postman
+    class V2Exporter
+      def export(document)
+        result = format_document(document)
+        validate!(result)
+        FileUtils.mkdir_p(File.dirname(export_file))
+        File.write(export_file, pretty_print? ? JSON.pretty_generate(result) : result.to_json)
+      end
+
+      private
+
+      def export_file
+        @export_file ||=
+          File.join(Fictium.configuration.export_path, 'postman', '2.1.0', 'collection.json')
+      end
+
+      def validate!(result)
+        JSON::Validator.validate!(schema, result)
+      end
+
+      def schema
+        @schema ||= JSON.parse(File.read(File.join(__dir__, 'schemas', '2.1.0.json')))
+      end
+
+      def pretty_print?
+        Fictium.configuration.pretty_print
+      end
+
+      def format_document(document)
+        data = { info: info_formatter.format(document), item: item_formatter.format(document) }
+        metadata_formatter.format(document, data)
+      end
+
+      def metadata_formatter
+        @metadata_formatter ||= MetadataFormatter.new
+      end
+
+      def info_formatter
+        @info_formatter ||= InfoFormatter.new
+      end
+
+      def item_formatter
+        @item_formatter ||= ItemFormatter.new
+      end
+    end
+  end
+end

data/lib/fictium/loader.rb

@@ -1,9 +1,11 @@
 require_relative 'configurations/configuration'
 require_relative 'configurations/info'
 require_relative 'configurations/api_blueprint'
+require_relative 'configurations/postman'
 
 require_relative 'evaluators/parameter_evaluator'
 require_relative 'evaluators/schema_evaluator'
+require_relative 'evaluators/postman_evaluator'
 
 require_relative 'poros/model'
 
@@ -12,8 +14,11 @@ require_relative 'poros/document'
 require_relative 'poros/example'
 require_relative 'poros/resource'
 
+require_relative 'poros/postman_metadata'
+
 # Require default (OpenApi v3) exporter
 require_relative 'exporters/open_api/v3_exporter'
 
 # Other exporters created by this gem
 require_relative 'exporters/api_blueprint_exporter'
+require_relative 'exporters/postman/v2_exporter'

data/lib/fictium/poros/model.rb

@@ -1,4 +1,7 @@
 module Fictium
   class Model
+    def postman
+      @postman ||= PostmanMetadata.new
+    end
   end
 end

data/lib/fictium/poros/postman_metadata.rb

@@ -0,0 +1,5 @@
+module Fictium
+  class PostmanMetadata
+    attr_accessor :event, :auth, :variable
+  end
+end

data/lib/fictium/rspec/autocomplete/example.rb

@@ -8,7 +8,7 @@ module Fictium
             example.response.merge!(
               status: response.status,
               body: response.body,
-              content_type: response.content_type,
+              content_type: response.media_type,
               header: filter_header(response.header.to_h)
             )
             process_http_request(example, response.request)
@@ -25,17 +25,23 @@ module Fictium
 
           def process_http_request(example, request)
             example.request ||= {}
-            example.request.merge!(
-              content_type: request.content_type,
-              body: request.body.string,
-              header: filter_header(request.headers.to_h)
-            )
+            example.request.merge!(process_base_request(request))
             extract_method(example, request)
             return unless example.default?
 
             autocomplete_params.extract_from_request(example.action, request)
           end
 
+          def process_base_request(request)
+            {
+              content_type: request.content_type,
+              body: request.body.string,
+              header: filter_header(request.headers.to_h),
+              path_parameters: request.path_parameters.except(:controller, :action),
+              query_parameters: request.query_parameters
+            }
+          end
+
           def extract_method(example, request)
             action = example.action
             action.method = request.method.downcase.to_sym if action.method.blank?

data/lib/fictium/rspec/resources.rb

@@ -35,6 +35,11 @@ module Fictium
         def resource_tags(*tags)
           metadata[:fictium_resource].tags += tags
         end
+
+        def postman_for(object, &block)
+          resource = metadata[:"fictium_#{object}"]
+          Fictium::PostmanEvaluator.new(resource).evaluate(&block)
+        end
       end
     end
   end

data/lib/fictium/version.rb

@@ -1,5 +1,5 @@
 module Fictium
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
   RAILS_MIN_VERSION = '>= 5.3'.freeze
   RAILS_MAX_VERSION = '< 6.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fictium
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ramiro Rojo
@@ -261,8 +261,10 @@ files:
 - lib/fictium/configurations/api_blueprint.rb
 - lib/fictium/configurations/configuration.rb
 - lib/fictium/configurations/info.rb
+- lib/fictium/configurations/postman.rb
 - lib/fictium/engine.rb
 - lib/fictium/evaluators/parameter_evaluator.rb
+- lib/fictium/evaluators/postman_evaluator.rb
 - lib/fictium/evaluators/schema_evaluator.rb
 - lib/fictium/exporters/api_blueprint_exporter.rb
 - lib/fictium/exporters/api_blueprint_exporter/action_formatter.rb
@@ -278,11 +280,23 @@ files:
 - lib/fictium/exporters/open_api/v3_exporter/param_formatter.rb
 - lib/fictium/exporters/open_api/v3_exporter/path_formatter.rb
 - lib/fictium/exporters/open_api/v3_exporter/path_generator.rb
+- lib/fictium/exporters/postman/schemas/2.1.0.json
+- lib/fictium/exporters/postman/v2_exporter.rb
+- lib/fictium/exporters/postman/v2_exporter/action_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/body_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/folder_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/header_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/info_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/item_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/metadata_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/request_formatter.rb
+- lib/fictium/exporters/postman/v2_exporter/response_formatter.rb
 - lib/fictium/loader.rb
 - lib/fictium/poros/action.rb
 - lib/fictium/poros/document.rb
 - lib/fictium/poros/example.rb
 - lib/fictium/poros/model.rb
+- lib/fictium/poros/postman_metadata.rb
 - lib/fictium/poros/resource.rb
 - lib/fictium/railtie.rb
 - lib/fictium/rspec.rb