api_scaffold 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcd72aeae0a6c2bb2083da25216c0c58297ae64efbbe5300d8cdc65b36488cd5
-  data.tar.gz: 53049968a234146abaa00dd295b255939658c888093d3350b5913bac30ca1563
+  metadata.gz: 837e66eb2af89f787a9e86612f616061d661cf6e32a44e0abc73481c6b90e921
+  data.tar.gz: '0393d39076b3cc3390d8a9bd5d80c48861133c5b0e5bbdb1741f92dfced9c787'
 SHA512:
-  metadata.gz: 8a6841a34cedf61627603a1186e7fabf19f344fff5abb384b7e2c2e71e348bb09d4c3b445355876215da2ddfcea345217006487e9a3057463dcfc032b0c21b70
-  data.tar.gz: ad2a7743d7441b37894b00d7b4d5653f05a3830f726a780e38926bafec6ed64b7e07de5f5bbcc1ccd0de14ccc85f5f9826087a2184bbd28c8d93506ab895e96a
+  metadata.gz: 630c5fe1f9c1c83b90fa5d09445dc9992aa8fffb6bc2a91b339d09840710362452955064934e827f6835bdb6ae62406e930f8e4ac3bc8def3153d4b22a6f36d5
+  data.tar.gz: 3ed60f893e21de1d93cb6f91abd0b546916eae373e11a9e5c2ec8ef12c5c2b197f4347ec9d27e1c7ee41fc395496c8f0d6314e6218db343ce83fccc9f43699ad

data/README.md

@@ -1,12 +1,16 @@
 # ApiScaffold
 
-A useful Rails API generator for scaffolding. Compatible with :
+A useful Rails API generator for scaffolding that follows the jsonapi.org specification (http://jsonapi.org/). Works with : 
 - Fast JSON API/Active Model Serializers
 - Rspec/TestUnit
 - Fixtures/FactoryBot
 - Api Pagination
-- Apipie
 
+For example if you have : 
+- Fast JSON API/AMS in your gemfile ? the scaffold will create a serializer and generate a controller using the scaffolded serializer.
+- Rspec as your configured test framework ? the scaffold will generate rspec working controller tests
+- Apipie installed ? the scaffold will generate api documentation
+- api-pagination in your gemfile ? the scaffold will paginate the index method of scaffolded controller 
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,6 +48,7 @@ If you wish to specify the api version:
 
 ## TODO
 - Nested resources 
+- GraphQL
 
 ## Contributing
 

data/lib/api_scaffold/version.rb

@@ -1,3 +1,3 @@
 module ApiScaffold
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/generators/api_scaffold/generator_helpers.rb

@@ -22,10 +22,6 @@ 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 error_serializer_created?
         File.exists? File.join(destination_root, "app/serializers/error_serializer.rb")
       end
@@ -61,10 +57,6 @@ module ApiScaffold
           end
         end.sort.to_h
       end
-
-      def apipie_param(attribute_name)
-        "param :#{attribute_name}, String, 'TODO: #{attribute_name} descrption'"
-      end
     end
   end
 end

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

@@ -6,30 +6,16 @@ require_dependency "<%= namespaced_path %>/application_controller"
 class <%= prefixed_controller_class_name %>Controller < ApplicationController
   before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
 
-  <% if apipie_installed? -%>def_param_group :<%= singular_table_name %> do
-    param :<%= singular_table_name %>, Hash, required: true, action_aware: true do
-    <% attributes_names.each do |attribute_name| -%><%= indent(apipie_param(attribute_name), 2) %>
-    <% end -%>end
-  end
-
-  api :GET, '/<%= plural_table_name %>', 'List <%= plural_table_name %>'
-  <% if gem_available?('api-pagination') %>param :page, String, 'Paginate results'
-  param :per_page, String, 'Number of records per page'
-  <% end -%>
-  <% end -%>def index
+  def index
     @<%= plural_table_name %> = <%= 'paginate ' if gem_available?('api-pagination') %><%= orm_class.all(class_name) %>
     render json: <%= "@#{plural_table_name}" %>
   end
-
   
-  <% if apipie_installed? -%>api :GET, '/<%= [prefix, plural_table_name].join("/") %>/:id', 'Show <%= singular_table_name %>'
-  <% end -%>def show
+  def show
     render json: <%= "@#{singular_table_name}" %>
   end
 
-  <% if apipie_installed? -%>api :POST, '/<%= [prefix, plural_table_name].join("/")  %>', 'Create <%= singular_table_name %>'
-  param_group :<%= singular_table_name %>
-  <% end -%>def create
+  def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     if @<%= orm_instance.save %>
@@ -39,9 +25,7 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
-  <% if apipie_installed? -%>api :PUT, '/<%= [prefix, plural_table_name].join("/")  %>/:id', 'Update <%= singular_table_name %>'
-  param_group :<%= singular_table_name %>
-  <% end -%>def update
+  def update
     if @<%= orm_instance.update("#{singular_table_name}_params") %>
       render json: <%= "@#{singular_table_name}" %>
     else
@@ -49,8 +33,7 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
-  <% if apipie_installed? -%>api :DELETE, '/<%= [prefix, plural_table_name].join("/")  %>/:id', 'Delete <%= singular_table_name %>'
-  <% end -%>def destroy
+  def destroy
     @<%= orm_instance.destroy %>
   end
 

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

@@ -6,28 +6,16 @@ require_dependency "<%= namespaced_path %>/application_controller"
 class <%= prefixed_controller_class_name %>Controller < ApplicationController
   before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
 
-  <% if apipie_installed? -%>def_param_group :<%= singular_table_name %> do
-    param :<%= singular_table_name %>, Hash, required: true, action_aware: true do
-    <% attributes_names.each do |attribute_name| -%><%= indent(apipie_param(attribute_name), 2) %>
-    <% end -%>end
-  end
-
-  api :GET, '/<%= [prefix, plural_table_name].join("/")  %>', 'List <%= plural_table_name %>'
-  <% if gem_available?('api-pagination') %>param :page, String, 'Paginate results'
-  param :per_page, String, 'Number of records per page'
-  <% end -%><% end -%>def index
+  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
 
-  <% if apipie_installed? -%>api :GET, '/<%= [prefix, plural_table_name].join("/")  %>/:id', 'Show <%= singular_table_name %>'
-  <% end -%>def show
+  def show
     render json: <%= class_name %>Serializer.new(<%= "@#{singular_table_name}" %>)
   end
   
-  <% if apipie_installed? -%>api :POST, '/<%= [prefix, plural_table_name].join("/")  %>', 'Create <%= singular_table_name %>'
-  param_group :<%= singular_table_name %>
-  <% end -%>def create
+  def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     if @<%= orm_instance.save %>
@@ -37,9 +25,7 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
-  <% if apipie_installed? -%>api :PUT, '/<%= [prefix, plural_table_name].join("/")  %>/:id', 'Update <%= singular_table_name %>'
-  param_group :<%= singular_table_name %>
-  <% end -%>def update
+  def update
     if @<%= orm_instance.update("#{singular_table_name}_params") %>
       render json: <%= class_name %>Serializer.new(<%= "@#{singular_table_name}" %>)
     else
@@ -47,8 +33,7 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     end
   end
 
-  <% if apipie_installed? -%>api :DELETE, '/<%= [prefix, plural_table_name].join("/")  %>/:id', 'Delete <%= singular_table_name %>'
-  <% end -%>def destroy
+  def destroy
     @<%= orm_instance.destroy %>
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stefan Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler