hoc_utils 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d322af731840a53efc077f1b06c37855bf762f56
-  data.tar.gz: 55871f41c59f6ee90890b02c23210e65971cfc6b
+  metadata.gz: eab9dc88e9cf7cca2f292f4bd2a885ef9ba884bb
+  data.tar.gz: 9233f7c085dee9d939ba096eec056711e75eca1d
 SHA512:
-  metadata.gz: 905e4b59fc1e3f2e4aabaa4e992bd45f5f4e713f5334ba2a85ee1c48943e8861b2107184a639ae0d9aa78dba209873291bbb1bdbaf59bd2760e6a06f93cd9b69
-  data.tar.gz: f04a1678f3f7c778154f98a7a2ed18078b444a17bf0dfc1ff7d420b7fb3d7ebdbf143b278732e97007c919f7a6135257353d18775404264a8408399485b78ad5
+  metadata.gz: fbc551bfd8e4a9bf8169d832c17fcbdd9d8c765f0820f1faa9899fd7a9bee4fe8ceafa5ce07e2c3b574d395d359fc51899cc3ed3e643236a65a969edd813b9a4
+  data.tar.gz: 1beacf1d5b84ba667dd4bda929cfffdb0813550a4aac663975983d1b2f1d20e70b18db3bddf03c0053aad6d91325fcb8b91cafdcdf0bf8a316f83dfbbfa32a05

data/README.md

@@ -1,6 +1,6 @@
 # HocUtils
-
 This is a collection of utilities for a HoC API application
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,10 +17,11 @@ Or install it yourself as:
 
     $ gem install hoc_utils
 
+## TODO
+* Routes for nested resources
+* Generate client code
+* DSL for specifying models and layout of admin pages
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hoc_utils.
 
 ## License
 

data/lib/generators/hoc_utils/api_scaffold/api_scaffold_generator.rb

@@ -15,9 +15,24 @@ module HocUtils
       class_option :admin, type: :boolean, default: true, desc: "Generate administration interface"
       class_option :routes, type: :boolean, default: true, desc: "Generate routes"
       class_option :api_version, type: :string, default: "v1", desc: "Version of namespace"
-
+      class_option :nested_to, type: :string, default: nil, desc: "Should be nested in"
       source_root File.expand_path('templates', __dir__)
 
+      def is_nested?
+        !options.nested_to.nil?
+      end
+
+      def singular_parent_name
+        options.nested_to.try(:downcase)
+      end
+
+      def plural_parent_name
+        options.nested_to.try(:pluralize)
+      end
+
+      def parent_class_name
+        singular_parent_name.try(:classify)
+      end
 
       def api_version
         options.api_version.downcase
@@ -44,12 +59,21 @@ ACTS
       # Scaffolds the api controller
       def generate_api_controller
         say "Generates app/controllers/api/#{api_version}/#{plural_table_name}_controller.rb", :bold
-        template "api_controller.rb.tt", "app/controllers/api/#{api_version}/#{plural_table_name}_controller.rb"
+        if is_nested?
+          template "nested_api_controller.rb.tt", "app/controllers/api/#{api_version}/#{plural_table_name}_controller.rb"
+        else
+          template "api_controller.rb.tt", "app/controllers/api/#{api_version}/#{plural_table_name}_controller.rb"
+        end
       end
 
       # Generates routes in config/routes.rb. Will namespace resources to api/[api_version].
       def generate_routes
         return unless options.routes?
+
+        if is_nested?
+          say "Sorry you have to generate the route manually. because I don't know how to do it when the resource is nested!", :yellow, :bold
+          return
+        end
         say "Generates routes. You may want to merge api/#{api_version} namespaces in config/routes.rb", :bold
         generate "resource_route api/#{api_version.downcase}/#{plural_table_name}"
       end
@@ -80,6 +104,14 @@ ACTS
               updated_at: { type: "string"},
             }
           },
