rspec-rails-api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae80a5b196a345ad25674bfae11ae466c979f216cca68912d205eb856c7096b9
-  data.tar.gz: 5201f1632652b2a46a2b436272497d7f0dc345b5710a8f218cfc0f80ac51241c
+  metadata.gz: dd54b9e82ea28dd61a4741ed3bc758b6ea4fdefe58dc55e3d1034f7d21b66740
+  data.tar.gz: a619a33620956af983cb443a8ce2e591b34a449641d983760714f58f06096a8b
 SHA512:
-  metadata.gz: 52e87c17a14f52fbec2b85e5c37d0b3c20b6059a0d5592bf10d11bc092be10cb4cb183446328bd1fd1f6b766cd145516a1ce83965d3e6915e530d4dfc01e86c0
-  data.tar.gz: 8ce1bd90eb8c0c99ca561fa2410b41eb0d9492414283e926e9c60143b970a9a23b5e1abdb82e99d5f0be6b9647a0444502a5778560abb12a83f82aad205ba3a4
+  metadata.gz: ba2e3a9cb38a2cb9147994f4870c31fe610fbbab96bef8d9b1416f0e7d7d142478d0163a2d8fcac1fa453a419cc3b9c482b6dcc4ff7e3cf3e7b77ee9fdec1e93
+  data.tar.gz: 6bcd3b295c0e56c5e429ebae3cb84086cbfeb0ca10172f397f4de436061b242248c1cbb1e2841103b3ef8ad1261f3d11604634f35ea9f54a1683922069c98978

data/README.md

@@ -37,14 +37,22 @@ RSpec.configure do |config|
   config.include Rspec::Rails::Api::DSL::Example
 end
 
-renderer = Rspec::Rails::Api::OpenApiRenderer.new
+renderer = RSpec::Rails::Api::OpenApiRenderer.new
+renderer.api_servers = [{ url: 'https://example.com' }]
+renderer.api_title = 'A nice API for a nice application'
+renderer.api_version = '1'
+renderer.api_description = 'Access update data in this project'
+# renderer.api_tos = 'http://example.com/tos.html'
+# renderer.api_contact = { name: 'Admin', email: 'admin@example.com', 'http://example.com/contact' } 
+# renderer.api_license = { name: 'Apache', url: 'https://opensource.org/licenses/Apache-2.0' }
 
 RSpec.configuration.after(:context, type: :acceptance) do |context|
   renderer.merge_context context.class.metadata[:rrad].to_h
 end
 
 RSpec.configuration.after(:suite) do
-  renderer.write_files
+  # Default path is 'tmp/rspec_rails_api_output.json/yaml'
+  renderer.write_files Rails.root.join('public', 'swagger_doc'), only: :json
 end
 ```
 

data/lib/rspec/rails/api/open_api_renderer.rb

@@ -14,16 +14,17 @@ module RSpec
       #   renderer.write_files
       #   ```
       class OpenApiRenderer # rubocop:disable Metrics/ClassLength
+        attr_writer :api_servers, :api_title, :api_version, :api_description, :api_tos
+
         def initialize
-          @metadata = {
-            resources: {},
-            entities:  {},
-          }
+          @metadata = { resources: {}, entities: {} }
           @api_infos = {}
           @api_servers = {}
           @api_paths = {}
           @api_components = {}
           @api_tags       = []
+          @api_contact    = {}
+          @api_license    = {}
         end
 
         def merge_context(context)
@@ -31,10 +32,15 @@ module RSpec
           @metadata[:entities].deep_merge! context[:entities]
         end
 
-        def write_files
+        def write_files(path = nil, only: %i[yaml json])
           content = prepare_metadata
-          File.write ::Rails.root.join('tmp', 'out.yaml'), content.to_yaml
-          File.write ::Rails.root.join('tmp', 'out.json'), content.to_json
+          path ||= ::Rails.root.join('tmp', 'rspec_api_rails')
+
+          only.each do |type|
+            next unless %i[yaml json].include? type
+
+            File.write "#{path}.#{type}", content.send("to_#{type}")
+          end
         end
 
         def prepare_metadata
@@ -50,12 +56,23 @@ module RSpec
           }.deep_stringify_keys
         end
 
+        def api_contact=(name: nil, email: nil, url: nil)
+          @api_contact[:name]  = name if name
+          @api_contact[:email] = email if email
+          @api_contact[:url]   = url if url
+        end
+
+        def api_license=(name: nil, url: nil)
+          @api_license[:name] = name if name
+          @api_license[:url] = url if url
+        end
+
         private
 
         def extract_metadatas
           extract_from_resources
-          extract_api_infos
-          extract_api_servers
+          api_infos
+          api_servers
         end
 
         def extract_from_resources
@@ -97,7 +114,7 @@ module RSpec
           parameters
         end
 
-        def process_path_param(name, param) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def process_path_param(name, param) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
           parameter = {
             name:        name.to_s,
             description: param[:description],
@@ -144,7 +161,6 @@ module RSpec
 
           action
         end
-
         # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
         def process_request_body(schema: nil, ref: nil)
@@ -186,26 +202,21 @@ module RSpec
           string.downcase.gsub(/[^\w]+/, '_')
         end
 
-        def extract_api_infos # rubocop:disable Metrics/MethodLength
+        def api_infos # rubocop:disable Metrics/CyclomaticComplexity
           @api_infos = {
-            title:          'Some sample app',
-            version:        '1.0',
-            description:    'A nice API',
-            termsOfService: 'https://example.com/tos',
-            contact:        {
-              name:  'API Team',
-              email: 'api-team@example.com',
-              url:   'http://example.com',
-            },
-            license:        {
-              name: 'Apache 2',
-              url:  'https://url-to-license.com',
-            },
+            title:   @api_title || 'Some sample app',
+            version: @api_version || '1.0',
           }
+          @api_infos[:description]    = @api_description if @api_description
+          @api_infos[:termsOfService] = @api_tos if @api_tos
+          @api_infos[:contact]        = @api_contact if @api_contact[:name]
+          @api_infos[:license]        = @api_license if @api_license[:name]
+
+          @api_infos
         end
 
-        def extract_api_servers
-          @api_servers = [
+        def api_servers
+          @api_servers || [
             { url: 'http://api.example.com' },
           ]
         end

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.1.2'
+      VERSION = '0.1.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2019-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport