json_voorhees 0.0.1

data/lib/generators/json_voorhees/engine_create_controller/templates/controller_template.rb.erb

@@ -0,0 +1,98 @@
+require_dependency "<%= module_snake %>/api/v<%= api_version %>/application_controller"
+require 'authorization'
+
+module <%= module_camel %>
+  class Api::V1::<%= resource_camel.pluralize %>Controller < Api::V1::ApplicationController
+    before_action :set_<%= resource_singular %>, only: [:show, :update, :destroy]
+    before_action :index_authorize, only: [:index]
+    before_action :show_authorize, only: [:show]
+    before_action :create_authorize, only: [:create]
+    before_action :update_authorize, only: [:update]
+    before_action :destroy_authorize, only: [:destroy]
+
+		# GET /api/1/<%= resource_plural %>
+    def index
+      @<%= resource_plural %> = ::<%= module_camel %>::<%= resource_camel %>.all
+      render json: @<%= resource_plural %>
+    end
+
+    # GET /api/1/<%= resource_plural %>/1
+    def show
+    	render json: @<%= resource_singular %>
+    end
+
+    # POST /api/1/<%= resource_plural %>
+    def create
+      @<%= resource_singular %> = ::<%= module_camel %>::<%= resource_camel %>.new(<%= resource_singular %>_params)
+      if @<%= resource_singular %>.save
+        render json: @<%= resource_singular %>
+      else
+        render :json => {errors: @<%= resource_singular %>.errors}, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /api/1/<%= resource_plural %>/1
+    def update
+    	if @<%= resource_singular %>.update(<%= resource_singular %>_params)
+        render json: @<%= resource_singular %>
+      else
+        render :json => {errors: @<%= resource_singular %>.errors}, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /api/1/<%= resource_plural %>/1
+    def destroy
+      @<%= resource_singular %>.destroy
+      render json: {}
+    end
+
+    private
+
+      # Use callbacks to share common setup or constraints between actions.
+
+      def set_<%= resource_singular %>
+        @<%= resource_singular %> = ::<%= module_camel %>::<%= resource_camel %>.find_by_id(params[:id])
+        if @<%= resource_singular %>.nil?
+          render :json => {errors: "<%= resource_camel %> was not found"}, status: :not_found
+        end
+      end
+
+      # Only allow a trusted parameter "white list" through.
+
+      def <%= resource_singular %>_params
+        params.require(:<%= resource_singular %>).permit(:params_here)
+      end
+
+      # Authorizations below here
+
+      def index_authorize
+        if !::Authorization::<%= module_camel %>::<%= resource_camel %>.index?(current_user)
+          render :json => {errors: "User is not authorized for this action"}, status: :forbidden
+        end
+      end
+
+      def show_authorize
+        if !::Authorization::<%= module_camel %>::<%= resource_camel %>.show?(@<%= resource_singular %>,current_user)
+          render :json => {errors: "User is not authorized for this action"}, status: :forbidden
+        end
+      end
+
+      def create_authorize
+        if !::Authorization::<%= module_camel %>::<%= resource_camel %>.create?(current_user)
+          render :json => {errors: "User is not authorized for this action"}, status: :forbidden
+        end
+      end
+
+      def update_authorize
+        if !::Authorization::<%= module_camel %>::<%= resource_camel %>.update?(@<%= resource_singular %>,current_user)
+          render :json => {errors: "User is not authorized for this action"}, status: :forbidden
+        end
+      end
+
+      def destroy_authorize
+        if !::Authorization::<%= module_camel %>::<%= resource_camel %>.destroy?(@<%= resource_singular %>,current_user)
+          render :json => {errors: "User is not authorized for this action"}, status: :forbidden
+        end
+      end
+  end
+end

data/lib/generators/json_voorhees/engine_create_controller/templates/no_auth_controller_template.rb.erb

@@ -0,0 +1,61 @@
+require_dependency "<%= module_snake %>/api/v<%= api_version %>/application_controller"
+require 'authorization'
+
+module <%= module_camel %>
+  class Api::V1::<%= resource_camel.pluralize %>Controller < Api::V1::ApplicationController
+    before_action :set_<%= resource_singular %>, only: [:show, :update, :destroy]
+
+		# GET /api/1/<%= resource_plural %>
+    def index
+      @<%= resource_plural %> = ::<%= module_camel %>::<%= resource_camel %>.all
+      render json: @<%= resource_plural %>
+    end
+
+    # GET /api/1/<%= resource_plural %>/1
+    def show
+    	render json: @<%= resource_singular %>
+    end
+
+    # POST /api/1/<%= resource_plural %>
+    def create
+      @<%= resource_singular %> = ::<%= module_camel %>::<%= resource_camel %>.new(<%= resource_singular %>_params)
+      if @<%= resource_singular %>.save
+        render json: @<%= resource_singular %>
+      else
+        render :json => {errors: @<%= resource_singular %>.errors}, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /api/1/<%= resource_plural %>/1
+    def update
+    	if @<%= resource_singular %>.update(<%= resource_singular %>_params)
+        render json: @<%= resource_singular %>
+      else
+        render :json => {errors: @<%= resource_singular %>.errors}, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /api/1/<%= resource_plural %>/1
+    def destroy
+      @<%= resource_singular %>.destroy
+      render json: {}
+    end
+
+    private
+
+      # Use callbacks to share common setup or constraints between actions.
+
+      def set_<%= resource_singular %>
+        @<%= resource_singular %> = ::<%= module_camel %>::<%= resource_camel %>.find_by_id(params[:id])
+        if @<%= resource_singular %>.nil?
+          render :json => {errors: "<%= resource_camel %> was not found"}, status: :not_found
+        end
+      end
+
+      # Only allow a trusted parameter "white list" through.
+
+      def <%= resource_singular %>_params
+        params.require(:<%= resource_singular %>).permit(:params_here)
+      end
+  end
+end

data/lib/generators/json_voorhees/engine_create_serializer/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Create the boilerplate serialization code that hooks into the authorization gem.
+    It needs to match a resource. Run this generator inside an engine.
+
+Example:
+    rails g json_voorhees:engine_create_serializer People User
+
+    This will create:
+        A file in app/serializers

data/lib/generators/json_voorhees/engine_create_serializer/engine_create_serializer_generator.rb

@@ -0,0 +1,34 @@
+module JsonVoorhees
+	class EngineCreateSerializerGenerator < Rails::Generators::Base
+	  source_root File.expand_path('../templates', __FILE__)
+	  argument :module_name, :type => :string
+	  argument :resource_name, :type => :string
+
+	  def sprint
+	  	template "serializer.rb.erb", "app/serializers/#{module_name.underscore}/#{resource_singular}_serializer.rb"
+	  end
+
+	  private
+
+	  def resource_singular
+	  	resource_name.underscore.singularize
+	  end
+
+	  def resource_plural
+	  	resource_name.underscore.pluralize
+	  end
+
+	  def resource_camel
+	  	resource_name.camelize.singularize
+	  end
+
+	  def module_camel
+	  	module_name.camelize
+	  end
+
+	  def module_snake
+	  	module_name.underscore.downcase
+	  end
+
+	end
+end

data/lib/generators/json_voorhees/engine_create_serializer/templates/serializer.rb.erb

@@ -0,0 +1,23 @@
+require 'authorization'
+
+module <%= module_camel %>
+  class <%= resource_camel %>Serializer < ActiveModel::Serializer
+  	embed :ids, include: true
+
+    attributes :id
+    attributes :created_at
+    attributes :updated_at
+    #has_one :bulletin
+    #has_many :posts
+
+    def include_id?
+    	return ::Authorization::<%= module_camel %>::<%= resource_camel %>.include_id?(current_user,object,@options)
+    end
+
+    def include_associations!
+      #include! :bulletin if ::Authorization::<%= module_camel %>::<%= resource_camel %>.include_bulletin?(current_user,object,@options)
+      #include! :posts if ::Authorization::<%= module_camel %>::<%= resource_camel %>.include_posts?(current_user,object,@options)
+    end
+
+  end
+end

data/lib/generators/json_voorhees/setup_app/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Run this after your main_app is created. It will set the layout of your application
+    as well as add and setup commonly used gems. It will even add a user class.
+
+Example:
+    rails g json_voorhees:setup_app
+
+    This will create:
+        A lot of boilerplate code

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

@@ -0,0 +1,207 @@
+module JsonVoorhees
+  class SetupAppGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    #argument :user_class, :type => :string
+    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 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"
+
+    def sprint
+    	create_file_structure
+    	dev_test_gems
+    	other_gems
+    	run_bundle
+    	rspec
+    	api_controller
+    	people
+    	routes
+    	make_controllers
+    	make_admin
+      #seed db?
+      #fancier admin?
+    	run_git
+    end
+
+    private
+
+    def make_admin
+      include_middleware
+      if options.user?
+        #copy admin page with user engine
+        copy_file "views/admin_with_user", "app/views/main/admin.html.erb"
+      else 
+        #copy admin page without user engine
+        copy_file "views/admin_no_user", "app/views/main/admin.html.erb"
+      end
+   	end
+
+    def include_middleware
+      inject_into_file 'config/application.rb', after: "class Application < Rails::Application\n" do <<-'RUBY'
+
+  #So Rails-Api doesn't remove all of the middleware
+  config.api_only = false
+
+      RUBY
+      end
+    end
+
+    def routes
+    	route "root to: \"app_index#app\""
+  		route "get \'admin\' => \'main#admin\', as: \"admin\" #admin_path"
+    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"
+      run "rm -f spec/controllers/main_controller_spec.rb"
+      #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"
+      run "rm -f app/views/layouts/application.html.erb"
+      copy_file "views/application", "app/views/layouts/application.html.erb"
+      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
+  http_basic_authenticate_with name: "admin", password: "password"
+
+      RUBY
+      end
+    end
+
+    def run_db_migrations
+  		run "rake db:migrate RAILS_ENV=development"
+  		run "rake db:migrate RAILS_ENV=test"
+  		run "rake db:migrate RAILS_ENV=production"
+    end
+
+    def run_git
+    	if !options.test?
+				git :init
+				git add: "."
+				git commit: "-m Initial commit"
+    	end
+    end
+
+    def people
+    	if options.user?
+    		run "rails plugin new engines/people --mountable"
+    		inside('engines/people') do
+    			#This needs to run the generator for setting up engines
+    			run "rails g json_voorhees:setup_engine people"
+    			#Now it needs to create the user class
+    			run "rails g scaffold user username:string email:string password_digest:string"
+    			run_db_migrations
+    			#Add this to the routes and gemfile
+    		end
+    		#Need to add the engine to the main_apps gemfile
+        route "mount People::Engine, at: \'/\'"
+        if options.arcadex?
+          copy_user_files_over
+          route "mount Arcadex::Engine, at: \'/\'"
+        end
+        insert_people_engine
+				run_bundle
+				run "rake railties:install:migrations"
+				run_db_migrations
+    	end
+    end
+
+    def insert_people_engine
+			inject_into_file 'Gemfile', after: "source \'https://rubygems.org\'\n" do <<-'RUBY'
+
+	gem 'people', :path => "engines/people"
+
+			RUBY
+			end
+    end
+
+    def copy_user_files_over
+    	copy_file "user/user_authorizations.rb", "gems/authorization/lib/authorization/people/user.rb"
+    	run "rm -f gems/authorization/lib/authorization.rb"
+    	copy_file "user/include_authorization.rb", "gems/authorization/lib/authorization.rb"
+    	copy_file "user/user_controller.rb", "engines/people/app/controllers/people/api/v1/users_controller.rb"
+    	run "rm -f engines/people/app/models/people/user.rb"
+    	copy_file "user/user_model.rb", "engines/people/app/models/people/user.rb"
+    	run "rm -f engines/people/config/routes.rb"
+    	copy_file "user/user_routes.rb", "engines/people/config/routes.rb"
+    	copy_file "user/user_serializer.rb", "engines/people/app/serializers/people/user_serializer.rb"
+    	copy_file "user/specs/factory_girl.rb", "spec/factories/people_user_factory.rb"
+    	copy_file "user/specs/model_specs.rb", "spec/engines/people/api/v1/models/user_spec.rb"
+    	copy_file "user/specs/request_specs.rb", "spec/engines/people/api/v1/requests/user_spec.rb"
+    	copy_file "user/specs/route_specs.rb", "spec/engines/people/api/v1/routing/user_spec.rb"
+    end
+                                                            
+    def api_controller
+    	if options.arcadex?
+    		copy_file "api_controller_with_arcadex.rb", "app/controllers/api/v1/api_controller.rb"
+    	else
+    		copy_file "api_controller_no_arcadex.rb", "app/controllers/api/v1/api_controller.rb"
+    	end
+    end
+
+    def rspec
+			generate "rspec:install"
+			run "rm -f .rspec"
+			copy_file "hidden_rspec.rb", ".rspec"
+			copy_file "rspec_factory_girl.rb", "spec/support/factory_girl.rb"
+			inject_into_file 'spec/rails_helper.rb', after: "RSpec.configure do |config|\n" do <<-'RUBY'
+
+	config.include ::Requests::JsonHelpers, :type => :request
+	config.include ::Requests::JsonHelpers, :type => :controller
+
+			RUBY
+			end
+			copy_file "json_helpers.rb", "spec/support/request_helpers.rb"
+    end
+
+    def run_bundle
+    	if !options.test?
+    		run "bundle update"
+				run "bundle install"
+    	end
+    end
+
+    def 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
+			gem "rails-api"
+			gem 'kaminari'
+			gem 'bcrypt', '~> 3.1.7'
+			gem 'type_cartographer'
+			gem 'devise', "~> 3.2.4" 
+			if options.arcadex?
+				gem 'arcadex', '~> 1.0.4'
+			end
+   	end
+
+    def dev_test_gems
+			gem_group :development, :test do
+				#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
+    end
+
+    def create_file_structure
+    	run "rm -rf test"
+			run "rm -f README.rdoc"
+			run "echo '# Describe your application here' > README.md"
+			run "mkdir engines && touch engines/.gitkeep"
+			run "mkdir gems && touch gems/.gitkeep"
+			run "mkdir notes && touch notes/.gitkeep"
+			run "rails plugin new gems/authorization"
+    end
+
+  end
+end

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

@@ -0,0 +1,2 @@
+class Api::V1::ApiController < ::ActionController::API
+end

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

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

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

@@ -0,0 +1,4 @@
+class AppIndexController < ActionController::Base
+  def app
+  end
+end

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

@@ -0,0 +1,3 @@
+--color
+warnings = false
+--require spec_helper

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

@@ -0,0 +1,7 @@
+module Requests
+	module JsonHelpers
+		def json
+			@json ||= JSON.parse(response.body)
+		end
+	end
+end

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

@@ -0,0 +1,16 @@
+RSpec.configure do |config|
+  #additional factory_girl configuration
+
+  # Factory girl methods don't need to be prefaced with FactoryGirl
+  config.include FactoryGirl::Syntax::Methods
+
+  # Best each test suite is run, make sure the factories are valid
+  config.before(:suite) do
+    begin
+      DatabaseCleaner.start
+      FactoryGirl.lint
+    ensure
+      DatabaseCleaner.clean
+    end
+  end
+end

data/lib/generators/json_voorhees/setup_app/templates/user/include_authorization.rb

@@ -0,0 +1,3 @@
+require 'authorization/people/user'
+module Authorization
+end

data/lib/generators/json_voorhees/setup_app/templates/user/specs/factory_girl.rb

@@ -0,0 +1,14 @@
+FactoryGirl.define do
+	sequence :username do |n|
+		"username#{n}"
+	end
+	sequence :email do |n|
+		"username#{n}@LaunchU.com"
+	end
+  factory :people_user, class: ::People::User do
+  	username
+  	email
+		password "password123"
+		password_confirmation "password123"
+  end
+end

data/lib/generators/json_voorhees/setup_app/templates/user/specs/model_specs.rb

@@ -0,0 +1,59 @@
+require "rails_helper"
+
+RSpec.describe ::People::User, '.username', :type => :model do
+	it "does not save when nil" do
+		user = FactoryGirl.build(:people_user, :username => nil)
+		expect(user.save).to equal(false)
+	end
+	it "does not save with invalid characters" do
+		#user = FactoryGirl.build(:people_user, :username => "!@#$%)")
+		#expect(user.save).to equal(false)
+	end
+end
+RSpec.describe ::People::User, '.email', :type => :model do
+	it "does not save when nil" do
+		user = FactoryGirl.build(:people_user, :email => nil)
+		expect(user.save).to equal(false)
+	end
+	it "does not save with invalid characters" do
+		#user = FactoryGirl.build(:people_user, :email => "!@#$%)")
+		#expect(user.save).to equal(false)
+	end
+end
+RSpec.describe ::People::User, '.password_digest', :type => :model do
+	it "does not save when nil" do
+		user = FactoryGirl.build(:people_user, :password => nil, :password_confirmation => nil)
+		expect(user.save).to equal(false)
+	end
+	it "does not save when not a match" do
+		user = FactoryGirl.build(:people_user, :password => "firstAttempt", :password_confirmation => "secondAttempt")
+		expect(user.save).to equal(false)
+	end
+	it "saves with a matching password and password_confirmation" do
+		user = FactoryGirl.build(:people_user, :password => "good_password", :password_confirmation => "good_password")
+		expect(user.save).to equal(true)
+	end
+end
+RSpec.describe ::People::User, :type => :model do
+	describe "dependencies" do
+		before(:example) do
+			@user = FactoryGirl.create(:people_user)
+		end
+		it "deletes ... when deleted" do
+
+		end
+	end
+end
+RSpec.describe ::People::User, :type => :model do
+	describe "callbacks" do
+		before(:example) do
+    	@user = FactoryGirl.create(:people_user)
+  	end
+		it "creates an authentication token" do
+			expect(@user.tokens.any?).to equal(true)
+		end
+		it "does not create an empty auth token" do
+			expect(@user.tokens[0].auth_token.nil?).to equal(false)
+		end
+	end
+end