auxiliary_rails 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958f50b63022de69faac6f1b94099164dbf3463d396e89788617bf12cedf8185
-  data.tar.gz: c06b0c5d5e55f2f2bc7344ef3525d1a5078fa621562b81f24c72f7084b399b1a
+  metadata.gz: 55024b258096ba35ea6d1ae4279ee9193d8c127d96186f86c91842b5436e7745
+  data.tar.gz: dccf5c0d9d4de4776af52ef0b55a3ca7b78debf1077019f55483e034df290753
 SHA512:
-  metadata.gz: 458a23d499bf1d4be3688c373f26c5e67fb021212f5164c55516d1d5d4319ab890a1c7ed40eb41908986be2111637c5588a26e46f399cd46114bf81e07dd608f
-  data.tar.gz: 7c7612a040bbe55300c4e95ddcdce21b83735524cb36f78efef0882532bbfac9a75dd035946da699001388743c71a603e4819ce4aaadcd66b7d636d7fe3764ec
+  metadata.gz: 98e16100b8ac8cf42af60dfbd6ee79ef906f2537cce8170c1cd14eff4bda1890757f6b44d14b69140924541c4366b6f85b4d7063d7752add414583bf3134cd3d
+  data.tar.gz: 05e38836a6ed91b0df116239d0f3643c59615dc7ff074f7cfbedc15408a7e774dacc97f877a703ae82f4f6ed41f4b8588e9df6c18c2eef14255e37bdb46a6a16

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    auxiliary_rails (0.1.7)
+    auxiliary_rails (0.1.8)
       thor
 
 GEM

data/README.md

@@ -46,14 +46,17 @@ rails new APP_PATH --skip-action-cable --skip-coffee --skip-test --database=post
 ### Generators
 
 ```sh
-# install everything
+# Install everything at once
 rails generate auxiliary_rails:install
 
-# install one by one
+# Install one by one
 rails generate auxiliary_rails:install_commands
 rails generate auxiliary_rails:install_errors
 rails generate auxiliary_rails:install_rubocop
 rails generate auxiliary_rails:install_rubocop --no-specify-gems
+
+# API resource generator
+rails generate auxiliary_rails:api_resource NAME
 ```
 
 ### View Helpers

data/lib/auxiliary_rails/version.rb

@@ -1,3 +1,3 @@
 module AuxiliaryRails
-  VERSION = '0.1.7'.freeze
+  VERSION = '0.1.8'.freeze
 end

data/lib/generators/auxiliary_rails/api_resource_generator.rb

@@ -37,7 +37,12 @@ module AuxiliaryRails
 
     def create_api_resource_spec_file
       template 'api_resource_spec_template.rb.erb',
-        "spec/#{api_module_path}/#{plural_file_name}_resource_spec.rb"
+        "spec/#{api_module_path}/resources/#{plural_file_name}_resource_spec.rb"
+    end
+
+    def say_instructions
+      say "Mount resource in #{api_module_name}:"
+      say "    mount #{resource_class_name}"
     end
 
     private
@@ -59,5 +64,9 @@ module AuxiliaryRails
     def entity_class_name
       "#{api_module_name}::Entities::#{class_name}Entity"
     end
+
+    def resource_class_name
+      "#{api_module_name}::Resources::#{plural_name.camelize}Resource"
+    end
   end
 end

data/lib/generators/auxiliary_rails/templates/apis/api_entity_template.rb.erb

@@ -1,6 +1,7 @@
 module <%= api_module_name %>::Entities
   class <%= class_name %>Entity < Grape::Entity
-    expose :id
+    expose :id,
+      documentation: { type: 'Integer' }
     # TODO: define `<%= class_name %>Entity` exposes
     expose :created_at, :updated_at
   end

data/lib/generators/auxiliary_rails/templates/apis/api_resource_spec_template.rb.erb

@@ -1,11 +1,18 @@
 require 'rails_helper'
 
-RSpec.describe <%= api_module_name %>::Resources::<%= plural_name.camelize %>Resource, type: :request do
+RSpec.describe <%= resource_class_name %>, type: :request do
   describe 'GET <%= api_url_path %>' do
     subject { get '<%= api_url_path %>' }
 
-    # TODO: write some tests
-    skip
+    it 'returns a list of <%= plural_name %>' do
+      create_list(:<%= singular_name %>, 2)
+
+      subject
+
+      expect_status :ok
+      expect_json_sizes 2
+      expect_json '0', id: <%= class_name %> %>.first.id
+    end
   end
 
   describe 'POST <%= api_url_path %>' do
@@ -16,17 +23,37 @@ RSpec.describe <%= api_module_name %>::Resources::<%= plural_name.camelize %>Res
   end
 
   describe 'GET <%= api_url_path %>/:id' do
-    # TODO: write some tests
-    skip
+    subject { get "<%= api_url_path %>/#{<%= singular_name %>.id}" }
+
+    let(:<%= singular_name %>) { create(:<%= singular_name %>) }
+
+    it 'returns a <%= singular_name %> by ID' do
+      subject
+
+      expect_status :ok
+      expect_json id: <%= singular_name %>.id
+    end
   end
 
   describe 'PUT <%= api_url_path %>/:id' do
-    # TODO: write some tests
-    skip
+    subject { put "<%= api_url_path %>/#{<%= singular_name %>.id}" }
+
+    let(:<%= singular_name %>) { create(:<%= singular_name %>) }
+
+    it 'updates a <%= singular_name %> by ID' do
+      skip
+    end
   end
 
   describe 'DELETE <%= api_url_path %>/:id' do
-    # TODO: write some tests
-    skip
+    subject { delete "<%= api_url_path %>/#{<%= singular_name %>.id}" }
+
+    let!(:<%= singular_name %>) { create(:<%= singular_name %>) }
+
+    it 'deletes a <%= singular_name %> by ID' do
+      expect { subject }.to change(<%= class_name %>, :count).by -1
+      expect_status 204
+      expect(response.body).to be_blank
+    end
   end
 end

data/lib/generators/auxiliary_rails/templates/apis/api_resource_template.rb.erb

@@ -12,21 +12,25 @@ module <%= api_module_name %>::Resources
     end
 
     resource :<%= plural_name %> do
-      desc 'Returns resource collection'
+      desc 'Returns a collection of <%= plural_name %>' do
+        success <%= entity_class_name %>
+      end
       get do
-        # TODO: authorize resource, :index?
+        # TODO: authorize <%= class_name %>, :index?
         present collection,
           with: <%= entity_class_name %>
       end
 
-      desc 'Creates a <%= class_name %>'
+      desc 'Creates a <%= class_name %>' do
+        success <%= entity_class_name %>
+      end
       params do
         requires :<%= singular_name %>, type: Hash do
           # TODO: define resource params or remove `params` block
         end
       end
       post do
-        @<%= singular_name %> = <%= class_name %>.new(declared(params)[:<%= singular_name %>])
+        @<%= singular_name %> = <%= class_name %>.new(params[:<%= singular_name %>])
         # TODO: authorize resource, :create?
         resource.save!
         present resource,
@@ -44,14 +48,16 @@ module <%= api_module_name %>::Resources
             with: <%= entity_class_name %>
         end
 
-        desc 'Updates a <%= class_name %>'
+        desc 'Updates a <%= class_name %>' do
+          success <%= entity_class_name %>
+        end
         params do
           requires :<%= singular_name %>, type: Hash do
             # TODO: define resource params or remove `params` block
           end
         end
         put do
-          resource.assign_attributes(declared(params)[:<%= singular_name %>])
+          resource.assign_attributes(params[:<%= singular_name %>])
           # TODO: authorize resource, :update?
           resource.save!
           present resource,

data/lib/generators/auxiliary_rails/templates/rubocop/rubocop_auxiliary_rails_template.yml

@@ -1,6 +1,6 @@
 # AuxiliaryRails RuboCop Config
 # Homepage: https://github.com/ergoserv/auxiliary_rails
-# Version: 7
+# Version: 8
 
 AllCops:
   Exclude:
@@ -17,9 +17,20 @@ Layout/AlignArguments:
 
 #################### Metrics ###############################
 
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - resource
+
 Metrics/MethodLength:
   Max: 30
 
+#################### Naming ################################
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'app/apis/**/resources/*_resource.rb'
+
 #################### Rails #################################
 
 Rails:
@@ -27,6 +38,9 @@ Rails:
 
 #################### RSpec #################################
 
+RSpec/ExampleLength:
+  Max: 10
+
 RSpec/NamedSubject:
   Enabled: false
 

data/lib/generators/auxiliary_rails/templates/rubocop/rubocop_template.yml

@@ -1,6 +1,10 @@
 inherit_from:
   - .rubocop_auxiliary_rails.yml
 
+inherit_mode:
+  merge:
+    - Exclude
+
 require:
   - rubocop-performance
   - rubocop-rails

data/templates/rails/elementary.rb

@@ -9,6 +9,7 @@ gem 'auxiliary_rails',
   branch: 'develop'
 
 gem_group :development, :test do
+  gem 'dotenv-rails'
   gem 'factory_bot_rails'
   gem 'faker'
   gem 'pry-byebug'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auxiliary_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Dmitry Babenko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-23 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler