json_voorhees 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 188b8da5f4822765363d1bed45872c3e93f56c80
-  data.tar.gz: 8b4bdd912df6949686114540c868e9e35152e635
+  metadata.gz: bcfe1caaeb6586f4e3e4b4295d4b28b29cd395d9
+  data.tar.gz: 94f373f7621a5e277f1a051429083df3dcf4a24b
 SHA512:
-  metadata.gz: 26652b4904e24acb9106bf9d3ffdc279d508f22bd261ff1174e8cf2dfcf676e4876cfaba8ddfe327bee648226d60779b1093acca9986b8daf9cfe59fa2b650a4
-  data.tar.gz: aefcbe4c6455204e40216c43bf0c079f06da6ea4e1c6a9129d9dbc4a675218c514b4332c4f8d8afe0f24d9ab893abb6b66ce9226f140cb47d8dce888ee81a6e0
+  metadata.gz: 07fe048f2bf236e5c8f52300aa18fc080d2b4d7f10ffef0bbb82875d3ac8bcab8c622bb17f02ab28be5356814f75b37ef5de995f6cb9786fb3f864674fa24733
+  data.tar.gz: 7ba4289ba29db5734968f5c680224069b558f716a927dfcab95cccb39e23a3021e65dd0a922cbafcbbb093dc83fae300be10a8c68b1a222b598503fdef750bca

data/README.md

@@ -1,4 +1,4 @@
-# JsonVoorhees
+# JsonVoorhees 0.3.5
 
 ## Introduction
 
@@ -10,12 +10,14 @@ helps build the project if you follow the conventions.
 
 ## Scaffold Use
 
-To install, put this in your main_app
+To install, put this in your main_app and run bundle install.
 
 ```bash
 gem "json_voorhees"
 ``` 
