roqua-support 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1991866262608934e88ac4b7d2cd0d794477ec72
-  data.tar.gz: 0eb198caeb8ca15f35086ca0fb66b97611779195
+  metadata.gz: 548055897fac03f26d5dddd82f144fa64d34d813
+  data.tar.gz: f497700a4fffb165d1b8b9a8d5ddc486bd77c841
 SHA512:
-  metadata.gz: f695a20d4bf268ec51a62ac3f3535b7078d4e395511df2ceadb81e685eddb2e3d34129fdceee704650fb52f9e39a9061c516ce09d57167c0843d16b58993c0ee
-  data.tar.gz: 19bb1d53157b599e686067628cc0eaaab20a7e648a8a7ffebf90e3a4355afec1107456e356f94ad6906b5ecf6e8cd475ecd0035fd4ad4249ce650a7393d6c6e8
+  metadata.gz: c8936bf834d18d7799e200de067c5739132b617c1aaf9e5cfe5fb44d2734ea277abad62ee3d7ecf7a60df0429b803919c757c1e9191fc8fcb02fe7726570b831
+  data.tar.gz: 6040338582c978cd5b0b00ff7d3bffdf728862c3551af1d7d517f579e57d3edb515d813c41ac9cab8b3acbb9c9247386d9514d1638b3599643b5394c1b991609

data/.gitignore

@@ -11,6 +11,8 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/spec
+spec/internal/log
 test/tmp
 test/version_tmp
-tmp
+tmp

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.10 / 2014-10-30
+
+* Added ActiveInteractionAwareResponder
+* Added ApiErrorsResponder
+
 ## 0.1.9 / 2014-06-18
 
 * add Fabricate.clear_singletons! utility method

data/Gemfile

@@ -6,4 +6,8 @@ gemspec
 group :test do
   gem 'guard-rspec', '~> 4.2.6'
   gem 'fuubar',      '~> 1.3.2'
+  gem 'actionpack',       '~> 4.0'
+  gem 'rspec-rails'
+  gem 'combustion', '~> 0.5.2'
+  gem 'active_interaction', '~> 1.0'
 end

data/Gemfile.lock

@@ -7,75 +7,116 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.1)
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    active_interaction (1.3.0)
+      activemodel (>= 3.2, < 5)
+    activemodel (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+    activesupport (4.1.6)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    celluloid-io (0.15.0)
-      celluloid (>= 0.15.0)
-      nio4r (>= 0.5.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
     coderay (1.1.0)
+    combustion (0.5.2)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
     diff-lcs (1.2.5)
-    ffi (1.9.3)
-    formatador (0.2.4)
-    fuubar (1.3.2)
+    erubis (2.7.0)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    fuubar (1.3.3)
       rspec (>= 2.14.0, < 3.1.0)
-      ruby-progressbar (~> 1.3)
-    guard (2.4.0)
+      ruby-progressbar (~> 1.4)
+    guard (2.7.0)
       formatador (>= 0.2.4)
-      listen (~> 2.1)
+      listen (~> 2.7)
       lumberjack (~> 1.0)
       pry (>= 0.9.12)
       thor (>= 0.18.1)
-    guard-rspec (4.2.6)
+    guard-rspec (4.2.10)
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
-    i18n (0.6.9)
+    hitimes (1.2.2)
+    i18n (0.6.11)
     json (1.8.1)
-    listen (2.5.0)
+    listen (2.7.11)
       celluloid (>= 0.15.2)
-      celluloid-io (>= 0.15.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    lumberjack (1.0.4)
+    lumberjack (1.0.9)
     method_source (0.8.2)
-    minitest (5.3.5)
-    nio4r (1.0.0)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
+    minitest (5.4.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.1.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
     rb-fsevent (0.9.4)
-    rb-inotify (0.9.3)
+    rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    ruby-progressbar (1.4.1)
-    slop (3.4.7)
-    thor (0.18.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-rails (3.0.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    ruby-progressbar (1.6.0)
+    slop (3.6.0)
+    thor (0.19.1)
     thread_safe (0.3.4)
-    timers (1.1.0)
-    tzinfo (1.2.1)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionpack (~> 4.0)
+  active_interaction (~> 1.0)
   bundler (~> 1.0)
+  combustion (~> 0.5.2)
   fuubar (~> 1.3.2)
   guard-rspec (~> 4.2.6)
   rake
   roqua-support!
   rspec (>= 2.12.0, < 4.0)
+  rspec-rails

data/README.md

@@ -45,6 +45,37 @@ require 'roqua/support/request_logger'
 Roqua::Support::RequestLogger.attach_to :action_controller
 ```
 
+### Responders
+
+#### option 1
+
+Create responder including the required responder modules and use it in a controller.
+
+```ruby
+class ApiResponder < ActionController::Responder
+  include Roqua::Responders::ApiErrorsResponder
+  include Roqua::Responders::ActiveInteractionAwareResponder
+end
+```
+
+```
+class ApiAreaController < ApplicationController
+  self.responder = ApiResponder
+  ...
+```
+
+#### option 2
+
+Use gem 'responders'
+
+And add required responder modules in a controller.
+
+```
+class ApiAreaController < ApplicationController
+  responders :flash, Roqua::Responders::ApiErrorsResponder, Roqua::Responders::ActiveInteractionAwareResponder
+  ...
+```
+
 ## Contributing
 
 1. Fork it

data/lib/roqua-support.rb

@@ -1,2 +1,9 @@
 require "roqua-support/version"
 require "roqua/support"
+
+module Roqua
+  module Responders
+    autoload :ApiErrorsResponder, 'roqua/responders/api_errors_responder'
+    autoload :ActiveInteractionAwareResponder, 'roqua/responders/active_interaction_aware_responder'
+  end
+end

data/lib/roqua-support/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module Support
-    VERSION = "0.1.9"
+    VERSION = "0.1.10"
   end
 end

data/lib/roqua/responders/active_interaction_aware_responder.rb

@@ -0,0 +1,25 @@
+# For json and xml, will render the result of an active_interaction operation if no errors where present.
+# Otherwise renders the interaction
+module Roqua
+  module Responders
+    module ActiveInteractionAwareResponder
+      def to_format
+        if resource.is_a?(ActiveInteraction::Base)
+          if resource.errors.empty?
+            @resource = resource.result
+            @resources[-1] = resource
+          end
+        end
+        super
+      end
+
+      def json_resource_errors
+        if !resource.is_a?(ActiveInteraction::Base) || resource.errors.empty?
+          super
+        else
+          {:errors => resource.errors.as_json}
+        end
+      end
+    end
+  end
+end

data/lib/roqua/responders/api_errors_responder.rb

@@ -0,0 +1,15 @@
+# Scopes json errors to the object-class:
+#
+# @example
+#   {errors: {person: name: ['blank']}}
+#
+# Does not play well with others, replaces json_resource_errors; when including multiple responders, ordering matters.
+module Roqua
+  module Responders
+    module ApiErrorsResponder
+      def json_resource_errors
+        {:errors => {resource.class.name.underscore => resource.errors}}
+      end
+    end
+  end
+end

data/lib/roqua/support/log_wrapper.rb

@@ -27,7 +27,7 @@ module Roqua
       info("#{message}:finished", {duration: duration}.merge(options))
       value
     rescue => e
-      error("#{message}:failed", {exception: e.class, message: e.message}.merge(options))
+      error("#{message}:failed", {exception: e.class.name, message: e.message}.merge(options))
       raise
     end
   end

data/spec/roqua/responders/active_interaction_aware_responder_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+require 'roqua/responders/active_interaction_aware_responder'
+class AIAResponder < ActionController::Responder
+  include Roqua::Responders::ActiveInteractionAwareResponder
+end
+
+require 'active_interaction'
+class TestInteraction < ActiveInteraction::Base
+  string :some_string
+  def execute
+    {foo: some_string}
+  end
+end
+
+class ApplicationController < ActionController::Base
+  respond_to :json
+end
+
+describe Roqua::Responders::ActiveInteractionAwareResponder, type: :controller do
+  context 'with a valid interaction' do
+    controller(ApplicationController) do
+      self.responder  = AIAResponder
+      def index
+        use_case = TestInteraction.run some_string: 'bla'
+        respond_with use_case
+      end
+    end
+
+    subject { get :index, format: :json }
+
+    it 'returns the result if valid' do
+      subject
+      expect(response.body).to eq '{"foo":"bla"}'
+    end
+
+  end
+
+  context 'with an invalid interaction' do
+    controller(ApplicationController) do
+      self.responder  = AIAResponder
+      def index
+        use_case = TestInteraction.run
+        respond_with use_case
+      end
+    end
+    subject { post :index, format: :json }
+
+    it 'returns the interaction' do
+      subject
+      expect(response.body).to eq '{"errors":{"some_string":["is required"]}}'
+    end
+  end
+end

data/spec/roqua/responders/api_errors_responder_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'roqua/responders/api_errors_responder'
+class AEResponder < ActionController::Responder
+  include Roqua::Responders::ApiErrorsResponder
+end
+
+class ApplicationController < ActionController::Base
+  respond_to :json
+end
+
+class SomeModel
+  include ActiveModel::Model
+
+  attr_accessor :name
+end
+
+describe Roqua::Responders::ApiErrorsResponder, type: :controller do
+  context 'with an invalid model' do
+    controller(ApplicationController) do
+      self.responder  = AEResponder
+      def index
+        sm = SomeModel.new name: 'foo'
+        sm.errors.add :name, "That is not a real name"
+        respond_with sm
+      end
+    end
+    subject { post :index, format: :json }
+
+    it 'returns the errors scoped on the object name' do
+      subject
+      expect(response.body).to eq '{"errors":{"some_model":{"name":["That is not a real name"]}}}'
+    end
+  end
+end

data/spec/roqua/support/errors_spec.rb

@@ -1,3 +1,4 @@
+require 'spec_helper'
 require 'roqua/support/errors'
 
 describe 'Error reporting' do
@@ -12,6 +13,7 @@ describe 'Error reporting' do
   let(:logwrapper) { Roqua::LogWrapper.new(logger) }
 
   before do
+    Rails.env = 'foo' # in test we don't log
     Roqua.logger = logwrapper
   end
 

data/spec/roqua/support/logging_spec.rb

@@ -85,4 +85,4 @@ module Roqua
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+
+Combustion.initialize! :action_controller
+
+require 'rspec/rails'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-support
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Marten Veldthuis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,6 +102,8 @@ files:
 - lib/roqua/core_ext/enumerable/sort_by_alphanum.rb
 - lib/roqua/core_ext/fabrication/singleton.rb
 - lib/roqua/core_ext/fixnum/clamp.rb
+- lib/roqua/responders/active_interaction_aware_responder.rb
+- lib/roqua/responders/api_errors_responder.rb
 - lib/roqua/support.rb
 - lib/roqua/support/command_runner.rb
 - lib/roqua/support/errors.rb
@@ -114,10 +116,13 @@ files:
 - spec/roqua/core_ext/enumerable/sort_by_alphanum_spec.rb
 - spec/roqua/core_ext/fabrication/singleton_spec.rb
 - spec/roqua/core_ext/fixnum/clamp_spec.rb
+- spec/roqua/responders/active_interaction_aware_responder_spec.rb
+- spec/roqua/responders/api_errors_responder_spec.rb
 - spec/roqua/support/errors_spec.rb
 - spec/roqua/support/logging_spec.rb
 - spec/roqua/support/request_logger_spec.rb
 - spec/roqua/support_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/roqua/healthy
 licenses:
 - MIT
@@ -138,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Helper objects and proxies used by a lot of RoQua applications
@@ -148,7 +153,11 @@ test_files:
 - spec/roqua/core_ext/enumerable/sort_by_alphanum_spec.rb
 - spec/roqua/core_ext/fabrication/singleton_spec.rb
 - spec/roqua/core_ext/fixnum/clamp_spec.rb
+- spec/roqua/responders/active_interaction_aware_responder_spec.rb
+- spec/roqua/responders/api_errors_responder_spec.rb
 - spec/roqua/support/errors_spec.rb
 - spec/roqua/support/logging_spec.rb
 - spec/roqua/support/request_logger_spec.rb
 - spec/roqua/support_spec.rb
+- spec/spec_helper.rb
+has_rdoc: