json_voorhees 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e48185b7d2ceab5a233d5bf52f70740198c9475
+  data.tar.gz: cf01fa56c07c05530cbb63607422e2e5a08425a7
+SHA512:
+  metadata.gz: 73a28bb54a0d9e728cb4d8417acb96194996e9204a75b66928a12493097330e3a80aa943440a9ab02b29e26e5be94ac91f3acdba0d55580b314f36cd19fd2b28
+  data.tar.gz: 45f48512ef76c40f646377185807bf727307654438bebec02003fd7ebe994dee8d42426f89a51aafcc15a6d88f9f8c3097db573b2d91bd8adaae69fb67184da6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# JsonVoorhees
+
+## Introduction
+
+I frequently take on projects that involve some kind of api and it was a nightmare
+repeating all of the boilerplate code to get it the backend to a useable state.
+I abstracted away all of the code that I typically use into a series of generators
+namespaced under json_voorhees. Not only does it set your project up, it also
+helps build the project if you follow the conventions.
+
+## 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]
+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_create_controller [engine name] [resource name]
+rails g json_voorhees:engine_create_serializer [engine name] [resource name]
+```
+
+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_make_authorizations [engine name] [resource name]
+rails g json_voorhees:app_make_tests [engine name] [resource name]
+```
+
+For every resource created, those 4 are ran in their respective locations.
+
+## Notes
+
+Remember to put your engine inside the main_apps Gemfile after you create it.
+Remember to mount the engine inside the main_apps routing file.
+Your engines resource routes need to go inside the correct scoping.
+After you create your model and create the api_controller, change the white listed
+	params in the controller to fit accordingly.
+The attribute changes need to also be accurately represented in the factory girl factory
+and also in the serializer and authorization gem.
+
+## To Do
+
+1. Create a couple scaffolding services
+2. Refactor everything
+3. Figure out a better way to test this thing

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JsonVoorhees'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/json_voorhees/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/json_voorhees/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/json_voorhees/application_controller.rb

@@ -0,0 +1,4 @@
+module JsonVoorhees
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/json_voorhees/application_helper.rb

@@ -0,0 +1,4 @@
+module JsonVoorhees
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/json_voorhees/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>JsonVoorhees</title>
+  <%= stylesheet_link_tag    "json_voorhees/application", media: "all" %>
+  <%= javascript_include_tag "json_voorhees/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+JsonVoorhees::Engine.routes.draw do
+end

data/lib/generators/json_voorhees/app_make_authorizations/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Creates authorizations that a resources controller and serializer reference
+    to see if it has permission to answer the request or even send a attribute back.
+    Run this generator from the main_app
+
+Example:
+    rails g json_voorhees:app_make_authorizations People User
+
+    This will create:
+        A file in gems/authorization.

data/lib/generators/json_voorhees/app_make_authorizations/app_make_authorizations_generator.rb

@@ -0,0 +1,39 @@
+module JsonVoorhees
+	class AppMakeAuthorizationsGenerator < Rails::Generators::Base
+	  source_root File.expand_path('../templates', __FILE__)
+	  argument :module_name, :type => :string
+	  argument :resource_name, :type => :string
+
+	  def sprint
+	  	template "auth_file.rb.erb", "gems/authorization/lib/authorization/#{module_name.underscore}/#{resource_singular}.rb"
+	  	require_authfile
+	  end
+
+	  private
+
+	  def require_authfile
+      prepend_file 'gems/authorization/lib/authorization.rb', "require \'authorization/#{module_name.underscore}/#{resource_singular}\'\n"
+	  end
+
+	  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/app_make_authorizations/templates/auth_file.rb.erb

@@ -0,0 +1,51 @@
+module Authorization
+	module <%= module_camel %>
+		module <%= resource_camel %>
+
+			#Used in the controller
+
+			def self.index?(tokenUser)
+				return true
+			end
+
+			def self.show?(<%= resource_singular %>,tokenUser)
+				return true
+			end
+
+			def self.create?(tokenUser)
+				return true
+			end
+
+			def self.update?(<%= resource_singular %>,tokenUser)
+        return true
+			end
+
+			def self.destroy?(<%= resource_singular %>,tokenUser)
+				return true
+			end
+
+			#Used in the serializer
+
+			def self.include_id?(current_user,<%= resource_singular %>_object,options)
+	    	action = options[:url_options][:_recall][:action]
+	    	controller = options[:url_options][:_recall][:controller]
+				return true
+			end
+
+			def self.include_created_at?(current_user,<%= resource_singular %>_object,options)
+	    	action = options[:url_options][:_recall][:action]
+	    	controller = options[:url_options][:_recall][:controller]
+				return true
+			end
+
+			def self.include_updated_at?(current_user,<%= resource_singular %>_object,options)
+	    	action = options[:url_options][:_recall][:action]
+	    	controller = options[:url_options][:_recall][:controller]
+				return true
+			end
+
+			private
+
+		end
+	end
+end

data/lib/generators/json_voorhees/app_make_tests/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates RSpec model, request, and routing specs along with a factory_girl factory.
+    Run this generator in the main_app
+
+Example:
+    rails g json_voorhees:app_make_tests People User
+
+    This will create:
+        Some files in spec