-To setup your application use
+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.
 
 ```bash
 rails g json_voorhees:setup_app
@@ -33,13 +35,15 @@ s.add_development_dependency "json_voorhees"
 rails g json_voorhees:setup_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 create your resources
+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.
 ```bash
 rails g json_voorhees:massive_scaffold [engine name] [resource name] [api_version] [scaffold parameters]
 ```
-Make sure the resource is in the correct scoping in the Engines routing file.
-Make sure everything is setup correctly by running rspec from the main_app.
-The factory girl factory may not be setup correction depending on your passed type.
+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
 
@@ -54,79 +58,31 @@ The factory girl factory may not be setup correction depending on your passed ty
 9. Copy migrations to main app and run db migrations in main app
 10. (in app) Run rspec to check for errors
 
-## Individual Generator Use
-
-To install, put this in your main_app
-
-```bash
-gem "json_voorhees"
-``` 
-
-To setup your application use
-
-```bash
-rails g json_voorhees:setup_app
-```
-It will install commonly used gems, enforce a layout for your app and even
-a user class if you want it.
-
-My APIs all use a series of engines hooked into the main_app. The main_app is
-the caretaker for things like specs and the admin page. It's also where the api_controller
-and application_controller reside. Their counterparts in an engine all inherit from
-one of these controllers. Since the engines need to be mounted into the route file,
-engines can version themselves and it helps to increment the project little by litter.
-This separation of concerns if done by logic can help break a project into smaller bitesized
-pieces which can then if need be go under their own version control and managed by different
-teams.
-
-Go to the engines folder and create an engine like so.
-
-```bash
-rails plugin new [engine name] --mountable
-cd [engine name]
-```
-Now add the gem to your gemspec like so and execute the following command
+Steps 1 through 2 are only done once. You need to run massive_scaffold for each
+resource.
 
-```bash
-s.add_development_dependency "json_voorhees"
-rails g json_voorhees:setup_engine [engine name]
-```
-After scaffolding out your resource, generate the necessary api controller
-and its serializer
-
-```bash
-rails g json_voorhees:engine_scaffold [engine name] [resource name] [api_version] [field:type field:type]
-
-or
-
-rails g json_voorhees:engine_create_controller [engine name] [resource name] [api_version] [field:type field:type]
-rails g json_voorhees:engine_create_serializer [engine name] [resource name] [field:type field:type]
-```
-
-Authorizations are all handled in a gem called authorization.
-Specs are also ran through RSpec and FactoryGirl, Go to the main_app and run
-
-```bash
-rails g json_voorhees:app_scaffold [engine name] [resource name] [api_version] [field:type field:type]
-
-or
-
-rails g json_voorhees:app_make_authorizations [engine name] [resource name] [field:type field:type]
-rails g json_voorhees:app_make_tests [engine name] [resource name] [api_version] [field:type field:type]
-```
-
-For every resource created, those 4 are ran in their respective locations.
-
-## Notes
+## Individual Generator Use
 
-1. After scaffolding and migrating, make sure to run rspec to make sure everything is setup correctly
-2. For advanced use, check out the description of each generators options
+If massive scaffold is too bulky for you, you have the option of running the
+generators individually. Use rails g to see the generators that come with
+the gem and the options. They each have a multitude of arguments and options.
+
+1. rails g json_voorhees:app_make_admin 
+2. rails g json_voorhees:app_make_authorizations
+3. rails g json_voorhees:app_make_tests
+4. rails g json_voorhees:app_make_user
+5. rails g json_voorhees:app_scaffold
+6. rails g json_voorhees:engine_create_controller
+7. rails g json_voorhees:engine_create_model
+8. rails g json_voorhees:engine_create_serializer
+9. rails g json_voorhees:engine_scaffold
+10. rails g json_voorhees:massive_scaffold
+11. rails g json_voorhees:setup_app
+12. rails g json_voorhees:setup_engine
 
 ## To Do
 
 1. Figure out a better way to test this thing
 2. Use option for namespaced engine or no engine
-3. Build on admin page
-4. Maybe give an option to include pagination?
-5. Option for websockets
-6. Update README
+3. Maybe give an option to include pagination?
+4. Option for websockets and paperclip?

data/lib/generators/json_voorhees/app_make_admin/app_make_admin_generator.rb

@@ -3,13 +3,59 @@ module JsonVoorhees
 	  source_root File.expand_path('../templates', __FILE__)
 	  class_option :arcadex, :type => :boolean, :default => true, :description => "Include arcadex gem and authentication in api_controller"
     class_option :user, :type => :boolean, :default => true, :description => "Create an admin page with user class"
+    class_option :active_admin, :type => :boolean, :default => true, :description => "Setup the active_admin gem, the gem needs to be already added"
 
 	  def sprint
-	  	make_admin
+      if options.active_admin?
+        make_active_admin
+      else
+	  	  make_admin
+      end
 	  end
 
 	  private
 
+    def make_active_admin
+      run "rails g active_admin:install --skip-users"
+      inject_into_file 'app/controllers/application_controller.rb', after: "protect_from_forgery with: :exception\n" do <<-'RUBY'
+  
+  #This needs to be put inside a config file. but this is good for now
+  #This only requires the password for the admin section of the website
+  protected
+
+  def authenticate
+    authenticate_or_request_with_http_basic do |username, password|
+      username == "admin" && password == "password"
+    end
+  end
+
+      RUBY
+      end
+      find_and_replace_initializer
+    end
+
+    def find_and_replace_initializer
+      gsub_file 'config/initializers/active_admin.rb',
+      'config.authentication_method = :authenticate_admin_user!',
+      '#config.authentication_method = :authenticate_admin_user!'
+      gsub_file 'config/initializers/active_admin.rb',
+      'config.current_user_method = :current_admin_user',
+      '#config.current_user_method = :current_admin_user'
+      gsub_file 'config/initializers/active_admin.rb',
+      'config.logout_link_path = :destroy_admin_user_session_path',
+      '#config.logout_link_path = :destroy_admin_user_session_path'
+      inject_into_file 'config/initializers/active_admin.rb', after: "ActiveAdmin.setup do |config|\n" do <<-'RUBY'
+
+  # http auth for admin area
+  config.before_filter :authenticate
+  config.authentication_method = false
+  config.current_user_method   = false
+  config.allow_comments = false
+
+      RUBY
+      end
+    end
+
     def make_admin
       if options.user? && options.arcadex?
         #copy admin page with user engine

data/lib/generators/json_voorhees/app_make_user/app_make_user_generator.rb

@@ -2,9 +2,13 @@ module JsonVoorhees
 	class AppMakeUserGenerator < Rails::Generators::Base
 	  source_root File.expand_path('../templates', __FILE__)
 	  class_option :arcadex, :type => :boolean, :default => true, :description => "Include arcadex tokens"
- 
+    class_option :active_admin, :type => :boolean, :default => true, :description => "Include admin scoping in routes file"
+
     def sprint
     	people
+      if options.active_admin?
+        run "rails g active_admin:resource people::user"
+      end
     end
 
     private

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

@@ -22,7 +22,10 @@ module People
       if user.save
         #If the user is saved, return a token
         token = user.tokens[0]
-        render :json => {user: user, token: token}
+        ::Arcadex::Create.set_token(token,360,request)
+        userHash = {id: user.id, username: user.username, email: user.email}
+        tokenHash = {auth_token: token.auth_token}
+        render :json => {user: userHash,token: tokenHash}
       else
         #Return an error if not saved
         render :json => {errors: user.errors}, status: :unprocessable_entity
@@ -36,7 +39,10 @@ module People
       user = ::People::V1::User.find_by(email: params[:email])
       if user && user.authenticate(params[:password])
         token = user.tokens.create
-        render :json => {user: user, token: token}
+        ::Arcadex::Create.set_token(token,360,request)
+        userHash = {id: user.id, username: user.username, email: user.email}
+        tokenHash = {auth_token: token.auth_token}
+        render :json => {user: userHash,token: tokenHash}
       else
         render :json => {errors: "Email and/or Password is incorrect"}, status: :unauthorized 
       end

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

@@ -2,9 +2,11 @@ People::Engine.routes.draw do
 
 	root to: "users#index"
 
+	<% if !options.active_admin? %>
   scope 'admin' do
 	  resources :users
 	end
+	<% end %>
 
 	scope 'api' do
 		scope '1' do

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

@@ -10,6 +10,7 @@ module JsonVoorhees
 	  class_option :request, :type => :boolean, :default => true, :description => "Create request stub tests"
 	  class_option :routing, :type => :boolean, :default => true, :description => "Create routing stub tests"
 	  class_option :arcadex, :type => :boolean, :default => true, :description => "Send requests with an arcadex header"
+	  class_option :active_admin, :type => :boolean, :default => true, :description => "Generate the admin resource"
 
 	  def sprint
 	  	inside "engines/#{module_name.underscore}" do
@@ -32,6 +33,9 @@ module JsonVoorhees
 	  	else
 	  		run "rails g json_voorhees:app_scaffold --skip-arcadex #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
 	  	end
+	  	if options.active_admin?
+	  		run "rails generate active_admin:resource #{module_name.underscore.downcase}::#{resource_name.underscore.downcase}"
+	  	end
 	  end
 
 	  private

data/lib/generators/json_voorhees/setup_app/setup_app_generator.rb

@@ -1,3 +1,5 @@
+require 'bundler'
+
 module JsonVoorhees
   class SetupAppGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
@@ -5,6 +7,7 @@ module JsonVoorhees
     class_option :user, :type => :boolean, :default => true, :description => "Create an engine for the user class"
     class_option :test, :type => :boolean, :default => false, :description => "Set true if running tests to skip things like bundle update and git"
     class_option :admin, :type => :boolean, :default => true, :description => "Create an admin page"
+    class_option :active_admin, :type => :boolean, :default => true, :description => "Setup the active_admin gem"
 
     def sprint
     	create_file_structure
@@ -17,39 +20,65 @@ module JsonVoorhees
         make_admin
       end
       if options.user?
-    	  make_user
+        make_user
       end
+      run "rake railties:install:migrations"
+      run_db_migrations
     	routes
     	make_controllers
+      if options.arcadex? && options.active_admin?
+        run "rails generate active_admin:resource arcadex::token"
+      end
     	run_git
     end
 
     private
 
     def make_admin
-      if !options.arcadex? && !options.user?
-        run "rails g json_voorhees:app_make_admin --skip-arcadex --skip-user"
-      end
-      if !options.arcadex? && options.user?
-        run "rails g json_voorhees:app_make_admin --skip-arcadex"
-      end
-      if !options.user? && options.arcadex?
-        run "rails g json_voorhees:app_make_admin --skip-user"
-      end
-      if options.user? && options.arcadex?
-        run "rails g json_voorhees:app_make_admin"
+      if !options.active_admin?
+        if !options.arcadex? && !options.user?
+          run "rails g json_voorhees:app_make_admin --skip-arcadex --skip-user --skip-active_admin"
+        end
+        if !options.arcadex? && options.user?
+          run "rails g json_voorhees:app_make_admin --skip-arcadex --skip-active_admin"
+        end
+        if !options.user? && options.arcadex?
+          run "rails g json_voorhees:app_make_admin --skip-user --skip-active_admin"
+        end
+        if options.user? && options.arcadex?
+          run "rails g json_voorhees:app_make_admin --skip-active_admin"
+        end
+      else
+        if !options.arcadex? && !options.user?
+          run "rails g json_voorhees:app_make_admin --skip-arcadex --skip-user"
+        end
+        if !options.arcadex? && options.user?
+          run "rails g json_voorhees:app_make_admin --skip-arcadex"
+        end
+        if !options.user? && options.arcadex?
+          run "rails g json_voorhees:app_make_admin --skip-user"
+        end
+        if options.user? && options.arcadex?
+          run "rails g json_voorhees:app_make_admin"
+        end
       end
     end
 
     def make_user
-      if !options.arcadex?
-        run "rails g json_voorhees:app_make_user --skip-arcadex"
+      if !options.active_admin?
+        if !options.arcadex?
+          run "rails g json_voorhees:app_make_user --skip-arcadex --skip-active_admin"
+        else
+          run "rails g json_voorhees:app_make_user --skip-active_admin"
+        end
       else
-        run "rails g json_voorhees:app_make_user"
+        if !options.arcadex?
+          run "rails g json_voorhees:app_make_user --skip-arcadex"
+        else
+          run "rails g json_voorhees:app_make_user"
+        end
       end
       run_bundle
-      run "rake railties:install:migrations"
-      run_db_migrations
     end
 
     def include_middleware
@@ -64,16 +93,19 @@ module JsonVoorhees
 
     def routes
     	route "root to: \"app_index#app\""
-  		route "get \'admin\' => \'main#admin\', as: \"admin\" #admin_path"
+      if !options.active_admin? && options.admin?
+  		  route "get \'admin\' => \'main#admin\', as: \"admin\" #admin_path"
+      end
     end
 
     def make_controllers
     	generate "controller", "app_index app"
       run "rm -f app/controllers/app_index_controller.rb"
       copy_file "app_index_controller.rb", "app/controllers/app_index_controller.rb"
-    	generate "controller", "main admin"
-      #Copy admin views
-      run "rm -f spec/controllers/main_controller_spec.rb"
+    	if !options.active_admin? && options.admin?
+        generate "controller", "main admin"
+        run "rm -f spec/controllers/main_controller_spec.rb"
+      end
       #Copy the views over
       copy_file "views/app", "app/views/app_index/app.html.erb"
       copy_file "views/app_index", "app/views/layouts/app_index.html.erb"
@@ -108,15 +140,16 @@ module JsonVoorhees
         #gem 'sqlite3', '~> 1.3.9'    # dev & test database
         gem 'figaro', '~> 0.7.0'     # env variables
         gem 'annotate', ">=2.6.0"
-        gem "better_errors", '~> 1.1.0'
-        gem "binding_of_caller", "~> 0.7.1" # needed by better_errors or variable inspection 
         gem 'rspec-rails', '~> 3.0.0'
         gem 'byebug', '~> 3.2.0'
         gem "factory_girl_rails", "~> 4.0"
         gem "database_cleaner", '~> 1.3.0'
       end
+      gem_group :development do
+        gem "better_errors", '~> 1.1.0'
+        gem "binding_of_caller", "~> 0.7.1" # needed by better_errors or variable inspection 
+      end
       # Other gems
-      gem 'authorization', :path => "gems/authorization"
       # This ties in nicely with Ember, 0.8.0 is the stable version
       gem "active_model_serializers", "~> 0.8.0"
       # This is the api of choice now
@@ -126,12 +159,16 @@ module JsonVoorhees
       gem 'type_cartographer'
       gem 'devise', "~> 3.2.4" 
       if options.arcadex?
-        gem 'arcadex'#, '~> 1.0.4'
+        gem 'arcadex', '~> 1.1.0'
       end
       if options.admin?
         gem 'autoprefixer-rails'
         gem 'bootstrap-sass', '~> 3.2.0'
       end
+      if options.active_admin?
+        gem 'activeadmin', :git => 'https://github.com/activeadmin/activeadmin.git', :branch => "master"
+      end
+      gem 'authorization', :path => "gems/authorization"
     end
 
     def create_file_structure
@@ -146,8 +183,9 @@ module JsonVoorhees
 
     def run_bundle
       if !options.test?
-        run "bundle update"
-        run "bundle install"
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
       end
     end
 

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

@@ -6,7 +6,7 @@ class Api::V1::ApiController < ::ActionController::API
 
     def authenticate_user
       #["current_user","current_token"] Make this true to check for email also
-      @instance_hash = ::Arcadex.full_authentication(params,request,false)
+      @instance_hash = ::Arcadex::Authentication.full_authentication(params,request,false)
       if @instance_hash.nil?
         render :json => {errors: "User is not logged in, register or log in"} , status: :unauthorized
       end

data/lib/generators/json_voorhees/setup_engine/setup_engine_generator.rb

@@ -28,9 +28,9 @@ module JsonVoorhees
 	  	inject_into_file "config/routes.rb", after: "#{module_name.camelize}::Engine.routes.draw do\n" do <<-'RUBY'
 
 	#root to: "controller_name#index"
-	scope 'admin' do
+	#scope 'admin' do
 
-		end
+	#end
 
 	scope 'api' do
 		scope '1' do

data/lib/json_voorhees/version.rb

@@ -1,3 +1,3 @@
 module JsonVoorhees
-  VERSION = "0.3.0"
+  VERSION = "0.3.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_voorhees
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Cleophus Robinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails