api_presenter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e411385a8bd85df6bc3efe9f1ec418d5608f26f
-  data.tar.gz: a7da14574b9aabd4501edafd1555feb16246ff05
+  metadata.gz: 0ac6c35bce2e92fb4729a274a36dd3e8def81451
+  data.tar.gz: ff79c2727b4dd200a6d8346d3362af4f689193fc
 SHA512:
-  metadata.gz: 810bfdd0b1932949b0d6984ac1b0935467de3e5d27858f05890b906447aa2124fc0beee23c0cf95a5d624df168a2e20eb2b38d567650c685e291a905724859a4
-  data.tar.gz: 29e3508ed61708ae44f7f4470e9687a0131d0e56a991b307ba1519ebd6b6755d92ff7903a26f7af6d25b6bd78d8f62b4a742332439d5b9b758f6bfc08e65f583
+  metadata.gz: 419305783b53de4985e852d0d69a6d8a8f39dfbe9b5255e0b6fef4e6fab9d8832bf6a75b3d0ef575a372c3d6e83e4dce9377adaf05eceabb79e630da9a933269
+  data.tar.gz: a1edcba953b05ebe0d699db1d336dc49c70cdefd54129a25b57589b32498049d4478c9617ff38b2b925c4b7bbce8a4b43a05e44a8218d2584c2ad17df4875dbb

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.0 (2016-11-09)
+
+Adds configuration options and generator.
+
 ## 0.2.4 (2016-11-07)
 
 Logical restructure. No API changes.

data/README.md

@@ -52,16 +52,22 @@ class User < ActiveRecord::Base
 end
 ```
 
+When requesting posts from the API, a client may also want any or all of the posts' categories, sub categories, and users. It may also want the current user's policies for the posts to generate correct UI.
+
 ### 0. Generate config file
 
 `rails g api_presenter:config`
 
-Generates a configuration file that allows you to override the default querystring params used by the `presenter` concern. More to come.
+Generates a configuration file that allows you to override the default querystring params used by the `presenter` concern. More configuration options coming soon.
 
 ### 1. Create your Presenter
 
+Using the supplied generator, generate a presenter class for your ActiveRecord model. The generator will also generate a convenient `ApplicationApiPresenter` class for centralized methods.
+
+`rails g api_presenter:presenter post`
+
 ```ruby
-class PostPresenter < ApiPresenter::Base
+class PostPresenter < ApiApplicationController
   def associations_map
     {
       categories:     { associations: { sub_category: :category } },
@@ -80,7 +86,7 @@ class PostPresenter < ApiPresenter::Base
 end
 ```
 
-Presenters can define up to three methods:
+Presenters have three opt-in methods:
 
 * `associations_map` The business-dictated includable resources for the ActiveRecord model (`Post`, in this case). Consists of the model name as key and traversal required to preload/load them. In most cases, the value of `associations` will correspond directly to associations on the primary model.
 * `policy_methods` A list of Pundit policy methods to resolve for the primary collection if policies are requested.
@@ -90,7 +96,7 @@ Presenters can define up to three methods:
 
 Your presentable collection can be an `ActiveRecord::Relation`, an array of records, or even a single record. Just call `present` on it from your controller action. The preloads will be performed, and the included collections/policies will be available in the `@presenter` instance variable.
 
-The following querystring params are used by the supplied controller concern's `present` method:
+The following configurable querystring params are used by the supplied controller concern's `present` method:
 
 * `count [Boolean]` Pass true if you just want a count of the primary collection
 * `policies [Boolean]` Pass true if you want to resolve policies for the primary collection records
@@ -107,6 +113,7 @@ class PostsController < ApplicationController
   #   GET /posts?include=categories,subCategories,users&policies=true
   #
   def index
+    authorize Post
     posts = PostQuery.records(current_user, params)
     present posts
   end
@@ -115,8 +122,9 @@ class PostsController < ApplicationController
   #   GET /posts/:id?include=categories,subCategories,users&policies=true
   #
   def show
-    post = Post.find(params[:id])
-    present post
+    @post = Post.find(params[:id])
+    authorize @post
+    present @post
   end
 end
 ```
@@ -125,11 +133,11 @@ end
 
 How you ultimately render the primary collection and the data produced by ApiPresenter is up to you. `@presenter` has the following properties:
 
-* `collection` The primary collection that was passed into the presenter.
-* `total_count` When using Kaminari or another pagination method that defines a `total_count` property, returns unpaginated count. If the primary collection is not an `ActiveRecord::Relation`, simply returns the number of records.
-* `included_collection_names` Convenience method that returns an array of included collecton model names.
-* `included_collections` A hash of included collections, consisting of the model name and corresponding records.
-* `policies` An array of resolved policies for the primary collection.
+* `collection [Array<ActiveRecord::Base>]` The primary collection that was passed into the presenter. Empty if count requested.
+* `total_count [Integer]` When using Kaminari or another pagination method that defines a `total_count` property, returns unpaginated count. If the primary collection is not an `ActiveRecord::Relation`, simply returns the number of records.
+* `included_collection_names [Array<Symbol>]` Convenience method that returns an array of included collecton model names.
+* `included_collections [Hash]` A hash of included collections, consisting of the model name and corresponding records.
+* `policies [Array<Hash>]` An array of resolved policies for the primary collection.
 
 Here's an example of how you might render this using JBduiler:
 
@@ -318,7 +326,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_presenter.
+Bug reports and pull requests are welcome on GitHub at https://github.com/uberllama/api_presenter.
 
 
 ## License

data/lib/api_presenter/version.rb

@@ -1,3 +1,3 @@
 module ApiPresenter
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/generators/api_presenter/config/USAGE

@@ -1 +1,8 @@
-Creates configuration file
+Description:
+    Generates configuration filee.
+
+Example:
+    rails generate api_presenter:config
+
+    This will create:
+        config/initializers/api_presenter.rb

data/lib/generators/api_presenter/config/config_generator.rb

@@ -4,7 +4,7 @@ module ApiPresenter
       source_root File.expand_path('../templates', __FILE__)
 
       def copy_config_file
-        copy_file 'api_presenter_config.rb', 'config/initializers/api_presenter_config.rb'
+        copy_file('config.rb', 'config/initializers/api_presenter.rb')
       end
     end
   end

data/lib/generators/api_presenter/presenter/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates an API presenter for an ActiveRecord model with the given name, and a base class ApplicationApiPresenter unless already exists.
+
+Example:
+    rails generate api_presenter:presenter post
+
+    This will create:
+      app/presenters/application_api_presenter.rb
+      app/presenters/post_presenter.rb

data/lib/generators/api_presenter/presenter/presenter_generator.rb

@@ -0,0 +1,17 @@
+module ApiPresenter
+  module Generators
+    class PresenterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_application_presenter
+        unless File.exist?('app/presenters/application_api_presenter.rb')
+          copy_file('application_presenter.rb', 'app/presenters/application_api_presenter.rb')
+        end
+      end
+
+      def create_presenter
+        template('presenter.rb', File.join('app/presenters', class_path, "#{file_name}_presenter.rb"))
+      end
+    end
+  end
+end

data/lib/generators/api_presenter/presenter/templates/application_presenter.rb

@@ -0,0 +1,2 @@
+class ApplicationApiPresenter < ApiPresenter::Base
+end

data/lib/generators/api_presenter/presenter/templates/presenter.rb

@@ -0,0 +1,13 @@
+class <%= class_name %>Presenter < ApplicationApiPresenter
+  def associations_map
+    {}
+  end
+
+  def policy_methods
+    []
+  end
+
+  def policy_associations
+    []
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_presenter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuval Kordov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,7 +139,11 @@ files:
 - lib/api_presenter/version.rb
 - lib/generators/api_presenter/config/USAGE
 - lib/generators/api_presenter/config/config_generator.rb
-- lib/generators/api_presenter/config/templates/api_presenter_config.rb
+- lib/generators/api_presenter/config/templates/config.rb
+- lib/generators/api_presenter/presenter/USAGE
+- lib/generators/api_presenter/presenter/presenter_generator.rb
+- lib/generators/api_presenter/presenter/templates/application_presenter.rb
+- lib/generators/api_presenter/presenter/templates/presenter.rb
 homepage: http://github.com/uberllama/api_presenter
 licenses:
 - MIT