jbuilder-json_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ff4461806b35c5a3d74588a69c25b2114cb229f
+  data.tar.gz: 14b6437c8ca3707ee94b7ecea417655976fb06d8
+SHA512:
+  metadata.gz: 243d498cce513d4794dfa8babe42ee888f102b5dd328679bf923873597d5c4232425bcb67d329ed5a69ef3808e244066466b4133412b27709ee847ba21d23fc0
+  data.tar.gz: 297d98968a8d93e6628f309e5b21ad9954216327dca0d4962405233c540496f60a588d60a7cca8ba1ce226ecca74d1a356012fe8f42781d54c50e9d14e78b733

data/README.md

@@ -0,0 +1,77 @@
+# Jbuilder::JsonApi | [![Build Status](https://travis-ci.org/vladfaust/jbuilder-json_api.svg?branch=master)](https://travis-ci.org/vladfaust/jbuilder-json_api) [![Code Climate](https://codeclimate.com/github/vladfaust/jbuilder-json_api/badges/gpa.svg)](https://codeclimate.com/github/vladfaust/jbuilder-json_api) [![Test Coverage](https://codeclimate.com/github/vladfaust/jbuilder-json_api/badges/coverage.svg)](https://codeclimate.com/github/vladfaust/jbuilder-json_api/coverage)
+
+Adds a `json.api_format!(resources)` method to quickly represent a resource or collection in a valid [JSON API](http://jsonapi.org/) format without any new superclasses or weird setups. Set'n'go! :rocket:
+
+## Motivation
+
+Official JSON API [implementations page](http://jsonapi.org/implementations/#server-libraries-ruby) shows us a variety of different serializers and other heavy-weight stuff. I' in love with [Jbuilder](https://github.com/rails/jbuilder), as it allows to format json responses with ease. Therefore I wanted to connect Jbuilder and JsonApi.org specs.
+
+I'd like to notice that there already is one gem called [jbuilder-jsonapi](https://github.com/csexton/jbuilder-jsonapi) by [csexton](https://github.com/csexton), but it adds a links helper only. It's not enough for me! :facepunch:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jbuilder-json_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jbuilder-json_api
+
+## Usage
+
+Replace any content within any `*.json.jbuilder` file with the code below:
+```ruby
+# Common example
+json.api_format! @resources, @errors, meta: @meta, access_level: @user_access_level
+
+# Articles w/o meta or access levels example
+json.api_format! @articles, @errors
+```
+You can also render formatted JSON straight from controller actions:
+```ruby
+respond_to do |f|
+    f.json { render layout: false, json: JSON.parse(JbuilderTemplate.new(view_context).api_format!(@item).target!) }
+    f.html { render nothing: true, status: :bad_request }
+end
+```
+Each resource instance, as well as the included one, will be invoked with `json_api_attrs` & `json_api_relations` methods. These methods **MAY** be implemented within each model. `api_format!` method will try to get an object's permitted (**you are free do define authentication logic yourself!**) attributes and relations via those two methods.
+
+Here is an example of implementation:
+```ruby
+# Item model
+
+def json_api_attr (access_level = nil)
+  attrs = []
+  attrs += %w(name description price buyoutable item_type category) if %i(user admin).include?access_level
+  attrs += %w(real_price in_stock) if access_level == :admin
+  attrs
+end
+
+def json_api_relations (access_level = nil)
+  %w(category orders)
+end
+```
+**Note** that the gem will call methods pulled with `json_api_relations and _attrs`. As for the above example, methods like `:name`, `:description`, `:orders` will be invoked for an Item instance. And yes, relations are fetched properly if an object responds to `orders`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/vladfaust/jbuilder-json_api](https://github.com/vladfaust/jbuilder-json_api). It would be really good if someone contributes. :smile:
+
+## ToDo
+
+- [ ] Maybe add `Content-Type: application/vnd.api+json`. This spec is ignored right now :smirk:
+- [ ] Add links tests
+- [ ] Somehow implement `[fields]` parameter

data/Rakefile

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

data/lib/jbuilder/json_api/version.rb

@@ -0,0 +1,3 @@
+module JsonAPI
+  VERSION = '0.0.1'
+end

data/lib/jbuilder/json_api.rb

@@ -0,0 +1,154 @@
+require 'jbuilder'
+require 'jbuilder/json_api/version'
+
+module JsonAPI
+  # Returns a valid-formatted JSON which follows JSON-API specifications:
+  # http://jsonapi.org/
+  #
+  # Arguments:
+  #   :resources: - list of resources to render (may be even one or nil)
+  #   :errors: - array of errors in below format:
+  #     [{ status: 422, detail: 'This error occurs because...' }, {...}]
+  #
+  # Options:
+  #   :access_level: - access level, e.g. nil, :user, :admin
+  #   :meta: - a hash representing meta (additional) information
+  #
+  def api_format! (resources = nil, errors = nil, options = {})
+    options.merge access_level: nil
+    options.merge meta: nil
+
+    # Firstly, print meta
+    # http://jsonapi.org/format/#document-meta
+    #
+    if options[:meta] && !options[:meta].empty?
+      meta options[:meta]
+    end
+
+    # Secondly, take care of errors. If there are any,
+    # no 'data' section should be represented.
+    # http://jsonapi.org/format/#document-top-level
+    #
+    # Read more at
+    # http://jsonapi.org/format/#errors
+    #
+    if errors && !errors.empty?
+      ignore_nil! (@ignore_nil.nil? ? true : @ignore_nil)
+      errors errors do |error|
+        id     error[:id]
+        status error[:status]
+        detail error[:detail]
+        code   error[:code]
+        title  error[:title]
+
+        source do
+          pointer   error[:pointer]
+          paramater error[:parameter]
+        end
+
+        links do
+          about error[:about]
+        end
+      end
+      return self
+    end
+
+    resources = ::Kernel::Array resources
+
+    # http://jsonapi.org/format/#document-links
+    #
+    links do
+      begin
+        set! 'self', @context.request.path
+      rescue
+        # No @context given, cannot find path
+      end
+    end
+
+    data do
+      resources.blank? ? array! : _api_resource_objects(resources, options[:access_level])
+    end
+
+    included = []
+    resources.each do |resource|
+      next unless resource.respond_to?'json_api_relations'
+      resource.json_api_relations(options[:access_level]).each do |relationship|
+        included += ::Kernel::Array(resource.send(relationship))
+      end
+    end
+    included.uniq!
+
+    included do
+      _api_resource_objects(included, options[:access_level], resources) unless included.blank?
+    end
+
+    self
+  end
+
+  private
+
+  # Formats a resources array properly
+  # http://jsonapi.org/format/#document-resource-objects
+  #
+  def _api_resource_objects (resources, access_level, parent_resources = nil)
+    resources.each do |resource|
+      child! do
+        type resource.class.name.demodulize.to_s.downcase
+        id   resource.id
+
+        # http://jsonapi.org/format/#document-resource-object-attributes
+        #
+        if resource.respond_to?'json_api_attrs'
+          attributes do
+            resource.json_api_attrs(access_level).each do |attribute|
+              set! attribute, resource.send(attribute)
+            end
+          end
+        end
+
+        # http://jsonapi.org/format/#document-resource-object-relationships
+        #
+        if resource.respond_to?'json_api_relations'
+          unless resource.json_api_relations(access_level).blank?
+            relationships do
+              resource.json_api_relations(access_level).each do |relationship|
+                set! relationship do
+                  links do
+                    begin
+                      related @context.send("#{ relationship.pluralize }_path")
+                    rescue
+                      # No @context given, cannot find path
+                    end
+                    # TODO add a link to the relationship itself
+                  end
+
+                  data do
+                    ::Kernel::Array(resource.send(relationship)).each do |relationship_instance|
+                      # Relationships shouldn't ever link to the parent resource
+                      #
+                      next if !parent_resources.nil? && parent_resources.include?(relationship_instance)
+                      child! do
+                        type relationship_instance.class.name.demodulize.to_s.downcase
+                        id relationship_instance.id
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        links do
+          begin
+            set! 'self', @context.send("#{ resource.class.name.demodulize.to_s.downcase }_path", resource)
+          rescue
+            # No @context given, cannot find path
+          end
+        end
+      end
+    end
+  end
+end
+
+Jbuilder.include JsonAPI

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: jbuilder-json_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vlad Faust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Adds a method to build a valid JSON API (jsonapi.org) response without
+  any new superclasses or weird setups. Set'n'go!
+email:
+- vladislav.faust@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/jbuilder/json_api.rb
+- lib/jbuilder/json_api/version.rb
+homepage: https://github.com/vladfaust/jbuilder-json_api
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Easily follow jsonapi.org specifications with Jbuilder
+test_files: []