washout_builder 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1328c1fa0594e65be4676b8297d41e56adbf698
-  data.tar.gz: c15f894745514023201ce24c7741e95cf5d9b8f9
+  metadata.gz: 2b43fddeb45664fd77e68b4f381d0527f05f1b33
+  data.tar.gz: dcd30f9428b187356b23b67066cc45ef0061cde4
 SHA512:
-  metadata.gz: 4875aea491dd888fa61cac8cf890a41a4d76adc598f3d87e0cbe496741aea0a59edb05aed5ed78f8e2a8644bc21360d1e74016cfc5e2d89f09aab169fc6fd2ce
-  data.tar.gz: 4da1ad2e73e3acd3c245718fe527ceab4239ab1acb551e53d6a22ee0cdb3b815994106b825f5800af611831afdde459ef6fc9c9fed3ad1a969a2d155b84f6d4b
+  metadata.gz: 2e303eef7c0b1cb37fec341ff73e7aafc1e64ca749c547ba25f626990eec90d4a4e767c2ac8dfd5d1e7a46f5442d68f5b376a725fbcc203171ebcc043e6dd377
+  data.tar.gz: c1f6c1c75275cdf4e14176e69e8353cb6c67c499a3552f164332d34a386857051dc941fd6c2a98d8058ac58e90007c8d5e24df59b0bbc083c9ce8b6c626e01e2

data/README.md

@@ -10,11 +10,17 @@ 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.4.0
+---------------------------------
+
+-	when displaying all services , the link to documentation is now using the new format **/soap_doc** for better readability
+-	Fixed an issue when generating documentation for a controller that didn't had the namespace set, the WSDL url and endpoint was missing from the generated source because of that. However if you don't set the namespace in controller the links to WSDL and endpoint would throw an error when trying to access them.
+
 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.
+-	The old way of acessing documentation is still kept, so if you mounted the engine at **/washout**, 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,18 +15,18 @@ module WashoutBuilder
     #
     # @api public
     def all
-       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
+      params[:name] = params[:defaults][:name] if params[:defaults].present?
+      find_all_routes
+      route_details = params[:name].present? ? controller_is_a_service?(params[:name]) : nil
+      if route_details.present? && defined?(controller_class(params[:name]))
+        @document = WashoutBuilder::Document::Generator.new(route_details, 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
@@ -45,17 +45,24 @@ module WashoutBuilder
     #
     # @api private
     def all_services
-      @map_controllers = map_controllers { |route| route.defaults[:controller] }
-      @map_controllers.blank? ? [] : @map_controllers.map do |controller_name|
-        {
-          'service_name' => controller_naming(controller_name),
-          'namespace' => service_namespace(controller_name),
-          'endpoint' => service_endpoint(controller_name),
-          'documentation_url' => service_documentation_url(controller_name)
-        }
+      @map_controllers = map_controllers { |hash| hash }
+      @map_controllers.blank? ? [] : @map_controllers.map do |hash|
+        controller_name = hash[:route].present? && hash[:route].respond_to?(:defaults) ? hash[:route].defaults[:controller] : nil
+        if controller_name.present?
+          {
+            'service_name' => controller_naming(controller_name),
+            'namespace' => service_namespace(hash, controller_name),
+            'endpoint' => service_endpoint(hash, controller_name),
+            'documentation_url' => service_documentation_url(hash, controller_name)
+          }
+        end
       end
     end
 
+    def generate_wsdl_action
+      '_generate_wsdl'
+    end
+
     # the way of converting from controller string in downcase in camelcase
     # @param [String] controller  The controller name in downcase letter
     #
@@ -73,18 +80,30 @@ module WashoutBuilder
     #
     # @api private
     def route_can_generate_wsdl?(route)
-      route.defaults[:action] == '_generate_wsdl'
+      route.defaults[:action] == generate_wsdl_action
     end
 
     def find_all_routes
-      rails_routes = Rails.application.routes.routes.map { |route| route }
-      engine_routes = []
-      ::Rails::Engine.subclasses.each do |engine|
-        engine.routes.routes.each do |route|
-          engine_routes << route
-        end
+      # get the controller and set the action for redirection
+      engines = [Rails.application]
+      engines.concat(::Rails::Engine.subclasses)
+
+      routes = engines.each_with_object([]) do |engine, routes_array|
+        engine_route = Rails.application.routes.named_routes[engine.engine_name]
+        routes_hash_array = engine.routes.routes.map { |route|
+          {
+            engine: engine,
+            route_set: engine.routes,
+            route: route,
+            mounted_at: engine_route.blank? ? nil : engine_route.path.spec.to_s
+          }
+        }
+
+        routes_array.concat(routes_hash_array)
       end
-      @routes = rails_routes.concat(engine_routes).uniq.compact
+
+      #routes = routes.sort_by { |hash| hash[:route].precedence }
+      @routes = routes
       @routes
     end
 
@@ -99,13 +118,13 @@ module WashoutBuilder
     # @return [ActionDispatch::Journey::Route, Array<ActionDispatch::Journey::Route>] Can return either a collection of routes or a single route depending on the action
     #
     # @api private
-    def map_controllers(action = 'map')
-      res = @routes.send(action) do |route|
-        if route_can_generate_wsdl?(route)
-          yield route if block_given?
+    def map_controllers(action = 'select')
+      res = @routes.send(action) do |hash|
+        if hash[:route].present? && route_can_generate_wsdl?(hash[:route])
+          yield hash if hash.present? && block_given?
         end
       end
-      res = res.uniq.compact if action == 'map'
+      res = res.compact.uniq{|hash| hash[:route] } if action == 'select'
       res
     end
 
@@ -119,8 +138,10 @@ module WashoutBuilder
     #
     # @api private
     def controller_is_a_service?(controller)
-      map_controllers('detect') do |route|
-        controller_naming(route.defaults[:controller]) == controller_naming(controller)
+      map_controllers('detect') do |hash|
+        if hash[:route].present? && hash[:route].respond_to?(:defaults)
+          controller_naming(hash[:route].defaults[:controller]) == controller_naming(controller)
+        end
       end
     end
 
@@ -135,6 +156,10 @@ module WashoutBuilder
       controller_naming("#{controller}_controller").constantize
     end
 
+    def route_helpers(hash)
+      hash[:route_set].url_helpers
+    end
+
     # retrieves the service namespace
     # @see #controller_class
     #
@@ -146,8 +171,9 @@ module WashoutBuilder
     # @return [String] The namespace of the soap service that is used in that controller
     #
     # @api private
-    def service_namespace(controller_name)
-      controller_class(controller_name).soap_config.namespace
+    def service_namespace(hash, controller_name)
+      #controller_class(controller_name).soap_config.namespace
+      route_helpers(hash).url_for(controller: controller_name, action: generate_wsdl_action, only_path: true)
     end
 
     # the endpoint is based on the namespace followed by /action suffix
@@ -156,8 +182,8 @@ module WashoutBuilder
     # @param [String] controller_name The name of the controller
     # @return [String] The endpoint of the web service
     # @api private
-    def service_endpoint(controller_name)
-      service_namespace(controller_name).gsub('/wsdl', '/action')
+    def service_endpoint(hash, controller_name)
+      service_namespace(hash, controller_name).gsub('/wsdl', '/action')
     end
 
     # constructs the documentation url for a specific web service
@@ -165,9 +191,9 @@ module WashoutBuilder
     # @param [String] controller_name The name of the controller
     # @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)}"
+    def service_documentation_url(hash, controller_name)
+      service_namespace(hash, controller_name).gsub('/wsdl', '/soap_doc')
+      #"#{washout_builder.root_path}#{controller_naming(controller_name)}"
     end
   end
 end

data/app/views/wash_with_html/doc.builder

@@ -34,13 +34,16 @@ xml.html( "xmlns" => "http://www.w3.org/1999/xhtml" ) {
     xml.h1 "#{ @document.service} Soap WebService interface description"
 
     xml.p{ |y| y << "Endpoint URI:";
-      xml.span( "class" => "pre") { |y| y << "#{@document.endpoint}"};
+      xml.span( "class" => "pre") {
+        xml.a( "href" => "#{@document.endpoint}") { |y| y << "#{@document.endpoint}" }
+      };
     }
 
     xml.p{ |y| y << "WSDL URI:";
       xml.span( "class" => "pre") {
         xml.a( "href" => "#{@document.namespace}") { |y| y << "#{@document.namespace}" }
-      };}
+      };
+    }
     xml.p ""
     unless @document.service_description.blank?
       xml.p "#{@document.service_description}"

data/lib/washout_builder/document/generator.rb

@@ -13,7 +13,7 @@ module WashoutBuilder
       #
       # @!attribute controller_name
       #   @return [String] The name of the controller that acts like a soap service
-      attr_accessor :soap_actions, :config, :controller_name
+      attr_accessor :soap_actions, :config, :controller_name, :route_details
 
       # Method used to initialize the instance of object
       # @see #controller_class
@@ -21,19 +21,24 @@ module WashoutBuilder
       # @param [String] controller The name of the controller that acts like a soap service
       # @return [void]
       # @api public
-      def initialize(controller)
+      def initialize(route_details, controller)
+        self.route_details = route_details
         controller_class_name = controller_class(controller)
         self.config = controller_class_name.soap_config
         self.soap_actions = controller_class_name.soap_actions
         self.controller_name = controller
       end
 
+      def controller_route_helpers
+        route_details[:route_set].url_helpers
+      end
+
       # Returns the namespace used for the controller by using the soap configuration of the controller
       #
       # @return [String] description of returned object
       # @api public
       def namespace
-        config.respond_to?(:namespace) ? config.namespace : nil
+        controller_route_helpers.url_for(controller: controller_name, action: "_generate_wsdl", only_path: true)
       end
 
       # Retrives the class of the controller by using its name

data/lib/washout_builder/version.rb

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

data/spec/app/controllers/washout_builder_controller_spec.rb

@@ -41,7 +41,8 @@ describe WashoutBuilder::WashoutBuilderController, type: :controller do
   end
 
   it 'render a service documentation' do
-    controller.expects(:controller_is_a_service?).with(params[:name]).returns(route)
+    controller.stubs(:controller_class).returns(ApiController)
+    controller.stubs(:controller_is_a_service?).with(params[:name]).returns(route)
     WashoutBuilder::Document::Generator.expects(:new).with(route.defaults[:controller])
     get :all, params
     expect(response).to render_template 'wash_with_html/doc'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wash_out
@@ -480,4 +480,3 @@ test_files:
 - spec/support/complex_types/fluffy_container.rb
 - spec/support/complex_types/project_type.rb
 - spec/support/complex_types/test_type.rb
-has_rdoc: