json_api_responders 1.2.2 → 2.0.0

data/README.md

@@ -1,8 +1,11 @@
 # JsonApiResponders
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json_api_responders`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/json_api_responders.svg)](https://badge.fury.io/rb/json_api_responders)
+[![Build Status](https://semaphoreci.com/api/v1/infinum/json_api_responders/branches/features-missing_responses/shields_badge.svg)](https://semaphoreci.com/infinum/json_api_responders)
+[![Code Climate](https://codeclimate.com/github/infinum/json_api_responders/badges/gpa.svg)](https://codeclimate.com/github/infinum/json_api_responders)
+[![Test Coverage](https://codeclimate.com/github/infinum/json_api_responders/badges/coverage.svg)](https://codeclimate.com/github/infinum/json_api_responders/coverage)
 
-TODO: Delete this and the text above, and describe your gem
+This gem gives a few convinient methods for working with JSONAPI. It is inspired by responders gem.
 
 ## Installation
 
@@ -16,21 +19,45 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install json_api_responders
+    user = User.first
+    respond_with user
+    respond_with user, on_error: { status: :unauthorized, detail: 'Invalid user or password' }
+    respond_with_error, status: 401, detail: 'Bad credentials'
 
-## Usage
+whatever can be passed to controller.render can be passed here:
 
-TODO: Write usage instructions here
+        respond_with user, serializer: UserSerializer
 
-## Development
+## Responses
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### index
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    render json: resource, status: 200
 
-## Contributing
+### show
+
+    render json: resource, status: 200
+
+### create
+
+    if resource.valid?
+      render json: resource, status: 201
+    else
+      render error: errors, status: 409
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_api_responders.
+### update
+
+    if resource.valid?
+      render json: resource, status: 200
+    else
+      render error: errors, status: 409
+
+### destroy
+
+    head status: 204
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/json_api_responders.

data/json_api_responders.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    fail('RubyGems 2.0 or newer is required to protect against public gem pushes.')
+    raise('RubyGems 2.0 or newer is required to protect against public gem pushes.')
   end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -28,5 +28,10 @@ Gem::Specification.new do |spec|
 
   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 'rspec-rails'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/json_api_responders/errors.rb

@@ -30,7 +30,13 @@ module JsonApiResponders
 
       def message
         "Unknown controller action '#{action}'.\n"\
-        "Accepted actions are #{JsonApi::Responder::ACTIONS.join(', ')}"
+        "Accepted actions are #{JsonApiResponders::Responder::ACTIONS.join(', ')}"
+      end
+    end
+
+    class StatusNotDefined < StandardError
+      def message
+        'Status is not defined'
       end
     end
   end

data/lib/json_api_responders/responder/actions.rb

@@ -14,7 +14,7 @@ module JsonApiResponders
       end
 
       def respond_to_create_action
-        if resource.persisted? && resource.valid?
+        if resource.valid?
           self.status ||= :created
           render_resource
         else
@@ -43,31 +43,7 @@ module JsonApiResponders
       end
 
       def resource_render_options
-        serializer_key = relation? ? :each_serializer : :serializer
-
-        render_options.merge(
-          json: resource,
-          serializer_key => serializer_class,
-          include: options[:include],
-          meta: options[:meta]
-        )
-      end
-
-      def serializer_class
-        (relation? ? options[:each_serializer] : options[:serializer]) ||
-          [
-            namespace,
-            "#{resource_class}Serializer"
-          ].compact.join('::').constantize
-      end
-
-      def resource_class
-        return resource.model if relation?
-        resource.class
-      end
-
-      def relation?
-        resource.is_a?(ActiveRecord::Relation) || resource.is_a?(Array)
+        render_options.merge(json: resource, **options)
       end
     end
   end

data/lib/json_api_responders/responder/sanitizers.rb

@@ -8,7 +8,7 @@ module JsonApiResponders
 
         if status.nil? || !status.is_a?(Symbol) ||
            Rack::Utils::SYMBOL_TO_STATUS_CODE[status].nil?
-          raise(JsonApiResponders::Errors::UnknownHTTPStatus, status)
+          raise(Errors::UnknownHTTPStatus, status)
         end
 
         status

data/lib/json_api_responders/responder.rb

@@ -5,68 +5,52 @@ module JsonApiResponders
   class Responder
     include Actions
 
-    attr_accessor :errors
-    attr_accessor :status
+    attr_accessor :options
     attr_reader :resource
-    attr_reader :options
-    attr_reader :params
     attr_reader :controller
-    attr_reader :namespace
 
-    def initialize(resource, options = {})
+    def initialize(controller, resource = nil, options = {})
+      @controller = controller
       @resource = resource
       @options = options
-      self.status = @options[:status] if @options[:status]
-      @params = @options[:params]
-      @controller = @options[:controller]
-      @namespace = @options[:namespace]
     end
 
     def respond!
-      render_response
+      return send("respond_to_#{action}_action") if ACTIONS.include?(action)
+      raise JsonApiResponders::Errors::UnknownAction, action
     end
 
-    def error
-      self.errors = {
-        errors: [
-          {
-            title: I18n.t("json_api.errors.#{status}.title"),
-            detail: @options[:error_detail] || I18n.t("json_api.errors.#{status}.detail"),
-            status: status_code
-          }
-        ]
-      }
-
+    def respond_error
       render_error
     end
 
-    private
+    def status
+      return nil if @options[:status].nil?
+      Sanitizers.status(@options[:status])
+    end
 
     def status=(status)
-      @status = Sanitizers.status(status)
+      @options[:status] = status
     end
 
-    def status_code
-      Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
-    end
+    private
 
     def render_error
-      controller.render(error_render_options)
-    end
-
-    def action
-      params[:action]
+      controller.render(
+        render_options.merge(
+          json: error_render_options,
+          status: error_status
+        )
+      )
     end
 
-    def render_response
-      return send("respond_to_#{action}_action") if action.in?(ACTIONS)
-      fail JsonApiResponders::Errors::UnknownAction, action
+    def error_status
+      return Sanitizers.status(on_error(:status)) if on_error(:status)
+      status
     end
 
-    def error_render_options
-      render_options.merge(
-        json: error_response
-      )
+    def action
+      @options[:params][:action]
     end
 
     def render_options
@@ -76,25 +60,28 @@ module JsonApiResponders
       }
     end
 
-    def error_response
-      return errors if errors
+    def error_render_options
+      errors = { errors: [] }
 
-      errors ||= {}
-      errors[:errors] ||= []
+      errors[:errors] << { detail: on_error(:detail) } if on_error(:detail)
 
       resource.errors.each do |attribute, message|
-        errors[:errors] << {
-          title: I18n.t("json_api.errors.#{status}.title"),
-          detail: resource.errors.full_message(attribute, message),
-          status: status_code.to_s,
-          source: {
-            parameter: attribute,
-            pointer: "data/attributes/#{attribute}"
-          }
-        }
+        errors[:errors] << error_response(attribute, message)
       end
 
       errors
     end
+
+    def error_response(attribute, message)
+      {
+        title: I18n.t("json_api.errors.#{status}.title"),
+        detail: resource.errors.full_message(attribute, message),
+        source: { parameter: attribute, pointer: "data/attributes/#{attribute}" }
+      }
+    end
+
+    def on_error(key)
+      @options.fetch(:on_error, {}).fetch(key, nil)
+    end
   end
 end

data/lib/json_api_responders/version.rb

@@ -1,6 +1,6 @@
 module JsonApiResponders
-  MAJOR = 1
-  MINOR = 2
-  PATCH = 2
+  MAJOR = 2
+  MINOR = 0
+  PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
 end

data/lib/json_api_responders.rb

@@ -6,53 +6,15 @@ module JsonApiResponders
   def self.included(base)
     base.rescue_from ActiveRecord::RecordNotFound, with: :record_not_found!
     base.rescue_from ActionController::ParameterMissing, with: :parameter_missing!
-    redefine_authorization(base)
-  end
-
-  def self.redefine_authorization(base)
-    return unless base.instance_methods.include?(:authenticate_user_from_token!)
-
-    base.class_eval do
-      alias_method(:_authenticate_from_token!, :authenticate_user_from_token!)
-
-      define_method :authenticate_user_from_token! do
-        result = catch(:warden) { _authenticate_from_token! }
-
-        return unless result
-        respond_with_error(:unauthorized)
-      end
-    end
-  end
-
-  private
-
-  def respond_with_error(error_type, error_detail = nil)
-    case error_type
-    when :unauthorized
-      Responder.new(nil, controller: self, status: :forbidden, error_detail: error_detail).error
-    when :not_found
-      Responder.new(nil, controller: self, status: :not_found).error
-    when :parameter_missing
-      Responder.new(nil, controller: self, status: :unprocessable_entity, error_detail: error_detail).error
-    end
   end
 
   def respond_with(resource, options = {})
-    options = {
-      namespace: self.class.parent,
-      params: params,
-      controller: self
-    }.merge(options)
-
-    Responder.new(resource, options).respond!
-  end
-
-  def record_not_found!
-    respond_with_error(:not_found)
+    options = { params: params }.merge(options)
+    Responder.new(self, resource, options).respond!
   end
 
-  def parameter_missing!(reason)
-    respond_with_error(:parameter_missing, reason.message)
+  def respond_with_error(status, detail = nil)
+    Responder.new(self, on_error: { status: status, error: detail }).respond_error
   end
 
   def deserialized_params
@@ -64,6 +26,16 @@ module JsonApiResponders
       )
   end
 
+  private
+
+  def record_not_found!
+    respond_with_error(:not_found)
+  end
+
+  def parameter_missing!(reason)
+    respond_with_error(:parameter_missing, reason.message)
+  end
+
   def json_api_parse_options
     {}
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_responders
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,72 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: '3.0'
+        version: '0'
 description: Automatically respond to JSON::API requests
 email:
 - stanko.krtalic@gmail.com
@@ -59,8 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -99,4 +157,3 @@ signing_key:
 specification_version: 4
 summary: Automatically respond to JSON::API requests
 test_files: []
-has_rdoc: