rspec_api_docs 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ce20a3a723a208098abb0c4a8fa188281097892
-  data.tar.gz: 49a7abd2d8a068bad4557d17afce34f25e199d15
+  metadata.gz: 8ec7c0ef83d3f6f2707a9c107495e711f807f1f0
+  data.tar.gz: 5abb86689a0fdfcf3e5e4bbaf0c5a6058e29f55d
 SHA512:
-  metadata.gz: 8cf2776787063db78c086a0838b1826799f2d1c351ef4cb08ef1d4ef12ae5228a1271fb64aaf48fd2b47a98650f05291c354705038c819843e293fe458c62d1a
-  data.tar.gz: 61955f7a1aa76a0852050e48847b768bd8226f96f41aeeb42b868ddca1f7cd6c27e5e390c6d04fafb049276e2f00c91488e9ed5c3932672ffab7ead4f7caac54
+  metadata.gz: 97c8b0f6fc41589fc312325e81f03161536e934e85d0b785e3c424b83a9d9c90fce743b76dd033757faaef29e407228f15ce5b7b0a43395d9e6a9162b907f4b8
+  data.tar.gz: 26c7238588d78e74ee89f4c62c53923eb398beaedd3577c9b7ce1615542723cf8185338ade81856938451b6e0b03721c7ad0ffc89aec2670d02929c791a2b02c

data/lib/rspec_api_docs/dir.rb

@@ -0,0 +1,8 @@
+class RspecApiDocs::Dir
+  def self.find_or_create_api_docs_folder_in(path)
+    api_docs_folder_path = File.join(path, '/api_docs/')
+    Dir.mkdir(api_docs_folder_path) unless Dir.exists?(api_docs_folder_path)
+
+    api_docs_folder_path
+  end
+end

data/lib/rspec_api_docs/file.rb

@@ -0,0 +1,9 @@
+class RspecApiDocs::File
+  def self.files_to_remove(files, api_docs_folder_path)
+    if files == []
+      Dir.glob(File.join(api_docs_folder_path, '*'))
+    else
+      files
+    end
+  end
+end

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/rspec_api_docs.rb

@@ -1,19 +1,13 @@
 require 'rspec/core'
 require "rspec_api_docs/version"
+require "rspec_api_docs/dir"
+require "rspec_api_docs/file"
 
 RSpec.configure do |config|
   config.before(:suite) do
-    if defined? Rails
-      api_docs_folder_path = File.join(Rails.root, '/api_docs/')
-    else
-      api_docs_folder_path = File.join(File.expand_path('.'), '/api_docs/')
-    end
-
-    Dir.mkdir(api_docs_folder_path) unless Dir.exists?(api_docs_folder_path)
+    api_docs_folder_path = RspecApiDocs::Dir.find_or_create_api_docs_folder_in(Rails.root)
 
-    files_to_remove = config.files_to_run == [] ? Dir.glob(File.join(api_docs_folder_path, '*')) : config.files_to_run
-
-    files_to_remove.each do |f|
+    RspecApiDocs::File.files_to_remove(config.files_to_run, api_docs_folder_path).each do |f|
       next unless f.match(/api\/v*.\/.*/)
 
       file = f.match(/api\/v*.\/.*/)[0].gsub('/', '_').gsub('api_', '').gsub('_controller_test.rb', '.txt')
@@ -23,75 +17,76 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do |example|
-    # exit unless this is under api/v*
-    next unless example.metadata[:file_path].match(/api\/v\d*/)
     begin
+      # exit unless this is under api/v*
+      next unless example.metadata[:file_path].match(/api\/v\d*/)
       next unless request && request.try(:symbolized_path_parameters)
-    rescue => e
-      # Continue anyway
-      next
-    end
 
-    if response
-      example_group = example.metadata[:example_group]
-      example_groups = []
+      if response
+        example_group = example.metadata[:example_group]
+        example_groups = []
 
-      while example_group
-        example_groups << example_group
-        example_group = example_group[:example_group]
-      end
+        while example_group
+          example_groups << example_group
+          example_group = example_group[:example_group]
+        end
 
-      file_name = request.symbolized_path_parameters[:controller].gsub(/\//, '_').gsub('api_', '')
+        file_name = request.symbolized_path_parameters[:controller].gsub(/\//, '_').gsub('api_', '')
 
-      id_symbol = request.symbolized_path_parameters.keys.find{|k| k.match /id/}
-      optional_param = request.symbolized_path_parameters[id_symbol] ? "/{:#{id_symbol}}" : ""
-      action = "#{request.request_method} #{request.symbolized_path_parameters[:controller]}#{optional_param}"
+        id_symbol = request.symbolized_path_parameters.keys.find{|k| k.match /id/}
+        optional_param = request.symbolized_path_parameters[id_symbol] ? "/{:#{id_symbol}}" : ""
+        action = "#{request.request_method} #{request.symbolized_path_parameters[:controller]}#{optional_param}"
 
-      if defined? Rails
-        file = File.join(Rails.root, "/api_docs/#{file_name}.txt")
-      else
-        file = File.join(File.expand_path('.'), "/api_docs/#{file_name}.txt")
-      end
+        if defined? Rails
+          file = File.join(Rails.root, "/api_docs/#{file_name}.txt")
+        else
+          file = File.join(File.expand_path('.'), "/api_docs/#{file_name}.txt")
+        end
 
-      collection = action.match(/(POST|GET|PATCH|DELETE) (portal\/api|api)\/v\d*\/(.*)/)[3]
-      File.open(file, 'a') do |f|
-        if File.zero?(File.join(Rails.root, "/api_docs/#{file_name}.txt"))
-          f.write "FORMAT: 1A\n"
-          f.write "HOST: https://qa1.google.co.uk/api\n\n"
+        collection = action.match(/(POST|GET|PATCH|DELETE) (portal\/api|api)\/v\d*\/(.*)/)[3]
+        action_title = "#{collection.capitalize} #{request.symbolized_path_parameters[:action].capitalize} [#{request.method}]"
+        File.open(file, 'a') do |f|
+          if File.zero?(File.join(Rails.root, "/api_docs/#{file_name}.txt"))
+            f.write "FORMAT: 1A\n"
+            f.write "HOST: https://qa1.google.co.uk/api\n\n"
 
-          f.write "# #{collection.capitalize}\n\n"
+            f.write "# #{collection.capitalize}\n\n"
 
-          f.write "description blah blah blah\n\n"
-        end
+            f.write "description blah blah blah\n\n"
+          end
 
-        # skip if the action is already defined
-        next if File.read(File.join(Rails.root, "/api_docs/#{file_name}.txt")).include?(action)
+          # skip if the action is already defined
+          next if File.read(File.join(Rails.root, "/api_docs/#{file_name}.txt")).include?(action_title)
 
-        f.write "## #{collection.capitalize} collection [/#{collection}]\n\n"
+          f.write "## #{collection.capitalize} collection [/#{collection}]\n\n"
 
-        f.write "### #{collection.capitalize} #{request.symbolized_path_parameters[:action].capitalize} [#{request.method}]\n\n"
+          f.write "### #{action_title}\n\n"
 
-        # Request
-        request_body = request.env["action_dispatch.request.request_parameters"]
-        authorization_header = request.env ? request.env['Authorization'] : request.headers['Authorization']
+          # Request
+          request_body = request.env["action_dispatch.request.request_parameters"]
+          authorization_header = request.env ? request.env['Authorization'] : request.headers['Authorization']
 
-        if request_body.present? || authorization_header.present?
-          f.write "+ Request #{request.content_type}\n\n"
+          if request_body.present? || authorization_header.present?
+            f.write "+ Request #{request.content_type}\n\n"
 
-          # Request Body
-          if request_body.present?# && request.content_type == 'application/json'
-            f.write "+ Body\n\n".indent(4)# if authorization_header
-            f.write "#{JSON.pretty_generate(JSON.parse(JSON.pretty_generate(request_body)))}\n\n".indent(authorization_header ? 12 : 8)
+            # Request Body
+            if request_body.present?# && request.content_type == 'application/json'
+              f.write "+ Body\n\n".indent(4)# if authorization_header
+              f.write "#{JSON.pretty_generate(JSON.parse(JSON.pretty_generate(request_body)))}\n\n".indent(authorization_header ? 12 : 8)
+            end
           end
-        end
 
-        # Response
-        f.write "+ Response #{response.status} #{response.content_type}\n\n"
+          # Response
+          f.write "+ Response #{response.status} #{response.content_type}\n\n"
 
-        if response.body.present? && response.content_type =~ /application\/json/
-          f.write "#{JSON.pretty_generate(JSON.parse(response.body))}\n\n".indent(8)
-        end
-      end unless response.status.to_s =~ /4\d\d/ || response.status.to_s =~ /3\d\d/
+          if response.body.present? && response.content_type =~ /application\/json/
+            f.write "#{JSON.pretty_generate(JSON.parse(response.body))}\n\n".indent(8)
+          end
+        end unless response.status.to_s =~ /4\d\d/ || response.status.to_s =~ /3\d\d/
+      end
+    rescue => e
+      # Just carry on as normal to that errors here don't iterfere with tests
+      Rails.logger.info "rspec_api_docs error: #{e}"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_docs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tom Kadwill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,8 @@ files:
 - bin/console
 - bin/setup
 - lib/rspec_api_docs.rb
+- lib/rspec_api_docs/dir.rb
+- lib/rspec_api_docs/file.rb
 - lib/rspec_api_docs/version.rb
 - rspec_api_docs.gemspec
 homepage: https://github.com/tomkadwill/rspec_api_docs
@@ -92,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Generate API blueprint docs when running Rspec