json_voorhees 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 603192b4fe8aa21892159a4e72b2aacb9cd9aa8c
-  data.tar.gz: c79b6b8ccf9fc8acc22d0fe42f45e371f5e7822f
+  metadata.gz: 85db652f4df886f9e564573f69313155cc208c09
+  data.tar.gz: 5c34d2f12abcff0f7619146d7b3f49b75de9d5db
 SHA512:
-  metadata.gz: 3ce4c588efd0acde009e6b09984f496571152bb765ea4561706e0ed76062d7a21a90380daae6fbb5ec22839c55d8c203aec1fc6ef1d3e34de4ee1ab4cc394629
-  data.tar.gz: 97697e505ab8e34a4cbbdd50def3420125bdfbcf54c7abce66779396d7f8c8e064da03a1c9525eb58ffff84822103e7367df2769488462f2ff5ab1cd457e92c9
+  metadata.gz: d53425a719f8ee49b347cd07f9ab52bd99febbec580557986f64b33110c4056ff92c6763240801fe0a201b57b758dff9a6f0fe070587aa4ed7fe0e5b6de2a9e7
+  data.tar.gz: 709fa8e55311d4f7d4f09252f0348072ee8a902cb706824d7a932cf5251bd7c711c3790fa7c0551764e232b72a4d91fe8453d12dfc1258db10ffa7fb91a3528e

data/README.md

@@ -1,24 +1,11 @@
-# JsonVoorhees 1.3.0
+# JsonVoorhees 1.4.2
 
 ## Introduction
 
-I frequently take on projects that involve some kind of an api and it was a nightmare
-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. 
-
-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.
+JsonVoorhees is an api builder that encapsulates all of it's generated code 
+inside of engines. It's essentially an opinionated framework built with rails
+generators. It comes with common gems, a user model and other common functionality
+such as token authentication.
 
 ## Scaffold Use
 
@@ -65,35 +52,28 @@ rails g json_voorhees:massive_scaffold chat message 1 user_id:integer message:te
 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 && rake db:migrate RAILS_ENV=test"
 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 modular functioning backend that only needs the model relationships wired together. The default tests get you pretty far.
-
-## Versioning
-
-This generator is strongly tied in with versioning. As so every
-model, controller, serializer, test and factory created with this tool are
-versioned. The main app hosts the application controllers and test suite. Everything
-else resides in engines for good modularity.
+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. It's a pretty good idea to create a script file that contains all of the scaffolds. It's essentially a schema for how to recreate your backend.
 
 ## Gotchas and Reminders
 
 1. Make sure the version of Rails is the same in both engine and app.
 2. The mailer doesn't need to be set up. For test and development it is set so this doesn't have to be the case but change the environment config file to make it work.
-3. To user the mailer, make sure to export GMAIL_USERNAME and GMAIL_PASSWORD to your environment. Or you can just overwrite the values in the environment config file.
+3. To use the mailer, make sure to export GMAIL_USERNAME and GMAIL_PASSWORD to your environment. Or you can just overwrite the values in the environment config file.
 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"
+7. To run the generators, sometimes spring will get in your way. If it hangs, 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.
+Does not work with Rails 4.2 yet. Byebug is added by default and this generator tries to add it twice so it fails.
 
 ##Future
 
 1. Sidekiq
 2. Paperclip
 3. Websockets
-4. Facebook support
+4. App tokens
 
 Emails are sent synchronously for now. I'm waiting for ActiveJob in Rails 4.2 so I can
 implement that interface and user the sidekiq adapter.

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

@@ -3,6 +3,7 @@ module JsonVoorhees
 	  source_root File.expand_path('../templates', __FILE__)
 
 	  def sprint
+	  	createSettings
 	  	createDev
 	  	createTest
 	  	createPro
@@ -11,6 +12,13 @@ module JsonVoorhees
 
 	  private
 
+	  	def createSettings
+	  		run "rails g rails_config:install"
+				prepend_to_file 'config/settings.yml' do
+"token_header: \"Auth_Token\"\napi_header: \"Api_Token\"\n"
+				end
+	  	end
+
 	 		def addToApplication
 				inject_into_file 'config/application.rb', after: "class Application < Rails::Application\n" do <<-'RUBY'
 
@@ -29,6 +37,7 @@ module JsonVoorhees
 	 		end
 
 	  	def createDev
+	  		::Settings.reload!
 	  		gsub_file "config/environments/development.rb", "config.action_mailer.raise_delivery_errors = false\n", "#config.action_mailer.raise_delivery_errors = false\n"
 				inject_into_file 'config/environments/development.rb', after: "configure do\n" do <<-'RUBY'
 
@@ -44,12 +53,16 @@ module JsonVoorhees
 	  password:             ENV['GMAIL_PASSWORD'],
 	  authentication:       'plain',
 	  enable_starttls_auto: true  }
-				
+	::Paperclip.options[:command_path] = "/usr/bin/"
+	#Set Paperclip defaults here
+	#Paperclip::Attachment.default_options[:storage] = :fog
+
 				RUBY
 				end
 	  	end
 
 	  	def createTest
+	  		::Settings.reload!
 	  		gsub_file "config/environments/test.rb", "config.action_mailer.delivery_method = :test\n", "#config.action_mailer.delivery_method = :test\n"
 				inject_into_file 'config/environments/test.rb', after: "configure do\n" do <<-'RUBY'
 
@@ -66,12 +79,16 @@ module JsonVoorhees
 	  password:             'testing123',
 	  authentication:       'plain',
 	  enable_starttls_auto: true  }
-				
+	::Paperclip.options[:command_path] = "/usr/bin/"
+	#Set Paperclip defaults here
+	#Paperclip::Attachment.default_options[:storage] = :fog
+
 				RUBY
 				end
 	  	end
 
 	  	def createPro
+	  		::Settings.reload!
 				inject_into_file 'config/environments/production.rb', after: "configure do\n" do <<-'RUBY'
 
 	config.action_mailer.perform_deliveries = true
@@ -86,7 +103,8 @@ module JsonVoorhees
 	  password:             ENV['GMAIL_PASSWORD'],
 	  authentication:       'plain',
 	  enable_starttls_auto: true  }
-				
+	#May need to set Paperclip defaults here
+
 				RUBY
 				end
 	  	end

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

@@ -6,7 +6,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>
     it "Gets all of the <%= resource_singular %>s" do
@@ -23,7 +23,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>/1
     it "Gets a <%= resource_singular %> by id" do
@@ -38,7 +38,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # post /api/<%= api_version %>/<%= resource_plural %>
     it "Creates <%= resource_singular %>" do
@@ -55,7 +55,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # patch/put /api/<%= api_version %>/<%= resource_plural %>/1
     it "Updates <%= resource_singular %>" do
@@ -74,7 +74,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # delete /api/<%= api_version %>/<%= resource_plural %>/1
     it "Deletes <%= resource_singular %>" do
@@ -97,7 +97,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # get /api/1/collection
     it "checks response of a collection route" do
@@ -111,7 +111,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     it "checks the index json sent back" do
 
@@ -124,7 +124,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:fbuser_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token}
+      @header = {::Settings.token_header => token}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>/1
     it "checks for a 404" do

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

@@ -6,7 +6,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>
     it "Gets all of the <%= resource_singular %>s" do
@@ -23,7 +23,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>/1
     it "Gets a <%= resource_singular %> by id" do
@@ -38,7 +38,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # post /api/<%= api_version %>/<%= resource_plural %>
     it "Creates <%= resource_singular %>" do
@@ -55,7 +55,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # patch/put /api/<%= api_version %>/<%= resource_plural %>/1
     it "Updates <%= resource_singular %>" do
@@ -74,7 +74,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # delete /api/<%= api_version %>/<%= resource_plural %>/1
     it "Deletes <%= resource_singular %>" do
@@ -97,7 +97,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # get /api/1/collection
     it "checks response of a collection route" do
@@ -111,7 +111,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     it "checks the index json sent back" do
 
@@ -124,7 +124,7 @@ RSpec.describe ::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>
     before(:example) do
       @user = FactoryGirl.create(:people_user_1)
       token = @user.tokens[0].auth_token
-      @header = {"Auth-Token" => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>/1
     it "checks for a 404" do

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

@@ -124,18 +124,18 @@ module JsonVoorhees
         gem 'annotate', ">=2.6.0"
         gem 'rspec-rails', '~> 3.0.0'
         gem 'byebug', '~> 3.2.0'
-        gem "factory_girl_rails", "~> 4.0"
-        gem "database_cleaner", '~> 1.3.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 
+        gem 'better_errors', '~> 1.1.0'
+        gem 'binding_of_caller', '~> 0.7.1' # needed by better_errors or variable inspection 
       end
       # Other gems
       # This ties in nicely with Ember, 0.8.0 is the stable version
-      gem "active_model_serializers", "~> 0.8.0"
+      gem 'active_model_serializers', '~> 0.8.0'
       # This is the api of choice now
-      gem "rails-api"
+      gem 'rails-api'
       gem 'kaminari'
       gem 'bcrypt', '~> 3.1.7'
       gem 'type_cartographer'
@@ -149,6 +149,9 @@ module JsonVoorhees
       gem 'whenever', :require => false
       gem 'rack-cors', :require => 'rack/cors'
       gem 'httparty'
+      gem 'paperclip', '~> 4.2'
+      gem 'aws-sdk', '~> 1.5.7'
+      gem 'rails_config', '~> 0.4.2'
       #gem 'websocket-rails'
     end
 

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

@@ -1,13 +1,20 @@
 class Api::V1::ApiController < ::ActionController::API
 
+  #before_action :authenticate_app
   before_action :authenticate_user
 
   private
 
+    #def authenticate_app
+    #end
+
     def authenticate_user
       set_hash
       if @instance_hash.nil?
+        response.headers["Logged-In-Status"] = "false"
         render :json => {errors: "User is not logged in, register or log in"} , status: :unauthorized
+      else
+        response.headers["Logged-In-Status"] = "true"
       end
     end
 
@@ -26,8 +33,8 @@ class Api::V1::ApiController < ::ActionController::API
 
     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,::Settings.token_header)
+      #@instance_hash = ::Arcadex::Authentication.authenticate_owner_with_index(params,request,"::Settings.token_header,"Email","email",true)
       #Ignore the token if the user's account is locked
       <% if !options.fbonly? %> 
       if !current_user.nil? && current_user.locked

data/lib/json_voorhees/version.rb

@@ -1,3 +1,3 @@
 module JsonVoorhees
-  VERSION = "1.4.1"
+  VERSION = "1.4.2"
 end

metadata

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