openapi_rest 0.0.1

data/lib/openapi_rest/railtie.rb

@@ -0,0 +1,9 @@
+module OpenAPIRest
+  class Railtie < Rails::Railtie
+    initializer "openapi_rest.action_controller" do
+      ActiveSupport.on_load :action_controller do
+        include OpenAPIRest::Extension::ClassMethods
+      end
+    end
+  end
+end

data/lib/openapi_rest/rest_renderer.rb

@@ -0,0 +1,75 @@
+module OpenAPIRest
+  ###
+  # Rest Response Renderer
+  #
+  class RestRenderer
+    attr_reader :controller
+    attr_reader :response
+
+    def initialize(args)
+      @controller = args[:controller]
+      @response = args[:response]
+    end
+
+    def render
+      unless response.is_a?(OpenAPIRest::QueryResponse)
+        controller.render(response)
+        return
+      end
+
+      return controller.render(error_response) if response.errors?
+
+      method = controller.request.request_method_symbol
+      return controller.render(nothing: true, status: 204) if [:delete, :patch, :put].include?(method)
+
+      if method == :post
+        path = "#{controller.openapi_path[:namespace]}#{response.resource}_path"
+        controller.render(json: to_json_response, status: 201, location: controller.send(path, response.results))
+        return
+      end
+
+      controller.render(json: to_json_response)
+    end
+
+    private
+
+    def to_json_response
+      if response.single?
+        single_response
+      else
+        collection_response
+      end
+    end
+
+    def fetch(opts)
+      response.results.as_json(opts.merge(only: [],
+                                          methods: response.fields))
+    end
+
+    def collection_response(opts = {})
+      resp = {}
+      resp[response.entity] = fetch(opts)
+      success_response(resp)
+    end
+
+    def single_response(opts = {})
+      success_response(fetch(opts))
+    end
+
+    def success_response(obj)
+      obj.to_json
+    end
+
+    def error_response
+      error_code = 400
+      {
+        status: error_code,
+        json: {
+          status: error_code,
+          message: Rack::Utils::HTTP_STATUS_CODES[error_code],
+          errors: response.errors
+        }
+      }
+    end
+  end
+end

data/lib/openapi_rest/validators/format.rb

@@ -0,0 +1,24 @@
+module OpenAPIRest
+  module Validators
+    ###
+    # Rest format validator
+    #
+    class Format
+      def initialize(format, value)
+        @format = format
+        @value = value
+      end
+
+      def valid?
+        return @value.is_a?(Numeric) if @format == 'int64' || @format == 'int32'
+        return !DateTimeHelper.in_utc(@value).nil? if @format == 'date-time'
+
+        true
+      end
+
+      def error(key)
+        { key => "not a #{@format}" }
+      end
+    end
+  end
+end

data/lib/openapi_rest/validators/pattern.rb

@@ -0,0 +1,21 @@
+module OpenAPIRest
+  module Validators
+    ###
+    # Rest pattern validator
+    #
+    class Pattern
+      def initialize(format, value)
+        @format = format
+        @value = value
+      end
+
+      def valid?
+        Regexp.new(@format).match(@value)
+      end
+
+      def error(key)
+        { key => "invalid format #{@format}" }
+      end
+    end
+  end
+end

data/lib/openapi_rest/version.rb

@@ -0,0 +1,3 @@
+module OpenAPIRest
+  VERSION = "0.0.1"
+end

data/test/openapi_rest/api_config_test.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'openapi_rest/api_config'
+
+describe OpenAPIRest::ApiConfig do
+  it 'initialize document correctly' do
+    api_config = OpenAPIRest::ApiConfig.new(document: 'mylocaldoc')
+    assert_equal(api_config.document, 'mylocaldoc')
+  end
+end

data/test/openapi_rest/api_doc_parser_test.rb

