json_api_server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c194229175b097b7ccda00f8ee5ca3eae2112d0
+  data.tar.gz: 40915f4a3054c9b734b8b6b85557c7fbcca27943
+SHA512:
+  metadata.gz: 8f7719d5a686ba555f117b55d884d03738940efbfd3c6aa5938f9cc1bee2731a9289acb49656629a2ed18fc5f9c74946d1530d9da057c6feed3180c0481e37b8
+  data.tar.gz: eee640d529fa50d6cbff7947d7f43bac2cbb9167a2e1d5ea9f2ac7b7c9eb1af524356fac79d82104deb8395c8a17bbf4b3041a6aac22f7944ede4566b6a0ad72

data/.dockerignore

@@ -0,0 +1,7 @@
+.git*
+doc/*
+spec/test_app/tmp/*
+spec/test_app/log/*
+.tags*
+*.gem
+erl_crash.dump

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/test_app/log/*
+/spec/test_app/tmp/*
+.tags*
+*.gem
+erl_crash.dump

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# inherit_from: .rubocop_todo.yml
+AllCops:
+  Exclude:
+    - 'spec/test_app/*'
+Metrics/LineLength:
+  Max: 150
+  Exclude:
+    - 'spec/**/*'
+Lint/DuplicatedKey:
+  Exclude:
+    - 'spec/controller/filter_spec.rb'
+Metrics/BlockLength:
+  CountComments: false
+  Exclude:
+    - 'json_api_server.gemspec'
+    - 'spec/**/*'
+Lint/UselessComparison:
+  Exclude:
+    - 'spec/json_api_server/attributes_builder_spec.rb'
+    - 'spec/json_api_server/relationships_builder_spec.rb'
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+Metrics/CyclomaticComplexity:
+  Max: 9
+Metrics/AbcSize:
+  Max: 25
+Style/GuardClause:
+  Exclude:
+    - 'lib/json_api_server/filter_builders.rb'
+    - 'lib/json_api_server/pagination.rb'
+    - 'lib/json_api_server/relationships_builder.rb'
+    - 'lib/json_api_server/validation_errors.rb'
+Metrics/MethodLength:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.3.3
+
+ENV GEM_HOME /home/gems/mygem
+RUN mkdir -p $GEM_HOME
+# https://docs.docker.com/engine/reference/builder/#workdir
+WORKDIR $GEM_HOME
+COPY . $GEM_HOME
+RUN bundle install
+# RUN cd spec/test_app &&r rake db:migrate && rake db:migrate RAILS_ENV=test

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_api_server.gemspec
+gemspec
+
+#  For pagination in test app.
+gem 'will_paginate', '~> 3.1'
+
+# For fast json serialization.
+gem 'oj', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 ed.mare
+
+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,432 @@
+# JsonApiServer
+
+This gem provides tools for building JSON APIs per http://jsonapi.org spec (1.0).
+It supports sparse fieldsets, sorting, filtering, pagination, and inclusion of
+related resources. Sorting, filtering, and inclusions are whitelisted
+so depth/complexity can be controlled.
+
+This library: (1) generates data for sorting, filtering,
+inclusions, and pagination, (2) provides serializers and helper classes for
+building the response with this data, and (3) handles/renders errors in JSON API format.
+Otherwise, you build your API as you normally do (i.e, routes, authorization,
+caching, etc.).
+
+Use at your own risk. This gem is under development and has not been used
+in production yet. Known to work with Ruby 2.3.x and Rails 5.x.
+Supports only ActiveRecord at this time.
+
+- **Example app** -> https://github.com/ed-mare/jsonapiserver-example
+- **Documentation** -> Install gem rdoc for more documentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_server
+
+## Usage
+
+Install gem rdoc for more documentation.
+
+##### 1) Include JsonApiServer::Controller::ErrorHandling in your base API controller.
+
+```ruby
+# i.e.,
+class BaseApiController < ApplicationController
+  include JsonApiServer::Controller::ErrorHandling
+end
+```
+
+It provides methods which render errors per http://jsonapi.org/format/#errors:
+
+- `render_400`, `render_401`, `render_404`, `render_409`, `render_422`, `render_500`,
+`render_unknown_format`, `render_503`.
+
+It rescues from and renders JSON API errors for:
+
+- StandardError (render_500)
+- JsonApiServer::BadRequest (render_400)
+- ActionController::BadRequest (render_400)
+- ActiveRecord::RecordNotFound, ActionController::RoutingError (render_404)
+- ActiveRecord::RecordNotUnique (render_409)
+- ActionController::RoutingError (render_404)
+- ActionController::UrlGenerationError (render_404)
+- ActionController::UnknownController (render_404)
+- ActionController::UnknownFormat (render_unknown_format 406)
+
+Additionally:
+
+- Use `render_422(object)` in controllers to render validation errors.
+
+Error messages are defined in 'config/locales/en.yml' and can be customized
+or redefined.
+
+i.e.,
+
+```ruby
+# Given a sandwiches controller...
+class Api::V1::SandwichesController < Api::BaseController
+    ...
+end
+
+# config/locales/en.yml
+en:
+  json_api_server:
+    controller:
+      sandwiches:
+        name: 'sandwich'
+
+# messages now become:
+# 404 => "This sandwich does not exist."
+# 409 => "This sandwich already exists."
+```
+
+##### 2) Include JsonApiServer::MimeTypes in initializers
+
+Spec: "JSON API requires use of the JSON API media type
+(application/vnd.api+json) for exchanging data."
+
+To support this mime type:
+
+```ruby
+# config/initializers/mime_types.rb
+include JsonApiServer::MimeTypes
+```
+##### 3) Configure the gem
+
+Configure the logger, base URL, serialization options and filter builders.
+
+```ruby
+# config/initializers/json_api_server.rb
+JsonApiServer.configure do |c|
+  c.base_url = 'https://www.something.com'
+  c.logger = Rails.logger
+  c.serializer_options = {
+        escape_mode: :json,
+        time: :xmlschema,
+        mode: :compat
+      }
+end
+```
+
+Optionally, set this Rails config so '`&`' is not escaped in pagination URLs:
+
+```ruby
+# application.rb
+config.active_support.escape_html_entities_in_json = false
+```
+
+##### 4) Use JsonApiServer::Builder to collect data in the controller.
+
+This class handles pagination, sorting, filters, inclusion of
+related resources, and sparse fieldsets. It collects the necessary data for the
+serializers.
+
+This class uses the following classes. See each class's rdoc for configuration options.
+
+- JsonApiServer::Pagination
+- JsonApiServer::Sort
+- JsonApiServer::Filter
+- JsonApiServer::Include
+- JsonApiServer::Fields
+
+A variety of search capabilities can be configured for model attributes with
+`JsonApiServer::Filter` - LIKE queries, ILIKE queries (Postgres), IN queries,
+comparison queries, range queries, and queries against Postgres jsonb arrays
+(case sensitive/insensitive). Plus, custom queries and custom filters can be easily
+added.
+
+**Example**:
+
+```ruby
+class TopicsController < BaseApiController
+  attr_accessor :pagination_options, :sort_options, :filter_options, :include_options
+
+  before_action do |c|
+    # Set a limit on the maximum number of records a user can request per page.
+    # Set the default number of records per page.
+    c.pagination_options = { default_per_page: 10, max_per_page: 60 }
+
+    # Whitelist sortable attributes and set default sort.
+    c.sort_options = {
+       permitted: [:character, :location, :published],
+       default: { id: :desc }
+    }
+
+    # Whitelist filters and configure how to perform the query. There are built-in
+    # query builder classes and custom classes can be plugged in.
+    c.filter_options = [
+       { id: { type: 'Integer' } },
+       { published: { type: 'Date' } },
+       :location,
+       { book: { wildcard: :both } }
+    ]
+
+    # Whitelist inclusions and optionally configure eagerloading.
+    c.include_options = [
+                          {'publisher': -> { includes(:publisher) }},
+                          {'comments': -> { includes(:comments) }},
+                          'comment.author'
+                        ]
+  end
+
+  def index
+    # collect the data
+    builder = JsonApiServer::Builder.new(request, Topic.current)
+     .add_pagination(pagination_options)
+     .add_filter(filter_options)
+     .add_include(include_options)
+     .add_sort(sort_options)
+     .add_fields
+
+   # pass the data to the serializer
+   serializer = TopicsSerializer.from_builder(builder)
+   render json: serializer.to_json, status: :ok
+  end
+
+  def show
+    builder = JsonApiServer::Builder.new(request, Topic.find(params[:id]))
+     .add_include(['publisher', 'comments', 'comments.includes'])
+     .add_fields
+
+    serializer = TopicSerializer.from_builder(builder)
+    render json: serializer.to_json, status: :ok
+  end
+
+  def create
+    topic = Topic.new(topic_params)
+
+    if topic.save
+       serializer = TopicSerializer.new(topic)
+       render json: serializer.to_json, status: :created
+    else
+       render_422(topic)  # return validation errors in JSON API format.
+    end    
+  end
+
+  protected
+
+  def topic_params
+    params.require(:data)
+          .require(:attributes)
+          .permit(:character, :book, :quote, :location, :published,
+                  :author, :publisher_id)
+  end
+
+end
+```
+
+##### 5) Create Serializers
+
+JsonApiServer serializers use the oj gem (https://github.com/ohler55/oj), a fast JSON parser
+and Object marshaller. Helper classes
+JsonApiServer::AttributesBuilder (sparse fieldsets), JsonApiServer::RelationshipsBuilder
+(relationships/included), JsonApiServer::Paginator (pagination), and JsonApiServer::MetaBuilder (meta)
+ assist with populating serializers.
+
+Caching is not built into the serializers
+given the variability of JSON API documents. Low level caching is recommended.
+
+---
+
+All serializers inherit from JsonApiServer::BaseSerializer. It creates this structure:
+
+```ruby
+{
+ ":jsonapi": {
+   ":version": "1.0"
+ },
+ ":links": null,
+ ":data": null,
+ ":included": null,
+ ":meta": null
+}
+```
+
+Sometimes only part of document is needed, i.e., when embedding one serializer in another.
+`as_json` takes an optional hash argument which determines which parts of the document to return.
+These options can also be set in JsonApiServer::BaseSerializer#as_json_options.
+
+```ruby
+serializer.as_json(include: [:data]) # => { data: {...} }
+serializer.as_json(include: [:links]) # => { links: {...} }
+serializer.as_json(include: [:links, :data]) # =>
+# {
+#   links: {...},
+#   data: {...}
+# }
+```
+
+---
+
+JsonApiServer::ResourceSerializer inherits from JsonApiServer::BaseSerializer.
+It is intended for a single resource (i.e, comment, author). Instantiate with a
+JsonApiServer::Builder instance:
+
+**Example**:
+
+```ruby
+class TopicSerializer < JsonApiServer::ResourceSerializer
+  resource_type 'topics'
+
+  def links
+    { self: File.join(base_url, "/topics/#{@object.id}") }
+  end
+
+  def data
+    {
+      type: self.class.type,
+      id: @object.id,
+      attributes: attributes,
+      relationships: inclusions.relationships
+    }
+  end
+
+  def included
+    inclusions.included
+  end
+
+  protected
+
+  def attributes
+    attributes_builder
+      .add_multi(@object, 'book', 'author', 'quote', 'character')
+      .add('location', @object.location)
+      .add('published', @object.published)
+      .add('created_at', @object.created_at.try(:iso8601, 9))
+      .add('updated_at', @object.updated_at.try(:iso8601, 9))
+      .attributes
+  end
+
+  # Example: provide different ways of accessing the same relationship data:
+  #
+  # 1) 'comments' puts all data in the relationship (easier to walk the tree).
+  # 2) 'comments.includes' puts data in the included section and relationship
+  # links to it.
+  def inclusions
+    @inclusions ||= begin
+      if relationship?('publisher')
+        relationships_builder.relate('publisher', publisher_serializer(@object.publisher))
+      end
+      if relationship?('comments')
+        relationships_builder.relate_each('comments', @object.comments) { |c| comment_serializer(c) }
+      elsif relationship?('comments.includes')
+        relationships_builder.include_each('comments.includes', @object.comments, type: 'comments',
+            relate: {include: [:relationship_data]}) { |c| comment_serializer(c) }
+      end
+
+      relationships_builder
+    end
+  end
+
+  # Pass includes and fields to child serializers.
+  def publisher_serializer(publisher, as_json_options=nil)
+    PublisherSerializer.new(publisher, includes: includes, fields: fields,
+      as_json_options: as_json_options || {include: [:data]})
+  end
+
+  # Pass includes and fields to child serializers.
+  def comment_serializer(comment, as_json_options=nil)
+    CommentSerializer.new(comment,  includes: includes, fields: fields,
+      as_json_options: as_json_options || {include: [:data]})
+  end
+end
+
+# instantiate in controller...
+builder = JsonApiServer::Builder.new(request, Topic.find(params[:id]))
+ .add_include(['publisher', 'comments', 'comments.includes'])
+ .add_fields
+serializer = TopicSerializer.from_builder(builder)
+```
+
+Helper methods:
+
+- JsonApiServer::ResourceSerializer#attributes_builder -- returns an instance of
+JsonApiServer::AttributesBuilder for the 'type' specified in `resource_type`.
+- JsonApiServer::ResourceSerializer#meta_builder -- returns an instance of
+JsonApiServer::MetaBuilder for building the meta section.
+- JsonApiServer::ResourceSerializer#relationships_builder -- returns an instance of
+JsonApiServer::RelationshipsBuilder with whitelisted includes.
+- JsonApiServer::ResourceSerializer#relationship? -- returns true if relationship is
+requested.
+- JsonApiServer::ResourceSerializer#inclusions? -- returns true if inclusions are
+requested.
+---
+
+JsonApiServer::ResourcesSerializer inherits from JsonApiServer::ResourceSerializer.
+It serializes a collection of objects with a specified serializer and merges them.
+It populates the links section with pagination URLs if JsonApiServer::Builder#add_pagination
+is called.
+
+**Example**:
+
+```ruby
+class TopicSerializer < JsonApiServer::ResourceSerializer
+  ...
+end
+
+class TopicsSerializer < JsonApiServer::ResourcesSerializer
+  serializer TopicSerializer # serializer for objects
+end
+
+builder = JsonApiServer::Builder.new(request, Topic.current)
+ .add_pagination(pagination_options)
+ .add_filter(filter_options)
+ .add_include(include_options)
+ .add_sort(sort_options)
+ .add_fields
+
+serializer = TopicsSerializer.from_builder(builder)
+```
+
+## Development
+
+1. Build the docker image:
+
+```shell
+docker-compose build
+```
+
+2. Start docker image with an interactive bash shell:
+
+```shell
+docker-compose run --rm gem
+```
+
+3. Once in bash session, code, run tests, start console, etc.
+
+```shell
+# run console with gem loaded
+bundle console
+
+# run tests - to be run from root of gem
+bundle exec rspec
+
+# generate rdoc
+rdoc --main 'README.md' --exclude 'spec' --exclude 'bin' --exclude 'Gemfile' --exclude 'Dockerfile' --exclude 'Rakefile'
+```
+
+## Todo
+
+- Test against multiple rubies/rails.
+- Clean up tests, esp. as_json which are brittle.
+- Test against Postgres.
+- Support Mongoid.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ed-mare/json_api_server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).