washout_builder 0.16.4 → 0.16.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43e83e0edb7d4949ee51ce2e81ce046cd56c3fe0
-  data.tar.gz: 54b316fadb23c7f03eb7ea48d7ff92ea59cbf9fe
+  metadata.gz: 4c29c616804c414323cef5873a40c5dc32dda16d
+  data.tar.gz: fcc127cab6b7b6c839df8a93f614d4d05bd9b6b2
 SHA512:
-  metadata.gz: db3f828270ebe965afb3f4db0db59eda59dc27cba1f517c51edac8ef5542923d37fe01559c7d186793775ef0e3cd76f384af70c71969ca993cbe46efac3217e2
-  data.tar.gz: 000637b4606ec221796d1efd7f976cdabaa1c43ca8d4ced6a6e5561c47d9ee75523e59506f1b1c20424545e9ba07a6fc3867fdb16dfb0819e92f6221eb4e15b6
+  metadata.gz: 99929f3655c1dc6a46df4fdeec82e9aaf2ce3c0c23046a9414df4c3fd40297f151ad697b11ea25ba9bff4cc4ec9b7983a4093c1a6a49034e228e859ad92c0c07
+  data.tar.gz: 4c95effbfe698198b8704b4111b99f335cb11a2a4d88e6e3eba6b7aaf59aa33215689e46e98653a80bd2a43944a321e21a6cc4c8680bcaa8e1bde80d00a2298e

data/README.rdoc

@@ -1,5 +1,5 @@
 = 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://travis-ci.org/bogdanRada/washout_builder.png?branch=master,develop" />}[https://travis-ci.org/bogdanRada/washout_builder]
 {<img src="https://gemnasium.com/bogdanRada/washout_builder.svg" alt="Dependency Status" />}[https://gemnasium.com/bogdanRada/washout_builder]
 {<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]
@@ -17,11 +17,13 @@ The way WashOut is used is not modified, it just extends its functionality by ge
 * 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
 
-= Screenshots (just an example)
+= LIVE DEMO!!!
 
-* {Screenshot 1}[https://f.cloud.github.com/assets/1104923/1582604/53ad8c04-51f1-11e3-963c-fb6c58d0a6a6.png]
-* {Screenshot 2}[https://f.cloud.github.com/assets/1104923/1563031/0efe630c-5058-11e3-8502-1e0b145de80c.png]
-* {Screenshot 3}[https://f.cloud.github.com/assets/1104923/1563032/0f43ddb0-5058-11e3-91d1-35409d4017b0.png]
+* {Demo Application}[http://washout-builder.herokuapp.com/]
+
+= Demo app source code:
+
+* {Source code}[https://github.com/bogdanRada/washout_builder_demo]
 
 = Requirements
 
@@ -33,9 +35,9 @@ The way WashOut is used is not modified, it just extends its functionality by ge
 
 Rails >3.0 only. MRI 1.9, 2.0, .
 
-JRuby is not offically supported since 0.15.0. 
+JRuby is not offically supported since 0.15.0.
 
-Ruby 1.8 is not officially supported since 0.5.3. 
+Ruby 1.8 is not officially supported since 0.5.3.
 
 We will accept further compatibilty pull-requests but no upcoming versions will be tested against it.
 
@@ -45,23 +47,23 @@ Rubinius support temporarily dropped since 0.6.2 due to Rails 4 incompatibility.
 
 Type the following from the command line to install:
 
-  gem install washout_builder  
+  gem install washout_builder
 
 Add the following to your Gemfile:
 
-  
+
   gem "washout_builder"
 
 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 
+  gem 'wash_out'       # The WashOut gem  would be used also  in production
 
   group :development, :test do
-    gem 'washout_builder'            # only  available in development mode. 
+    gem 'washout_builder'            # only  available in development mode.
   end
- 
+
 
 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.
 
@@ -72,7 +74,7 @@ You can still do everything that gem does .
 
 In order to see the documentation you must write something like this  in the routes (exactly like you would do when using only WashOut)
 
-In the following file  +config/routes.rb+ you can put this configuration 
+In the following file  +config/routes.rb+ you can put this configuration
 
  WashOutSample::Application.routes.draw do
   wash_out :rumbas
@@ -82,32 +84,32 @@ In the following file  +config/routes.rb+ you can put this configuration
     wash_out :project_service
   end
 
-  mount WashoutBuilder::Engine => "/washout" 
+  mount WashoutBuilder::Engine => "/washout"
  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.
 
-If you want to access directly the hml documentation that was generated for RumbasController  you can do that by accessing url like this:  
+If you want to access directly the hml documentation that was generated for RumbasController  you can do that by accessing url like this:
 
- /washout/Rumbas    #camelcase name 
- /washout/rumbas    #without camelcase   
+ /washout/Rumbas    #camelcase name
+ /washout/rumbas    #without camelcase
 
  /washout/Api::ProjectService   # for namespaced services with camelcase
  /washout/api/project_service   # without camelcase
 
 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", 
+  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 :
 
- soap_action "find",  
+ soap_action "find",
   :args   => {:number => :integer} ,
-  :return => :boolean, 
-  :raises => [MyCustomSoapError, MyOtherCustomSoapError ] , 
+  :return => :boolean,
+  :raises => [MyCustomSoapError, MyOtherCustomSoapError ] ,
   :description => "some description about this method to show in the documentation"
 
 

data/lib/washout_builder/version.rb

@@ -12,7 +12,7 @@ module WashoutBuilder
     # the minor version of the gem
     MINOR = 16
     # the tiny version of the gem
-    TINY = 4
+    TINY = 5
     # 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: 0.16.4
+  version: 0.16.5
 platform: ruby
 authors:
 - bogdanRada
@@ -568,66 +568,6 @@ files:
 - app/views/wash_with_html/all_services.builder
 - app/views/wash_with_html/doc.builder
 - config/routes.rb
-- example/test_app/.gitignore
-- example/test_app/Gemfile
-- example/test_app/README.rdoc
-- example/test_app/Rakefile
-- example/test_app/app/assets/images/.keep
-- example/test_app/app/assets/javascripts/application.js
-- example/test_app/app/assets/stylesheets/application.css
-- example/test_app/app/controllers/api/core.rb
-- example/test_app/app/controllers/api/project_service_controller.rb
-- example/test_app/app/controllers/api/rumbas_controller.rb
-- example/test_app/app/controllers/application_controller.rb
-- example/test_app/app/controllers/concerns/.keep
-- example/test_app/app/helpers/application_helper.rb
-- example/test_app/app/mailers/.keep
-- example/test_app/app/models/.keep
-- example/test_app/app/models/api/fluffy.rb
-- example/test_app/app/models/api/fluffy_container.rb
-- example/test_app/app/models/api/project_type.rb
-- example/test_app/app/models/api/test_namespace/test_type.rb
-- example/test_app/app/models/concerns/.keep
-- example/test_app/app/models/user.rb
-- example/test_app/app/views/layouts/application.html.erb
-- example/test_app/bin/bundle
-- example/test_app/bin/rails
-- example/test_app/bin/rake
-- example/test_app/bin/setup
-- example/test_app/bin/spring
-- example/test_app/config.ru
-- example/test_app/config/application.rb
-- example/test_app/config/boot.rb
-- example/test_app/config/database.yml
-- example/test_app/config/environment.rb
-- example/test_app/config/environments/development.rb
-- example/test_app/config/environments/production.rb
-- example/test_app/config/environments/test.rb
-- example/test_app/config/initializers/api_token.rb
-- example/test_app/config/initializers/assets.rb
-- example/test_app/config/initializers/backtrace_silencers.rb
-- example/test_app/config/initializers/cookies_serializer.rb
-- example/test_app/config/initializers/filter_parameter_logging.rb
-- example/test_app/config/initializers/inflections.rb
-- example/test_app/config/initializers/mime_types.rb
-- example/test_app/config/initializers/session_store.rb
-- example/test_app/config/initializers/wrap_parameters.rb
-- example/test_app/config/locales/en.yml
-- example/test_app/config/routes.rb
-- example/test_app/config/secrets.yml
-- example/test_app/db/migrate/20150826095420_create_users.rb
-- example/test_app/db/schema.rb
-- example/test_app/db/seeds.rb
-- example/test_app/lib/assets/.keep
-- example/test_app/lib/tasks/.keep
-- example/test_app/log/.keep
-- example/test_app/public/404.html
-- example/test_app/public/422.html
-- example/test_app/public/500.html
-- example/test_app/public/favicon.ico
-- example/test_app/public/robots.txt
-- example/test_app/vendor/assets/javascripts/.keep
-- example/test_app/vendor/assets/stylesheets/.keep
 - init.rb
 - lib/washout_builder.rb
 - lib/washout_builder/document/complex_type.rb

data/example/test_app/.gitignore

@@ -1,17 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-journal
-
-# Ignore all logfiles and tempfiles.
-/log/*
-!/log/.keep
-/tmp

data/example/test_app/Gemfile

@@ -1,53 +0,0 @@
-source 'https://rubygems.org'
-
-
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem 'rails', '4.2.4'
-# Use sqlite3 as the database for Active Record
-gem 'sqlite3'
-# Use SCSS for stylesheets
-gem 'sass-rails', '~> 5.0'
-# Use Uglifier as compressor for JavaScript assets
-gem 'uglifier', '>= 1.3.0'
-# Use CoffeeScript for .coffee assets and views
-gem 'coffee-rails', '~> 4.1.0'
-# See https://github.com/rails/execjs#readme for more supported runtimes
-# gem 'therubyracer', platforms: :ruby
-
-# Use jquery as the JavaScript library
-gem 'jquery-rails'
-# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
-gem 'turbolinks'
-
-
-gem 'wash_out', git: 'git://github.com/inossidabile/wash_out.git'
-# Gems used only for assets and not required in production environments by
-# default.
-gem 'washout_builder', :path => '../../../washout_builder'
-
-
-
-
-# Use ActiveModel has_secure_password
-# gem 'bcrypt', '~> 3.1.7'
-
-# Use Unicorn as the app server
-# gem 'unicorn'
-
-# Use Capistrano for deployment
-# gem 'capistrano-rails', group: :development
-
-group :development, :test do
-  gem 'better_errors'
-  gem 'binding_of_caller'
-  #codesmell and speed tests
-  gem 'rack-mini-profiler'
-  gem 'rails-footnotes'
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem 'byebug'
-  # Access an IRB console on exception pages or by using <%= console %> in views
-  gem 'web-console', '~> 2.0'
-
-  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
-  gem 'spring'
-end

data/example/test_app/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/example/test_app/Rakefile

@@ -1,6 +0,0 @@
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Rails.application.load_tasks

data/example/test_app/app/assets/javascripts/application.js

@@ -1,16 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require jquery
-//= require jquery_ujs
-//= require turbolinks
-//= require_tree .

data/example/test_app/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/example/test_app/app/controllers/api/core.rb

@@ -1,20 +0,0 @@
-
-class Api::Core  < ApplicationController
-
-  before_filter :dump_parameters
-
-
-  def require_api_authorization
-    unless Rails.env.development?
-      if request.parameters['Envelope'].present? && request.parameters['Envelope']['Header'].present? &&  request.parameters['Envelope']['Header']['authToken'].present? &&  request.parameters['Envelope']['Header']['authToken']== TestApp::Application.config.api__auth_token
-        return true
-      else
-        head :forbidden
-      end
-    end
-  end
-
-  def dump_parameters
-    Rails.logger.debug params.inspect if Rails.env.development?
-  end
-end

data/example/test_app/app/controllers/api/project_service_controller.rb

@@ -1,28 +0,0 @@
-class Api::ProjectServiceController < Api::Core
-  before_filter  :require_api_authorization
-
-  soap_service  namespace: "#{Rails.configuration.api_namespace}project_service/wsdl"
-
-  # Simple case
-  soap_action "create_or_update",  :args   => Api::ProjectType , :return => :boolean,  :to => :create_or_update
-
-
-  def create_or_update
-    render :soap => true
-  end
-
-  soap_action "delete_member",  :args   => {:mail  => :string, 'redmine_projectid' => :integer, "project_type"=> Api::TestNamespace::TestType } , :return => :boolean,  :to => :set_inactive_project_assignment
-
-  def set_inactive_project_assignment
-  render :soap => true
-  end
-
-
-
-  soap_action "add_members",  :args   => {:members  =>  [{:mail => :string }] , 'redmine_projectid' => :integer, 'project_type' => :string} , :return => :boolean,  :to => :create_or_set_active_project_assignment
-
-  def create_or_set_active_project_assignment
-    render :soap => true
-  end
-
-end

data/example/test_app/app/controllers/api/rumbas_controller.rb

@@ -1,83 +0,0 @@
-class Api::RumbasController < Api::Core
-  soap_service namespace: 'urn:WashOut'
-
-  # Simple case
-  soap_action "integer_to_string",
-              :args   => :integer,
-              :return => :string
-  def integer_to_string
-    render :soap => params[:value].to_s
-  end
-
-  soap_action "concat",
-              :args   => { :a => :string, :b => :string },
-              :return => :string
-  def concat
-    render :soap => (params[:a] + params[:b])
-  end
-
-  # Complex structures
-  soap_action "AddCircle",
-              :args   => { :circle => { :center => { :x => :integer,
-                                                     :y => :integer },
-                                        :radius => :double } },
-              :return => nil, # [] for wash_out below 0.3.0
-              :to     => :add_circle
-  def add_circle
-    circle = params[:circle]
-
-    raise SOAPError, "radius is too small" if circle[:radius] < 3.0
-
-    Circle.new(circle[:center][:x], circle[:center][:y], circle[:radius])
-
-    render :soap => nil
-  end
-
-  # Arrays
-  soap_action "integers_to_boolean",
-              :args => { :data => [:integer] },
-              :return => [:boolean]
-  def integers_to_boolean
-    render :soap => params[:data].map{|x| x ? 1 : 0}
-  end
-
-  # Params from XML attributes;
-  # e.g. for a request to the 'AddCircle' action:
-  #   <soapenv:Envelope>
-  #     <soapenv:Body>
-  #       <AddCircle>
-  #         <Circle radius="5.0">
-  #           <Center x="10" y="12" />
-  #         </Circle>
-  #       </AddCircle>
-  #     </soapenv:Body>
-  #   </soapenv:Envelope>
-  soap_action "AddCircle",
-              :args   => { :circle => { :center => { :@x => :integer,
-                                                     :@y => :integer },
-                                        :@radius => :double } },
-              :return => nil, # [] for wash_out below 0.3.0
-              :to     => :add_circle
-  def add_circle
-    circle = params[:circle]
-    Circle.new(circle[:center][:x], circle[:center][:y], circle[:radius])
-
-    render :soap => nil
-  end
-
-  # With a customised input tag name, in case params are wrapped;
-  # e.g. for a request to the 'IntegersToBoolean' action:
-  #   <soapenv:Envelope>
-  #     <soapenv:Body>
-  #       <MyRequest>  <!-- not <IntegersToBoolean> -->
-  #         <Data>...</Data>
-  #       </MyRequest>
-  #     </soapenv:Body>
-  #   </soapenv:Envelope>
-  soap_action "integers_to_boolean",
-              :args => { :my_request => { :data => [:integer] } },
-              :as => 'MyRequest',
-              :return => [:boolean]
-
-
-end