data/lib/generators/json_voorhees/app_make_tests/app_make_tests_generator.rb

@@ -0,0 +1,51 @@
+module JsonVoorhees
+	class AppMakeTestsGenerator < Rails::Generators::Base
+	  source_root File.expand_path('../templates', __FILE__)
+	  argument :module_name, :type => :string
+	  argument :resource_name, :type => :string
+	  argument :api_version, :type => :string, :default => "1"
+	  class_option :model, :type => :boolean, :default => true, :description => "Create model stub tests"
+	  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"
+
+	  def sprint
+	  	if options.model?
+	  		template "model.rb.erb", "spec/engines/#{module_name.underscore}/api/v#{api_version}/models/#{resource_singular}_spec.rb"
+	  	end
+	  	if options.request?
+	  		if options.arcadex?
+	  			template "request.rb.erb", "spec/engines/#{module_name.underscore}/api/v#{api_version}/requests/#{resource_singular}_spec.rb"
+	  		else
+	  		end
+	  	end
+	  	if options.routing?
+	  		template "routing.rb.erb", "spec/engines/#{module_name.underscore}/api/v#{api_version}/routing/#{resource_singular}_spec.rb"
+	  	end
+	  	template "factory.rb.erb", "spec/factories/#{module_name.underscore}_#{resource_singular}_factory.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/app_make_tests/templates/factory.rb.erb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+	#sequence :email do |n|
+	#	"name#{n}"
+	#end
+  factory :<%= module_snake %>_<%= resource_singular %>, class: ::<%= module_camel %>::<%= resource_camel %> do
+  	#name 
+  	#attr "Default value"
+  end
+end

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

@@ -0,0 +1,30 @@
+require "rails_helper"
+
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, '.username', :type => :model do
+	describe "Attributes" do
+		it "does not save when attribute is nil" do
+			#<%= resource_singular %> = FactoryGirl.build(:<%= module_snake %>_<%= resource_singular %>, :attribute => nil)
+			#expect(<%= resource_singular %>.save).to equal(false)
+		end
+	end
+end
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, :type => :model do
+	describe "Dependencies" do
+		before(:example) do
+			@<%= resource_singular %> = FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>)
+		end
+		it "deletes ... when deleted" do
+
+		end
+	end
+end
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, :type => :model do
+	describe "Callbacks" do
+		before(:example) do
+    	@<%= resource_singular %> = FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>)
+  	end
+		it "creates a ..." do
+			#expect(object.posts.nil?).to equal(false) 	
+		end
+	end
+end

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

@@ -0,0 +1,102 @@
+require "rails_helper"
+
+#-#-#-#-#REST#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, :type => :request do
+  describe "Rest Routes" do
+    before(:example) do
+      @user = FactoryGirl.create(:people_user)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token, "Email" => @user.email}
+    end
+    # get /api/<%= api_version %>/<%= resource_plural %>
+    it "Gets all of the <%= resource_singular %>s" do
+      FactoryGirl.create_list(:<%= module_snake %>_<%= resource_singular %>, 10)
+      get 'api/<%= api_version %>/<%= resource_plural %>', nil, @header
+      expect(response.status).to eq(200) #ok
+    end
+    # get /api/<%= api_version %>/<%= resource_plural %>/1
+    it "Gets a <%= resource_singular %> by id" do
+      FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>)
+      get 'api/<%= api_version %>/<%= resource_plural %>/1', nil, @header
+      expect(response.status).to eq(200) #ok
+    end
+    # post /api/<%= api_version %>/<%= resource_plural %>
+    it "Creates <%= resource_singular %>" do
+      attrs = FactoryGirl.attributes_for(:<%= module_snake %>_<%= resource_singular %>)
+      #attrs[:column] = "LaunchU"  
+      hash = {"<%= resource_singular %>" => attrs}
+      post 'api/<%= api_version %>/<%= resource_plural %>', hash, @header
+      expect(response.status).to eq(200) #ok
+    end
+    # patch/put /api/<%= api_version %>/<%= resource_plural %>/1
+    it "Updates <%= resource_singular %>" do
+      #Create the <%= resource_singular %> through the api
+      attrs = FactoryGirl.attributes_for(:<%= module_snake %>_<%= resource_singular %>)
+      #attrs[:column] = "LaunchU"  
+      hash = {"<%= resource_singular %>" => attrs}
+      post 'api/<%= api_version %>/<%= resource_plural %>', hash, @header
+      #Now update the created <%= resource_singular %> by changing the <%= resource_singular %>name
+      #attrs[:column] = "BlastOff"
+      hash = {"<%= resource_singular %>" => attrs}
+      put "api/<%= api_version %>/<%= resource_plural %>/1", hash, @header
+      expect(response.status).to eq(200) #ok
+    end
+    # delete /api/<%= api_version %>/<%= resource_plural %>/1
+    it "Deletes <%= resource_singular %>" do
+      #Create the <%= resource_singular %> through the api
+      attrs = FactoryGirl.attributes_for(:<%= module_snake %>_<%= resource_singular %>)
+      #attrs[:column] = "LaunchU"  
+      hash = {"<%= resource_singular %>" => attrs}
+      post 'api/<%= api_version %>/<%= resource_plural %>', hash, @header
+      expect(<%= module_camel %>::<%= resource_camel %>.count).to eq(1)
+      #Now delete the <%= resource_singular %> through the api
+      delete 'api/<%= api_version %>/<%= resource_plural %>/1', nil, @header
+      expect(json).to eq({})
+      expect(response.status).to eq(200) #ok
+      expect(<%= module_camel %>::<%= resource_camel %>.count).to eq(0)
+    end
+  end
+end
+#-#-#-#-#Collection Routes#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, :type => :request do
+  describe "Collection Routes" do
+    before(:example) do
+      @user = FactoryGirl.create(:people_user)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token, "Email" => @user.email}
+    end
+    # get /api/1/collection
+    it "checks response of a collection route" do
+
+    end
+  end
+end
+#-#-#-#-#Serialization#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, :type => :request do
+  describe "Serialization" do
+    before(:example) do
+      @user = FactoryGirl.create(:people_user)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token, "Email" => @user.email}
+    end
+    it "checks the index json sent back" do
+
+    end
+  end
+end
+#-#-#-#-#Errors#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::<%= resource_camel %>, :type => :request do
+  describe "Errors" do
+    before(:example) do
+      @user = FactoryGirl.create(:people_user)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token, "Email" => @user.email}
+    end
+    # get /api/<%= api_version %>/<%= resource_plural %>/1
+    it "checks for a 404" do
+      FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>)
+      get 'api/<%= api_version %>/<%= resource_plural %>/20', nil, @header
+      expect(response.status).to eq(404) #ok
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require "rails_helper"
+
+#The standard rest routes for the group controller
+RSpec.describe "<%= module_camel.pluralize %> controller rest routing", :type => :routing do
+	routes { <%= module_camel %>::Engine.routes }
+
+	it "routes to index" do
+		expect(:get => "/api/<%= api_version %>/<%= resource_plural %>").to route_to(
+			:controller => "<%= module_snake %>/api/v<%= api_version %>/<%= resource_plural %>",
+			:action => "index"
+		)
+	end
+	it "routes to show" do
+		expect(:get => "/api/<%= api_version %>/<%= resource_plural %>/1").to route_to(
+			:controller => "<%= module_snake %>/api/v<%= api_version %>/<%= resource_plural %>",
+			:action => "show",
+			:id => "1"
+		)
+	end
+	it "routes to create" do
+		expect(:post => "/api/<%= api_version %>/<%= resource_plural %>/").to route_to(
+			:controller => "<%= module_snake %>/api/v<%= api_version %>/<%= resource_plural %>",
+			:action => "create"
+		)
+	end
+	it "routes to update" do
+		expect(:put => "/api/<%= api_version %>/<%= resource_plural %>/1/").to route_to(
+			:controller => "<%= module_snake %>/api/v<%= api_version %>/<%= resource_plural %>",
+			:action => "update",
+			:id => "1"
+		)
+	end
+	it "routes to update" do
+		expect(:patch => "/api/<%= api_version %>/<%= resource_plural %>/1/").to route_to(
+			:controller => "<%= module_snake %>/api/v<%= api_version %>/<%= resource_plural %>",
+			:action => "update",
+			:id => "1"
+		)
+	end
+	it "routes to delete" do
+		expect(:delete => "/api/<%= api_version %>/<%= resource_plural %>/1/").to route_to(
+			:controller => "<%= module_snake %>/api/v<%= api_version %>/<%= resource_plural %>",
+			:action => "destroy",
+			:id => "1"
+		)
+	end
+end

data/lib/generators/json_voorhees/engine_create_controller/USAGE

@@ -0,0 +1,12 @@
+Description:
+		A namespaced and versioned json controller that inherits from the main_apps api_controller.
+		Note a model still needs to be created that matches this resource. I like to scaffold it.
+    Run this generator inside the engine. 
+
+Example:
+    rails g json_voorhees:engine_create_controller People User
+
+    This will create:
+    		Some files in app/controllers
+    		
+

data/lib/generators/json_voorhees/engine_create_controller/engine_create_controller_generator.rb

@@ -0,0 +1,40 @@
+module JsonVoorhees
+	class EngineCreateControllerGenerator < Rails::Generators::Base
+	  source_root File.expand_path('../templates', __FILE__)
+	  argument :module_name, :type => :string
+	  argument :resource_name, :type => :string
+	  argument :api_version, :type => :string, :default => "1"
+	  class_option :authorization, :type => :boolean, :default => true, :description => "Include authorization in controller"
+
+	  def sprint
+	  	if options.authorization?
+	  		template "controller_template.rb.erb", "app/controllers/#{module_name.underscore}/api/v#{api_version}/#{resource_plural}_controller.rb"
+	  	else
+	  		template "no_auth_controller_template.rb.erb", "app/controllers/#{module_name.underscore}/api/v#{api_version}/#{resource_plural}_controller.rb"
+	  	end
+	  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