json_voorhees 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97d0bc5b64a0b3f39b53d22065e2cea831606fc1
-  data.tar.gz: 92b3368a5bc42303fee50e40a7d106c19b1ad0a9
+  metadata.gz: e58d03e1eccb3897bacd346af98d38c535341a35
+  data.tar.gz: 08b50880e0bb6e316ce6c0cf53714ca3d858c648
 SHA512:
-  metadata.gz: 260cfcdb5422342bfb056426121c30886840380e67e3c7287a3f8c3b86d3760ebdbd97b5f71619b5b91c71b4475d6652252d71f68cb91bdb60efedfbcda5bf97
-  data.tar.gz: 5ae939cfed5120ae9027122732434dc77ff41e9e5d962558174049d906e3ef90642adace7bfdd56251bb868ac0ba4a4973a4a70db97b8393b044c2c01c0713a5
+  metadata.gz: 737b04ec550dc16ef0eaba9fd3b0e2e6c30a6fcf932e48e87ddaf4bb32d286e8fc3dfda1c2ff65978ef0d33c30cecbf8cc0e5583dc867351fb5024968cb5686a
+  data.tar.gz: ac9d2aa35b9510b399b6fc9849daab5ede7f8105d0b17b74b827d958fb7b1962d9c9baa5b53ee9dbff8913b84e7cdccfc698bac893c13b783d091fb5dae81d8b

data/README.md

@@ -6,7 +6,19 @@ I frequently take on projects that involve some kind of an api and it was a nigh
 repeating all of the boilerplate code to get the backend in 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.
+helps build the project if you follow the conventions. 
+
+The standards that I set up for my APIs are those that separate all resources into engines and 
+version everything. The benefits are seen immediately when versioning a controller etc but
+when versioning a model not so. Versioning a model into classes like so, People::User, 
+People::V1::User and People::V2::User allow you to separate the model that contains the admin 
+display details (People::User) and the model that follows the rules of the api. In addition,
+to avoid polluting controllers, authorizations are handled by the main app in a gem. Every
+action is before_filtered to a function in the authorization gem and handed the current_user,
+the current_resource and a couple auxillary variables. Tests are also handled in the 
+main app. The scaffolds will take care of the tedious work, just know where everything is
+when you need it. Once you are accustomed to the location of everything, it will be very
+easy to speed through the backends development.
 
 ## Scaffold Use
 
@@ -17,8 +29,15 @@ gem "json_voorhees"
 ```
 ```bash
 rails g json_voorhees:setup_app
+
+or
+
+rails g json_voorhees:setup_app --fbonly
 ```
 
+The latter command will instead create a user from a fb access token in the login
+process.
+
 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.
 
@@ -63,6 +82,9 @@ else resides in engines for good modularity.
 4. To use gmail, your account needs to have an app_password. That is the password that should go on file.
 5. Account mailer in the people engine needs to be updated with the correct domain as well the host in application.rb config file for production.
 6. The account controller isn't under the api, forgotten_passwords etc should be implemented on the server. 
+7. To run the generators, sometimes spring will get in your way. If it hands run "spring stop"
+8. Cors may not work the same on all machines and rails versions. If it is acting up in production, if serve static assets is false, it wont find the Rails Static middleware to insert before and it will throw an error.
+9. For fbonly, make sure you go to the facebook folder and look at the file. You need to set the environment variables FB_APPID1 and FB_SECRET1.
 
 Does not work with Rails 4.2 yet. Byebug is added by default and this generator tries to add it twice.
 

data/lib/generators/json_voorhees/app_environment/app_environment_generator.rb

@@ -16,7 +16,8 @@ module JsonVoorhees
 
     #So url_for works in the mailer
 		config.action_mailer.default_url_options = { host: 'localhost:3000' }
-		config.middleware.insert_before "ActionDispatch::Static", "Rack::Cors" do
+		#config.middleware.insert_before "ActionDispatch::Static", "Rack::Cors" do
+		config.middleware.use Rack::Cors do
       allow do
         origins '*'
         resource '*', :headers => :any, :methods => [:get, :post, :put, :delete, :options]

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

@@ -5,16 +5,25 @@ module JsonVoorhees
 	  argument :resource_name, :type => :string
 	  argument :api_version, :type => :string, :default => "1"
 	  argument :attributes, type: :array, default: [], banner: "field:type field:type"
+	  class_option :fbonly, :type => :boolean, :default => false, :description => "Use facebook login?"
 
 	  def sprint
   		template "model.rb.erb", "spec/engines/#{module_snake}/api/v#{api_version}/models/#{resource_singular}_spec.rb"
-  		template "request.rb.erb", "spec/engines/#{module_snake}/api/v#{api_version}/requests/#{resource_singular}_spec.rb"
   		template "routing.rb.erb", "spec/engines/#{module_snake}/api/v#{api_version}/routing/#{resource_singular}_spec.rb"
   		template "factory.rb.erb", "spec/factories/#{module_snake}_#{resource_singular}_#{api_version}_factory.rb"
+  		requests
   	end
 
 	  private
 
+	  def requests
+	  	if options.fbonly?
+	  		template "fbonly_request.rb.erb", "spec/engines/#{module_snake}/api/v#{api_version}/requests/#{resource_singular}_spec.rb"
+	  	else
+	  		template "request.rb.erb", "spec/engines/#{module_snake}/api/v#{api_version}/requests/#{resource_singular}_spec.rb"
+	  	end
+	  end
+
 	  def default_values(field1)
 	  	field = field1.downcase
 	  	if field == "integer"

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

@@ -0,0 +1,136 @@
+require "rails_helper"
+
+#-#-#-#-#REST#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Index" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    end
+    # get /api/<%= api_version %>/<%= resource_plural %>
+    it "Gets all of the <%= resource_singular %>s" do
+      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
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Show" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    end
+    # get /api/<%= api_version %>/<%= resource_plural %>/1
+    it "Gets a <%= resource_singular %> by id" do
+      <%= resource_singular %> = FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>)
+      get "api/<%= api_version %>/<%= resource_plural %>/#{<%= resource_singular %>.id}", nil, @header
+      expect(response.status).to eq(200) #ok
+    end
+  end
+end
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Create" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    end
+    # post /api/<%= api_version %>/<%= resource_plural %>
+    it "Creates <%= resource_singular %>" do
+      attrs = FactoryGirl.attributes_for(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>)
+      #attrs[:column] = "LaunchU"  
+      hash = {"<%= resource_singular %>" => attrs}
+      post 'api/<%= api_version %>/<%= resource_plural %>', hash, @header
+      expect(response.status).to eq(200) #ok
+    end
+  end
+end
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Update" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    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 %>_<%= api_version %>)
+      #attrs[:column] = "LaunchU"  
+      <%= resource_singular %> = FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>)
+      hash = {"<%= resource_singular %>" => attrs}
+      put "api/<%= api_version %>/<%= resource_plural %>/#{<%= resource_singular %>.id}", hash, @header
+      expect(response.status).to eq(200) #ok
+    end
+  end
+end
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Destroy" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    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 %>_<%= api_version %>)
+      #attrs[:column] = "LaunchU"  
+      <%= resource_singular %> = FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>)
+      expect(<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>.count).to eq(1)
+      #Now delete the <%= resource_singular %> through the api
+      delete "api/<%= api_version %>/<%= resource_plural %>/#{<%= resource_singular %>.id}", nil, @header
+      expect(json).to eq({})
+      expect(response.status).to eq(200) #ok
+      expect(<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>.count).to eq(0)
+    end
+  end
+end
+#-#-#-#-#Collection Routes#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Collection Routes" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    end
+    # get /api/1/collection
+    it "checks response of a collection route" do
+
+    end
+  end
+end
+#-#-#-#-#Serialization#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Serialization" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    end
+    it "checks the index json sent back" do
+
+    end
+  end
+end
+#-#-#-#-#Errors#-#-#-#-#
+RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>, :type => :request do
+  describe "Errors" do
+    before(:example) do
+      @user = FactoryGirl.create(:fbuser_user_1)
+      token = @user.tokens[0].auth_token
+      @header = {"Auth-Token" => token}
+    end
+    # get /api/<%= api_version %>/<%= resource_plural %>/1
+    it "checks for a 404" do
+      <%= resource_singular %> = FactoryGirl.create(:<%= module_snake %>_<%= resource_singular %>_<%= api_version %>)
+      get "api/<%= api_version %>/<%= resource_plural %>/#{<%= resource_singular %>.id + 1}", nil, @header
+      expect(response.status).to eq(404) #ok
+    end
+  end
+end

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

@@ -1,20 +1,44 @@
 module JsonVoorhees
 	class AppMakeUserGenerator < Rails::Generators::Base
 	  source_root File.expand_path('../templates', __FILE__)
+    class_option :fbonly, :type => :boolean, :default => false, :description => "Use facebook login?"
 
     def sprint
-    	people
+      route "mount Arcadex::Engine, at: \'/\'"
+      if options.fbonly?
+        fb_only
+      else
+        people
+      end
     end
 
     private
 
+      def fb_only
+        run "git clone https://github.com/cleor41/fbuser.git"
+        run "mv fbuser engines/fbuser"
+        run "rm -rf engines/fbuser/.git"
+        #Need to add the engine to the main_apps gemfile
+        route "mount Fbuser::Engine, at: \'/\'"
+        insert_fb_user_engine
+        run "rails g fbuser:all"
+      end
+
+      def insert_fb_user_engine
+        inject_into_file 'Gemfile', after: "source \'https://rubygems.org\'\n" do <<-'RUBY'
+
+  gem 'fbuser', :path => "engines/fbuser"
+
+        RUBY
+        end
+      end
+
       def people
         run "git clone https://github.com/cleor41/people.git"
         run "mv people engines/people"
         run "rm -rf engines/people/.git"
     		#Need to add the engine to the main_apps gemfile
         route "mount People::Engine, at: \'/\'"
-        route "mount Arcadex::Engine, at: \'/\'"
         insert_people_engine
         run "rails g people:all"
       end

data/lib/generators/json_voorhees/app_scaffold/app_scaffold_generator.rb

@@ -8,7 +8,11 @@ module JsonVoorhees
 
 		def sprint
 			run "rails g json_voorhees:app_make_authorizations #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
-			run "rails g json_voorhees:app_make_tests #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
+			if Kernel.const_defined?("Fbuser")
+				run "rails g json_voorhees:app_make_tests --fbonly #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
+			else
+				run "rails g json_voorhees:app_make_tests #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
+			end
 		end
 
 		private

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

@@ -3,6 +3,7 @@ require 'bundler'
 module JsonVoorhees
   class SetupAppGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
+    class_option :fbonly, :type => :boolean, :default => false, :description => "Use facebook login?"
 
     def sprint
     	create_file_structure
@@ -57,7 +58,11 @@ module JsonVoorhees
     end
 
     def make_user
-      run "rails g json_voorhees:app_make_user"
+      if options.fbonly?
+        run "rails g json_voorhees:app_make_user --fbonly"
+      else
+        run "rails g json_voorhees:app_make_user"
+      end
       run_bundle
     end
 
@@ -89,7 +94,7 @@ module JsonVoorhees
     end
                                                             
     def api_controller
-    	copy_file "api_controller_with_arcadex.rb", "app/controllers/api/v1/api_controller.rb"
+    	template "api_controller_with_arcadex.rb", "app/controllers/api/v1/api_controller.rb"
     end
 
     def rspec
@@ -139,6 +144,7 @@ module JsonVoorhees
       gem 'authorization', :path => "gems/authorization"
       gem 'whenever', :require => false
       gem 'rack-cors', :require => 'rack/cors'
+      gem 'httparty'
       #gem 'websocket-rails'
     end
 

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

@@ -2,10 +2,6 @@ class Api::V1::ApiController < ::ActionController::API
 
   before_action :authenticate_user
 
-  def route_options
-    cors_preflight_check
-  end
-
   private
 
     def authenticate_user
@@ -15,6 +11,7 @@ class Api::V1::ApiController < ::ActionController::API
       end
     end
 
+<% if !options.fbonly? %> 
     def authenticate_password
       if current_user.nil?
         return true
@@ -25,15 +22,18 @@ class Api::V1::ApiController < ::ActionController::API
         return false
       end
     end
+<% end %>
 
     def set_hash
       #["current_owner","current_token"] Make this true to check for email also
-      #@instance_hash = ::Arcadex::Authentication.get_instance(params,request,"Auth-Token")
-      @instance_hash = ::Arcadex::Authentication.authenticate_owner_with_index(params,request,"Auth-Token","Email","email",true)
+      @instance_hash = ::Arcadex::Authentication.get_instance(params,request,"Auth-Token")
+      #@instance_hash = ::Arcadex::Authentication.authenticate_owner_with_index(params,request,"Auth-Token","Email","email",true)
       #Ignore the token if the user's account is locked
+      <% if !options.fbonly? %> 
       if !current_user.nil? && current_user.locked
         @instance_hash = nil
       end
+      <% end %>
     end
 
     def current_user

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

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

data/lib/json_voorhees/version.rb

@@ -1,3 +1,3 @@
 module JsonVoorhees
-  VERSION = "1.3.2"
+  VERSION = "1.4.0"
 end

data/test/test_script.txt

@@ -1,5 +1,7 @@
 Go to the test directory and run this script. Make sure rspec tests are green.
 
+For non FB only
+
 cp fresh_copy/test_app . &&
 cd test_app &&
 rails g json_voorhees:setup_app &&
@@ -11,8 +13,24 @@ rake db:migrate RAILS_ENV=test &&
 rake db:migrate RAILS_ENV=production &&
 rspec
 
+For FB only
+
+cp fresh_copy/test_app test_app2 &&
+cd test_app2 &&
+rails g json_voorhees:setup_app --fbonly &&
+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
+
+cd .. &&
+rm -rf test_app2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_voorhees
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Cleophus Robinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -78,6 +78,7 @@ files:
 - lib/generators/json_voorhees/app_make_tests/USAGE
 - lib/generators/json_voorhees/app_make_tests/app_make_tests_generator.rb
 - lib/generators/json_voorhees/app_make_tests/templates/factory.rb.erb
+- lib/generators/json_voorhees/app_make_tests/templates/fbonly_request.rb.erb
 - lib/generators/json_voorhees/app_make_tests/templates/model.rb.erb
 - lib/generators/json_voorhees/app_make_tests/templates/request.rb.erb
 - lib/generators/json_voorhees/app_make_tests/templates/routing.rb.erb