json_voorhees 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71a66abefa5a85831ef4bbf9510d25bcf38dddb5
-  data.tar.gz: 56ccfc8f14228a4075ef1e7d3e91ee2023040229
+  metadata.gz: f0a3783e034387e3b3fe1ffa96110dc1dc046899
+  data.tar.gz: d5ffcdf7ba7141709a132bd81888c0137fe086bd
 SHA512:
-  metadata.gz: e58f8950a27547257cab1183a88bbdf9fbc9dbe7cd5c747f2cb447a9c41858941fe9ed37d6d96d1be8a3707a2c7b073f00fb0b4f11bae47bc1986ce05682e5b1
-  data.tar.gz: 43e0f16175df29d0d4eed85c1c2c9ed5a633e349ee7c48dfa544c10f1b6ceb6522a67c1f14150a3ace2c091e5f8ce2b4bd242632b00b03cfc2d21b35885827df
+  metadata.gz: b0cb1d59e6ea52d8e292f2a545a7c1d1c6d9d1e916edf9e9b158e02fa607b197b45f530a0f85c68c296487dcded0e329bdd64be2f350343ea2814f58fe90dcf3
+  data.tar.gz: d3c3cac26a0cea3e6db719b52d7ee2e9a1af425177f18ea033b3078edf0f5b1459d1c418525661831a3612217667b6a5cc779fcd50caf3e2950fa3e5e8fbd5d0

data/README.md

@@ -1,11 +1,11 @@
-# JsonVoorhees 1.4.9
+# JsonVoorhees 1.5.0
 
 ## Introduction
 
 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.
+such as token authentication. It builds in a scalable solution for authorizations. All controller actions are before filtered into a method that takes as arguments the current user, the parameters and current object. As a bonus, when the object is ready to be serialized, every attribute and association implements active model serializers include? method. Both controller and serializer consult the corresponding method in the created authorizations gem. This leaves the controller and serializer slim and all of the authorizations in one spot. You can be as granular as you want to be. Since tests are already set up for you, it makes implementing your features a breeze. Enjoy!
 
 ## Scaffold Use
 
@@ -54,8 +54,31 @@ rails g json_voorhees:massive_scaffold chat message 1 user_id:integer message:te
 
 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.
 
+### Test it out
+
+After creating your rails app and including the json_voorhees gem,
+cd into your directory and run this command. Explore the files to see
+what it does for you.
+
+```bash
+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 &&
+rails g json_voorhees:massive_scaffold ocean pacific 1 fun:boolean description:string &&
+rake railties:install:migrations && 
+rake db:migrate RAILS_ENV=development && 
+rake db:migrate RAILS_ENV=test && 
+rake db:migrate RAILS_ENV=production &&
+rspec
+```
+
 ## Gotchas and Reminders
 
+JsonVoorhees is only tested on rails apps from 4 - 4.1.6 but
+it should work on anything below 4.2. 4.2 finally includes some
+commonly used gems so it throws an error when JsonVoorhees tries
+to include it again. I'll write up a list of these offenders later.
+
 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
@@ -82,12 +105,15 @@ the defaults.
 
 Does not work with Rails 4.2 yet. Byebug is added by default and this generator tries to add it twice so it fails.
 
+##Bugs
+
+Serializer doesn't call the correct method for attributes
+
 ##Future
 
 1. Sidekiq
 2. Paperclip
 3. Websockets
-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 use the sidekiq adapter.

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

@@ -19,7 +19,7 @@ module <%= module_camel %>
 
   <% attributes.each do |pair| %>
     def include_<%= pair.split(/:/)[0] %>?
-      return ::Authorization::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>.include_created_at?(current_user,object,@options)
+      return ::Authorization::<%= module_camel %>::V<%= api_version %>::<%= resource_camel %>.include_<%= pair.split(/:/)[0] %>?(current_user,object,@options)
     end
   <% end %>
     def include_created_at?

data/lib/json_voorhees/version.rb

@@ -1,3 +1,3 @@
 module JsonVoorhees
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

metadata

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