openapi_rest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c61d29ffa18db72ca6edda6a9c339bc52524a754
+  data.tar.gz: e41d85daabf180c24b46536d978162fdaf6fbc46
+SHA512:
+  metadata.gz: 911b007aa471968568166df886991b762f9ea96787bb0a766766d689478972bcc3444ed80fcd7babef641ef0e36674f16b4d6f8b939f194e322ab321cacda025
+  data.tar.gz: 43fc588ff2fbd5dc9e602a37d9bb174e0e6a24475e04049ef31ecbb0755def950b70722b6cd539d4148dc02570b2e9c45e1ad87306c4595a83c12bf67c797584

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Bizimply Ltd
+
+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,141 @@
+# OpenAPIRest
+
+This gem aims to provide an easier way to implement REST api endpoints using OpenAPI specs in a Rails project.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapi_rest'
+```
+
+And then execute:
+
+    $ bundle install
+    
+Now, generate the initializer:
+
+    $ rails g openapi_rest:install
+
+
+## Usage
+
+Place your OpenAPI spec yml file in `config/`, see example `generators/templates/api_docs.yml`. The file needs to be formatted in OpenAPI v2.0.  You can then use `OpenAPIRest::ApiModel` directly from a controller.  Example:
+
+```ruby
+class Product < ActiveRecord::Base
+  
+end
+```
+
+```ruby
+module Api
+  module V1
+    class MyController < ActionController::Base
+      def index 
+        response = OpenAPIRest::ApiModel.new(:product).where(params)
+        render_rest response
+      end
+
+      def show
+        # The find method will expect a second parameter that ultimately will call find_by
+        response = OpenAPIRest::ApiModel.new(:product).find(params, id: params[:id])
+        if response.results?
+          render_rest response
+        end
+      end
+
+      def update
+        # The find method will expect a second parameter that ultimately will call find_by
+        response = OpenAPIRest::ApiModel.new(:product).find(params, id: params[:id])
+        if response.results?
+          response.update_resource
+
+          render_rest response
+        end
+      end
+
+      def create
+        # For cases when our model needs to be inserted through another model.
+        response = OpenAPIRest::ApiModel.new(:product).build(params, extra_param_ids: store.id)
+
+        response.create_resource
+
+        render_rest response
+      end
+
+      def destroy
+        response = OpenAPIRest::ApiModel.new(:product).find(params, id: params[:id])
+        if response.results?
+          # When using cancancan gem, we can get the AR model by calling results.
+          # authorize! :delete, response.results
+
+          response.delete_resource
+
+          render_rest response
+        end
+      end
+    end
+  end
+end
+```
+
+`render_rest` is a custom method that takes a `QueryResponse` object to be rendered.
+
+Last but not least, we need to tell to the Rails app which routes will be using the openapi parsing and if the routes have any namespace with the following syntax:
+
+```ruby
+
+scope module: :api, defaults: { format: 'json' }, openapi: true, namespace: 'api' do
+  scope module: :v1 do
+    resources :myresources, only: [:index, :show]
+  end
+end
+
+```
+
+### Adding a Custom Filter 
+
+Create a wrapper object that inherits from `OpenAPIRest::ApiModel` if you need custom filter.  From the ApiModel you will have access to the `@model` class variable which is the original AR model.
+
+Example:
+
+```ruby
+module Api
+  class MyFilteredApiModel < OpenAPIRest::ApiModel
+    def filter(params)
+      @model = model.where('mymodelname.updated_at > ?', params[:date_param])
+    end
+  end
+end
+```
+
+On the Controller side:
+
+```ruby
+module Api
+  module V1
+    class MyController < ActionController::Base
+      def index
+        # The where and find methods can contain a block which will return the wrapper so you can specify custom filters 
+        response = Api::MyFilteredApiModel.new(:product).where(params) do |wrapper|
+          wrapper.filter(params)
+        end
+
+        render_rest response
+      end
+    end
+  end
+end
+```
+      
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bizimply/OpenAPI-Rails-REST
+
+## 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,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "openapi_rest"
+
+# 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(__FILE__)

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/generators/openapi_rest/install_generator.rb

@@ -0,0 +1,11 @@
+module OpenapiRest
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root(File.expand_path(File.dirname(__FILE__)))
+      def copy_initializer
+        copy_file 'openapi_doc.rb', 'config/initializers/openapi_doc.rb'
+        copy_file '../templates/api_docs.yml', 'config/api_docs.yml'
+      end
+    end
+  end
+end

data/lib/generators/openapi_rest/openapi_doc.rb

@@ -0,0 +1,3 @@
+OpenAPIRest::ApiDoc.configure do |c|
+  c.document = YAML::load_file(File.join(Rails.root, 'config/api_docs.yml'))
+end

data/lib/generators/templates/api_docs.yml

@@ -0,0 +1,162 @@
+# this is an example of the Uber API
+# as a demonstration of an API spec in YAML
+swagger: '2.0'
+info:
+  title: Supermarket API
+  description: Move your app forward with the Supermarket API
+  version: "1.0.0"
+# the domain of the service
+host: api.supermarket.com
+# array of all schemes that your API supports
+schemes:
+  - https
+# will be prefixed to all paths
+basePath: /v1
+produces:
+  - application/json
+paths:
+  /products:
+    get:
+      summary: Product Types
+      description: |
+        The Products endpoint returns information about the *Uber* products
+        offered at a given location. The response includes the display name
+        and other details about each product, and lists the products in the
+        proper display order.
+      parameters:
+        - name: latitude
+          in: query
+          description: Latitude component of location.
+          required: true
+          type: number
+          format: double
+        - name: longitude
+          in: query
+          description: Longitude component of location.
+          required: true
+          type: number
+          format: double
+      tags:
+        - Products
+      responses:
+        200:
+          description: An array of products
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Product'
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+    post:
+      summary: Creates Product
+      description: |
+        The Products endpoint creates a product.
+      parameters:
+        - name: product_id
+          in: body
+          description: Product ID
+          required: true
+          type: string
+        - name: name
+          in: body
+          description: Display Name
+          required: false
+          type: string
+      tags:
+        - Products
+      responses:
+        200:
+          description: A products
+          schema:
+            type: object
+            items:
+              $ref: '#/definitions/Product'
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+  /products/{id}:
+    patch:
+      summary: Updates a Product
+      description: |
+        The Products endpoint updates a product.
+      parameters:
+        - name: id
+          in: path
+          description: Product ID
+          required: true
+          type: number
+        - $ref: "#/parameters/ProductUpdate"
+      tags:
+        - Products
+      responses:
+        204:
+          description: A products
+          schema:
+            type: object
+            items:
+              $ref: '#/definitions/Product'
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/Error'
+    delete:
+      summary: Deletes a Product
+      description:
+        Deletes a single product identified by its id.
+      parameters:
+        - name: id
+          in: path
+          description: ID of product
+          required: true
+          type: number
+      tags:
+        - Employees
+      responses:
+        204:
+          description: Success
+        default:
+          description: Unexpected error
+          schema:
+            $ref: '#/definitions/ErrorMessage'
+parameters:
+  ProductUpdate:
+    name: product
+    in: body
+    required: true
+    schema:
+      properties:
+        name:
+          type: string
+          description: Name of the product
+definitions:
+  Product:
+    type: object
+    properties:
+      product_id:
+        type: string
+        description: Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.
+      description:
+        type: string
+        description: Description of product.
+      name:
+        type: string
+        description: Display name of product.
+      capacity:
+        type: string
+        description: Capacity of product. For example, 4 people.
+      image:
+        type: string
+        description: Image URL representing the product.
+  Error:
+    type: object
+    properties:
+      code:
+        type: integer
+        format: int32
+      message:
+        type: string
+      fields:
+        type: string

data/lib/openapi_rest.rb

@@ -0,0 +1,22 @@
+require 'rails'
+require 'openapi_rest/version'
+require 'openapi_rest/validators/format.rb'
+require 'openapi_rest/validators/pattern.rb'
+require 'openapi_rest/operations/filter.rb'
+require 'openapi_rest/operations/paginate.rb'
+require 'openapi_rest/operations/sort.rb'
+require 'openapi_rest/api_config.rb'
+require 'openapi_rest/api_doc.rb'
+require 'openapi_rest/api_doc_parser.rb'
+require 'openapi_rest/api_model.rb'
+require 'openapi_rest/api_parameters.rb'
+require 'openapi_rest/api_validator.rb'
+require 'openapi_rest/extension.rb'
+require 'openapi_rest/query_builder.rb'
+require 'openapi_rest/query_response.rb'
+require 'openapi_rest/railtie'
+require 'openapi_rest/rest_renderer'
+
+module OpenAPIRest
+  # Your code goes here...
+end

data/lib/openapi_rest/api_config.rb

@@ -0,0 +1,12 @@
+module OpenAPIRest
+  ###
+  # Api doc config based on OpenAPI specs
+  #
+  class ApiConfig
+    attr_accessor :document
+
+    def initialize(user_config = {})
+      self.document = user_config[:document]
+    end
+  end
+end

data/lib/openapi_rest/api_doc.rb

@@ -0,0 +1,19 @@
+module OpenAPIRest
+  ###
+  # Api doc parser based on OpenAPI specs
+  #
+  module ApiDoc
+    @config = nil
+
+    class << self
+      def configure
+        yield config = OpenAPIRest::ApiConfig.new
+        @config = config
+      end
+
+      def document
+        @config.document
+      end
+    end
+  end
+end