api_presenter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4779e47afef65722b830ee6c85455f3f9853cf40
+  data.tar.gz: f5b677a9c48fcac592de8b9e7e631f06924e3dd5
+SHA512:
+  metadata.gz: 5f3a9f458b103dbadea74c3844b129a53a9328af660e0bdca3215183c0ceccd92d97c9bc0a76050e1a0e6fcb13e331dcb9bc09a193d16041db20fa3b4baa181e
+  data.tar.gz: 91e99b5f3919c87cad9997a8d6341dd3cd613894c5f986e2a7b0feb1d47ca7a00c4f8d7bbfef3d5bf832fd3158b12f5415f4d6b4b3c59ac5e4248858862a3249

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_presenter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yuval Kordov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,244 @@
+# ApiPresenter
+
+A much longer readme is coming, including best practices and cautions, but in the meantime lets keep it simple...
+
+When creating RESTful APIs for web or mobile clients, there are a couple of common use cases that have emerged:
+
+* Allow inclusion of associated data to mitigate number of requests
+* Include permissions so that the client can intelligently draw its UI (ex: edit/delete buttons), while maintaining a single source of truth
+
+ApiPresenter does both of these things, plus a bit more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_presenter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_presenter
+
+## Usage
+
+We'll use a simple blog as the usage example for this gem. The blog has the following model structure:
+
+```ruby
+class Category < ActiveRecord::Base
+  has_many :sub_categories
+  has_many :posts, through: :sub_categories
+end
+
+class SubCategory < ActiveRecord::Base
+  belongs_to :category
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :sub_category
+  belongs_to :creator, class_name: 'User'
+  belongs_to :publisher, class_name: 'User'
+end
+
+class User < ActiveRecord::Base
+  has_many :created_posts, class_name: 'Post', foreign_key: 'creator_id'
+  has_many :published_posts, class_name: 'Post', foreign_key: 'publisher_id'
+end
+```
+
+When clients request posts (the primary collection), they may want any or all of the above data for those posts.
+
+### Create your Presenter
+
+```ruby
+class PostPresenter < ApiPresenter::Base
+  def associations_map
+    {
+      categories:     { associations: { sub_category: :category } },
+      sub_categories: { associations: :sub_category },
+      users:          { associations: [:creator, :publisher] }
+    }
+  end
+
+  def policy_methods
+    [:update, :destroy]
+  end
+
+  # def policy_associations
+  #   :user_profile
+  # end
+end
+```
+
+Presenters can define up to three methods:
+
+* `associations_map` The includable resources for the ActiveRecord model (Post, in this case). Consists of the model name as key and traversla 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.
+* `policy_associations` Additional records to preload in order to optimize policies that must traverse asscoiations.
+
+### Enable your controllers
+
+ApiPresenter provides a controller concern that executes the Presenter. This process analyzes your params, preloads records as needed, and produces a `@presenter` object you can work with.
+
+```ruby
+class ApplicationController
+  include ApiPresenter::Concerns::Presentable
+end
+
+class PostsCOntroller < ApplicationController
+  def index
+    posts = PostQuery.records(current_user, params)
+    present posts
+  end
+
+  def show
+    post = Post.find(params[:id])
+    present post
+  end
+end
+```
+
+### Render the result
+
+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.
+
+Here's an example of how you might render this using JBduiler:
+
+### api/posts/index.json.jbuilder
+
+```ruby
+json.posts(@presenter.collection) do |post|
+  json.partial!(post)
+end
+json.partial!("api/shared/included_collections_and_meta", presenter: @presenter)
+```
+
+### api/shared/included_collections_and_meta
+
+```ruby
+presenter.included_collections.each do |collection_key, collection|
+  json.set!(collection_key, collection) do |record|
+    json.partial!(record)
+  end
+end
+
+json.meta do
+  json.total_count(presenter.total_count)
+  json.policies presenter.policies
+end
+```
+
+## Advanced Usage
+
+### Conditional includes
+
+There are a number of ways you can conditionally include resources, depending, for insatnce, on user type.
+
+#### Add conditions inside `associations_map` method
+
+```ruby
+class PostPresenter < ApiPresenter::Base
+  def associations_map
+    current_user.admin? ? admin_associations_map : user_associations_map
+  end
+
+  private
+
+  def user_associations_map
+    {
+      sub_categories: { associations: :sub_category },
+      users:          { associations: [:creator, :publisher] }
+    }
+  end
+
+  def admin_associations_map
+    {
+      categories:     { associations: { sub_category: :category } },
+      sub_categories: { associations: :sub_category },
+      users:          { associations: [:creator, :publisher] }
+    }
+  end
+end
+```
+
+#### Use `condition` property within `association_map` definition
+
+Via inline string:
+
+```ruby
+class PostPresenter < ApiPresenter::Base
+  def associations_map
+  {
+    categories:     { associations: { sub_category: :category }, condition: 'current_user.admin?' },
+    sub_categories: { associations: :sub_category },
+    users:          { associations: [:creator, :publisher] }
+  }
+  end
+end
+```
+
+Via method call:
+
+```ruby
+class PostPresenter < ApiPresenter::Base
+  def associations_map
+  {
+    categories:     { associations: { sub_category: :category }, condition: :admin? },
+    sub_categories: { associations: :sub_category },
+    users:          { associations: [:creator, :publisher] }
+  }
+  end
+
+  private
+
+  def admin?
+    current_user.admin?
+  end
+end
+```
+
+#### Control it from your policy
+
+```ruby
+class CategoryPolicy < ApplicationPolicy
+  def index?
+    user.admin?
+  end
+end
+```
+
+## TODO
+
+* More doc
+* Decouple from Pundit
+* Make index policy checking on includes optional
+* Allow custom collection names
+* Add test helper to assert presenter was called for a given controller action
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/api_presenter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api_presenter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_presenter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_presenter"
+  spec.version       = ApiPresenter::VERSION
+  spec.authors       = ["Yuval Kordov", "Little Blimp"]
+  spec.email         = ["yuval@littleblimp.com"]
+  spec.summary       = "Return associations and policies with API responses"
+  spec.description   = "Facilitates optimized side loading of associated resources and permission policies from RESTful endpoints"
+  spec.homepage      = "http://github.com/uberllama/api_presenter"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "activesupport", ">= 3.0.0"
+  spec.add_dependency "pundit"
+  spec.add_development_dependency "activerecord", ">= 4.2.3"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_presenter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api_presenter/version.rb

@@ -0,0 +1,3 @@
+module ApiPresenter
+  VERSION = "0.1.0"
+end

data/lib/api_presenter.rb

@@ -0,0 +1,204 @@
+require 'pundit'
+require 'api_presenter/parse_include_params'
+require 'api_presenter/version'
+require 'api_presenter/concerns/presentable'
+require 'api_presenter/resolvers/base'
+require 'api_presenter/resolvers/policies_resolver'
+require 'api_presenter/resolvers/included_collections_resolver'
+
+module ApiPresenter
+  class Base
+
+    attr_reader :current_user, :params, :relation
+
+    # @example
+    #   @presenter = PostPresenter.call(
+    #     current_user: current_user,
+    #     relation:     relation,
+    #     params:       params
+    #   )
+    #
+    # @param (see #initialize)
+    #
+    # @return [ApiPresenter::Base]
+    #
+    def self.call(**kwargs)
+      new(kwargs).call
+    end
+
+    # @param current_user [User]                          Optional. current_user context.
+    # @param relation     [ActiveRecord::Relation, Array] Relation or array-wrapped record(s) to present
+    # @param params       [Hash]                          Controller params
+    # @option params      [Boolean]       :count          Optional. If true, return count only.
+    # @option params      [String, Array] :include        Optional. Associated resources to include.
+    # @option params      [Boolean]       :policies       Optional. If true, resolve polciies for relation.
+    #
+    def initialize(current_user: nil, relation:, params: {})
+      @current_user = current_user
+      @relation     = relation
+      @params       = params
+    end
+
+    # @return [ApiPresenter::Base]
+    #
+    def call
+      return self if count_only?
+      initialize_resolvers
+      call_resolvers
+      self
+    end
+
+    # Primary collection, empty if count requested
+    #
+    # @return [ActiveRecord::Relation, Array<ActiveRecord::Base>]
+    #
+    def collection
+      count_only? ? [] : relation
+    end
+
+    # Count of primary collection
+    #
+    # @note Delegate to Kaminari's `total_count` property, or regular count if not a paginated relation
+    #
+    # @return [Integer]
+    #
+    def total_count
+      relation.respond_to?(:total_count) ? relation.total_count : relation.count
+    end
+
+    # Policies for the primary collection
+    #
+    # @example
+    #   [
+    #     { post_id: 1, update: true, destroy: true },
+    #     { post_id: 2, update: false, destroy: false }
+    #   ]
+    #
+    # @return [<Array<Hash>]
+    #
+    def policies
+      @policies_resolver ? @policies_resolver.resolved_policies : {}
+    end
+
+    # Class names of included collections
+    #
+    # @example
+    #   [:categories, :sub_categories, :users]
+    #
+    # @return [Array<Symbol>]
+    #
+    def included_collection_names
+      @included_collection_names ||= ParseIncludeParams.call(params[:include])
+    end
+
+    # Map of included collection names and loaded record
+    #
+    # @example
+    #   {
+    #     categories:     [#<Category id:1>],
+    #     sub_categories: [#<SubCategory id:1>],
+    #     users:          [#<User id:1>, #<User id:2]
+    #   }
+    #
+    # @return [Hash]
+    #
+    def included_collections
+      @included_collections_resolver ? @included_collections_resolver.resolved_collections : {}
+    end
+
+    # Preload additional records with the relation
+    #
+    # @note Called by resolvers, but can also be called if additional data is required that does
+    #   not need to be loaded as an included collection, and for some reason cannot be chained
+    #   onto the original relation.
+    #
+    # @param associations [Symbol, Array<Symbol>]
+    #
+    def preload(associations)
+      @relation = @relation.preload(associations)
+    end
+
+    # Hash map that defines the sources for included collection names
+    #
+    # @example
+    #   def associations_map
+    #     {
+    #       categories:     { associations: { sub_category: :category } },
+    #       sub_categories: { associations: :sub_category },
+    #       users:          { associations: [:creator, :publisher] }
+    #     }
+    #   end
+    #
+    # @abstract
+    #
+    # @return [Hash]
+    #
+    def associations_map
+      {}
+    end
+
+    # Policy methods to resolve for the primary relation
+    #
+    # @example Single
+    #   def policy_methods
+    #     :update
+    #   end
+    #
+    # @example Multiple
+    #   def policy_methods
+    #     [:update, :destroy]
+    #   end
+    #
+    # @abstract
+    #
+    # @return [Symbol, Array<Symbol>]
+    #
+    def policy_methods
+      []
+    end
+
+    # Policy associations to preload to optimize policy resolution
+    #
+    # @example Single
+    #   def policy_associations
+    #     :user_profile
+    #   end
+    #
+    # @example Multiple
+    #   def policy_associations
+    #     [:user_profile, :company]
+    #   end
+    #
+    # @abstract
+    #
+    # @return [Symbol, Array<Symbol>]
+    #
+    def policy_associations
+      []
+    end
+
+    private
+
+    def count_only?
+      @count_only ||= !!params[:count]
+    end
+
+    def resolve_policies?
+      @resolve_policies ||= current_user && !!params[:policies]
+    end
+
+    def resolve_included_collctions?
+      included_collection_names.any?
+    end
+
+    def initialize_resolvers
+      @policies_resolver              = Resolvers::PoliciesResolver.new(self) if resolve_policies?
+      @included_collections_resolver  = Resolvers::IncludedCollectionsResolver.new(self) if resolve_included_collctions?
+    end
+
+    def call_resolvers
+      @policies_resolver.call if @policies_resolver
+      @included_collections_resolver.call if @included_collections_resolver
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: api_presenter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuval Kordov
+- Little Blimp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Facilitates optimized side loading of associated resources and permission
+  policies from RESTful endpoints
+email:
+- yuval@littleblimp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_presenter.gemspec
+- bin/console
+- bin/setup
+- lib/api_presenter.rb
+- lib/api_presenter/version.rb
+homepage: http://github.com/uberllama/api_presenter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Return associations and policies with API responses
+test_files: []