answer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d150524234b3a35613f57c4d3a49848246539850
+  data.tar.gz: 9c37f405e6cbf22db80c93ade0cbcd7c85b7e9ef
+SHA512:
+  metadata.gz: dab2999188d20f4a8c2244b85dbf68e96e96515c635fc99bdd3d9463fc9e7d8c9c21054643aeae6a9c54f93a922447a9a9fce1dcbd9f254f7bb3b30e7d338ddb
+  data.tar.gz: abf435ab1715dfbf7584c50e95862eddbd48789ab842c9cf3d2bf8e65a2fa23e7c98c9ef3b6aba0f41e780fbc5b7cc6656511f003c1f8c4c7adba11e0ae3d03c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in answer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dominik Bylica
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Answer
+
+A json-renderable result object working well with AR, AM Serializers, and Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'answer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install answer
+
+## Usage
+
+```ruby
+Answer.new(object, success, status, serializer)
+```
+
+Best way to use it? Return it from your service object, call `#render` on it right inside your controller action, and never care about another thing.
+
+```ruby
+class Controller < ApplicationController
+  def create
+    Answer.new(Model.create).render(self)
+  end
+end
+```
+
+You can supply your success or success and status, etc., but the best thing is that those can be inferred for you because of what your object really is. If saving failed, Answer knows it. You don't have to care about that. You can ask if the object represents a `#success?` and what http `#status` it has, but if you call `#render` on it, you'll get your json with errors rendered automatically. It works best with ActiveRecord models, but you can use it with any objects you want.
+
+And, btw, you can also supply ActiveModel serializers of your choice if they don't match the naming convention.
+
+## More
+
+Check the spec here: https://github.com/fenoloftaleina/answer/blob/master/spec/answer_spec.rb.
+
+And the example app here: https://github.com/fenoloftaleina/example-answer-app.
+
+## Contributing
+
+Pull requests are very much welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/answer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'answer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "answer"
+  spec.version       = Answer::VERSION
+  spec.authors       = ["Dominik Bylica"]
+  spec.email         = ["byldominik+fenoloftaleina@gmail.com"]
+
+  spec.summary       = %q{A json-renderable result object working well with AR, AM Serializers, and Rails.}
+  spec.homepage      = "https://github.com/fenoloftaleina/answer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "active_model_serializers", "~> 0.9.0"
+  spec.add_development_dependency "activesupport"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "answer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/answer.rb

@@ -0,0 +1,10 @@
+require 'answer/version'
+require 'answer/result_object'
+
+module Answer
+  class << self
+    def new(*args)
+      Answer::ResultObject.new(*args)
+    end
+  end
+end

data/lib/answer/result_object.rb

@@ -0,0 +1,90 @@
+require 'active_model/serializer'
+require 'active_support/all'
+
+Answer::ResultObject = Struct.new(:result_object, :result_success, :result_status, :serializer) do
+  def success?
+    if @success.nil?
+      @success = evaluate_success
+    end
+
+    @success
+  end
+
+  def object
+    @object ||= object_or_errors
+  end
+
+  def status
+    @status ||= result_status || (nil_result? && 404) || (success? ? 200 : 422)
+  end
+
+  def render(controller)
+    render_hash = { json: object, status: perfect_status(controller) }
+    if serializer
+      if object.respond_to?(:each)
+        render_hash[:json] = ActiveModel::ArraySerializer.new(
+          object, each_serializer: serializer
+        )
+      else
+        render_hash[:serializer] = serializer
+      end
+    end
+
+    controller.render(render_hash)
+  end
+
+  private
+  def evaluate_success
+    if result_success.nil?
+      if nil_result?
+        false
+      elsif responds_to_errors?
+        result_object.errors.empty?
+      else
+        true
+      end
+    else
+      !!result_success
+    end
+  end
+
+  def responds_to_errors?
+    if @responds_to_errors.nil?
+      @responds_to_errors = result_object.respond_to?(:errors)
+    end
+
+    @responds_to_errors
+  end
+
+  def nil_result?
+    result_object.nil?
+  end
+
+  def object_or_errors
+    if success?
+      result_object
+    else
+      { errors: pack_errors }
+    end
+  end
+
+  def pack_errors
+    if nil_result?
+      { base: ['Record not found'] }
+    elsif responds_to_errors?
+      result_object.errors
+    elsif result_object.is_a?(Hash)
+      result_object
+    else
+      { base: Array(result_object) }
+    end
+  end
+
+  def perfect_status(controller)
+    if controller.params[:action] == 'create' && status == 200
+      201
+    else
+      status
+    end
+  end
+end

data/lib/answer/version.rb

@@ -0,0 +1,3 @@
+module Answer
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: answer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominik Bylica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- byldominik+fenoloftaleina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- answer.gemspec
+- bin/console
+- bin/setup
+- lib/answer.rb
+- lib/answer/result_object.rb
+- lib/answer/version.rb
+homepage: https://github.com/fenoloftaleina/answer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A json-renderable result object working well with AR, AM Serializers, and
+  Rails.
+test_files: []