json_voorhees 0.5.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b042ee66e3328f4870f3e78b768dcb2c1438bb73
-  data.tar.gz: 1009ea01dae0b8aaae0faa233321357d00715a26
+  metadata.gz: e2c926864334abb5b22eb0fc430e9055a048dffc
+  data.tar.gz: 3813492073e69ea5b0b3db2c032c58dda4c42a18
 SHA512:
-  metadata.gz: 0fbdd8f41b9d344eeb731bf8117aba9da21cb2fc991d5f4e682798af12b6a13f4a6b7905d54a05456dae7c6c865d7e7c52033a24c0205a6a960f9c26bc57d6f6
-  data.tar.gz: 476bdab6ef62ee34e16dbd436933b871b4e8ef48e4e89e6a9363c438c616d7fb17d3ac39ff93d5ae7e4f7ae5937b8dc3d84dc0f7734816d04c0592295a4f3eaa
+  metadata.gz: 579cf7928420d787ecd5a9faaa7eaabb9b51b7e87b41bec0edb153ded265d96eebf4703dc5ba8912db88edcc09383559d0005228d76509b574e1f1b792bfbfc6
+  data.tar.gz: dcfb1a56bd048626ef630a5bee36013924d7442b753fcfc3acf0aef983d76e93992cfa149ca7669d5b3a81270bf014a158b57e4a85efe407a9b362f77dfa0fdd

data/README.md

@@ -1,4 +1,4 @@
-# JsonVoorhees 0.5.1
+# JsonVoorhees 1.0.0
 
 ## Introduction
 
@@ -14,7 +14,7 @@ To install, put this in your main_app and run bundle install.
 
 ```bash
 gem "json_voorhees"
-``` 
+```
 To setup your application use the command below. It takes options that allow you
 to do things like skip active_admin, skip a generic admin page, skip arcadex, and even
 skip a user class. The default runs with active_admin, a user class and arcadex.
@@ -22,22 +22,17 @@ skip a user class. The default runs with active_admin, a user class and arcadex.
 ```bash
 rails g json_voorhees:setup_app
 ```
-Go to the engines folder and create an engine like so.
 
-```bash
-rails plugin new [engine name] --mountable
-cd [engine name]
-```
-Add the gem to your gemspec and execute the following command
+Now when you want to create an engine run the below command from the main app.
+It takes care of mounting the engine, setting up the controllers, routes and gemspecs.
 
 ```bash
-s.add_development_dependency "json_voorhees"
-rails g json_voorhees:setup_engine [engine name]
+rails g json_voorhees:create_engine [engine name]
 ```
-Make sure the engine is mounted in your app and it's in the main apps gemfile.
-Go to the main_app and run this scaffold to create your resource. It runs on
-top of rails scaffold and in the process creates the api counterpart. You have
-the option of skipping the normal rails scaffold.
+
+Now we can create resources, run the below command from the main_app. Specs will be created
+and the routes for that resource are setup.  
+
 ```bash
 rails g json_voorhees:massive_scaffold [engine name] [resource name] [api_version] [scaffold parameters]
 
@@ -45,27 +40,17 @@ example
 
 rails g json_voorhees:massive_scaffold chat message 1 user_id:integer message:text
 ```
-Make sure the resource is in the correct scoping in the Engines routing file. Then
-copy over the engines migrations and migrate the main app. Check if everything is fine by
-running rspec from the main app.
 
 ## Project Flow
 
 1. Create main app
-2. (in app) rails g json_voorhees:setup_app
-3. Create engine (and add relative path to gemfile)
-4. Mount engine
-5. (in engine) rails g json_voorhees:setup_engine [engine name] and make sure rails is the same version
-6. Add json_voorhees to the engines gemspec
-7. (in app) rails g json_voorhees:massive_scaffod [engine name] [resource name] [api_version] [field:type field:type]
-8. Fix the engines route file
-9. Copy migrations to main app and run db migrations in main app
-10. (in app) Run rspec to check for errors
-
-Steps 1 through 2 are only done once. You need to run massive_scaffold for each
-resource.
+2. (in main_app root) rails g json_voorhees:setup_app
+3. (in main_app root) rails g json_voorhees:create_engine [engine name]
+4. (in main_app root) rails g json_voorhees:massive_scaffold [engine name] [resource name] [api_version] [field:type field:type]
+5. (in main_app root) Copy migrations to main app and run db migrations in main app like so. "rake railties:install:migrations && rake db:migrate RAILS_ENV=development"
+6. (in main_app root) Run "rspec" to check for errors
 
-I usually set the app up, and then design the database. I make a list of all the models I need, then separate them into engines. Then I run 20 or so massive scaffolds using "&&". The result is a functioning backend that only needs the model relationships wired together. The default tests get you pretty far.
+I usually set the app up, and then design the database. I make a list of all the models I need, then separate them into engines. Then I run 20 or so massive scaffolds using "&&". The result is a modular functioning backend that only needs the model relationships wired together. The default tests get you pretty far.
 
 ## Individual Generator Use
 
@@ -85,6 +70,7 @@ the gem and the options. They each have a multitude of arguments and options.
 10. rails g json_voorhees:massive_scaffold
 11. rails g json_voorhees:setup_app
 12. rails g json_voorhees:setup_engine
+13. rails g json_voorhees:create_engine
 
 ## Versioning
 
@@ -95,9 +81,7 @@ else resides in engines for good modularity.
 
 ## Recent Additions
 
-If the api has routes that can be accessed without a logged in user, skip
-the authenticate_user filter and call set_hash before the method. Now current_user
-will return the current user or nil and the application will not render a 401.
+Create the create_engine generator and made hooking the engine up to the main_app painless.
 
 ## Reminder
 
@@ -113,13 +97,12 @@ If active admin is used (it is by default) the admin section username is admin a
 
 ## To Do
 
-1. Figure out a better way to test this thing
-2. Use option for namespaced engine or no engine
-3. Maybe give an option to include pagination?
-4. Option for websockets and paperclip?
-5. Make the non defaults easier to user
-6. Use Devise as the default user and admin user? This will make it easier for users to reset their password as this is already setup.
-7. Git clone arcadex, type_validator and defcon to make it easier for users to customize?
-8. Move the people engine into it's own gem?
-9. Create a whenever task to destroy expired tokens.
-10. Fix the breadcrumbs link in ActiveAdmin.
+1. Maybe give an option to include pagination?
+2. Option for websockets and paperclip?
+3. Make the non defaults easier to user
+4. Use Devise as the default user and admin user? This will make it easier for users to reset their password as this is already setup.
+5. Git clone arcadex, type_validator and defcon to make it easier for users to customize?
+6. Move the people engine into it's own gem?
+7. Create a whenever task to destroy expired tokens.
+8. Fix the breadcrumbs link in ActiveAdmin.
+9. Add a mailgun and support for forgotten passwords

data/lib/generators/json_voorhees/app_make_tests/templates/no_auth_request.rb.erb

@@ -10,6 +10,8 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
       FactoryGirl.create_list(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>, 10)
       get 'api/<%= api_version %>/<%= resource_plural %>'
       expect(response.status).to eq(200) #ok
+      expect(::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>.count).to eq(10)
+      expect(json["<%= resource_plural %>"].length).to eq(10)
     end
   end
 end

data/lib/generators/json_voorhees/app_make_tests/templates/request.rb.erb

@@ -13,6 +13,8 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
       FactoryGirl.create_list(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>, 10)
       get 'api/<%= api_version %>/<%= resource_plural %>', nil, @header
       expect(response.status).to eq(200) #ok
+      expect(::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>.count).to eq(10)
+      expect(json["<%= resource_plural %>"].length).to eq(10)
     end
   end
 end

data/lib/generators/json_voorhees/app_make_user/templates/user/user_controller.rb

@@ -65,7 +65,7 @@ module People
 
     # POST /api/1/users/authenticate
     def authenticate
-      if authenticate_password
+      if user_authenticate_password
         return
       end
       render json: {}
@@ -84,7 +84,7 @@ module People
 
     # PATCH/PUT /api/1/users/1
     def update
-      if authenticate_password
+      if user_authenticate_password
         return
       end
       if @user.update(user_params)
@@ -97,8 +97,8 @@ module People
     private
       # Use callbacks to share common setup or constraints between actions.
 
-      def authenticate_password
-        if !@user.authenticate(params[:user][:password])
+      def user_authenticate_password
+        if authenticate_password
           render :json => {errors: "Email and/or Password is incorrect"}, status: :unauthorized 
           return true
         end

data/lib/generators/json_voorhees/create_engine/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate create_engine Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/json_voorhees/create_engine/create_engine_generator.rb

@@ -0,0 +1,45 @@
+module JsonVoorhees
+	class CreateEngineGenerator < Rails::Generators::Base
+		  source_root File.expand_path('../templates', __FILE__)
+		  argument :module_name, :type => :string
+
+			def sprint
+		  	inside "" do
+		  		run "rails plugin new engines/#{module_snake} --mountable"
+		  	end
+		  	inside "engines/#{module_snake}" do
+		  		add_dependency
+		  		run "rails g json_voorhees:setup_engine #{module_snake}"
+		  	end
+		  	inside "config" do
+		  		mount
+		  	end
+		  	inside "" do
+		  		gem "#{module_snake}", :path => "engines/#{module_snake}"
+		  		run "bundle install"
+		  	end
+		  end
+
+		  private
+
+		  def mount
+		  	gsub_file "routes.rb", "root to: \"app_index#app\"\n", "root to: \"app_index#app\"\n 	mount #{module_camel}::Engine, at: '/'\n"
+		  end
+
+		  def add_dependency
+		  	inject_into_file "#{module_snake}.gemspec", after: "s.add_development_dependency \"sqlite3\"\n" do <<-'RUBY'
+	s.add_development_dependency "json_voorhees"
+				RUBY
+				end
+		  end
+
+		  def module_camel
+			  	module_name.camelize
+			end
+
+			def module_snake
+			  module_name.underscore.downcase
+			end
+
+	end
+end

data/lib/generators/json_voorhees/massive_scaffold/massive_scaffold_generator.rb

@@ -27,6 +27,7 @@ module JsonVoorhees
 	  		else
 	  			run "rails g json_voorhees:engine_scaffold #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")} --skip-arcadex"
 	  		end
+	  		correct_routes
 	  	end
 	  	if options.arcadex?
 	  		run "rails g json_voorhees:app_scaffold #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
@@ -37,10 +38,16 @@ module JsonVoorhees
 	  		#run "rails generate active_admin:resource #{module_name.underscore.downcase}::#{resource_name.singularize.underscore.downcase}"
 	  		make_custom_active_admin
 	  	end
+
 	  end
 
 	  private
 
+	  	def correct_routes
+	  		gsub_file 'config/routes.rb', "resources :#{resource_plural}", "#resources :#{resource_plural}"
+	  		gsub_file 'config/routes.rb', "scope '1' do\n", "scope '1' do\nresources :#{resource_plural}, controller: \'api/v1/#{resource_plural}\'\n"
+	  	end
+
 	  	def make_custom_active_admin
 	  		template "active_admin_register.rb.erb", "app/admin/#{module_name.underscore}_#{resource_singular}.rb"
 	  	end

data/lib/generators/json_voorhees/setup_app/templates/api_controller_with_arcadex.rb

@@ -17,6 +17,17 @@ class Api::V1::ApiController < ::ActionController::API
       end
     end
 
+    def authenticate_password
+      if current_user.nil?
+        return true
+      end
+      if !current_user.authenticate(params[:user][:password]) 
+        return true
+      else
+        return false
+      end
+    end
+
     def set_hash
       #["current_user","current_token"] Make this true to check for email also
       @instance_hash = ::Arcadex::Authentication.full_authentication(params,request,false)

data/lib/json_voorhees/version.rb

@@ -1,3 +1,3 @@
 module JsonVoorhees
-  VERSION = "0.5.5"
+  VERSION = "1.0.0"
 end

data/test/lib/generators/json_voorhees/create_engine_generator_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+require 'generators/create_engine/create_engine_generator'
+
+module JsonVoorhees
+  class CreateEngineGeneratorTest < Rails::Generators::TestCase
+    tests CreateEngineGenerator
+    destination Rails.root.join('tmp/generators')
+    setup :prepare_destination
+
+    # test "generator runs without errors" do
+    #   assert_nothing_raised do
+    #     run_generator ["arguments"]
+    #   end
+    # end
+  end
+end

data/test/test_script.txt

@@ -0,0 +1,18 @@
+Go to the test directory and run this script. Make sure rspec tests are green.
+
+cp fresh_copy/test_app . &&
+cd test_app &&
+rails g json_voorhees:setup_app &&
+rails g json_voorhees:create_engine ocean &&
+rails g json_voorhees:massive_scaffold ocean atlantic 1 cold:boolean hot:boolean &&
+rake railties:install:migrations && 
+rake db:migrate RAILS_ENV=development && 
+rake db:migrate RAILS_ENV=test && 
+rake db:migrate RAILS_ENV=production &&
+rspec
+
+Remember to delete the copied test_app before commiting!
+From the test/test_app directory
+
+cd .. &&
+rm -rf test_app

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_voorhees
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Cleophus Robinson
@@ -91,6 +91,8 @@ files:
 - lib/generators/json_voorhees/app_make_user/templates/user/user_serializer.rb
 - lib/generators/json_voorhees/app_scaffold/USAGE
 - lib/generators/json_voorhees/app_scaffold/app_scaffold_generator.rb
+- lib/generators/json_voorhees/create_engine/USAGE
+- lib/generators/json_voorhees/create_engine/create_engine_generator.rb
 - lib/generators/json_voorhees/engine_create_controller/USAGE
 - lib/generators/json_voorhees/engine_create_controller/engine_create_controller_generator.rb
 - lib/generators/json_voorhees/engine_create_controller/templates/controller_template.rb.erb
@@ -200,12 +202,14 @@ files:
 - test/lib/generators/json_voorhees/app_make_admin_generator_test.rb
 - test/lib/generators/json_voorhees/app_make_user_generator_test.rb
 - test/lib/generators/json_voorhees/app_scaffold_generator_test.rb
+- test/lib/generators/json_voorhees/create_engine_generator_test.rb
 - test/lib/generators/json_voorhees/engine_create_model_generator_test.rb
 - test/lib/generators/json_voorhees/engine_make_model_generator_test.rb
 - test/lib/generators/json_voorhees/engine_scaffold_generator_test.rb
 - test/lib/generators/json_voorhees/engine_serializer_generator_test.rb
 - test/lib/generators/json_voorhees/massive_scaffold_generator_test.rb
 - test/test_helper.rb
+- test/test_script.txt
 homepage: https://github.com/cleor41/json_voorhees
 licenses:
 - MIT
@@ -238,6 +242,7 @@ test_files:
 - test/lib/generators/json_voorhees/app_scaffold_generator_test.rb
 - test/lib/generators/json_voorhees/engine_scaffold_generator_test.rb
 - test/lib/generators/json_voorhees/massive_scaffold_generator_test.rb
+- test/lib/generators/json_voorhees/create_engine_generator_test.rb
 - test/lib/generators/json_voorhees/app_make_admin_generator_test.rb
 - test/lib/generators/json_voorhees/engine_serializer_generator_test.rb
 - test/json_voorhees_test.rb
@@ -276,6 +281,7 @@ test_files:
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/log/development.log
 - test/test_helper.rb
+- test/test_script.txt
 - test/fresh_copy/test_app/Gemfile.lock
 - test/fresh_copy/test_app/bin/rake
 - test/fresh_copy/test_app/bin/rails