washout_builder 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2c28b176b2de0598f62ef2d7aa9de7af602f3cf
-  data.tar.gz: eed01ecb9d7f866619501586dab38178c94e6124
+  metadata.gz: f1328c1fa0594e65be4676b8297d41e56adbf698
+  data.tar.gz: c15f894745514023201ce24c7741e95cf5d9b8f9
 SHA512:
-  metadata.gz: 2987851f0993d3628193353e0117f04a9b992b45dcf02e673d607ff57fb3345124eebdeae7437f65c3baad9474cf4e00ed737efcaf4a2f9b2900b1b98ea92665
-  data.tar.gz: ea68df3f7771dad6a413c0a987d013c8f44e6cf486d7e4bec124a133520052d3c623b02d1ceb71803577942fb6d0db1f96637d2036d40fd820eb0229d50807e0
+  metadata.gz: 4875aea491dd888fa61cac8cf890a41a4d76adc598f3d87e0cbe496741aea0a59edb05aed5ed78f8e2a8644bc21360d1e74016cfc5e2d89f09aab169fc6fd2ce
+  data.tar.gz: 4da1ad2e73e3acd3c245718fe527ceab4239ab1acb551e53d6a22ee0cdb3b815994106b825f5800af611831afdde459ef6fc9c9fed3ad1a969a2d155b84f6d4b

data/README.md

@@ -10,6 +10,12 @@ WashOutBuilder is a Soap Service Documentation generator (extends [WashOut](http
 
 The way [WashOut](https://github.com/inossidabile/wash_out) is used is not modified, it just extends its functionality by generating html documentation to your services that you write
 
+NEW Improvements in version 1.3.0
+---------------------------------
+
+-	link to accessing documentation for a single controller is now easier. You can use the same route as for seeing WSLD, but replacing **/wsdl** with **/soap_doc**
+-	The old way of acessing documentation is still kept, so if you mounted the engine at **/washout_builder**, you can still acess the documentation by appending to this url the full name of the controller including the namespace and the engine name(in case the controller is from a engine) as described below.
+
 Features
 --------
 

data/app/controllers/washout_builder/washout_builder_controller.rb

@@ -15,20 +15,21 @@ module WashoutBuilder
     #
     # @api public
     def all
-      find_all_routes
-      route = params[:name].present? ? controller_is_a_service?(params[:name]) : nil
-      if route.present?
-        @document = WashoutBuilder::Document::Generator.new(route.defaults[:controller])
-        render template: 'wash_with_html/doc', layout: false,
-               content_type: 'text/html'
-      else
-        @services = all_services
-        render template: 'wash_with_html/all_services', layout: false,
-               content_type: 'text/html'
-      end
+       params[:name] = params[:defaults][:name] if params[:defaults].present?
+       find_all_routes
+       route = params[:name].present? ? controller_is_a_service?(params[:name]) : nil
+       if route.present? && defined?(controller_class(params[:name]))
+         @document = WashoutBuilder::Document::Generator.new(controller_class(params[:name]).controller_path)
+         render template: 'wash_with_html/doc', layout: false,
+         content_type: 'text/html'
+       elsif
+         @services = all_services
+         render template: 'wash_with_html/all_services', layout: false,
+         content_type: 'text/html'
+       end
     end
 
-  private
+    private
 
     # tries to find all services by searching through the rails controller
     # and returns their namespace, endpoint and a documentation url
@@ -165,6 +166,7 @@ module WashoutBuilder
     # @return [String] The documentation url for the web service ( relative to base url)
     # @api private
     def service_documentation_url(controller_name)
+      #service_namespace(controller_name).gsub('/wsdl', '/soap_doc')
       "#{washout_builder.root_url}#{controller_naming(controller_name)}"
     end
   end

data/lib/washout_builder.rb

@@ -6,6 +6,27 @@ require 'active_support/core_ext/string/output_safety.rb'
 
 Gem.find_files('washout_builder/**/*.rb').each { |path| require path }
 
+
+ActionDispatch::Routing::Mapper.class_eval do
+  alias_method :original_wash_out, :wash_out
+    # Adds the routes for a SOAP endpoint at +controller+.
+    def wash_out(controller_name, options={})
+      if @scope
+        scope_frame = @scope.respond_to?(:frame) ? @scope.frame : @scope
+        options.each_with_index { |key, value|  scope_frame[key] = value }
+      end
+
+      controller_class_name = [options[:module], controller_name].compact.join("/").underscore
+
+      match "#{controller_name}/soap_doc"   =>  WashoutBuilder::Engine, via: :get,
+        defaults: { name: "#{controller_class_name}" },
+        format: false,
+        as: "#{controller_class_name}_soap_doc"
+
+        original_wash_out(controller_name, options)
+    end
+end
+
 # finds all the exception class and extends them by including the ExceptionModel module in order to be
 # able to generate documentation for exceptions
 WashoutBuilder::Type.all_fault_classes.each do |exception_class|

data/lib/washout_builder/type.rb

@@ -26,7 +26,7 @@ module WashoutBuilder
       classes << WashOut::SOAP::ClassMethods if defined?(WashOut::SOAP::ClassMethods)
       classes
     end
-
+    
     # returns the base class that is used for parsing definitions of soap actions
     #
     # @return [Class] returns the base class that is used for parsing definitions of soap actions

data/lib/washout_builder/version.rb

@@ -10,9 +10,9 @@ module WashoutBuilder
     # the major version of the gem
     MAJOR = 1
     # the minor version of the gem
-    MINOR = 2
+    MINOR = 3
     # the tiny version of the gem
-    TINY = 4
+    TINY = 0
     # if the version should be a e
     PRE = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - bogdanRada