washout_builder 0.9.7 → 0.9.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGZkMGI2MWRmZjllMmI0YmQzNTY1YWE2NWY2MjNiZTU2NjI2ZDVjYw==
+    ZjBhNzE2NTAxZjVhY2I4OGY4YTQ2YjNiY2E4ZWQ4ZTMwYTQ2NzlhMA==
   data.tar.gz: !binary |-
-    ODAzNmNiOWQ5MmU3NTEzMmNlYmEzZDY1N2EzYTIyYmMyNWRjNTFmNw==
+    MWMyNGZkMWQ0YjI4M2UyNjQyY2IyZDg0YTFlYjkwNjcxNTk5NGQ2Yg==
 SHA512:
   metadata.gz: !binary |-
-    NDdiMzcwZTM2MzJhNTY2OTFlNzhkOWY3ODIyZmY2OTdjNDBjMGZjOGQxMTg2
-    OTNlODhiZTMyYTU5MGE4MWNmOTg0ZWZkNDdmNzg4NzdmMDA0MWRjOTNhYzM5
-    NjhiNzY4NzliYjVmYTA5YmE0MTEzNDkyNTdiMjRkZGY3ZWVmOTU=
+    OGIwN2FkYTAzYzBlN2NjNGI1YmVjMTQ2MTZlMTc3OWM0NmE3ZjliYmI4YzMz
+    ZDA3M2ZjYWJkMTYwNmZmZDcwYTUxN2MzMDVmZGU5ZmY5NmZmNmYwOWVjYmYy
+    NjU2OTZiNDI0ZmFjMjU1YThkNWUzNTc1ODYyYmQzYjcxYjJjMjA=
   data.tar.gz: !binary |-
-    ZjE3NDA5MTBhNDA3NmE3YTgzNmI5NWYxNGIxOTE3NjYyMDk0MDA1MjU0ZGQy
-    MzZkMTUwODg2YTE5MWEzNzQ4NjAxNDllNTAzMjg2MzEzOTU2YWVlM2JmM2I2
-    N2U1NDQzNWVlM2FlZTQzZDRkOWQ5YTdiMDA5NjZjZjJmZGE5MTc=
+    ZjRjZTBjMjQ2ZWViNDdjZTk4MjRjMGE3YTIyNGM5M2NhNmNhMDlhYjQyMjIw
+    YWViYWM5Y2UwNzJlNjg4NWRiMjEyNTgyNWJiN2Q4MWQwMzg1YWRjMmJmOTRj
+    Yjg1ZWFmYzhhNDQ2NTcwZmNhODQzZjRjYzQyMWIzNjhkYjM4ZGY=

data/README.rdoc

@@ -51,8 +51,7 @@ Or if you want this to be available only in development mode , you can do someth
   group :development, :test do
     gem 'washout_builder'            # The documentation will only be available in development mode. 
   end
-
-Just make sure that the requirements for this gem are met and everything should be fine. 
+ 
 
 Please read {release details}[https://github.com/bogdanRada/washout_builder/releases] if you are upgrading. We break backward compatibility between large ticks but you can expect it to be specified at release notes.
 
@@ -61,21 +60,26 @@ Please read {release details}[https://github.com/bogdanRada/washout_builder/rele
 The way soap_actions, or reusable types are defined or how the configuration is made using WashOut(https://github.com/inossidabile/wash_out)  haven't changed
 You can still do everything that gem does .
 
-When specifying the <b>soap_action</b> you can also pass a <b>option for description</b> and a <b>list of exceptions(need to be classes)</b> that the method can raise at a certain moment.
+In order to see the documentation you must write something like this  in the routes (exactly like you would do when using only WashOut)
 
-The exception classes used <b>must inherit</b> from  <tt>WashOut::SOAPError</tt>, which has  by default  a error code and a message as attributes but you can extend it by adding more attributes to your own custom class. 
+In the following file  +config/routes.rb+ you can put this configuration 
 
-The WashOut::SoapError now includes Virtus.model from +virtus+ gem. This way you can add attributes like this:
+ WashOutSample::Application.routes.draw do
+  wash_out :rumbas
+  wash_out :my_other_service
+ end
 
+You can access the url +/washout+ and you will see a list with available services ( in our case there are only two : The RumbasController and MyOtherServiceController) with links to their documentation and where you can find the WSDL.
 
-  class MyCustomSoapError < WashOut::SOAPError
-  
-    attribute :custom_attribute, String
-    attribute :other_custom_attribute, Integer
-  
-   end
+If you want to access directly the hml documentation that was generated for RumbasController  you can do that by accessing url +/rumbas/doc+ And the WSDL will be available at +/rumbas/wsdl+
 
-<b> If your custom exception class doesn't  have any  attributes set, only the inherited attributes will appear!!!</b> 
+
+When specifying the <b>soap_service</b> you can also pass a <b>option for description</b> . Here is an example
+
+  soap_service  namespace: "http://my.app.com/my_service/wsdl", 
+   :description => "here goes some description for your service"
+
+When specifying the <b>soap_action</b> you can also pass a <b>option for description</b> and a <b>list of exceptions(need to be classes)</b> that the method can raise at a certain moment.
 
 Here is an example :
 
@@ -86,20 +90,38 @@ Here is an example :
   :description => "some description about this method to show in the documentation"
 
 
-In order to see the documentation you must write something like this  in the routes (exactly like you would do when using only WashOut)
+The exception classes used <b>must inherit</b> from  <tt>WashOut::SOAPError</tt>, which has  by default  a error code and a message as attributes but you can extend it by adding more attributes to your own custom class. 
 
-In the following file  +config/routes.rb+ you can put this configuration 
+The WashOut::SoapError now includes Virtus.model from +virtus+ gem. This way you can add attributes like this:
 
- WashOutSample::Application.routes.draw do
-  wash_out :rumbas
-  wash_out :my_other_service
- end
+  class MyCustomSoapError < WashOut::SOAPError
+  
+    attribute :custom_attribute, String
+    attribute :other_custom_attribute, Integer
+  
+   end
+   
+You can also specify complex types like this:
 
-You can access the url +/washout+ and you will see a list with available services ( in our case there are only two : The RumbasController and MyOtherServiceController) with links to their documentation and where you can find the WSDL.
+  class MyCustomSoapError < WashOut::SOAPError
+  
+   attribute :errors,Array[Integer]
+   attribute :custom, Array[MyCustomModel]
+   attribute :custom2, MyCustomModel
+  
+   end
 
-If you want to access directly the hml documentation that was generated for RumbasController  you can do that by accessing url +/rumbas/doc+ And the WSDL will be available at +/rumbas/wsdl+
+<b>The class MyCustomModel must include +Virtus.model+ if you want it to show up in the documentation!</b> 
+
+And you can also use inheritance between custom exception classes like this:
 
+  class MySecondCustomSoapError < MyCustomSoapError
+  
+    atribute :option , String
+  
+   end
 
+And you will see in the documentation that the class +MySecondCustomSoapError+ will extend +MyCustomSoapError+
 
 = Testing
 

data/app/views/wash_with_html/doc.builder

@@ -42,9 +42,9 @@ xml.html( "xmlns" => "http://www.w3.org/1999/xhtml" ) {
         xml.a( "href" => "#{@namespace}") { |y| y << "#{@namespace}" }
       };}
 
-    unless @service_description.blank?
+    unless @soap_config.description.blank?
       xml.h1 "#{@service}"
-      xml.p "#{@service_description}"
+      xml.p "#{@soap_config.description}"
     end
 
     xml.div("class" => "noprint") {

data/lib/washout_builder/version.rb

@@ -1,3 +1,3 @@
 module WashoutBuilder
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

metadata

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