api_scaffold 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de9076335da73692a8f0939ed95bc1b3a16a84bbd48b3a6ff79944cb92a75334
-  data.tar.gz: 370118c487da1671f38b351e15eade622d5cf761d9d08552fa005b699acb156e
+  metadata.gz: b849a097b4d3de796e261221a6d46245f92eb5abf6cdc5b169b6113896612594
+  data.tar.gz: a9c0066a65c33bd6a5a95b72af2e231df9a472c3dd7fdc42431c5c07f165e68c
 SHA512:
-  metadata.gz: 7c80e4e950a0d7af2cfeaa1b20b7c5e269df98acbb2e93ab3dbfdd754612c018ceaf1c84542589bc882d9ea24bf051aab40b70bd69fef3b26dd2df93b00aa0ba
-  data.tar.gz: 82f2d6485ad5d7eb67d38e318ec68a9788628773a76cbfbc2e58dcaca5059cbf845e1f6290ee3a8aa2c950cfc4a723fc182f1856e8304a768beacc748dcc3ba8
+  metadata.gz: a4fd95d6617e0286e26c07f80be7930731643bf8c4f84970a5c1224a4b28dc7050eb983487d8dfa9de42822a945554ed4a1dc80b79e77c0b60c1704241b2c984
+  data.tar.gz: 8c33ea95c27483219ee09595956486556b36716bc28e43c81be98398d7854cc047ebebed894296dc9f6b5d222eebe4771ed7615070ec5b26d107c42ca042ecf1

data/README.md

@@ -1,6 +1,6 @@
 # ApiScaffold
 
-A useful Rails API generator for scaffolding. Compatible with  :
+A useful Rails API generator for scaffolding. Compatible with :
 - Fast JSON API/Active Model Serializers
 - Rspec/TestUnit/Fixtures/FactoryBot
 - Api Pagination
