grape-active_model_serializers 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3e93ead8a09d258d62697918cb9f2c02b928bcd
-  data.tar.gz: 3674a40549e956720723447f751b8a9dea4f2158
+  metadata.gz: 2d1b47b4d3f44dde1cb0c35ce95cb37564f4a136
+  data.tar.gz: 958969c14502aba0f2c60b243a9d748627825639
 SHA512:
-  metadata.gz: b735ccb020ec984ab176a277b0864373923234f0927c87c4b434decf633b8b17281e865753b2b43289524aa65f1db8495f0c3e16155e89f1d84a42957d6e4acd
-  data.tar.gz: a152d5e8e472f71b2dd316bf10815502a13f1fc250c2cffa1a999a2a377ca0e3f0053fe74103120118f3f4c9880d33110c2878a664c81c382d176fbe926e3834
+  metadata.gz: 1b97e9cd92e4b755ac4a724cedbbffc520de4b8a23466589621e8c697ff076eaea3f8f2a1a3d2468246a157c9aacf235476705bfd623cebffc4ad7e2ee7c0f85
+  data.tar.gz: e76168614c025652c0766f42b11a474ea23794774f27f441df99de1a9efbf009af15f263d81afeefaa6d17a65f578cfa47494c5f7f58461d682c00bbaa1321e2

data/.rubocop_todo.yml

@@ -1,20 +1,48 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-01-13 18:47:14 -0500 using RuboCop version 0.28.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-10-09 10:22:52 -0500 using RuboCop version 0.41.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 25
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 1
 Metrics/AbcSize:
-  Max: 20
+  Max: 18
 
-# Offense count: 7
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 87
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 18
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 5
 Style/Documentation:
-  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/grape-active_model_serializers/endpoint_extension.rb'
+    - 'lib/grape-active_model_serializers/error_formatter.rb'
+    - 'lib/grape-active_model_serializers/formatter.rb'
+    - 'lib/grape-active_model_serializers/options_builder.rb'
+    - 'lib/grape-active_model_serializers/serializer_resolver.rb'
 
 # Offense count: 2
-# Configuration parameters: Exclude.
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
 Style/FileName:
-  Enabled: false
+  Exclude:
+    - 'lib/grape-active_model_serializers.rb'
+    - 'spec/grape-active_model_serializers_spec.rb'

data/.travis.yml

@@ -4,29 +4,30 @@ sudo: false
 
 matrix:
   include:
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       script:
         - bundle exec danger
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.8.0
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.9.0
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.10.1
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.12.0
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.13.0
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.14.0
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.15.0
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=0.16.2
-    - rvm: 2.3.1
+    - rvm: 2.5.0
       env: GRAPE_VERSION=HEAD
-    - rvm: 2.3.0
-    - rvm: 2.2.5
+    - rvm: 2.4.3
+    - rvm: 2.3.6
+    - rvm: 2.2.9
     - rvm: rbx-2
     - rvm: jruby-19mode
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,8 +1,8 @@
 ## Changelog
 
-### 1.5.2 (Next)
+### 1.5.2 (March 14, 2018)
 
