washout_builder 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b43fddeb45664fd77e68b4f381d0527f05f1b33
-  data.tar.gz: dcd30f9428b187356b23b67066cc45ef0061cde4
+  metadata.gz: b8b50b25747f6af3feb7d0a12b37a0b6852afff0
+  data.tar.gz: 1db16f0e175ddfde4b33db6af4632f7296356485
 SHA512:
-  metadata.gz: 2e303eef7c0b1cb37fec341ff73e7aafc1e64ca749c547ba25f626990eec90d4a4e767c2ac8dfd5d1e7a46f5442d68f5b376a725fbcc203171ebcc043e6dd377
-  data.tar.gz: c1f6c1c75275cdf4e14176e69e8353cb6c67c499a3552f164332d34a386857051dc941fd6c2a98d8058ac58e90007c8d5e24df59b0bbc083c9ce8b6c626e01e2
+  metadata.gz: fa41d90617873733ec118b9e9e707904127a085ee4295640d1ebc607bb8e18ec8c4f751644f2a5ccaffd2f1e18bfba7c572fac06f667486fd9523af01d2656bb
+  data.tar.gz: f909f7ee2631bcec25593e46d29aa7a2acf0ff35aa88b868e605bd846d3c9e1d7bd05172e9e3af09711c6fec23af2abcdb654ee082c457c1d98b53882dc94f5f

data/README.md

@@ -10,6 +10,24 @@ 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.5.0
+---------------------------------
+
+-	The WashoutBuilder::Engine can now be automatically be mounted in Rails application by using a simple configuration in **config/application.rb** which allows you to whitelist or blacklist the environment where WashoutBuilder::Engine can be mounted .
+-	By default all the options are set to **nil**, so the engine does not get mounted automatically by default. You need to set them if you want this to work.
+
+E.g.
+
+```ruby
+if config.respond_to?(:washout_builder) # needed in case the gem is not in the default group
+  config.washout_builder.mounted_path = "/washout"  # the path where the engine should be mounted on
+  config.washout_builder.whitelisted_envs = "*" # this can either be an array of strings or a string. If you specify "*" ,will mean all environments , otherwise you can specify "development" or ['development', 'staging'] or nil
+  config.washout_builder.blacklisted_envs = nil # this can either be an array of strings or a string. You can specify for example "production" or ['production', 'test'], or nil
+end
+```
+
+If you don't set them and they are left with default nil values, you will have to use the old way, by manually mount the engine in the Rails routes configuration file (**config/routes.rb**) by following examples below.
+
 NEW Improvements in version 1.4.0
 ---------------------------------
 
@@ -108,7 +126,8 @@ WashOutSample::Application.routes.draw do
         wash_out :project_service
     end
 