+          # AUTO GENERATED STUB TODO: update with correct fields
+          #{plural_table_name}: {
+            type: 'object',
+            properties: {
+              meta: { "$ref": "#/definitions/meta" },
+              #{plural_table_name}: { type: 'array', items: { "$ref": "#/definitions/#{singular_table_name}" },},
+            }
+          },
         }
         end
       end
@@ -108,6 +140,7 @@ ACTS
         say("* Run 'rails rswag:specs:swaggerize' to update swagger.", :green)
         say("* Make sure any referenced models are updated with eg. has_many :#{plural_table_name}", :green)
         say("* Customize the table and form definition in 'app/admin/#{plural_table_name}_admin.rb'", :green)
+        say("* Setup nested route") if is_nested?
         say("* #beAwesome", :green)
       end
 

data/lib/generators/hoc_utils/api_scaffold/templates/api_controller.rb.tt

@@ -4,8 +4,7 @@ class Api::<%= api_version.upcase %>::<%= plural_table_name.camelize %>Controlle
 
   # GET /api/<%= api_version %><%= route_url %>
   def index
-    @<%= plural_table_name %> = <%= class_name %>.all
-    render_result({ <%= plural_table_name %>: @<%= plural_table_name %>.as_api_response(:basic) })
+    render_collection(<%= class_name %>.all, :<%= plural_table_name %>)
   end
 
   # GET /api/<%= api_version %><%= route_url %>/1

data/lib/generators/hoc_utils/api_scaffold/templates/nested_api_controller.rb.tt

@@ -0,0 +1,54 @@
+class Api::<%= api_version.upcase %>::<%= plural_table_name.camelize %>Controller < Api::<%= api_version.upcase %>::ApiController
+  before_action :set_<%= singular_parent_name %>
+  before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
+
+  # GET /api/<%= api_version %><%= route_url %>
+  def index
+    render_collection(@<%= singular_parent_name %>.<%= plural_table_name %>.all, :<%= plural_table_name %>)
+  end
+
+  # GET /api/<%= api_version %><%= route_url %>/1
+  def show
+    render_result(@<%= singular_table_name %>.as_api_response(:basic))
+  end
+
+  # POST /api/<%= api_version %><%= route_url %>
+  def create
+    @<%= "#{singular_table_name} = #{singular_parent_name}.#{plural_table_name}.new(#{singular_table_name}_params)" %>
+
+    if @<%= singular_table_name %>
+      render_result(@<%= singular_table_name %>.as_api_response(:basic), :created)
+    else
+      render_error(@<%= singular_table_name %>.errors.full_messages.first, :unprocessable_entity)
+    end
+  end
+
+  # PATCH/PUT /api/<%= api_version %><%= route_url %>/1
+  def update
+    if @<%= singular_table_name %>.update(<%= singular_table_name %>_params)
+      render_result(@<%= singular_table_name %>.as_api_response(:basic))
+    else
+      render_error(@<%= singular_table_name %>.errors.full_messages.first, :unprocessable_entity)
+    end
+  end
+
+  # DELETE /api/<%= api_version %><%= route_url %>/1
+  def destroy
+    @<%= singular_table_name %>.destroy
+  end
+
+  private
+
+  # Use callbacks to share common setup or constraints between actions.
+  def set_<%= singular_parent_name %>
+    @<%= singular_parent_name %> = <%= parent_class_name %>.find(params[:id])
+  end
+  def set_<%= singular_table_name %>
+    @<%= singular_table_name %> = @<%= singular_parent_name %>.<%= plural_table_name %>.find(params[:id])
+  end
+
+  # Only allow a trusted parameter "white list" through.
+  def <%= "#{singular_table_name}_params" %>
+    params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+  end
+end

data/lib/generators/hoc_utils/api_scaffold/templates/spec.rb.tt

@@ -1,13 +1,16 @@
-# frozen_string_literal: true
 require 'swagger_helper'
 describe 'House of Code API' do
-  path '/api/<%= "#{api_version}/#{plural_table_name}" %>' do
+  path '/api/<%= "#{api_version}/"%><%= "#{plural_parent_name}/:#{singular_parent_name}_id/" if is_nested?%><%= plural_table_name %>' do
     get 'Get <%= plural_table_name %>' do
       tags '<%= plural_table_name.camelize %>'
       description 'Gets <%= plural_table_name %>'
       produces 'application/json'
       consumes 'application/json'
+
+      parameter name: :all, in: :query, type: :boolean
+      parameter name: :page, in: :query, type: :integer
       parameter name: :Authorization, in: :header, required: true, type: :string
+      <%= "parameter name: :#{singular_parent_name}_id, in: :path, required:true, type: integer" if is_nested? %>
       response '200', '<%= plural_table_name.camelize %>' do
         schema '$ref' => '#/definitions/<%= plural_table_name %>'
         run_test!
@@ -23,6 +26,7 @@ describe 'House of Code API' do
       description 'Creates <%= singular_table_name %> with given input'
       produces 'application/json'
       consumes 'application/json'
+      <%= "parameter name: :#{singular_parent_name}_id, in: :path, required:true, type: integer" if is_nested? %>
       parameter name: :<%= singular_table_name %>, in: :body, schema: {
         '$ref' => '#/definitions/<%= singular_table_name %>_input'
       }
@@ -37,14 +41,14 @@ describe 'House of Code API' do
       end
     end
   end
-
-  path '/api/<%= "#{api_version}/#{plural_table_name}" %>/{id}' do
+  path '/api/<%= "#{api_version}/"%><%= "#{plural_parent_name}/:#{singular_parent_name}_id/" if is_nested?%><%= plural_table_name %>/{id}' do
     get 'Get <%= singular_table_name %>' do
       tags '<%= plural_table_name.camelize %>'
       description 'Gets <%= singular_table_name %> with :id'
       produces 'application/json'
       consumes 'application/json'
-      parameter name: :id, in: :path, type: :integer
+      <%= "parameter name: :#{singular_parent_name}_id, in: :path, required:true, type: integer" if is_nested? %>
+      parameter name: :id, in: :path, type: :integer, required: true
       parameter name: :Authorization, in: :header, required: true, type: :string
       response '200', '<%= singular_table_name.camelize %>' do
         schema '$ref' => '#/definitions/<%= singular_table_name %>'
@@ -61,7 +65,8 @@ describe 'House of Code API' do
       description 'Updates <%= singular_table_name %> with :id'
       produces 'application/json'
       consumes 'application/json'
-      parameter name: :id, in: :path, type: :integer
+      <%= "parameter name: :#{singular_parent_name}_id, in: :path, required:true, type: integer" if is_nested? %>
+      parameter name: :id, in: :path, type: :integer, required: true
       parameter name: :Authorization, in: :header, required: true, type: :string
       response '200', '<%= singular_table_name.camelize %>' do
         schema '$ref' => '#/definitions/<%= singular_table_name %>_input'
@@ -78,7 +83,9 @@ describe 'House of Code API' do
       description 'Deletes <%= singular_table_name %> with :id'
       produces 'application/json'
       consumes 'application/json'
+      <%= "parameter name: :#{singular_parent_name}_id, in: :path, required:true, type: integer" if is_nested? %>
       parameter name: :Authorization, in: :header, required: true, type: :string
+      parameter name: :id, in: :path, type: :integer, required: true
       response '200', '<%= singular_table_name.camelize %> deleted' do
         run_test!
       end

data/lib/hoc_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoc_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Gert Lavsen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -84,6 +84,7 @@ files:
 - lib/generators/hoc_utils/api_scaffold/USAGE
 - lib/generators/hoc_utils/api_scaffold/api_scaffold_generator.rb
 - lib/generators/hoc_utils/api_scaffold/templates/api_controller.rb.tt
+- lib/generators/hoc_utils/api_scaffold/templates/nested_api_controller.rb.tt
 - lib/generators/hoc_utils/api_scaffold/templates/spec.rb.tt
 - lib/hoc_utils.rb
 - lib/hoc_utils/version.rb