swagger-docs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f911cef6a9a1c31b6a3eb7b20a9475708d84b450
-  data.tar.gz: 7c7561937304375ceacc3738e4fcd68c4b3cc228
+  metadata.gz: 8288447cb546d04ee3e791e473f06351c1f9e702
+  data.tar.gz: cf69d2574759663cdccb895d4c320c0b085fa0e4
 SHA512:
-  metadata.gz: 862ec9249db73769611ae420128215e7ac356911cf42983560eb22083f9a8dc11ff9c46c4bbb20daecc09afe613b930dddf18c0bdd0e741b8a4edb21c229c14d
-  data.tar.gz: 878c2194761ad4d6ce4be794fa782dbb8c2dff643ebd239d368c466090b2f7fe2025cf953c27048a8360c24429896a41a538219f632908cdffdbaea56bd810ef
+  metadata.gz: 0cfdeb3b6ffc0c27f2306739d7831496c65c480efd54ad583923b5c0d1a5e6aa12643f55e59ffe4797e71b87f7d29fdba49c8f5d866f167906cc1e113f4be7a1
+  data.tar.gz: aa89d0b6b9cac77cd1b9ab5e952b89ce3c85bed99fdc0933e891ba9bcf633180ffc72e6e1ba82e1dfbb197fdb261efafbdc66970f83dbfe474073894716aa6f2

checksums.yaml.gz.sig

@@ -1 +1 @@
-�����9�4�~�o,�"�W��������(z��6;�:#�x�9�ƺ%�h�'�_P��u�����[�V�'��j�A~}��؟�_��Wq��QE�IfQ�W֪a�\�1ߛ���Z���0�}���
�Aܙ9�y^6��v�j�CM{|�؂��&����%ddB�m���y���-�ۗS��y�eW��͞ir~�_-�Y,ط�9	;)��H��`[�1B
���)=�E�s��ř�0
k��
+0�zQ��"Hr
����B�I9��PJ����|�.�(�7��ȟ�T�zH���r�t4��~3��1�,��2�5�F��1��By}e����kUvq�����w�Μ�����\.#뫷��1�d�Y�P_t�2}��wa�\�4�B2��l\�d�:Mg�4C���-�&a\�T��r.�)����z��Z�Ԙ>���d�P�|�	m�BTX �W��C"c�d�

data/README.md

@@ -38,7 +38,7 @@ Create an initializer in config/initializers (e.g. swagger_docs.rb) and define y
 
 ```
 Swagger::Docs::Config.register_apis({
-  "1.0" => {:controller_base_path => "api/v1", :api_file_path => "public/api/v1/"}
+  "1.0" => {:controller_base_path => "api/v1", :api_file_path => "public/api/v1/", :base_path => "http://api.somedomain.com"}
 })
 ```
 

data/lib/swagger/docs/generator.rb

@@ -45,18 +45,19 @@ module Swagger
         end
 
         def write_doc(api_version, config)
-          base_path = config[:controller_base_path]
+          base_path = config[:base_path]
+          controller_base_path = config[:controller_base_path]
           api_file_path = config[:api_file_path]
           results = {:processed => [], :skipped => []}
 
           FileUtils.mkdir_p(api_file_path) # recursively create out output path
           Dir.foreach(api_file_path) {|f| fn = File.join(api_file_path, f); File.delete(fn) if !File.directory?(fn)} # clean output path
 
-          header = { :api_version => api_version, :swagger_version => "1.2", :base_path => "/#{base_path}"}
+          header = { :api_version => api_version, :swagger_version => "1.2", :base_path => "#{base_path}/#{controller_base_path}"}
           resources = header.merge({:apis => []})
 
           paths = Rails.application.routes.routes.map{|i| "#{i.defaults[:controller]}" }
-          paths = paths.uniq.select{|i| i.start_with?(base_path)}
+          paths = paths.uniq.select{|i| i.start_with?(controller_base_path)}
           paths.each do |path|
             klass = "#{path.to_s.camelize}Controller".constantize
             if !klass.methods.include?(:swagger_config) or !klass.swagger_config[:controller]
@@ -71,7 +72,7 @@ module Swagger
               operations = Hash[operations.map {|k, v| [k.to_s.gsub("@","").to_sym, v] }] # rename :@instance hash keys
               operations[:method] = verb
               operations[:nickname] = "#{path.camelize}##{action}"
-              apis << {:path => get_api_path(route.path.spec).gsub("/#{base_path}",""), :operations => [operations]}
+              apis << {:path => get_api_path(route.path.spec).gsub("/#{controller_base_path}",""), :operations => [operations]}
             end
             demod = "#{path.to_s.camelize}".demodulize.camelize.underscore
             resource = header.merge({:resource_path => "/#{demod}", :apis => apis})

data/lib/swagger/docs/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Docs
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/lib/swagger/docs/generator_spec.rb

@@ -23,7 +23,7 @@ describe Swagger::Docs::Generator do
       stub_route("^DELETE$", "destroy", "api/v1/sample", "/api/v1/sample/:id(.:format)")
     ]
     @config = Swagger::Docs::Config.register_apis({
-      "1.0" => {:controller_base_path => "api/v1", :api_file_path => "#{TMP_DIR}api/v1/"}
+      "1.0" => {:controller_base_path => "api/v1", :api_file_path => "#{TMP_DIR}api/v1/", :base_path => "http://api.no.where"}
     })
     Rails.stub_chain(:application, :routes, :routes).and_return(routes)
     Swagger::Docs::Generator.set_real_methods
@@ -65,7 +65,7 @@ describe Swagger::Docs::Generator do
         expect(response["swaggerVersion"]).to eq "1.2"
       end
       it "writes basePath correctly" do
-        expect(response["basePath"]).to eq "/api/v1"
+        expect(response["basePath"]).to eq "http://api.no.where/api/v1"
       end
       it "writes apis correctly" do
         expect(response["apis"].count).to eq 1
@@ -92,7 +92,7 @@ describe Swagger::Docs::Generator do
         expect(response["swaggerVersion"]).to eq "1.2"
       end
       it "writes basePath correctly" do
-        expect(response["basePath"]).to eq "/api/v1"
+        expect(response["basePath"]).to eq "http://api.no.where/api/v1"
       end
       it "writes resourcePath correctly" do
         expect(response["resourcePath"]).to eq "/sample"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rich Hollis