caprese 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f662bf206bc10125464b9779d47c1d6704e0062
+  data.tar.gz: cd8f888d31eed365bc32e9efeb762903c04780b9
+SHA512:
+  metadata.gz: 85b15e24d4f7f89d67d4741dd1e3d47d0ecf90414a6ce0e6b1499a24aa0d3f58b8aec2e8e47270c1c0e5d82d5cedd11f0525dfe9a4761a263ea2290d1a15cbe7
+  data.tar.gz: a1c2e81f96bce6b52c80c7ca61aed31018121a542b9baa67c819ec9c66565495ee96d434211128cb6cc75399682a251be3d742764e8ab8a9c7bc4d8496006e8d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*
+/spec/dummy/tmp/*

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.5
+  - 2.2.2
+env:
+  - DB=sqlite
+script:
+  - cd spec/dummy
+  - RAILS_ENV=test bundle exec rake db:migrate --trace
+  - bundle exec rake db:test:prepare
+  - cd ../..
+  - bundle exec rake
+before_script:
+  - cp spec/dummy/config/database.travis.yml spec/dummy/config/database.yml
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Landgrebe && Peak Labs, LLC DBA Occasion App
+
+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,41 @@
+# Caprese
+
+Caprese is a Rails library for creating RESTful APIs in as few words as possible. It handles all CRUD operations on resources and their associations for you, and you can customize how these operations
+are carried out by overriding intermediate helper methods and by defining callbacks around any CRUD action.
+
+What separates Caprese from similar gems is that it is trying to do as little as possible, instead allowing gems that are better at other things to do what they are good at, as opposed to Caprese trying to do it all.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'caprese'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install caprese
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/nicklandgrebe/caprese.
+
+
+## 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,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "caprese"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/caprese.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caprese/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "caprese"
+  spec.version       = Caprese::VERSION
+  spec.authors       = ["Nick Landgrebe", "Pelle ten Cate", "Kieran Klaassen"]
+  spec.email         = ["nick@landgre.be"]
+
+  spec.summary       = "Opinionated Rails library for writing RESTful APIs"
+  spec.license       = "MIT"
+
+  spec.homepage      = 'https://github.com/nicklandgrebe/caprese'
+
+  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.required_ruby_version = '>= 2.1'
+
+  spec.add_dependency 'active_model_serializers', '~> 0.10.0'
+  spec.add_dependency 'kaminari'
+  spec.add_dependency 'rails', '>= 4.2.0', '~> 4.2.6'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'responders', '~> 2.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/caprese/adapter/json_api/error.rb

@@ -0,0 +1,123 @@
+require 'caprese/adapter/json_api/json_pointer'
+
+module Caprese
+  module Adapter
+    class JsonApi
+      module Error
+        # rubocop:disable Style/AsciiComments
+        UnknownSourceTypeError = Class.new(ArgumentError)
+
+        # Builds a JSON API Errors Object
+        # {http://jsonapi.org/format/#errors JSON API Errors}
+        #
+        # @param [Caprese::Serializer::ErrorSerializer] error_serializer
+        # @return [Array<Symbol, Array<String>>] i.e. attribute_name, [attribute_errors]
+        def self.resource_errors(error_serializer, options)
+          error_serializer.as_json.flat_map do |attribute_name, attribute_errors|
+            attribute_name = JsonApi.send(:transform_key_casing!, attribute_name,
+              options)
+            attribute_error_objects(error_serializer.object.record, attribute_name, attribute_errors)
+          end
+        end
+
+        # FIXME: param_errors implies multiple errors, but since we use a fail first
+        # strategy, there will only be one param error ever, as reflected by this method's
+        # definition
+        def self.param_errors(error_serializer, options)
+          error_attributes = error_serializer.as_json
+          [
+            {
+              code: error_attributes[:code],
+              detail: error_attributes[:message],
+              source: error_source(:parameter, nil, error_attributes[:field])
+            }
+          ]
+        end
+
+        # definition:
+        #   JSON Object
+        #
+        # properties:
+        #   ☐ id      : String
+        #   ☐ status  : String
+        #   ☐ code    : String
+        #   ☐ title   : String
+        #   ☑ detail  : String
+        #   ☐ links
+        #   ☐ meta
+        #   ☑ error_source
+        #
+        # description:
+        #   id     : A unique identifier for this particular occurrence of the problem.
+        #   status : The HTTP status code applicable to this problem, expressed as a string value
+        #   code   : An application-specific error code, expressed as a string value.
+        #   title  : A short, human-readable summary of the problem. It **SHOULD NOT** change from
+        #     occurrence to occurrence of the problem, except for purposes of localization.
+        #   detail : A human-readable explanation specific to this occurrence of the problem.
+        # structure:
+        #   {
+        #     title: 'SystemFailure',
+        #     detail: 'something went terribly wrong',
+        #     status: '500'
+        #   }.merge!(errorSource)
+        def self.attribute_error_objects(record, attribute_name, attribute_errors)
+          attribute_errors.map do |attribute_error|
+            {
+              source: error_source(:pointer, record, attribute_name),
+              code: attribute_error[:code],
+              detail: attribute_error[:message]
+            }
+          end
+        end
+
+        # errorSource
+        # description:
+        #   oneOf
+        #     ☑ pointer   : String
+        #     ☑ parameter : String
+        #
+        # description:
+        #   pointer: A JSON Pointer RFC6901 to the associated entity in the request document e.g. "/data"
+        #   for a primary data object, or "/data/attributes/title" for a specific attribute.
+        #   https://tools.ietf.org/html/rfc6901
+        #
+        #   parameter: A string indicating which query parameter caused the error
+        # structure:
+        #   if is_attribute?
+        #     {
+        #       pointer: '/data/attributes/red-button'
+        #     }
+        #   else
+        #     {
+        #       parameter: 'pres'
+        #     }
+        #   end
+        def self.error_source(source_type, record, attribute_name)
+          case source_type
+          when :pointer
+            if record.has_attribute?(attribute_name)
+              {
+                pointer: JsonApi::JsonPointer.new(:attribute, record, attribute_name)
+              }
+            elsif attribute_name.to_s.split('.').size > 1
+              {
+                pointer: JsonApi::JsonPointer.new(:relationship_attribute, record, attribute_name)
+              }
+            else
+              {
+                pointer: JsonApi::JsonPointer.new(:relationship, record, attribute_name)
+              }
+            end
+          when :parameter
+            {
+              parameter: attribute_name
+            }
+          else
+            fail UnknownSourceTypeError, "Unknown source type '#{source_type}' for attribute_name '#{attribute_name}'"
+          end
+        end
+        # rubocop:enable Style/AsciiComments
+      end
+    end
+  end
+end

data/lib/caprese/adapter/json_api/json_pointer.rb

@@ -0,0 +1,52 @@
+module Caprese
+  module Adapter
+    class JsonApi
+      module JsonPointer
+        module_function
+
+        POINTERS = {
+          attribute:    '/data/attributes/%s'.freeze,
+          relationship: '/data/relationships/%s'.freeze,
+          primary_data: '/data%s'.freeze
+        }.freeze
+
+        # Iterates over the field of an error and converts it to a pointer in JSON API format
+        #
+        # @example
+        #   new(:attribute, record, 'name')
+        #   => '/data/attributes/name'
+        #
+        # @example
+        #   new(:relationship, record, 'post')
+        #   => '/data/attributes/name'
+        #
+        # @example
+        #   new(:relationship_attribute, record, 'post.user.name')
+        #   => '/data/relationships/post/data/relationships/user/data/attributes/name'
+        #
+        # @param [Symbol] pointer_type the type of pointer: :attribute, :relationship, :primary_data
+        def new(pointer_type, record, value)
+          if pointer_type == :relationship_attribute
+            value.to_s.split('.').inject('') do |pointer, v|
+              pointer +
+                if record.class.reflections.key?(v)
+                  record =
+                    if record.class.reflections[v].collection?
+                      record.send(v).first
+                    else
+                      record.send(v)
+                    end
+
+                  format(POINTERS[:relationship], v)
+                else
+                  format(POINTERS[:attribute], v)
+                end
+            end
+          else
+            format(POINTERS[pointer_type], value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caprese/adapter/json_api/jsonapi.rb

@@ -0,0 +1,49 @@
+module Caprese
+  module Adapter
+    class JsonApi
+      # {http://jsonapi.org/format/#document-jsonapi-object Jsonapi Object}
+
+      # toplevel_jsonapi
+      # definition:
+      #   JSON Object
+      #
+      # properties:
+      #   version : String
+      #   meta
+      #
+      # description:
+      #   An object describing the server's implementation
+      # structure:
+      #   {
+      #     version: ActiveModelSerializers.config.jsonapi_version,
+      #     meta: ActiveModelSerializers.config.jsonapi_toplevel_meta
+      #   }.reject! { |_, v| v.blank? }
+      # prs:
+      #   https://github.com/rails-api/active_model_serializers/pull/1050
+      module Jsonapi
+        module_function
+
+        def add!(hash)
+          hash.merge!(object) if include_object?
+        end
+
+        def include_object?
+          ActiveModelSerializers.config.jsonapi_include_toplevel_object
+        end
+
+        # TODO: see if we can cache this
+        def object
+          object = {
+            jsonapi: {
+              version: ActiveModelSerializers.config.jsonapi_version,
+              meta: ActiveModelSerializers.config.jsonapi_toplevel_meta
+            }
+          }
+          object[:jsonapi].reject! { |_, v| v.blank? }
+
+          object
+        end
+      end
+    end
+  end
+end

data/lib/caprese/adapter/json_api/link.rb

@@ -0,0 +1,88 @@
+module Caprese
+  module Adapter
+    class JsonApi
+      # link
+      # definition:
+      #  oneOf
+      #    linkString
+      #    linkObject
+      #
+      # description:
+      #   A link **MUST** be represented as either: a string containing the link's URL or a link
+      #   object."
+      # structure:
+      #   if href?
+      #     linkString
+      #   else
+      #     linkObject
+      #   end
+      #
+      # linkString
+      # definition:
+      #   URI
+      #
+      # description:
+      #   A string containing the link's URL.
+      # structure:
+      #  'http://example.com/link-string'
+      #
+      # linkObject
+      # definition:
+      #   JSON Object
+      #
+      # properties:
+      #   href (required) : URI
+      #   meta
+      # structure:
+      #   {
+      #     href: 'http://example.com/link-object',
+      #     meta: meta,
+      #   }.reject! {|_,v| v.nil? }
+      class Link
+        include ActiveModelSerializers::SerializationContext::UrlHelpers
+
+        def initialize(serializer, value)
+          @_routes ||= nil # handles warning
+          # actionpack-4.0.13/lib/action_dispatch/routing/route_set.rb:417: warning: instance variable @_routes not initialized
+          @serializer = serializer
+          @object = serializer.object
+          @scope = serializer.scope
+          # Use the return value of the block unless it is nil.
+          if value.respond_to?(:call)
+            @value = instance_eval(&value)
+          else
+            @value = value
+          end
+        end
+
+        def href(value)
+          @href = value
+          nil
+        end
+
+        def meta(value)
+          @meta = value
+          nil
+        end
+
+        def default_url_options
+          Caprese.config.default_url_options
+        end
+
+        def as_json
+          return @value if @value
+
+          hash = {}
+          hash[:href] = @href if defined?(@href)
+          hash[:meta] = @meta if defined?(@meta)
+
+          hash.any? ? hash : nil
+        end
+
+        protected
+
+        attr_reader :object, :scope, :serializer
+      end
+    end
+  end
+end

data/lib/caprese/adapter/json_api/meta.rb

@@ -0,0 +1,37 @@
+module Caprese
+  module Adapter
+    class JsonApi
+      # meta
+      # definition:
+      #   JSON Object
+      #
+      # description:
+      #   Non-standard meta-information that can not be represented as an attribute or relationship.
+      # structure:
+      #   {
+      #     attitude: 'adjustable'
+      #   }
+      class Meta
+        def initialize(serializer)
+          @object = serializer.object
+          @scope = serializer.scope
+
+          # Use the return value of the block unless it is nil.
+          if serializer._meta.respond_to?(:call)
+            @value = instance_eval(&serializer._meta)
+          else
+            @value = serializer._meta
+          end
+        end
+
+        def as_json
+          @value
+        end
+
+        protected
+
+        attr_reader :object, :scope
+      end
+    end
+  end
+end

data/lib/caprese/adapter/json_api/pagination_links.rb

@@ -0,0 +1,69 @@
+module Caprese
+  module Adapter
+    class JsonApi
+      class PaginationLinks
+        MissingSerializationContextError = Class.new(KeyError)
+        FIRST_PAGE = 1
+
+        attr_reader :collection, :context
+
+        def initialize(collection, adapter_options)
+          @collection = collection
+          @adapter_options = adapter_options
+          @context = adapter_options.fetch(:serialization_context) do
+            fail MissingSerializationContextError, <<-EOF.freeze
+ JsonApi::PaginationLinks requires a ActiveModelSerializers::SerializationContext.
+ Please pass a ':serialization_context' option or
+ override CollectionSerializer#paginated? to return 'false'.
+             EOF
+          end
+        end
+
+        def as_json
+          per_page = collection.try(:per_page) || collection.try(:limit_value) || collection.size
+          pages_from.each_with_object({}) do |(key, value), hash|
+            params = query_parameters.merge(page: { number: value, size: per_page }).to_query
+
+            hash[key] = "#{url(adapter_options)}?#{params}"
+          end
+        end
+
+        protected
+
+        attr_reader :adapter_options
+
+        private
+
+        def pages_from
+          return {} if collection.total_pages <= FIRST_PAGE
+
+          {}.tap do |pages|
+            pages[:self] = collection.current_page
+
+            unless collection.current_page == FIRST_PAGE
+              pages[:first] = FIRST_PAGE
+              pages[:prev]  = collection.current_page - FIRST_PAGE
+            end
+
+            unless collection.current_page == collection.total_pages
+              pages[:next] = collection.current_page + FIRST_PAGE
+              pages[:last] = collection.total_pages
+            end
+          end
+        end
+
+        def url(options)
+          @url ||= options.fetch(:links, {}).fetch(:self, nil) || request_url
+        end
+
+        def request_url
+          @request_url ||= context.request_url
+        end
+
+        def query_parameters
+          @query_parameters ||= context.query_parameters
+        end
+      end
+    end
+  end
+end

data/lib/caprese/adapter/json_api/relationship.rb

@@ -0,0 +1,65 @@
+module Caprese
+  module Adapter
+    class JsonApi
+      class Relationship
+        # {http://jsonapi.org/format/#document-resource-object-related-resource-links Document Resource Object Related Resource Links}
+        # {http://jsonapi.org/format/#document-links Document Links}
+        # {http://jsonapi.org/format/#document-resource-object-linkage Document Resource Relationship Linkage}
+        # {http://jsonapi.org/format/#document-meta Document Meta}
+        def initialize(parent_serializer, serializable_resource_options, association, included_associations)
+          @parent_serializer = parent_serializer
+          @association = association
+          @serializable_resource_options = serializable_resource_options
+          @included_associations = included_associations
+        end
+
+        def as_json
+          hash = {}
+
+          # Only render a relationship's data if it was included, if Caprese.config.optimize_relationships
+          if association.options[:include_data] &&
+            (!Caprese.config.optimize_relationships || included_associations[association.name])
+            hash[:data] = data_for(association)
+          end
+
+          links = links_for(association)
+          hash[:links] = links if links.any?
+
+          meta = meta_for(association)
+          hash[:meta] = meta if meta
+
+          hash
+        end
+
+        protected
+
+        attr_reader :parent_serializer, :serializable_resource_options, :association, :included_associations
+
+        private
+
+        def data_for(association)
+          serializer = association.serializer
+          if serializer.respond_to?(:each)
+            serializer.map { |s| ResourceIdentifier.new(s, serializable_resource_options).as_json }
+          elsif (virtual_value = association.options[:virtual_value])
+            virtual_value
+          elsif serializer && serializer.object
+            ResourceIdentifier.new(serializer, serializable_resource_options).as_json
+          end
+        end
+
+        def links_for(association)
+          association.links.each_with_object({}) do |(key, value), hash|
+            result = Link.new(parent_serializer, value).as_json
+            hash[key] = result if result
+          end
+        end
+
+        def meta_for(association)
+          meta = association.meta
+          meta.respond_to?(:call) ? parent_serializer.instance_eval(&meta) : meta
+        end
+      end
+    end
+  end
+end