@@ -0,0 +1,71 @@
+require 'minitest/autorun'
+require 'openapi_rest/api_doc_parser'
+
+describe OpenAPIRest::ApiDocParser do
+  before do
+    OpenAPIRest::ApiDoc.configure do |c|
+      c.document = ::YAML::load_file('lib/generators/templates/api_docs.yml')
+    end
+
+    @api_doc_parser = OpenAPIRest::ApiDocParser.new(path: '/products',
+                                                    method: 'get')
+  end
+
+  ['definitions', 'parameters', 'paths'].each do |method_name|
+    it "##{method_name}" do
+      name = OpenAPIRest::ApiDoc.document.fetch(method_name, {})
+      refute_nil(@api_doc_parser.send(method_name))
+      assert_equal(@api_doc_parser.send(method_name).to_s, name)
+    end
+  end
+
+  it '#find(key)' do
+    definitions = OpenAPIRest::ApiDoc.document.fetch('definitions', {})
+    assert_equal(@api_doc_parser.definitions.find('Product').to_s, definitions.fetch('Product'))
+  end
+
+  it '#base_path' do
+    assert_equal(@api_doc_parser.base_path, '/v1')
+  end
+
+  it '#find_path' do
+    paths = OpenAPIRest::ApiDoc.document.fetch('paths', {}).fetch('/products').fetch('get')
+    assert_equal(@api_doc_parser.find_path.to_s, paths)
+  end
+
+  it '#properties' do
+    properties = OpenAPIRest::ApiDoc.document.fetch('definitions', {}).fetch('Product').fetch('properties')
+    assert_equal(@api_doc_parser.definitions.find('Product').properties.to_s, properties)
+  end
+
+  describe '#schema' do
+    it 'with items' do
+      product = OpenAPIRest::ApiDoc.document.fetch('definitions', {}).fetch('Product')
+      assert_equal(@api_doc_parser.find_path.responses.find(200).schema.to_s, product)
+    end
+
+    it 'with ref' do
+      error = OpenAPIRest::ApiDoc.document.fetch('definitions', {}).fetch('Error')
+      assert_equal(@api_doc_parser.find_path.responses.find('default').schema.to_s, error)
+    end
+  end
+
+  it '#find_parameters' do
+    assert_equal(@api_doc_parser.find_path.find_parameters, { 'latitude' => 'latitude', 'longitude' => 'longitude' })
+  end
+
+  it '#responses' do
+    responses = OpenAPIRest::ApiDoc.document.fetch('paths', {}).fetch('/products').fetch('get').fetch('responses')
+    assert_equal(@api_doc_parser.find_path.responses.to_s, responses)
+  end
+
+  it '#responses' do
+    keys = OpenAPIRest::ApiDoc.document.fetch('paths', {}).fetch('/products').fetch('get').fetch('responses').keys
+    assert_equal(@api_doc_parser.find_path.responses.keys, keys)
+  end
+
+  it '#[](key)' do
+    products = OpenAPIRest::ApiDoc.document.fetch('paths', {}).fetch('/products')
+    assert_equal(@api_doc_parser.paths['/products'].to_s, products)
+  end
+end

data/test/openapi_rest/api_doc_test.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'openapi_rest/api_doc'
+require 'yaml'
+
+describe OpenAPIRest::ApiDoc do
+  before do
+    OpenAPIRest::ApiDoc.configure do |c|
+      c.document = ::YAML::load_file('lib/generators/templates/api_docs.yml')
+    end
+  end
+
+  it '#document' do
+    refute_nil(OpenAPIRest::ApiDoc.document)
+  end
+end

data/test/openapi_rest/api_model_test.rb

@@ -0,0 +1,49 @@
+require 'minitest/autorun'
+require 'spec_helper'
+require 'action_controller'
+require 'openapi_rest/api_model'
+require 'openapi_rest/api_parameters'
+require 'openapi_rest/api_validator'
+require 'openapi_rest/query_builder'
+require 'openapi_rest/query_response'
+require 'openapi_rest/operations/filter'
+require 'openapi_rest/operations/paginate'
+require 'openapi_rest/operations/sort'
+
+describe OpenAPIRest::ApiModel do
+  before do
+    OpenAPIRest::ApiDoc.configure do |c|
+      c.document = ::YAML::load_file('lib/generators/templates/api_docs.yml')
+    end
+
+    @api_model = OpenAPIRest::ApiModel.new(:product)
+  end
+
+  it '#model' do
+    assert_equal(@api_model.model, Product)
+  end
+
+  it '#build' do
+    params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'post' },
+                                              product: { product_id: '1234' })
+    api_product = @api_model.build(params)
+
+    refute_nil(api_product)
+    assert_kind_of(OpenAPIRest::QueryResponse, api_product)
+  end
+
+  it '#find' do
+    params = ActionController::Parameters.new(openapi_path: { path: '/products/0000', method: 'get' },
+                                              product: { product_id: '0000' })
+    response = @api_model.find(params, product_id: '0000')
+
+    assert_equal(response.results, Product.find_by(product_id: '0000'))
+  end
+
+  it '#where' do
+    params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'get' })
+    response = @api_model.where(params)
+
+    assert_equal(response.results, Product.all.to_a)
+  end
+end

