washout_builder 0.3.5 → 0.3.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTBjY2VlMDQ3YTc5N2ZjZWIzOTU5MWI5NDEwOTBmMTMzYWM2NDVmNg==
+    ODQ0MzViM2Y5MzVhZDc5MDg5MDkyMTJmMTU5YTlmYzA4YTg5MDhhNw==
   data.tar.gz: !binary |-
-    OTViODkwOTQyOTY2Y2I1MjI3YmI1Mzc4OTczMjRlZDVjOTViOGYxOQ==
+    ZGVmODdiOTUxODhiODk1YjkwMDc1MWZlOWZkOGJkYjgwOTYxOTI3Nw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDZkYjlkZDFlMDEwYTEwNTJjMzMyOWQxYzk2YmYxYTUyZWUwNTA4MTZhZDU2
-    NWQ2NWFhOWQxYzIyMGY3ODg1MWIxZjIyOTI1MjM3YTBkYTNmNWZkYzQ1MzQ0
-    ODA5NzgxNzdiOTUzN2Q2NTE1NGU5ZGJhZDgxN2UwZjU4ZTRiNDE=
+    ZTQ2NTY5NGE3ZWMyMTQwMWEzMDk2ZDNkZWNiMjNmMzBkOGI1ZDM4MzEzMzMx
+    NmJhODViNGE4MTA4ZTFjZjNhY2EyN2FjNGI0ZGYyODllMzA1ZmQ1ZmEzYTEw
+    ZmE1M2U3OGMwMTcxYTljYmJkZTQ3OTk3YTAxYTZlNjcwMjc2NWM=
   data.tar.gz: !binary |-
-    Yjg5MTQ5ZDM3ZDg3NjAxY2U0ZmQ0YTIyYmRhMmZhOWY1NmExNDM5YzA5Nzk1
-    OWM2YmU3MGM1NjgzMWYxOTgzYzk4N2FkZGE4NDQ2ZDk1YWE0Zjg1MjA4OGU1
-    OWMwMzQ5YWEzZjMxZGYyZTNlYzQzN2RmOWI0NjNlMTA2ZWI3NzI=
+    OTdhZjYwNGY5OGY5NjFhMzBiNjZlNzBlYzFlZmYyOWI2Y2RiNWM5ZWMwYmVl
+    M2ZhMzEwMzQ0MmNhMDRiNDFmYTAxMjk0YWI4MzFjNmNmYmY0MjFlYjdkZDg5
+    ZWU4ZWE5MzY4NmI3MjJkMDE1ZTJhMjJlNzA5NzdmOTI2ZGU1MTE=

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 gemspec
 
 
-gem 'wash_out', "~> 0.9.1"
+gem 'wash_out', "~> 0.9.1",  git: 'git://github.com/inossidabile/wash_out.git'
 
 gem 'wasabi'
 gem 'savon', '>= 2.0.0'

data/README.rdoc

@@ -3,13 +3,12 @@
 = Overview
 WashOutBuilder is a  Soap Service Documentation generator (extends WashOut https://github.com/inossidabile/wash_out/)
 
-The way WashOut is used is not modified, it just extends its functionality by providing html documentation
+The way WashOut is used is not modified, it just extends its functionality by generating html documentation to your services that you write
 
 = Features
 
 * Provides way of seeing the available services with links to documentation, endpoint and namespace
 * Provides a human-readable HTML documentation generated  for each service that you write
-* Can also create custom exception  classes and use them to send custom fault errors to the client application
 
 = Screenshots (just an example)
 
@@ -21,7 +20,7 @@ The way WashOut is used is not modified, it just extends its functionality by pr
 
 1. {Ruby 1.9.x}[http://www.ruby-lang.org]
 2. {Ruby on Rails}[http://rubyonrails.org].
-3. {WashOut Gem v. 0.9.0}[https://github.com/inossidabile/wash_out]
+3. {WashOut Gem v. 0.9.1}[https://github.com/inossidabile/wash_out]
 4. {Nori Gem}[https://github.com/savonrb/nori]
 
 = Compatibility
@@ -40,10 +39,20 @@ Type the following from the command line to install:
 
 Add the following to your Gemfile:
 
-  gem 'wash_out',"~> 0.9.0", git: 'git://github.com/inossidabile/wash_out.git'
+  
   gem "washout_builder"
 
-it will automatically install  also wash_out version 0.9.0 that is currently used
+it will automatically install  also +wash_out+ gem  that is currently used
+
+Or if you want this to be available only in development mode , you can do something like this inside the Gemfile:
+
+  gem 'wash_out'       # The WashOut gem  would be used also  in production 
+
+  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.
 
@@ -52,8 +61,11 @@ 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 soap_action you can also pass a option for description and a list of exceptions that the method can raise at a certain moment.
-The exception classes used must inherit from WashOut::SoapError and have accessible_attributes in order to show up in the documentation
+When specifying the <b>soap_action</b> you can also pass a <b>option for description</b> and a <b>list of exceptions</b> that the method can raise at a certain moment.
+
+The exception classes used <b>must inherit</b> from  <tt>WashOut::Dispatcher::SOAPError</tt>
+
+This class  <tt>WashOut::Dispatcher::SOAPError</tt> has  by default  a error code and a message as attributes but you can extend it by adding more accessible_attributes to your own custom class. 
 
 Here is an example :
 
@@ -73,20 +85,7 @@ You can access the url +/washout+ and you will see a list with available service
 
 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+
 
-= Setup  custom  exceptions
-
-There is a class WashOut::SoapError
-This class has as attributes :  a error_code, and a message. 
-
-If you only  want to send a faultcode for your exception in the webservice application you can do this
-
- class MyException < WashOut::SoapError; end
- 
-and then when you raise it in the code you can do this 
-
-  raise MyException.new (1001, "damn! found a error") . 
 
-This exception is going to be catched by the gem and is going to send it to the client with the specified fault code and message
 
 = Testing
 

data/app/helpers/washout_builder_helper.rb

@@ -155,10 +155,11 @@ module WashoutBuilderHelper
   end
 
   def create_html_fault_type(xml, param)
+      if param.ancestors.include?(WashOut::Dispatcher::SOAPError)
     xml.h3 "#{param}"
     xml.a("name" => "#{param}") {}
     xml.ul("class" => "pre") {
-      if param.ancestors.include?(WashoutBuilder::SoapFault)
+    
 
         param.accessible_attributes.each do |attribute|
           xml.li { |pre|
@@ -172,8 +173,8 @@ module WashoutBuilderHelper
           }
         end
         xml.li { |pre| pre << "<span class='blue'>string</span>&nbsp;<span class='bold'>backtrace</span>" }
-      end
     }
+    end
   end
 
   def create_html_public_methods(xml, map)

data/lib/washout_builder/version.rb

@@ -1,3 +1,3 @@
 module WashoutBuilder
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

metadata

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