-* Your contribution here.
+* [#76](https://github.com/ruby-grape/grape-active_model_serializers/pull/76): Add custom error formatter - [@xn](https://github.com/xn).
 
 ### 1.5.1 (April 25, 2017)
 

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-case version = ENV['GRAPE_VERSION'] || '~> 0.10.0'
+case version = ENV['GRAPE_VERSION'] || '~> 1.0.0'
 when 'HEAD'
   gem 'grape', github: 'intridea/grape'
 else

data/README.md

@@ -36,6 +36,12 @@ require 'grape-active_model_serializers'
 class API < Grape::API
   format :json
   formatter :json, Grape::Formatter::ActiveModelSerializers
+
+  # Serializes errors with ActiveModel::Serializer::ErrorSerializer if an ActiveModel.
+  # Serializer conforms to the adapter, ex: json, jsonapi.
+  # So an error formatted with a jsonapi formatter would render as per:
+  # http://jsonapi.org/format/#error-objects
+  error_formatter :json, Grape::Formatter::ActiveModelSerializers
 end
 ```
 

data/RELEASING.md

@@ -0,0 +1,70 @@
+# Releasing Grape::ActiveModelSerializers
+
+There're no particular rules about when to release grape-active_model_serializers. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/ruby-grape/grape-active_model_serializers) for all supported platforms.
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.7.2 (February 6, 2014)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/grape-active_model_serializers/version.rb
+git commit -m "Preparing for release, 0.7.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+grape-active_model_serializers 0.7.2 built to pkg/grape-active_model_serializers-0.7.2.gem.
+Tagged v0.7.2.
+Pushed git commits and tags.
+Pushed grape-active_model_serializers 0.7.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Modify [lib/grape-active_model_serializers/version.rb](lib/grape-active_model_serializers/version.rb), increment the third number (eg. change `0.7.2` to `0.7.3`).
+
+
+```ruby
+module Grape
+  module ActiveModelSerializers
+    VERSION = '0.7.3'.freeze
+  end
+end
+```
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+#### 0.7.3 (Next)
+
+* Your contribution here.
+```
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/grape-active_model_serializers/version.rb
+git commit -m "Preparing for next development iteration, 0.7.3."
+git push origin master
+```

data/lib/grape-active_model_serializers.rb

@@ -1,6 +1,7 @@
 require 'active_model_serializers'
 require 'grape'
 require 'grape-active_model_serializers/endpoint_extension'
+require 'grape-active_model_serializers/error_formatter'
 require 'grape-active_model_serializers/formatter'
 require 'grape-active_model_serializers/serializer_resolver'
 require 'grape-active_model_serializers/options_builder'

data/lib/grape-active_model_serializers/error_formatter.rb

@@ -0,0 +1,53 @@
+module Grape
+  module ErrorFormatter
+    module ActiveModelSerializers
+      extend Base
+
+      class << self
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
+          message = present(message, env) if respond_to?(:present)
+          message = wrap_message(message)
+
+          rescue_options = options[:rescue_options] || {}
+          if rescue_options[:backtrace] && backtrace && !backtrace.empty?
+            message = message.merge(backtrace: backtrace)
+          end
+          if rescue_options[:original_exception] && original_exception
+            message = message
+                      .merge(original_exception: original_exception.inspect)
+          end
+          if ::Grape.const_defined? :Json
+            ::Grape::Json.dump(message)
+          else
+            ::MultiJson.dump(message)
+          end
+        end
+
+        private
+
+        def wrap_message(message)
+          if active_model?(message)
+            ::ActiveModelSerializers::SerializableResource.new(
+              message,
+              serializer: ActiveModel::Serializer::ErrorSerializer
+            ).as_json
+          elsif ok_to_pass_through?(message)
+            message
+          else
+            { error: message }
+          end
+        end
+
+        def active_model?(message)
+          message.respond_to?(:errors) &&
+            message.errors.is_a?(ActiveModel::Errors)
+        end
+
+        def ok_to_pass_through?(message)
+          message.is_a?(Exceptions::ValidationErrors) ||
+            message.is_a?(Hash)
+        end
+      end
+    end
+  end
+end

data/lib/grape-active_model_serializers/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module ActiveModelSerializers
-    VERSION = '1.5.1'.freeze
+    VERSION = '1.5.2'.freeze
   end
 end

data/spec/grape-active_model_serializers/error_formatter_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'grape-active_model_serializers/error_formatter'
+
+describe Grape::ErrorFormatter::ActiveModelSerializers do
+  subject { Grape::ErrorFormatter::ActiveModelSerializers }
+  let(:backtrace) { ['Line:1'] }
+  let(:options) { Hash.new }
+  let(:env) { { 'api.endpoint' => app.endpoints.first } }
+  let(:original_exception) { StandardError.new('oh noes!') }
+
+  let(:app) {
+    Class.new(Grape::API) do |app|
+      app.format :json
+      app.formatter :jsonapi, Grape::Formatter::ActiveModelSerializers
+      app.error_formatter :jsonapi, Grape::ErrorFormatter::ActiveModelSerializers
+
+      app.namespace('space') do |ns|
+        ns.get('/', root: false) do
+          error!(message)
+        end
+      end
+    end
+  }
+  let(:foo) {
+    Class.new {
+      include ActiveModel::Model
+
+      attr_accessor :name
+
+      def initialize(attributes = {})
+        super
+        errors.add(:name, 'We don\'t like bears')
+      end
+    }
+  }
+
+  before do
+    ActiveModel::Serializer.config.adapter = :json_api
+  end
+
+  after do
+    ActiveModel::Serializer.config.adapter = :json
+  end
+
+  describe '#call' do
+    context 'message is an activemodel' do
+      let(:message) {
+        foo.new(name: 'bar')
+      }
+      it 'formats the error' do
+        result = subject
+                 .call(message, backtrace, options, env, original_exception)
+        json_hash = JSON.parse(result)
+
+        expected_result = {
+          'errors' => [
+            {
+              'source' => {
+                'pointer' => '/data/attributes/name'
+              },
+              'detail' => 'We don\'t like bears'
+            }
+          ]
+        }
+
+        expect(json_hash == expected_result).to eq(true)
+      end
+    end
+
+    context 'message is hash like' do
+      let(:message) { { 'errors' => ['error'] } }
+      it 'passes the message through' do
+        result = subject
+                 .call(message, backtrace, options, env, original_exception)
+        json_hash = JSON.parse(result)
+
+        expect(json_hash == message).to eq(true)
+      end
+    end
+
+    context 'message is text' do
+      let(:message) { 'error' }
+      it 'wraps the error' do
+        result = subject
+                 .call(message, backtrace, options, env, original_exception)
+        json_hash = JSON.parse(result)
+
+        expect(json_hash == { 'error' => message }).to eq(true)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Jonathan Richard Henry Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -141,6 +141,7 @@ files:
 - Guardfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - UPGRADING.md
 - grape-active_model_serializers.gemspec
@@ -148,12 +149,14 @@ files:
 - lib/.travis.yml
 - lib/grape-active_model_serializers.rb
 - lib/grape-active_model_serializers/endpoint_extension.rb
+- lib/grape-active_model_serializers/error_formatter.rb
 - lib/grape-active_model_serializers/formatter.rb
 - lib/grape-active_model_serializers/options_builder.rb
 - lib/grape-active_model_serializers/serializer_resolver.rb
 - lib/grape-active_model_serializers/version.rb
 - spec/features/grape-active_model_serializers/render_spec.rb
 - spec/grape-active_model_serializers/endpoint_extension_spec.rb
+- spec/grape-active_model_serializers/error_formatter_spec.rb
 - spec/grape-active_model_serializers/formatter_spec.rb
 - spec/grape-active_model_serializers/versioned_api_formatter_spec.rb
 - spec/grape-active_model_serializers_spec.rb
@@ -193,13 +196,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Use active_model_serializer in grape
 test_files:
 - spec/features/grape-active_model_serializers/render_spec.rb
 - spec/grape-active_model_serializers/endpoint_extension_spec.rb
+- spec/grape-active_model_serializers/error_formatter_spec.rb
 - spec/grape-active_model_serializers/formatter_spec.rb
 - spec/grape-active_model_serializers/versioned_api_formatter_spec.rb
 - spec/grape-active_model_serializers_spec.rb
@@ -219,4 +223,3 @@ test_files:
 - spec/support/serializers/v3/user_serializer.rb
 - spec/support/serializers/v4/user_serializer.rb
 - spec/support/serializers/v5/user_serializer.rb
-has_rdoc: