json_voorhees 1.4.2 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85db652f4df886f9e564573f69313155cc208c09
-  data.tar.gz: 5c34d2f12abcff0f7619146d7b3f49b75de9d5db
+  metadata.gz: c6f2eab0df10d6e1e8ad40dc83e8102b3fe18675
+  data.tar.gz: f7f6418c6be9c0bc139c57af5c8c61c056f10a78
 SHA512:
-  metadata.gz: d53425a719f8ee49b347cd07f9ab52bd99febbec580557986f64b33110c4056ff92c6763240801fe0a201b57b758dff9a6f0fe070587aa4ed7fe0e5b6de2a9e7
-  data.tar.gz: 709fa8e55311d4f7d4f09252f0348072ee8a902cb706824d7a932cf5251bd7c711c3790fa7c0551764e232b72a4d91fe8453d12dfc1258db10ffa7fb91a3528e
+  metadata.gz: 27c697b7b514b85030cb972a84bc1aec83112e9c46b9dc60b64de4b35147db7abaea155ec24e3508d73203e76ca87c6267ca83bb08bde8b715064fa629243b01
+  data.tar.gz: 89e6cbe41f549e99f9104fb984f7dcfe2edbd4e26d7e460caf18c9e3e3f5ddc712d0d244210edc02604e7c35dbaabce12e3985b4005b4a7be13a2a102c5552dd

data/README.md

@@ -1,4 +1,4 @@
-# JsonVoorhees 1.4.2
+# JsonVoorhees 1.4.5
 
 ## Introduction
 
@@ -56,6 +56,15 @@ I usually set the app up, and then design the database. I make a list of all the
 
 ## Gotchas and Reminders
 
+After authenticating the user, routes will by default require the users token
+to be sent with every request. This can be disabled by skipping the filter in 
+the controller. If you want to set the user optionally, call set_hash. It wont
+return an error if the user can't be authenticated. In addition, every request
+to the api will need the api token sent with it. It can exist in either the
+headers or params hash. Look at the settings file in config to see what the 
+default header and keys are. In production, make sure this key is set to
+something different and remove it from version control.
+
 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 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.
@@ -76,4 +85,4 @@ Does not work with Rails 4.2 yet. Byebug is added by default and this generator
 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.
+implement that interface and use the sidekiq adapter.

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

@@ -15,7 +15,20 @@ module JsonVoorhees
 	  	def createSettings
 	  		run "rails g rails_config:install"
 				prepend_to_file 'config/settings.yml' do
-"token_header: \"Auth_Token\"\napi_header: \"Api_Token\"\n"
+"token_header: \"Auth_Token\"\nmain_api_header: \"Main_Api_Header\"\n"
+				end
+				createEnvSettings
+	  	end
+
+	  	def createEnvSettings
+				prepend_to_file 'config/settings/development.yml' do
+	"main_api_key: \"123456789\"\n"
+				end
+				prepend_to_file 'config/settings/test.yml' do
+	"main_api_key: \"123456789\"\n"
+				end
+				prepend_to_file 'config/settings/production.yml' do
+	"main_api_key: \"123456789\"\n"
 				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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token}
+      @header = {::Settings.token_header => token, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     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 = {::Settings.token_header => token, "Email" => @user.email}
+      @header = {::Settings.token_header => token, "Email" => @user.email, ::Settings.main_api_header => ::Settings.main_api_key}
     end
     # get /api/<%= api_version %>/<%= resource_plural %>/1
     it "checks for a 404" do

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

@@ -9,7 +9,7 @@ module JsonVoorhees
 		def sprint
 			run "rails g json_voorhees:app_make_authorizations #{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(" ")}"
+				run "rails g json_voorhees:app_make_tests #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")} --fbonly"
 			else
 				run "rails g json_voorhees:app_make_tests #{module_name} #{resource_name} #{api_version} #{attributes.join(" ")}"
 			end

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

@@ -1,12 +1,16 @@
 class Api::V1::ApiController < ::ActionController::API
 
-  #before_action :authenticate_app
+  before_action :authenticate_app
   before_action :authenticate_user
 
   private
 
-    #def authenticate_app
-    #end
+    def authenticate_app
+      api_key = ::Arcadex::Header.grab_param_header(params,request,::Settings.main_api_header,false)
+      if api_key.nil? || api_key != ::Settings.main_api_key
+        render :json => {errors: "App is not authorized"} , status: :forbidden
+      end
+    end
 
     def authenticate_user
       set_hash

data/lib/json_voorhees/version.rb

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

metadata

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