@@ -26,7 +26,7 @@ Or install it yourself as:
 Add this code to config/routes.rb if you want your routes to be inserted under the v1 namespace.
 
 ```ruby
-scope :api, defaults: { format: :json } do
+namespace :api, defaults: { format: :json } do
   namespace :v1 do
   end
 end
@@ -42,8 +42,7 @@ If you wish to specify the api version:
 
 ## TODO
 - Make compatible with nested resources
-- Add apiepie to controller scaffold if apipie is installed
-- create individual scaffolds for controller, authentication and tests
+- Add api docs to controller scaffold
 
 ## Contributing
 

data/lib/api_scaffold/version.rb

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

data/lib/generators/api_scaffold/api_scaffold_generator.rb

@@ -25,17 +25,17 @@ module ApiScaffold
 
       def create_controller_files
         if gem_available?('fast_jsonapi') || gem_available?('active_model_serializers')
-          template "controllers/serializer_controller.rb", File.join("app/controllers/", prefix, "#{controller_file_name}_controller.rb")
+          template "controllers/serializer_controller.rb", File.join("app/controllers/api/", prefix, "#{controller_file_name}_controller.rb")
         else
-          template "controllers/controller.rb", File.join("app/controllers/", prefix, "#{controller_file_name}_controller.rb")
+          template "controllers/controller.rb", File.join("app/controllers/api", prefix, "#{controller_file_name}_controller.rb")
         end
       end
 
       def create_controller_test_files
         if test_framework == :rspec
-          template "tests/rspec/controller_spec.rb", File.join("spec/controllers", prefix, "#{controller_file_name}_controller_spec.rb")
+          template "tests/rspec/controller_spec.rb", File.join("spec/controllers/api", prefix, "#{controller_file_name}_controller_spec.rb")
         else
-          template "tests/test_unit/controller_spec.rb", File.join("test/controllers", prefix, "#{controller_file_name}_controller_test.rb")
+          template "tests/test_unit/controller_spec.rb", File.join("test/controllers/api", prefix, "#{controller_file_name}_controller_test.rb")
         end
       end
 
@@ -43,7 +43,7 @@ module ApiScaffold
         # Include tabs and line break for proper formatting
         routes_string = "      resources :#{controller_file_name}, except: [:new, :edit]\n"
         # Inject into file following the api scope and v1 namespace
-        inject_into_file 'config/routes.rb', after: "  scope :api, defaults: { format: :json } do\n    namespace :#{prefix} do\n" do
+        inject_into_file 'config/routes.rb', after: "  namespace :api, defaults: { format: :json } do\n    namespace :#{prefix} do\n" do
           routes_string
         end
       end

data/lib/generators/api_scaffold/generator_helpers.rb

@@ -7,15 +7,15 @@ module ApiScaffold
       end
 
       def prefixed_class_name
-        "#{prefix.capitalize}::#{class_name}"
+        "Api::#{prefix.capitalize}::#{class_name}"
       end
 
       def prefixed_controller_class_name
-        "#{prefix.capitalize}::#{controller_class_name}"
+        "Api::#{prefix.capitalize}::#{controller_class_name}"
       end
 
       def prefixed_url(resource)
-        [prefix, resource, 'url'].join('_')
+        ['api', prefix, resource, 'url'].join('_')
       end
 
       def gem_available?(gem_name)

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

@@ -19,7 +19,7 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     if @<%= orm_instance.save %>
-      render json: <%= "@#{singular_table_name}" %>, status: :created, location: [:<%= prefix %>, <%= "@#{singular_table_name}" %>]
+      render json: <%= "@#{singular_table_name}" %>, status: :created, location: [:api, :<%= prefix %>, <%= "@#{singular_table_name}" %>]
     else
       render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
     end

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

@@ -19,7 +19,7 @@ class <%= prefixed_controller_class_name %>Controller < ApplicationController
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
 
     if @<%= orm_instance.save %>
-      render json: <%= class_name %>Serializer.new(<%= "@#{singular_table_name}" %>), status: :created, location: [:<%= prefix %>, <%= "@#{singular_table_name}" %>]
+      render json: <%= class_name %>Serializer.new(<%= "@#{singular_table_name}" %>), status: :created, location: [:api, :<%= prefix %>, <%= "@#{singular_table_name}" %>]
     else
       render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity
     end

data/lib/generators/api_scaffold/templates/tests/rspec/controller_spec.rb

@@ -85,7 +85,7 @@ RSpec.describe <%= prefixed_controller_class_name %>Controller, type: :controlle
 <% end -%>
         expect(response).to have_http_status(:created)
         expect(response.content_type).to eq('application/json')
-        expect(response.location).to eq(<%= prefix %>_<%= file_name %>_url(<%= class_name %>.last))
+        expect(response.location).to eq(api_<%= prefix %>_<%= file_name %>_url(<%= class_name %>.last))
       end
     end
     context "with invalid params" do
@@ -154,4 +154,4 @@ RSpec.describe <%= prefixed_controller_class_name %>Controller, type: :controlle
     end
   end
 end
-<% end -%>
+<% end -%>

data/lib/generators/api_scaffold/templates/tests/test_unit/controller_spec.rb

@@ -11,34 +11,34 @@ class <%= prefixed_controller_class_name %>ControllerTest < ActionDispatch::Inte
   end
 
   test "should get index" do
-    get <%= [prefix, index_helper].join('_') %>_url, as: :json
+    get <%= ['api', prefix, index_helper].join('_') %>_url, as: :json
     assert_response :success
   end
 
   test "should create <%= singular_table_name %>" do
     assert_difference('<%= class_name %>.count') do
-      post <%= [prefix, index_helper].join('_') %>_url, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }, as: :json
+      post <%= ['api', prefix, index_helper].join('_') %>_url, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }, as: :json
     end
 
     assert_response 201
   end
 
   test "should show <%= singular_table_name %>" do
-    get <%= [prefix, show_helper].join('_') %>, as: :json
+    get <%= ['api', prefix, show_helper].join('_') %>, as: :json
     assert_response :success
   end
 
   test "should update <%= singular_table_name %>" do
-    patch <%= [prefix, show_helper].join('_') %>, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }, as: :json
+    patch <%= ['api', prefix, show_helper].join('_') %>, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }, as: :json
     assert_response 200
   end
 
   test "should destroy <%= singular_table_name %>" do
     assert_difference('<%= class_name %>.count', -1) do
-      delete <%= [prefix, show_helper].join('_') %>, as: :json
+      delete <%= ['api', prefix, show_helper].join('_') %>, as: :json
     end
 
     assert_response 204
   end
 end
-<% end -%>
+<% end -%>

metadata

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