power_api 0.1.0

data/lib/power_api/generator_helper/template_builder_helper.rb

@@ -0,0 +1,23 @@
+module PowerApi::GeneratorHelper::TemplateBuilderHelper
+  extend ActiveSupport::Concern
+
+  def concat_tpl_statements(*methods)
+    methods.reject(&:blank?).join("\n")
+  end
+
+  def concat_tpl_method(method_name, *method_lines)
+    concat_tpl_statements(
+      "def #{method_name}",
+      *method_lines,
+      "end"
+    )
+  end
+
+  def tpl_class(class_def, *statements)
+    concat_tpl_statements(
+      "class #{class_def}",
+      *statements,
+      "end\n"
+    )
+  end
+end

data/lib/power_api/generator_helper/version_helper.rb

@@ -0,0 +1,16 @@
+module PowerApi::GeneratorHelper::VersionHelper
+  extend ActiveSupport::Concern
+
+  included do
+    attr_reader :version_number
+  end
+
+  def version_number=(value)
+    @version_number = value.to_s.to_i
+    raise PowerApi::GeneratorError.new("invalid version number") if version_number < 1
+  end
+
+  def first_version?
+    version_number.to_i == 1
+  end
+end

data/lib/power_api/generator_helpers.rb

@@ -0,0 +1,25 @@
+module PowerApi
+  class GeneratorHelpers
+    include GeneratorHelper::ResourceHelper
+    include GeneratorHelper::VersionHelper
+    include GeneratorHelper::SwaggerHelper
+    include GeneratorHelper::AmsHelper
+    include GeneratorHelper::ControllerHelper
+    include GeneratorHelper::RoutesHelper
+    include GeneratorHelper::PaginationHelper
+    include GeneratorHelper::SimpleTokenAuthHelper
+    include GeneratorHelper::RubocopHelper
+
+    def initialize(config = {})
+      config.each do |attribute, value|
+        load_attribute(attribute, value)
+      end
+    end
+
+    private
+
+    def load_attribute(attribute, value)
+      send("#{attribute}=", value)
+    end
+  end
+end

data/lib/power_api/version.rb

@@ -0,0 +1,3 @@
+module PowerApi
+  VERSION = '0.1.0'
+end

data/lib/tasks/power_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :power_api do
+#   # Task goes here
+# end

data/power_api.gemspec

@@ -0,0 +1,44 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem"s version:
+require "power_api/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "power_api"
+  s.version       = PowerApi::VERSION
+  s.authors       = ["Platanus", "Leandro Segovia"]
+  s.email         = ["rubygems@platan.us", "ldlsegovia@gmail.com"]
+  s.homepage      = "https://github.com/platanus/power_api"
+  s.summary       = "Set of other gems and configurations designed to build incredible APIs"
+  s.description   = "It is a Rails engine that gathers a set of other gems and configurations designed to build incredible APIs"
+  s.license       = "MIT"
+
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", ">= 4.2.0"
+
+  s.add_dependency "active_model_serializers", "~> 0.10.0"
+  s.add_dependency "api-pagination"
+  s.add_dependency "kaminari"
+  s.add_dependency "ransack"
+  s.add_dependency "responders"
+  s.add_dependency "rswag-api"
+  s.add_dependency "rswag-ui"
+  s.add_dependency "simple_token_authentication", "~> 1.0"
+  s.add_dependency "versionist", "~> 1.0"
+
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "factory_bot_rails"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-rails"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "rswag-specs"
+  s.add_development_dependency "rubocop", "0.65.0"
+  s.add_development_dependency "rubocop-rspec"
+  s.add_development_dependency "sqlite3", "~> 1.3.0"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link power_api_manifest.js

data/spec/dummy/app/assets/javascripts/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/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/concerns/api/deprecated_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'Api::Deprecated', type: :controller do
+  before do
+    routes.draw { get :action1, to: "anonymous#action" }
+
+    get :action
+  end
+
+  context "with deprecated action" do
+    controller do
+      include ::Api::Deprecated
+
+      deprecate :action
+
+      def action
+        head :ok
+      end
+    end
+
+    it { expect(response.status).to eq(200) }
+    it { expect(response.headers["Deprecated"]).to eq(true) }
+  end
+
+  context "with deprecated action" do
+    controller do
+      include ::Api::Deprecated
+
+      def action
+        head :ok
+      end
+    end
+
+    it { expect(response.status).to eq(200) }
+    it { expect(response.headers["Deprecated"]).to be_nil }
+  end
+end