data/test/openapi_rest/api_parameters_test.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'spec_helper'
+require 'action_controller'
+require 'openapi_rest/api_parameters'
+
+describe OpenAPIRest::ApiParameters do
+  before do
+    OpenAPIRest::ApiDoc.configure do |c|
+      c.document = ::YAML::load_file('lib/generators/templates/api_docs.yml')
+    end
+
+    params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'post' },
+                                              product: { product_id: '0000' })
+
+    model = OpenAPIRest::ApiModel.new(:product)
+
+    @api_parameters = OpenAPIRest::ApiParameters.new(api_model: model,
+                                                     params: params,
+                                                     openapi_path: params[:openapi_path])
+  end
+
+  it '#initialize' do
+    refute_nil(@api_parameters)
+  end
+
+  describe '#valid?' do
+    it 'with errors' do
+      model = OpenAPIRest::ApiModel.new(:product)
+      params = ActionController::Parameters.new(product_id: '0000')
+
+      api_parameters_with_error = OpenAPIRest::ApiParameters.new(api_model: model,
+                                                                 params: params,
+                                                                 openapi_path: { path: '/products', method: 'post' })
+
+      assert_equal(api_parameters_with_error.valid?, false)
+      refute_empty(api_parameters_with_error.validation_errors)
+    end
+
+    it 'without errors' do
+      assert_equal(@api_parameters.valid?, true)
+      assert_empty(@api_parameters.validation_errors)
+    end
+  end
+
+  it '#response_permitted_params' do
+    params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'get' })
+
+    model = OpenAPIRest::ApiModel.new(:product)
+
+    api_parameters = OpenAPIRest::ApiParameters.new(api_model: model,
+                                                    params: params,
+                                                    openapi_path: params[:openapi_path])
+
+    assert_equal(api_parameters.response_permitted_params, [:product_id, :description, :name, :capacity,
+                                                            :image])
+  end
+end

data/test/openapi_rest/api_validator_test.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'openapi_rest/api_validator'
+require 'openapi_rest/validators/format'
+require 'openapi_rest/validators/pattern'
+
+describe OpenAPIRest::ApiValidator do
+  describe '#evaluate' do
+    describe 'with integers' do
+      before do
+        @params = {}
+        @params['format'] = 'int64'
+      end
+
+      it 'be valid' do
+        OpenAPIRest::ApiValidator.new(@params).evaluate([:id], { id: 123 })
+      end
+
+      it 'not be valid' do
+        OpenAPIRest::ApiValidator.new(@params).evaluate([:id], { id: 'test' })
+      end
+    end
+  end
+end

data/test/openapi_rest/query_builder_test.rb

@@ -0,0 +1,32 @@
+require 'minitest/autorun'
+
+describe OpenAPIRest::QueryBuilder do
+  before do
+    OpenAPIRest::ApiDoc.configure do |c|
+      c.document = ::YAML::load_file('lib/generators/templates/api_docs.yml')
+    end
+
+    @api_model = OpenAPIRest::ApiModel.new(:product)
+  end
+
+  describe '' do
+    before do
+      params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'post' },
+                                                product: { product_id: '2222' })
+      @query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :create))
+    end
+
+    it 'check default params' do
+      assert_empty(@query_builder.query)
+      assert_nil(@query_builder.sort)
+      assert_equal(@query_builder.limit, 10)
+      assert_equal(@query_builder.offset, 0)
+      assert_empty(@query_builder.fields)
+      assert_equal(@query_builder.single_result?, true)
+      assert_equal(@query_builder.single?, true)
+      assert_equal(@query_builder.resource, 'product')
+      assert_equal(@query_builder.entity, 'products')
+      refute_nil(@query_builder.response)
+    end
+  end
+end

data/test/openapi_rest/query_response_test.rb

@@ -0,0 +1,129 @@
+require 'minitest/autorun'
+
+describe OpenAPIRest::QueryResponse do
+  before do
+    OpenAPIRest::ApiDoc.configure do |c|
+      c.document = ::YAML::load_file('lib/generators/templates/api_docs.yml')
+    end
+
+    @api_model = OpenAPIRest::ApiModel.new(:product)
+  end
+
+  describe '#create_resource' do
+    describe 'without errors' do
+      before do
+        params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'post' },
+                                                  product: { product_id: '2222' })
+        query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :create))
+        @response = query_builder.response
+        @response.create_resource
+      end
+
+      it 'check default params' do
+        product_created = Product.find_by(product_id: '2222')
+
+        assert_empty(@response.errors)
+        assert_equal(@response.errors?, false)
+        refute_nil(@response)
+        assert_equal(@response.results, product_created)
+
+        refute_nil(product_created)
+      end
+    end
+
+    describe 'with errors' do
+      before do
+        params = ActionController::Parameters.new(openapi_path: { path: '/products', method: 'post' }, product: {})
+        query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :create))
+        @response = query_builder.response
+        @response.create_resource
+      end
+
+      it 'check default params' do
+        refute_nil(@response)
+        refute_empty(@response.errors)
+        assert_equal(@response.errors?, true)
+      end
+    end
+  end
+
+  describe '#update_resource' do
+    describe 'without errors' do
+      before do
+        params = ActionController::Parameters.new(openapi_path: { path: '/products/{id}', method: 'patch' },
+                                                  product: { name: 'test product' })
+        query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :squery,
+                                                                                 query: { product_id: '2222' }))
+        @response = query_builder.response
+        @response.update_resource
+      end
+
+      it 'check default params' do
+        product_updated = Product.find_by(product_id: '2222')
+
+        assert_empty(@response.errors)
+        assert_equal(@response.errors?, false)
+        refute_nil(@response)
+        assert_equal(@response.results, product_updated)
+
+        refute_nil(product_updated)
+        assert_equal(product_updated.name, 'test product')
+      end
+    end
+
+    describe 'with wrong params' do
+      before do
+        params = ActionController::Parameters.new(openapi_path: { path: '/products/{id}', method: 'patch' },
+                                                  product: { capacity: 'test' })
+        query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :squery,
+                                                                                query: { product_id: '2222' }))
+        @response = query_builder.response
+        @response.update_resource
+      end
+
+      it 'check default params' do
+        product_updated = Product.find_by(product_id: '2222')
+
+        refute_nil(@response)
+        assert_equal(@response.results, product_updated)
+
+        assert_nil(product_updated.capacity)
+      end
+    end
+  end
+
+  describe '#delete_resource' do
+    describe 'without errors' do
+      before do
+        @product_deleted = Product.find_by(product_id: '5555')
+
+        params = ActionController::Parameters.new(openapi_path: { path: '/products/{id}', method: 'delete' })
+        query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :squery,
+                                                                                 query: { product_id: '5555' }))
+        @response = query_builder.response
+        @response.delete_resource
+      end
+
+      it 'check default params' do
+        assert_empty(@response.errors)
+        assert_equal(@response.errors?, false)
+        assert_equal(@response.results?, true)
+        assert_equal(@response.results, @product_deleted)
+      end
+    end
+
+    describe 'non existing' do
+      before do
+        params = ActionController::Parameters.new(openapi_path: { path: '/products/{id}', method: 'delete' })
+        query_builder = OpenAPIRest::QueryBuilder.new(@api_model, params.merge!(operation: :squery,
+                                                                                 query: { product_id: '4444' }))
+        @response = query_builder.response
+        @response.delete_resource
+      end
+
+      it 'check default params' do
+        assert_equal(@response.results?, false)
+      end
+    end
+  end
+end