washout_builder 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28e063d6a4b5eaf6ddbfa719878fb79cd1fd97a2
-  data.tar.gz: 2bf44c71f0a33cd2835eca1cd03dc1eab968d074
+  metadata.gz: 802bd845220cba1431d3e914c831885a808f409b
+  data.tar.gz: 01217f8a74c7d265fa154f92ae9935331676448a
 SHA512:
-  metadata.gz: 6537d2449d4d330dca6a4d1b8c2820dd9d47d5d7c1df3bd5e21a80a85e99f093350c743f4ee7540e5118155b3a2513cc878d60b3cda0d65051a466218eff8154
-  data.tar.gz: d3a9fbb41c8f68c7ea3cd828d862110ef28207ba3a09bdf1f6449a0fac2fe95b024d4c5fb4869e52639f6379f83d964f38aa68de8fe27b4cd59a05f18d0cb7ff
+  metadata.gz: 893d39b63b0a4c07d84437b1962a6490cc83e361d528fb67e7f4e1ae8550f6fc8b137b9c3a45db6d68cbb033e58e06119b6f857231b9d77e90f4349416e18bbe
+  data.tar.gz: 5fc32ae9c7b33126937e4793169effa58f0d9ec9f842e49e6c528a508f569f7d12614dc56cdd26c35f91e9ec5bc9818914126b9019335a0293706664cac61d6e

data/.coveralls.yml

@@ -1,2 +1,2 @@
 service_name: travis-ci
-repo_token: UaUbPHZDlrwJTkU33FqFBf4FaMU4vhBwV
+repo_token: RcokBkjBaFERh6P3aMwGQ5EJStDmHmHQT

data/README.rdoc

@@ -1,7 +1,7 @@
 = washout_builder  {<img src="https://badge.fury.io/rb/washout_builder.png" alt="Gem Version" />}[http://badge.fury.io/rb/washout_builder]
 {<img src="https://travis-ci.org/bogdanRada/washout_builder.png?branch=master,develop" />}[https://travis-ci.org/bogdanRada/washout_builder]   
-{<img src="https://www.versioneye.com/user/projects/52fc7297ec1375346600007d/badge.png" alt="Dependency Status" />}[https://www.versioneye.com/user/projects/52fc7297ec1375346600007d]{<img src="https://www.versioneye.com/user/projects/52fc7297ec1375346600007d/badge.png" alt="Dependency Status" />}[https://www.versioneye.com/user/projects/52fc7297ec1375346600007d]
-{<img src="https://coveralls.io/repos/bogdanRada/washout_builder/badge.png?alt=true" alt="Coveralls Coverage Status" />}[https://coveralls.io/r/bogdanRada/washout_builder]
+{<img src="https://www.versioneye.com/user/projects/52fc7297ec1375346600007d/badge.svg?style=flat" alt="Dependency Status" />}[https://www.versioneye.com/user/projects/52fc7297ec1375346600007d]
+{<img src="https://coveralls.io/repos/bogdanRada/washout_builder/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/bogdanRada/washout_builder?branch=master]
 {<img src="https://codeclimate.com/github/bogdanRada/washout_builder.png" />}[https://codeclimate.com/github/bogdanRada/washout_builder]
 {<img src="https://reposs.herokuapp.com/?path=bogdanRada/washout_builder"  alt="Repo Size"/>}[https://github.com/bogdanRada/washout_builder]
 {<img src="https://ruby-gem-downloads-badge.herokuapp.com/washout_builder?type=total&style=dynamic"  alt="Gem Downloads"/>}[https://rubygems.org/gems/washout_builder]

data/app/controllers/washout_builder/washout_builder_controller.rb

@@ -2,6 +2,10 @@ require_relative "../../../lib/washout_builder/document/generator"
 class WashoutBuilder::WashoutBuilderController < ActionController::Base
   protect_from_forgery
 
+  # Will show all api services if no name parameter is receiverd
+  # If a name parameter is present wiill try to use that and find a controller 
+  # that was that name by camelcasing the name . 
+  # IF a name is provided will show the documentation page for that controller 
   def all
     route = params[:name].present? ? controller_is_a_service?(params[:name]) : nil
     if route.present?
@@ -16,12 +20,13 @@ class WashoutBuilder::WashoutBuilderController < ActionController::Base
   
   private
   
-  
+  # tries to find all services by searching through the rails controller 
+  # and returns their namespace, endpoint and a documentation url
   def all_services
-    @map_controllers = map_controllers
+    @map_controllers = map_controllers do |route|  route.defaults[:controller]   end
     @services = @map_controllers.blank? ? [] : @map_controllers.map do |controller_name|
       {
-        'service_name' =>   controller_name.camelize  ,
+        'service_name' =>   controller_naming(controller_name)  ,
         'namespace' => service_namespace(controller_name),
         'endpoint' => service_endpoint(controller_name),
         'documentation_url' => service_documentation_url(controller_name),
@@ -32,36 +37,53 @@ class WashoutBuilder::WashoutBuilderController < ActionController::Base
       :content_type => 'text/html'
   end
   
-  def all_controllers
-    Rails.application.routes.routes
+  # the way of converting from controller string in downcase in camelcase 
+  def controller_naming(controller)
+    controller.camelize
+  end
+  
+  # checking if a route has the action for generating WSDL
+  def route_can_generate_wsdl?(route)
+    route.defaults[:action] == "_generate_wsdl"
   end
   
-  def map_controllers
-    all_controllers.map do |route|
-      route.defaults[:controller]   if route.defaults[:action] == "_generate_wsdl"
-    end.uniq.compact
+  # method for getting all controllers that have the generate wsdl action or finding out
+  # if a single controller is a soap service
+  def map_controllers(action = "map")
+    res =  Rails.application.routes.routes.send(action) do |route|
+      if route_can_generate_wsdl?(route)
+        yield route if block_given?
+      end
+    end
+    res = res.uniq.compact if action == "map"
+    return res
   end
   
+  # checking if a controller is a soap service
   def  controller_is_a_service?(controller)
-    route = all_controllers.detect do |route|
-      route.defaults[:controller].camelize == controller.camelize && route.defaults[:action] == "_generate_wsdl"
+    map_controllers("detect") do |route|
+      controller_naming(route.defaults[:controller]) == controller_naming(controller) 
     end
   end
 
+  # getting the controller class from the controller string
   def controller_class(controller)
-    "#{controller}_controller".camelize.constantize
+    controller_naming("#{controller}_controller").constantize
   end
   
+  # retrieves the service namespace
   def service_namespace(controller_name)
     controller_class(controller_name).soap_config.namespace
   end
   
+  # the endpoint is based on the namespace followed by /action suffix 
   def service_endpoint(controller_name)
     service_namespace(controller_name).gsub("/wsdl", "/action")
   end
   
+  # constructs the documentation url for a specific web service 
   def service_documentation_url(controller_name)
-    "#{washout_builder.root_url}#{controller_name.camelize}"
+    "#{washout_builder.root_url}#{controller_naming(controller_name)}"
   end
 
 end

data/app/helpers/washout_builder_complex_type_helper.rb

@@ -1,6 +1,8 @@
 module WashoutBuilderComplexTypeHelper
   
-  
+   # this method is for printing the attributes of a complex type
+   # if the attributes are primitives this will show the attributes with  blue color
+   # otherwise will call another method for printing the complex attribute
   def create_element_type_html(pre, element)
     element.type = "string" if element.type == "text"
     element.type = "integer" if element.type == "int"
@@ -11,7 +13,9 @@ module WashoutBuilderComplexTypeHelper
       end
   end
   
-  
+ 
+  # checks if a complex attribute of a complex type is a array or not
+  # and retrieves the complex class name of the attribute and prints it 
   def create_complex_element_type_html(pre, element)
     complex_class = element.get_complex_class_name
     unless  complex_class.nil?
@@ -23,4 +27,4 @@ module WashoutBuilderComplexTypeHelper
 end
 
 
-  
+  

data/app/helpers/washout_builder_fault_type_helper.rb

@@ -1,27 +1,36 @@
 module WashoutBuilderFaultTypeHelper
   
+  # checks if a complex attribute of a complex type SoapFault is array or not
+  # if the attribute is an array will print also the type of the elements contained in the array
+  # otherwise will show the complex class of the attribute
   def create_fault_model_complex_element_type(pre, attr_primitive, attribute, array)
     attribute_primitive = array == true ? "Array of #{attr_primitive}" : "#{attr_primitive}"
     pre << "<a href='##{attr_primitive}'><span class='lightBlue'> #{attribute_primitive}</span></a>&nbsp;<span class='bold'>#{attribute}</span>"
   end
   
-  
+  # if the attribute is an array  this method is used to identify the type of the elements inside the array
   def member_type_is_basic?(attr_details)
     WashoutBuilder::Type::BASIC_TYPES.include?(attr_details[:member_type].to_s.downcase) ? attr_details[:member_type].to_s.downcase : attr_details[:member_type]
   end
-  
+  # checks is the attribute has a primitive value or a complex value
   def primitive_type_is_basic?(attr_details)
-   WashoutBuilder::Type::BASIC_TYPES.include?(attr_details[:primitive].to_s.downcase) 
+    WashoutBuilder::Type::BASIC_TYPES.include?(attr_details[:primitive].to_s.downcase) 
   end
 
+  # if the attribute value is of type nil the documentation will show string 
+  # otherwise the primitive value
   def get_primitive_type_string(attr_details)
     attr_details[:primitive].to_s.downcase == "nilclass" ? "string" : attr_details[:primitive].to_s.downcase
   end  
   
+  # if the attribute is of type array the method identifies the type of the elements inside the array
   def get_member_type_string(attr_details)
     attr_details[:primitive].to_s.downcase == "array" ? member_type_is_basic?(attr_details) :  attr_details[:primitive]
   end
   
+  # this method is used to print all attributes of a SoapFault element 
+  # if the attribute value is a primitve value it will be shown in blue and will also show the type of the primitive
+  # if is a complex type will use another method for finding out the complex class 
   def create_html_fault_model_element_type(pre, attribute, attr_details)
     if primitive_type_is_basic?(attr_details) || attr_details[:primitive] == "nilclass" 
       pre << "<span class='blue'>#{get_primitive_type_string(attr_details)}</span>&nbsp;<span class='bold'>#{attribute}</span>"
@@ -29,4 +38,4 @@ module WashoutBuilderFaultTypeHelper
       create_fault_model_complex_element_type(pre, get_member_type_string(attr_details), attribute, true )
     end
   end
-end
+end

data/lib/washout_builder.rb

@@ -1,13 +1,5 @@
 require 'wash_out'
-require 'washout_builder/soap'
-require 'washout_builder/engine'
-require 'washout_builder/document/shared_complex_type'
-require 'washout_builder/document/complex_type'
-require 'washout_builder/document/exception_model'
-require 'washout_builder/document/generator'
-require 'washout_builder/type'
-require 'washout_builder/version'
-
+Gem.find_files("washout_builder/**/*.rb").each { |path| require path }
 
 WashOut::Param.send :include, WashoutBuilder::Document::ComplexType
 
@@ -51,13 +43,32 @@ end
 
 
 WashOut::Param.class_eval do
-   
+  
   def self.parse_builder_def(soap_config, definition)
     raise RuntimeError, "[] should not be used in your params. Use nil if you want to mark empty set." if definition == []
     return [] if definition == nil
-
-    definition = { :value => definition } unless definition.is_a?(Hash)
-
+    
+    # the following lines was removed because when generating the documentation
+    #  the "source_class" attrtibute of the object was not the name of the class of the complex tyoe
+    # but instead was the name given in the hash
+    # Example :
+    #  class ProjectType < WashOut::Type
+    #  map :project => {
+    # :name                                    => :string,
+    #  :description                           => :string,
+    #  :users                                    => [{:mail => :string }],
+    #  }
+    #end
+    # 
+    # The name of the complex type should be ProjectType and not "project"
+    
+    
+    #     if definition.is_a?(Class) && definition.ancestors.include?(WashOut::Type)
+    #        definition = definition.wash_out_param_map
+    #    end
+    
+    definition = { :value => definition } unless definition.is_a?(Hash) # for arrays and symbols
+    
     definition.collect do |name, opt|
       if opt.is_a? WashOut::Param
         opt
@@ -65,9 +76,9 @@ WashOut::Param.class_eval do
         WashOut::Param.new(soap_config, name, opt[0], true)
       else
         WashOut::Param.new(soap_config, name, opt)
+        end
       end
     end
-  end
   
 end
   

data/lib/washout_builder/document/complex_type.rb

@@ -1,3 +1,4 @@
+require_relative "./shared_complex_type"
 module WashoutBuilder
   module Document
     module ComplexType
@@ -120,4 +121,4 @@ module WashoutBuilder
   
     end
   end
-end
+end

data/lib/washout_builder/document/exception_model.rb

@@ -1,3 +1,4 @@
+require_relative "./shared_complex_type"
 module WashoutBuilder
   module Document
     module ExceptionModel

data/lib/washout_builder/version.rb

@@ -6,7 +6,7 @@ module WashoutBuilder   # Returns the version of the currently loaded Rails as a
   module VERSION
     MAJOR = 0
     MINOR = 14
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wash_out
@@ -395,8 +395,6 @@ files:
 - spec/app/helpers/washout_builder_method_arguments_helper_spec.rb
 - spec/app/helpers/washout_builder_method_list_helper_spec.rb
 - spec/app/helpers/washout_builder_method_return_type_helper_spec.rb
-- spec/app/integration/washout_builder_all_services_spec.rb
-- spec/app/integration/washout_builder_service_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
@@ -420,6 +418,8 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
+- spec/integration/washout_builder_all_services_spec.rb
+- spec/integration/washout_builder_service_spec.rb
 - spec/lib/washout_builder/document/complex_type_spec.rb
 - spec/lib/washout_builder/document/exception_model_spec.rb
 - spec/lib/washout_builder/document/generator_spec.rb
@@ -462,8 +462,6 @@ test_files:
 - spec/app/helpers/washout_builder_method_arguments_helper_spec.rb
 - spec/app/helpers/washout_builder_method_list_helper_spec.rb
 - spec/app/helpers/washout_builder_method_return_type_helper_spec.rb
-- spec/app/integration/washout_builder_all_services_spec.rb
-- spec/app/integration/washout_builder_service_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
@@ -487,6 +485,8 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/public/stylesheets/.gitkeep
 - spec/dummy/script/rails
+- spec/integration/washout_builder_all_services_spec.rb
+- spec/integration/washout_builder_service_spec.rb
 - spec/lib/washout_builder/document/complex_type_spec.rb
 - spec/lib/washout_builder/document/exception_model_spec.rb
 - spec/lib/washout_builder/document/generator_spec.rb