data/spec/dummy/app/controllers/concerns/api/error_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe 'Api::Error', type: :controller do
+  before do
+    routes.draw { get :action, to: "anonymous#action" }
+
+    get :action
+  end
+
+  def response_body
+    JSON.parse(response.body).deep_symbolize_keys
+  end
+
+  context "with Exception error" do
+    let(:expected_response) do
+      {
+        detail: ":-(",
+        message: "server_error",
+        type: "RuntimeError"
+      }
+    end
+
+    controller do
+      include ::Api::Error
+
+      def action
+        raise ':-('
+      end
+    end
+
+    it { expect(response_body).to eq(expected_response) }
+    it { expect(response.status).to eq(500) }
+  end
+
+  context "with ActiveRecord::RecordNotFound error" do
+    let(:expected_response) do
+      {
+        detail: ":-(",
+        message: "record_not_found"
+      }
+    end
+
+    controller do
+      include ::Api::Error
+
+      def action
+        raise ActiveRecord::RecordNotFound.new(":-(")
+      end
+    end
+
+    it { expect(response_body).to eq(expected_response) }
+    it { expect(response.status).to eq(404) }
+  end
+
+  context "with ActiveModel::ForbiddenAttributesError error" do
+    let(:expected_response) do
+      {
+        detail: ":-(",
+        message: "protected_attributes"
+      }
+    end
+
+    controller do
+      include ::Api::Error
+
+      def action
+        raise ActiveModel::ForbiddenAttributesError.new(":-(")
+      end
+    end
+
+    it { expect(response_body).to eq(expected_response) }
+    it { expect(response.status).to eq(400) }
+  end
+
+  context "with ActiveRecord::RecordInvalid error" do
+    let(:expected_response) do
+      {
+        message: "invalid_attributes",
+        errors: {
+          body: ["can't be blank"],
+          title: ["can't be blank"]
+        }
+      }
+    end
+
+    controller do
+      include ::Api::Error
+
+      def action
+        raise Blog.create!
+      end
+    end
+
+    it { expect(response_body).to eq(expected_response) }
+    it { expect(response.status).to eq(400) }
+  end
+end

data/spec/dummy/app/controllers/concerns/api/filtered_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'Api::Filtered', type: :controller do
+  let(:filters) do
+    nil
+  end
+
+  controller do
+    include ::Api::Filtered
+
+    def action
+      render json: filtered_collection(Blog.all)
+    end
+  end
+
+  before do
+    routes.draw { get :action, to: "anonymous#action" }
+
+    create(:blog, title: "Lean's blog")
+    create(:blog, title: "Santiago's blog")
+
+    get :action, params: { q: filters }
+  end
+
+  def resources_count
+    JSON.parse(response.body).count
+  end
+
+  it { expect(resources_count).to eq(2) }
+  it { expect(response.status).to eq(200) }
+
+  context "with filters" do
+    let(:filters) do
+      {
+        title_cont: "Lean"
+      }
+    end
+
+    it { expect(resources_count).to eq(1) }
+    it { expect(response.status).to eq(200) }
+  end
+end

data/spec/dummy/app/controllers/concerns/api/versioned_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe 'Api::Versioned', type: :controller do
+  let(:available_versions) { 1 }
+  let(:headers) do
+    {}
+  end
+
+  before do
+    allow(ENV).to receive(:fetch).with(
+      "AVAILABLE_API_VERSIONS", 1
+    ).and_return(available_versions)
+
+    routes.draw { get :action, to: "anonymous#action" }
+    request.headers.merge!(headers) unless headers.blank?
+    get :action
+  end
+
+  controller do
+    include ::Api::Versioned
+    include ::Api::Error
+
+    def action
+      head :ok
+    end
+  end
+
+  context "with default version" do
+    it { expect(response.status).to eq(200) }
+    it { expect(response.headers["Content-Type"]).to eq("text/html; version=1") }
+
+    context "with invalid version header" do
+      let(:headers) do
+        {
+          "Accept" => "version=2"
+        }
+      end
+
+      it { expect(response.status).to eq(400) }
+    end
+  end
+
+  context "with multiple versions" do
+    let(:available_versions) { 2 }
+    let(:headers) do
+      {
+        "Accept" => "version=2"
+      }
+    end
+
+    it { expect(response.status).to eq(200) }
+    it { expect(response.headers["Content-Type"]).to eq("text/html; version=2") }
+
+    context "with invalid version header" do
+      let(:headers) do
+        {
+          "Accept" => "version=3"
+        }
+      end
+
+      it { expect(response.status).to eq(400) }
+    end
+  end
+end