api_scaffold 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b849a097b4d3de796e261221a6d46245f92eb5abf6cdc5b169b6113896612594
-  data.tar.gz: a9c0066a65c33bd6a5a95b72af2e231df9a472c3dd7fdc42431c5c07f165e68c
+  metadata.gz: 8cff1f27b341cc49d8383e4757e9b84b9fb90aedb088732684039e366b3f7366
+  data.tar.gz: bf63be47cc9fd48631f3f590ce1d7d8929273a79f8303a3194aed66cda16006c
 SHA512:
-  metadata.gz: a4fd95d6617e0286e26c07f80be7930731643bf8c4f84970a5c1224a4b28dc7050eb983487d8dfa9de42822a945554ed4a1dc80b79e77c0b60c1704241b2c984
-  data.tar.gz: 8c33ea95c27483219ee09595956486556b36716bc28e43c81be98398d7854cc047ebebed894296dc9f6b5d222eebe4771ed7615070ec5b26d107c42ca042ecf1
+  metadata.gz: 8e3bd30111768c6013ee26c00e323fe49672bf18469a909453e88c28a204c3307cdc4f265bf0e492e269c420991ae5977c3ceb622b38736294fae3e56144d7ef
+  data.tar.gz: c1e00571790e5f9d119976c8bf766e80bd7d03b9f4b4ca25e48f0ed7a083da899d79e3d5f23c5246f1aa2837324c941105ec708389b7e29d206d1d03a7768c62

data/README.md

@@ -4,6 +4,7 @@ A useful Rails API generator for scaffolding. Compatible with :
 - Fast JSON API/Active Model Serializers
 - Rspec/TestUnit/Fixtures/FactoryBot
 - Api Pagination
+- Apipie
 
 ## Installation
 
@@ -42,7 +43,6 @@ If you wish to specify the api version:
 
 ## TODO
 - Make compatible with nested resources
-- Add api docs to controller scaffold
 
 ## Contributing
 

data/lib/api_scaffold/version.rb

@@ -1,3 +1,3 @@
 module ApiScaffold
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/generators/api_scaffold/generator_helpers.rb

@@ -22,6 +22,10 @@ module ApiScaffold
         Gem::Specification::find_all_by_name(gem_name).any?
       end
 
+      def apipie_installed?
+        File.exists? File.join(destination_root, "config/initializers/apipie.rb")
+      end
+
       def test_framework
         Rails.application.config.generators.options[:rails][:test_framework]
       end
@@ -41,6 +45,7 @@ module ApiScaffold
       def attributes_string
         attributes_hash.map { |k, v| "#{k}: #{v}" }.join(", ")
       end
+      
       def attributes_hash
         return {} if attributes_names.empty?
 
@@ -52,6 +57,10 @@ module ApiScaffold
           end
         end.sort.to_h
       end
+
+      def apipie_param(attribute)
+        "param :#{attribute.name}, String, 'TODO: #{attribute.name} descrption'"
+      end
     end
   end
 end

data/lib/generators/api_scaffold/templates/controllers/controller.rb

@@ -6,16 +6,27 @@ require_dependency "<%= namespaced_path %>/application_controller"
 class <%= prefixed_controller_class_name %>Controller < ApplicationController
   before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
 
-  def index
+  <% if apipie_installed? -%>def_param_group :<%= singular_table_name %> do
+    param :<%= singular_table_name %>, Hash, required: true, action_aware: true do
+    <% attributes.each do |attribute| -%><%= indent(apipie_param(attribute), 2) %>
+    <% end -%>end
+  end
+
+  api!
+  <% end -%>def index
     @<%= plural_table_name %> = <%= 'paginate ' if gem_available?('api-pagination') %><%= orm_class.all(class_name) %>
     render json: <%= "@#{plural_table_name}" %>
   end
 
+  <%= 'api!' if apipie_installed? -%>
+
   def show
     render json: <%= "@#{singular_table_name}" %>
   end
 
-  def create
+  <% if apipie_installed? -%>api!
+  param_group :<%= singular_table_name %>
+  <% end -%>def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     if @<%= orm_instance.save %>
@@ -25,7 +36,9 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
-  def update
+  <% if apipie_installed? -%>api!
+  param_group :<%= singular_table_name %>
+  <% end -%>def update
     if @<%= orm_instance.update("#{singular_table_name}_params") %>
       render json: <%= "@#{singular_table_name}" %>
     else
@@ -33,6 +46,8 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
+  <%= 'api!' if apipie_installed? -%>
+
   def destroy
     @<%= orm_instance.destroy %>
   end

data/lib/generators/api_scaffold/templates/controllers/serializer_controller.rb

@@ -6,16 +6,27 @@ require_dependency "<%= namespaced_path %>/application_controller"
 class <%= prefixed_controller_class_name %>Controller < ApplicationController
   before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
 
-  def index
+  <% if apipie_installed? -%>def_param_group :<%= singular_table_name %> do
+    param :<%= singular_table_name %>, Hash, required: true, action_aware: true do
+    <% attributes.each do |attribute| -%><%= indent(apipie_param(attribute), 2) %>
+    <% end -%>end
+  end
+
+  api!
+  <% end -%>def index
     @<%= plural_table_name %> = <%= 'paginate ' if gem_available?('api-pagination') %><%= orm_class.all(class_name) %>
     render json: <%= class_name %>Serializer.new(<%= "@#{plural_table_name}" %>)
   end
 
+  <%= 'api!' if apipie_installed? -%>
+
   def show
     render json: <%= class_name %>Serializer.new(<%= "@#{singular_table_name}" %>)
   end
 
-  def create
+  <% if apipie_installed? -%>api!
+  param_group :<%= singular_table_name %>
+  <% end -%>def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     if @<%= orm_instance.save %>
@@ -25,7 +36,9 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
-  def update
+  <% if apipie_installed? -%>api!
+  param_group :<%= singular_table_name %>
+  <% end -%>def update
     if @<%= orm_instance.update("#{singular_table_name}_params") %>
       render json: <%= class_name %>Serializer.new(<%= "@#{singular_table_name}" %>)
     else
@@ -33,6 +46,8 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
+  <%= 'api!' if apipie_installed? -%>
+
   def destroy
     @<%= orm_instance.destroy %>
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Stefan Atkinson