-    mount WashoutBuilder::Engine => "/washout"
+    # The verfication "if defined?(WashoutBuilder::Engine)" is needed in case the "washout_builder" gem is not in the default group
+    mount WashoutBuilder::Engine => "/washout" if defined?(WashoutBuilder::Engine)
 end
 
 ```

data/lib/washout_builder.rb

@@ -2,31 +2,38 @@ require 'wash_out'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/concern'
-require 'active_support/core_ext/string/output_safety.rb'
+require 'active_support/core_ext/string/output_safety'
+require 'active_support/ordered_options'
+require 'active_support/core_ext/string/starts_ends_with'
 
 Gem.find_files('washout_builder/**/*.rb').each { |path| require path }
 
 
 ActionDispatch::Routing::Mapper.class_eval do
   alias_method :original_wash_out, :wash_out
-    # Adds the routes for a SOAP endpoint at +controller+.
-    def wash_out(controller_name, options={})
+  # Adds the routes for a SOAP endpoint at +controller+.
+  def wash_out(controller_name, options={})
+    env_checker = WashoutBuilder::EnvChecker.new(Rails.application)
+    if env_checker.available_for_env?(Rails.env)
+      options = options.symbolize_keys if options.is_a?(Hash)
       if @scope
         scope_frame = @scope.respond_to?(:frame) ? @scope.frame : @scope
-        options.each_with_index { |key, value|  scope_frame[key] = value }
+        # needed for backward compatibility with old version when this module name was camelized
+        options[:module] = options[:module].to_s.underscore if options[:module].present?
+        options.each { |key, value|  scope_frame[key] = value }
+        controller_class_name = [scope_frame[:module], controller_name].compact.join("/").underscore
+      else
+        controller_class_name = controller_name.to_s.underscore
       end
 
-      controller_class_name = [options[:module], controller_name].compact.join("/").underscore
-
       match "#{controller_name}/soap_doc"   =>  WashoutBuilder::Engine, via: :get,
-        defaults: { name: "#{controller_class_name}" },
-        format: false,
-        as: "#{controller_class_name}_soap_doc"
-
-        original_wash_out(controller_name, options)
+      defaults: { name: "#{controller_class_name}" },
+      format: false,
+      as: "#{controller_class_name}_soap_doc"
     end
+    original_wash_out(controller_name, options)
+  end
 end
-
 # finds all the exception class and extends them by including the ExceptionModel module in order to be
 # able to generate documentation for exceptions
 WashoutBuilder::Type.all_fault_classes.each do |exception_class|

data/lib/washout_builder/engine.rb

@@ -1,8 +1,16 @@
+require_relative './env_checker'
 module WashoutBuilder
   # the engine that is used to mount inside the rails application
   class Engine < ::Rails::Engine
     isolate_namespace WashoutBuilder
-    initializer 'washout_builder.configuration' do |_app|
+    config.washout_builder = ActiveSupport::OrderedOptions.new
+    initializer 'washout_builder.configuration' do |app|
+      mounted_path = app.config.washout_builder[:mounted_path]
+      if WashoutBuilder::EnvChecker.new(app).available_for_env?(Rails.env)
+        app.routes.append do
+          mount WashoutBuilder::Engine => mounted_path if mounted_path.is_a?(String) && mounted_path.starts_with?('/')
+        end
+      end
     end
   end
 end

data/lib/washout_builder/env_checker.rb

@@ -0,0 +1,50 @@
+module WashoutBuilder
+  class EnvChecker
+
+    attr_reader :whitelist, :blacklist
+    attr_writer :whitelist, :blacklist
+
+    def initialize(app)
+      self.whitelist = get_valid_data(app.config.washout_builder[:whitelisted_envs])
+      self.blacklist = get_valid_data(app.config.washout_builder[:blacklisted_envs])
+    end
+
+    def available_for_env?(env_name)
+      if (whitelist.present? || blacklist.present?)
+        if whitelist.find{|a| blacklist.include?(a) }.blank?
+          if whitelist.include?('*') || (!valid_for_env?(blacklist, env_name) && valid_for_env?(whitelist, env_name))
+            return true
+          end
+        end
+      else
+        return true
+      end
+      return false
+    end
+
+
+    private
+
+    def valid_for_env?(list, env_name)
+      try_find_suitable_env(list, env_name).present?
+    end
+
+    def get_valid_data(list)
+      list.is_a?(Array) ? list : [list].compact
+    end
+
+    def try_find_suitable_env(list, env_name)
+      return if list.blank?
+      # The keys of the map can be strings or regular expressions that are
+      # matched against the env name and returns the found value
+      list.find do |env_pattern|
+        if env_pattern.is_a? Regexp
+          env_pattern.match env_name
+        elsif env_pattern.is_a? String
+          env_pattern == env_name
+        end
+      end
+    end
+
+  end
+end

data/lib/washout_builder/version.rb

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

data/spec/app/controllers/washout_builder_controller_spec.rb

@@ -27,7 +27,7 @@ describe WashoutBuilder::WashoutBuilderController, type: :controller do
 
   it 'gets the services' do
     get :all
-    expect(assigns(:services)).to eq([{ 'service_name' => 'Api', 'namespace' => '/api/wsdl', 'endpoint' => '/api/action', 'documentation_url' => 'http://test.host/Api' }])
+    expect(assigns(:services)).to eq([{ 'service_name' => 'Api', 'namespace' => '/api/wsdl', 'endpoint' => '/api/action', 'documentation_url' => '/api/soap_doc' }])
   end
 
   it 'renders the template' do
@@ -43,7 +43,7 @@ describe WashoutBuilder::WashoutBuilderController, type: :controller do
   it 'render a service documentation' do
     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])
+    WashoutBuilder::Document::Generator.expects(:new).with(route, route.defaults[:controller])
     get :all, params
     expect(response).to render_template 'wash_with_html/doc'
   end

data/spec/lib/washout_builder/document/generator_spec.rb

@@ -29,8 +29,17 @@ describe WashoutBuilder::Document::Generator do
   end
 
   let(:service_class) { ApiController }
+  let(:route_details) { mock }
+  let(:route_set) { mock }
+  let(:route_url_helpers) { mock }
+
+  before(:each) do
+    route_details.stubs(:[]).with(:route_set).returns(route_set)
+    route_set.stubs(:url_helpers).returns(route_url_helpers)
+    route_url_helpers.stubs(:url_for).returns(soap_config.namespace)
+  end
   before(:each) do
-    @document = WashoutBuilder::Document::Generator.new('api')
+    @document = WashoutBuilder::Document::Generator.new(route_details, 'api')
     @document.stubs(:controller_class).returns(service_class)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: washout_builder
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - bogdanRada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wash_out
@@ -368,6 +368,7 @@ files:
 - lib/washout_builder/document/generator.rb
 - lib/washout_builder/document/shared_complex_type.rb
 - lib/washout_builder/engine.rb
+- lib/washout_builder/env_checker.rb
 - lib/washout_builder/param.rb
 - lib/washout_builder/soap.rb
 - lib/washout_builder/type.rb
@@ -480,3 +481,4 @@ 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: