json_api_responders 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c661ab2ab937e5f41f6f4447f4223def1f55c8bf
+  data.tar.gz: 0ffdc9290b732bff8e65f4df240cd5b37a1b2aad
+SHA512:
+  metadata.gz: 34836428bc2a2633118dade15b90bfb5e3dbbbbb671427b3f7d44b3beea7970a7ba0f1d4c331274e4d1e7bd2e4d5cfcf6ad34bf215073d35365b9144d480441c
+  data.tar.gz: 5e6b7b3e90442b7de163178ea0b769dc9d0417f60b10e0b2219666eb4401d36f588c55a2528c8352d6e6edd98517316d17b430e853de0a339d1d2306354d5c4d

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.3.0
+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 json_api_responders.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_responders'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_responders
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_api_responders.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_responders"
+
+# 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/json_api_responders.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_api_responders/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'json_api_responders'
+  spec.version = JsonApiResponders::VERSION
+  spec.authors = ['Stanko Krtalić Rusendić']
+  spec.email = ['stanko.krtalic@gmail.com']
+
+  spec.summary = 'Automatically respond to JSON::API requests'
+  spec.description = 'Automatically respond to JSON::API requests'
+  spec.homepage = 'https://github.com/infinum/json_api_responders'
+
+  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.')
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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'
+end

data/lib/json_api_responders.rb

@@ -0,0 +1,64 @@
+require 'json_api_responders/version'
+require 'json_api_responders/errors'
+require 'json_api_responders/responder'
+
+module JsonApiResponders
+  def self.included(base)
+    base.rescue_from ActiveRecord::RecordNotFound, with: :record_not_found!
+    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)
+    case error_type
+    when :unauthorized
+      Responder.new(nil, controller: self, status: :forbidden).unauthorized
+    when :not_found
+      Responder.new(nil, controller: self, status: :not_found).not_found
+    end
+  end
+
+  def respond_with(resource, options = {})
+    options = {
+      namespace: self.class.parent,
+      status: :ok,
+      params: params,
+      controller: self
+    }.merge(options)
+
+    Responder.new(resource, options).respond!
+  end
+
+  def record_not_found!
+    respond_with_error(:not_found)
+  end
+
+  def deserialized_params
+    @_deserialized_options ||=
+      ActionController::Parameters.new(
+        ActiveModelSerializers::Deserialization.jsonapi_parse(
+          params, json_api_parse_options
+        )
+      )
+  end
+
+  def json_api_parse_options
+    {}
+  end
+end

data/lib/json_api_responders/errors.rb

@@ -0,0 +1,37 @@
+module JsonApiResponders
+  module Errors
+    class UnknownHTTPStatus < StandardError
+      attr_reader :status
+
+      def initialize(status)
+        @status = status
+        super(message)
+      end
+
+      def message
+        status_symbols =
+          Rack::Utils::SYMBOL_TO_STATUS_CODE.keys.map(&:to_s)
+        status_codes =
+          Rack::Utils::SYMBOL_TO_STATUS_CODE.invert.keys.map(&:to_s)
+        statuses = (status_symbols + status_codes).join(', ')
+
+        "Unknown HTTP status code '#{status}'.\n"\
+        "Available status codes and symbols are: #{statuses}"
+      end
+    end
+
+    class UnknownAction < StandardError
+      attr_reader :action
+
+      def initialize(action)
+        @action = action
+        super(message)
+      end
+
+      def message
+        "Unknown controller action '#{action}'.\n"\
+        "Accepted actions are #{JsonApi::Responder::ACTIONS.join(', ')}"
+      end
+    end
+  end
+end

data/lib/json_api_responders/responder.rb

@@ -0,0 +1,90 @@
+require 'json_api_responders/responder/actions'
+require 'json_api_responders/responder/sanitizers'
+
+module JsonApiResponders
+  class Responder
+    include Actions
+
+    attr_accessor :errors
+    attr_accessor :status
+    attr_reader :resource
+    attr_reader :options
+    attr_reader :params
+    attr_reader :controller
+    attr_reader :namespace
+
+    def initialize(resource, options = {})
+      @resource = resource
+      @options = options
+      self.status = @options[:status]
+      @params = @options[:params]
+      @controller = @options[:controller]
+      @namespace = @options[:namespace]
+    end
+
+    def respond!
+      render_response
+    end
+
+    def not_found
+      self.errors = {
+        title: I18n.t('json_api.errors.not_found.title'),
+        status: status
+      }
+
+      render_error
+    end
+
+    def unauthorized
+      self.errors = {
+        title: I18n.t('json_api.errors.unauthorized.title'),
+        status: status
+      }
+
+      render_error
+    end
+
+    private
+
+    def status=(status)
+      @status = Sanitizers.status(status)
+    end
+
+    def action
+      params[:action]
+    end
+
+    def render_response
+      return send("respond_to_#{action}_action") if action.in?(ACTIONS)
+      raise(JsonApi::Errors::UnknownAction, action)
+    end
+
+    def render_error
+      controller.render(error_render_options)
+    end
+
+    def error_render_options
+      render_options.merge(
+        json: error_messages
+      )
+    end
+
+    def render_options
+      {
+        status: status,
+        content_type: 'application/vnd.api+json'
+      }
+    end
+
+    def error_messages
+      return errors if errors
+
+      resource.errors.full_messages.map do |message|
+        {
+          title: message,
+          status: status
+        }
+      end
+    end
+  end
+end

data/lib/json_api_responders/responder/actions.rb

@@ -0,0 +1,72 @@
+module JsonApiResponders
+  class Responder
+    module Actions
+      ACTIONS = %w(index show create update destroy).freeze
+
+      def respond_to_index_action
+        self.status ||= :ok
+        render_resource
+      end
+
+      def respond_to_show_action
+        self.status ||= :ok
+        render_resource
+      end
+
+      def respond_to_create_action
+        if resource.persisted? && resource.valid?
+          self.status ||= :created
+          render_resource
+        else
+          self.status ||= :conflict
+          render_error
+        end
+      end
+
+      def respond_to_update_action
+        if resource.valid?
+          self.status ||= :ok
+          render_resource
+        else
+          self.status ||= :conflict
+          render_error
+        end
+      end
+
+      def respond_to_destroy_action
+        self.status ||= :no_content
+        controller.head(status, render_options)
+      end
+
+      def render_resource
+        controller.render(resource_render_options)
+      end
+
+      def resource_render_options
+        serializer_key = relation? ? :each_serializer : :serializer
+
+        render_options.merge(
+          json: resource,
+          serializer_key => serializer_class
+        )
+      end
+
+      def serializer_class
+        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)
+      end
+    end
+  end
+end

data/lib/json_api_responders/responder/sanitizers.rb

@@ -0,0 +1,18 @@
+module JsonApiResponders
+  class Responder
+    module Sanitizers
+      def self.status(status)
+        if status.is_a?(Integer)
+          status = Rack::Utils::SYMBOL_TO_STATUS_CODE.invert[status]
+        end
+
+        if status.nil? || !status.is_a?(Symbol) ||
+           Rack::Utils::SYMBOL_TO_STATUS_CODE[status].nil?
+          raise(JsonApi::Errors::UnknownHTTPStatus, status)
+        end
+
+        status
+      end
+    end
+  end
+end

data/lib/json_api_responders/version.rb

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: json_api_responders
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stanko Krtalić Rusendić
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-06 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'
+description: Automatically respond to JSON::API requests
+email:
+- stanko.krtalic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_api_responders.gemspec
+- lib/json_api_responders.rb
+- lib/json_api_responders/errors.rb
+- lib/json_api_responders/responder.rb
+- lib/json_api_responders/responder/actions.rb
+- lib/json_api_responders/responder/sanitizers.rb
+- lib/json_api_responders/version.rb
+homepage: https://github.com/infinum/json_api_responders
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Automatically respond to JSON::API requests
+test_files: []
+has_rdoc: