apia-insomnia 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a1544a5b227ca74b2e3d239178e62f7aae387eb663fae30d2aafdf4058b5919
+  data.tar.gz: ca641e4c63a055b3e6c57fa3e17cd2381ce17601fc077d9188ba63366d2df1c6
+SHA512:
+  metadata.gz: 817d441b2dbddea0627a5127fe7feda72ec5b10e50278dabd819c8dde215c48039aa61096c7301f3113e7511841c548766a9b9f045d682644b9e0decc483d0b1
+  data.tar.gz: 2fb2c1c496f453435d85c514cf1256a88e881caaf9d513c2b326391026b90c638e48cc50327431847884c76181cbb6dc614d65a19cb674280c98be17d90088e4

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/apia-insomnia.rb

@@ -0,0 +1,7 @@
+# rubocop:disable Naming/FileName
+
+# frozen_string_literal: true
+
+require 'apia/insomnia/rack'
+
+# rubocop:enable Naming/FileName

data/lib/apia/insomnia/rack.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'apia/insomnia/schema'
+
+module Apia
+  module Insomnia
+    class Rack
+
+      def initialize(app, api, path, **options)
+        @app = app
+        @api = api
+        @path = "/#{path.sub(/\A\/+/, '').sub(/\/+\z/, '')}"
+        @options = options
+      end
+
+      def development?
+        env_is_dev = ENV['RACK_ENV'] == 'development'
+        return true if env_is_dev && @options[:development].nil?
+
+        @options[:development] == true
+      end
+
+      def api
+        return Object.const_get(@api) if @api.is_a?(String) && development?
+        return @cached_api ||= Object.const_get(@api) if @api.is_a?(String)
+
+        @api
+      end
+
+      def base_url
+        @options[:base_url] || 'https://api.example.com/api/v1'
+      end
+
+      def call(env)
+        if @options[:hosts]&.none? { |host| host == env['HTTP_HOST'] }
+          return @app.call(env)
+        end
+
+        unless env['PATH_INFO'] == @path
+          return @app.call(env)
+        end
+
+        schema = Schema.new(api, base_url)
+        body = schema.json
+
+        [200, { 'Content-Type' => 'application/json', 'Content-Length' => body.bytesize.to_s }, [body]]
+      end
+
+    end
+  end
+end

data/lib/apia/insomnia/schema.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Apia
+  module Insomnia
+    class Schema
+
+      def initialize(api, base_url)
+        @api = api
+        @base_url = base_url
+        @spec = {
+          '_type' => 'export',
+          '__export_format' => 3,
+          '__export__date' => Time.now.to_s,
+          'resources' => []
+        }
+        setup
+      end
+
+      def json
+        @spec.to_json
+      end
+
+      private
+
+      def setup
+        add_resource('workspace', '__WORKSPACE_ID__',
+                     name: @api.definition.name,
+                     description: @api.definition.description)
+
+        add_resource('environment', get_id('environment', @api),
+                     name: 'Default Environment',
+                     data: {
+                       base_url: @base_url,
+                       bearer_token: 'Add token here...'
+                      })
+
+        add_groups(@api.definition.route_set.groups)
+        add_requests(@api.definition.route_set.routes)
+      end
+
+      def add_groups(groups)
+        groups.sort_by(&:name).each_with_index do |group, index|
+          add_resource('request_group', get_id('folder', group), {
+            name: group.name,
+            parentId: get_id('folder', group.parent),
+            metaSortKey: index,
+            enivronment: {}
+          })
+          add_groups(group.groups) if group.groups
+        end
+        nil
+      end
+
+      def add_requests(routes)
+        routes.each do |route|
+          next unless route.endpoint.definition.schema?
+
+          hash = {
+            name: route.endpoint.definition.name,
+            description: route.endpoint.definition.description,
+            url: "{{ base_url }}/#{route.path}",
+            parentId: get_id('folder', route.group),
+            method: route.request_method.to_s.upcase
+          }
+
+          authenticator = route.endpoint.definition.authenticator ||
+                          route.controller&.definition&.authenticator ||
+                          @api.definition.authenticator
+
+          case authenticator&.definition&.type
+          when :bearer
+            hash[:authentication] = { type: 'bearer', token: '{{ bearer_token }}' }
+          end
+
+          if route.request_method == :get
+            hash[:parameters] = []
+            add_parameters_to_array(hash[:parameters], route.endpoint.definition.argument_set)
+
+          else
+            hash[:body] = { mimeType: 'application/json' }
+            hash[:headers] = [{ name: 'Content-Type', value: 'application/json' }]
+
+            body_arguments = {}
+            add_arguments_to_hash(body_arguments, route.endpoint.definition.argument_set)
+            hash[:body][:text] = JSON.pretty_generate(body_arguments)
+          end
+
+          add_resource('request', get_id('request', route), hash)
+        end
+      end
+
+      def add_parameters_to_array(array, set, prefix = '')
+        set.definition.arguments.each_value do |arg|
+          if arg.type.argument_set?
+            sub_array = []
+            add_parameters_to_array(sub_array, arg.type.klass, arg.name.to_s)
+            sub_array.each { |a| array << a }
+          else
+
+            if prefix.empty?
+              name_for_param = arg.name.to_s
+            else
+              name_for_param = prefix + "[#{arg.name}]"
+            end
+
+            param = {
+              name: name_for_param,
+              value: nil,
+              disabled: !arg.required?
+            }
+            array << param
+          end
+        end
+      end
+
+      def add_arguments_to_hash(hash, set)
+        set.definition.arguments.each_value do |arg|
+          name_for_hash = arg.name.to_s
+          hash[name_for_hash] = get_default_value_for_argument(arg)
+        end
+      end
+
+      def get_default_value_for_argument(argument)
+        if argument.type.argument_set? && argument.type.klass.definition.is_a?(Apia::Definitions::LookupArgumentSet)
+          {
+            argument.type.klass.definition.arguments.values.map(&:name).join('|') => ''
+          }
+        elsif argument.type.argument_set?
+          hash = {}
+          add_arguments_to_hash(hash, argument.type.klass)
+          hash
+        elsif argument.type.enum?
+          argument.type.klass.definition.values.keys.join(' | ')
+        end
+      end
+
+      def add_resource(type, id, options)
+        @spec['resources'] << {
+          '_type' => type,
+          '_id' => id
+        }.merge(options)
+      end
+
+      def get_id(prefix, object)
+        return nil if object.nil?
+
+        prefix = prefix.upcase
+
+        @ids ||= {}
+        @ids[prefix] ||= []
+        unless @ids[prefix].include?(object)
+          @ids[prefix] << object
+        end
+        id = @ids[prefix].index(object) + 1
+        "__#{prefix}_#{id}__"
+      end
+
+    end
+  end
+end

data/lib/apia/insomnia/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Apia
+  module Insomnia
+
+    VERSION_FILE_ROOT = File.expand_path('../../../VERSION', __dir__)
+    if File.file?(VERSION_FILE_ROOT)
+      VERSION = File.read(VERSION_FILE_ROOT).strip.sub(/\Av/, '')
+    else
+      VERSION = '0.0.0.dev'
+    end
+
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: apia-insomnia
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Raid schema generator for Insomnia.
+email:
+- adam@k.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/apia-insomnia.rb
+- lib/apia/insomnia/rack.rb
+- lib/apia/insomnia/schema.rb
+- lib/apia/insomnia/version.rb
+homepage: https://github.com/krystal/apia-insomnia
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: This gem provides a tool for generating an Insomnia compatible schema for
+  a Apia API.
+test_files: []