power_api 0.1.0

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+Bundler::GemHelper.install_tasks

data/app/assets/config/power_api_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/power_api .js
+//= link_directory ../stylesheets/power_api .css

data/app/assets/javascripts/power_api/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/power_api/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/concerns/api/deprecated.rb

@@ -0,0 +1,23 @@
+module Api::Deprecated
+  extend ActiveSupport::Concern
+
+  class_methods do
+    attr_accessor :deprecated_actions
+
+    def deprecate(*actions)
+      self.deprecated_actions ||= {}
+      self.deprecated_actions[to_s] = actions
+    end
+  end
+
+  included do
+    after_action :deprecate_actions
+
+    def deprecate_actions
+      return unless self.class.deprecated_actions
+
+      deprecated_actions = self.class.deprecated_actions[self.class.to_s]
+      response.headers["Deprecated"] = true if deprecated_actions.include?(params[:action].to_sym)
+    end
+  end
+end

data/app/controllers/concerns/api/error.rb

@@ -0,0 +1,37 @@
+module Api::Error
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from "Exception" do |exception|
+      logger.error exception.message
+      logger.error exception.backtrace.join("\n")
+      respond_api_error(:internal_server_error, message: "server_error",
+                                                type: exception.class.to_s,
+                                                detail: exception.message)
+    end
+
+    rescue_from "ActiveRecord::RecordNotFound" do |exception|
+      respond_api_error(:not_found, message: "record_not_found",
+                                    detail: exception.message)
+    end
+
+    rescue_from "ActiveModel::ForbiddenAttributesError" do |exception|
+      respond_api_error(:bad_request, message: "protected_attributes",
+                                      detail: exception.message)
+    end
+
+    rescue_from "ActiveRecord::RecordInvalid" do |exception|
+      respond_api_error(:bad_request, message: "invalid_attributes",
+                                      errors: exception.record.errors)
+    end
+
+    rescue_from "PowerApi::InvalidVersion" do |exception|
+      respond_api_error(:bad_request, message: "invalid_api_version",
+                                      errors: exception.message)
+    end
+  end
+
+  def respond_api_error(status, error = {})
+    render json: error, status: status
+  end
+end

data/app/controllers/concerns/api/filtered.rb

@@ -0,0 +1,15 @@
+module Api::Filtered
+  extend ActiveSupport::Concern
+
+  def filtered_collection(collection)
+    collection.ransack(query_string_filters).result
+  end
+
+  private
+
+  def query_string_filters
+    return {} if params[:q].blank?
+
+    params[:q]&.to_unsafe_h || {}
+  end
+end

data/app/controllers/concerns/api/versioned.rb

@@ -0,0 +1,36 @@
+module Api::Versioned
+  extend ActiveSupport::Concern
+
+  DEFAULT_API_VERSIONS = 1
+
+  included do
+    before_action :check_api_version!
+    after_action :add_version_to_content_type
+  end
+
+  private
+
+  def available_api_versions
+    ENV.fetch("AVAILABLE_API_VERSIONS", DEFAULT_API_VERSIONS)
+  end
+
+  def check_api_version!
+    return if (1..available_api_versions) === version_number
+
+    raise ::PowerApi::InvalidVersion.new("invalid API version")
+  end
+
+  def version_number
+    @version_number ||= begin
+      v = request.headers["Accept"].to_s.match(/version=(\d+)/)&.captures&.first.to_i
+      v.zero? ? DEFAULT_API_VERSIONS : v
+    end
+  end
+
+  def add_version_to_content_type
+    content_type_header = response.headers["Content-Type"]
+    parts = !content_type_header ? [] : content_type_header.to_s.split(";").map(&:strip)
+    parts << "version=#{@version_number}"
+    response.headers["Content-Type"] = parts.join("; ")
+  end
+end

data/app/controllers/power_api/base_controller.rb

@@ -0,0 +1,14 @@
+module PowerApi
+  class BaseController < ApplicationController
+    include Rails::Pagination
+
+    include Api::Error
+    include Api::Deprecated
+    include Api::Versioned
+    include Api::Filtered
+
+    self.responder = ApiResponder
+
+    respond_to :json
+  end
+end

data/app/helpers/power_api/application_helper.rb

@@ -0,0 +1,4 @@
+module PowerApi
+  module ApplicationHelper
+  end
+end

data/app/jobs/power_api/application_job.rb

@@ -0,0 +1,4 @@
+module PowerApi
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/power_api/application_mailer.rb

@@ -0,0 +1,6 @@
+module PowerApi
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/power_api/application_record.rb

@@ -0,0 +1,5 @@
+module PowerApi
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/responders/api_responder.rb

@@ -0,0 +1,13 @@
+class ApiResponder < ActionController::Responder
+  def api_behavior
+    raise MissingRenderer.new(format) unless has_renderer?
+
+    if delete?
+      head :no_content
+    elsif post?
+      display resource, status: :created
+    else
+      display resource
+    end
+  end
+end

data/app/views/layouts/power_api/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Power api</title>
+  <%= stylesheet_link_tag    "power_api/application", media: "all" %>
+  <%= javascript_include_tag "power_api/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/power_api/engine', __FILE__)
+APP_PATH = File.expand_path('../../spec/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+PowerApi::Engine.routes.draw do
+end

data/lib/generators/power_api/controller/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Create a new API controller for a given version
+
+Example:
+    rails generate power_api:controller blog

data/lib/generators/power_api/controller/controller_generator.rb

@@ -0,0 +1,152 @@
+class PowerApi::ControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  class_option(
+    :attributes,
+    type: 'array',
+    default: [],
+    aliases: '-a',
+    desc: 'attributes to show in serializer'
+  )
+
+  class_option(
+    :version_number,
+    type: 'numeric',
+    default: 1,
+    aliases: '-v',
+    desc: 'the API version number you want to add this controller'
+  )
+
+  class_option(
+    :use_paginator,
+    type: 'boolean',
+    default: false,
+    desc: 'to indicate whether the controller will use pager or not'
+  )
+
+  class_option(
+    :allow_filters,
+    type: 'boolean',
+    default: false,
+    desc: 'to indicate whether the controller will allow query string filters or not'
+  )
+
+  class_option(
+    :authenticate_with,
+    type: 'string',
+    default: nil,
+    desc: "to indicate if authorization is required to access the controller"
+  )
+
+  class_option(
+    :parent_resource,
+    type: 'string',
+    default: nil,
+    desc: "to indicate if the current resource is nested in another"
+  )
+
+  class_option(
+    :owned_by_authenticated_resource,
+    type: 'boolean',
+    default: false,
+    desc: "to indicate if the resource's owner must be the authorized resource"
+  )
+
+  def create_controller
+    create_file(
+      helper.resource_controller_path,
+      helper.resource_controller_tpl
+    )
+
+    helper.format_ruby_file(helper.resource_controller_path)
+  end
+
+  def add_routes
+    if helper.parent_resource?
+      add_normal_route(actions: ["show", "update", "destroy"])
+      add_nested_route
+    else
+      add_normal_route
+    end
+
+    helper.format_ruby_file(helper.routes_path)
+  end
+
+  def create_serializer
+    create_file(
+      helper.ams_serializer_path,
+      helper.ams_serializer_tpl
+    )
+
+    helper.format_ruby_file(helper.ams_serializer_path)
+  end
+
+  def configure_swagger
+    create_file(
+      helper.swagger_resource_schema_path,
+      helper.swagger_schema_tpl
+    )
+
+    helper.format_ruby_file(helper.swagger_resource_schema_path)
+
+    insert_into_file(
+      helper.swagger_version_definition_path,
+      helper.swagger_definition_entry,
+      after: helper.swagger_definition_line_to_inject_schema
+    )
+
+    create_file(
+      helper.swagger_resource_spec_path,
+      helper.swagger_resource_spec_tpl
+    )
+
+    helper.format_ruby_file(helper.swagger_resource_spec_path)
+  end
+
+  private
+
+  def add_nested_route
+    line_to_replace = helper.parent_resource_routes_line_regex
+    nested_resource_line = helper.resource_route_tpl(actions: ['index', 'create'])
+    add_nested_parent_route unless helper.parent_route_exist?
+
+    if helper.parent_route_already_have_children?
+      add_route(line_to_replace) { |match| "#{match}\n#{nested_resource_line}" }
+    else
+      add_route(line_to_replace) do |match|
+        "#{match.delete_suffix('\n')} do\n#{nested_resource_line}\nend\n"
+      end
+    end
+  end
+
+  def add_normal_route(actions: [])
+    add_route(helper.api_version_routes_line_regex) do |match|
+      "#{match}\n#{helper.resource_route_tpl(actions: actions)}"
+    end
+  end
+
+  def add_nested_parent_route
+    add_route(helper.api_version_routes_line_regex) do |match|
+      "#{match}\n#{helper.resource_route_tpl(is_parent: true)}"
+    end
+  end
+
+  def add_route(line_to_replace, &block)
+    gsub_file helper.routes_path, line_to_replace do |match|
+      block.call(match)
+    end
+  end
+
+  def helper
+    @helper ||= PowerApi::GeneratorHelpers.new(
+      version_number: options[:version_number],
+      resource: file_name,
+      authenticated_resource: options[:authenticate_with],
+      parent_resource: options[:parent_resource],
+      owned_by_authenticated_resource: options[:owned_by_authenticated_resource],
+      resource_attributes: options[:attributes],
+      use_paginator: options[:use_paginator],
+      allow_filters: options[:allow_filters]
+    )
+  end
+end

data/lib/generators/power_api/install/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Install the engine in host app.
+
+Example:
+    rails generate power_api:install

data/lib/generators/power_api/install/install_generator.rb

@@ -0,0 +1,67 @@
+class PowerApi::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  class_option(
+    :authenticated_resources,
+    type: 'array',
+    default: [],
+    desc: 'define which model or models will be token authenticatable'
+  )
+
+  def create_api_base_controller
+    create_file(helper.api_base_controller_path, helper.api_base_controller_tpl)
+  end
+
+  def create_ams_initializer
+    create_file(helper.ams_initializer_path, helper.ams_initializer_tpl)
+  end
+
+  def install_rswag
+    generate "rswag:ui:install"
+    generate "rswag:api:install"
+    generate "rswag:specs:install"
+
+    create_file(helper.rswag_ui_initializer_path, helper.rswag_ui_initializer_tpl, force: true)
+    create_file(helper.swagger_helper_path, helper.swagger_helper_tpl, force: true)
+    create_file(helper.spec_swagger_path)
+    create_file(helper.spec_integration_path)
+  end
+
+  def install_first_version
+    generate "power_api:version 1"
+  end
+
+  def install_api_pagination
+    create_file(
+      helper.api_pagination_initializer_path,
+      helper.api_pagination_initializer_tpl,
+      force: true
+    )
+  end
+
+  def install_simple_token_auth
+    create_file(
+      helper.simple_token_auth_initializer_path,
+      helper.simple_token_auth_initializer_tpl,
+      force: true
+    )
+
+    helper.authenticated_resources.each do |resource|
+      generate resource.authenticated_resource_migration
+
+      insert_into_file(
+        resource.path,
+        helper.simple_token_auth_method,
+        after: resource.class_definition_line
+      )
+    end
+  end
+
+  private
+
+  def helper
+    @helper ||= PowerApi::GeneratorHelpers.new(
+      authenticated_resources: options[:authenticated_resources]
+    )
+  end
+end