onsi 1.3.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57fb51dbc1c13dd74a18af1538b58c25f2feb39cb945688009f3d78c88520238
-  data.tar.gz: 9612c74cc9fbaf207d49bbb30bcd60170c339a6d52f031efafee4578d99c32bf
+  metadata.gz: 866068b856dc9ce02d03c655448053a23e776388fdfa7569576411c8c92b01a4
+  data.tar.gz: 4c1eb3d324d81f30bf394120d3baf6822d83fa7e2b0ca1bc6124081ed71fb9ac
 SHA512:
-  metadata.gz: 88a3da865f1c6843d659aba1a6213de659a9fd3eb6fa0e6492cc9ea91c8e94139ccaf98d54cded23bb9571bb7b5f658006ebafa33299bef1990e36408247f082
-  data.tar.gz: 2254e6f2b098df7df588b3295dace8abedb8a707db96ed98c7465be2ff30d0d13104261866fbb9b6927fd9a2f3d502e42e3db463c5a00d6f040cbc48bf27037b
+  metadata.gz: ef0a1ee5e326bc2bfa9769882143be56d27b1bf0811d81aa0fce1a26a7c5df4c49d56961f84d1ce82c1c2dbe4e9afd06efab0bf6408940410c12ed2fa5cb46a1
+  data.tar.gz: 0201c618fcc64b69801ed66ff2fd85bea5f912027b53437aa65ffd7b83d67a8c8c111443b3481eee328c6d8e0b592df217886bab0da2d8291f22a5f4f085bbae

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## Version 2.0.0
+
+### unreleased
+
+- Added pagination support
+
+- Fix: Relationships without a valid value now render a `nil` data structure. This is a breaking change. To keep the old behavior you can use `legacy_relationship_render!`
+
+    ```ruby
+    api_render(:v1) do
+      legacy_relationship_render!
+    end
+    ```
+
 ## Version 1.3.0
 
 ### Released March 19, 2019

data/README.md

@@ -126,3 +126,4 @@ class PeopleController < ApplicationController
   end
 end
 ```
+

data/lib/onsi.rb

@@ -4,6 +4,7 @@ require 'onsi/error_responder'
 require 'onsi/errors'
 require 'onsi/includes'
 require 'onsi/middleware'
+require 'onsi/paginate'
 require 'onsi/model'
 require 'onsi/params'
 require 'onsi/resource'

data/lib/onsi/error_responder.rb

@@ -34,6 +34,7 @@ module Onsi
       rescue_from Onsi::Params::RelationshipNotFound,    with: :respond_missing_relationship_error_400
       rescue_from Onsi::Errors::UnknownVersionError,     with: :respond_invalid_version_error_400
       rescue_from Onsi::Errors::IncludedParamError,      with: :respond_included_param_error_400
+      rescue_from Onsi::Errors::PaginationError,         with: :respond_pagination_error_400
     end
 
     ##
@@ -154,6 +155,18 @@ module Onsi
       render_error(response)
     end
 
+    ##
+    # @private
+    def respond_pagination_error_400(error)
+      response = ErrorResponse.new(400)
+      response.add(
+        400,
+        'pagination_error',
+        details: error.message
+      )
+      render_error(response)
+    end
+
     private
 
     def error_metadata(error)

data/lib/onsi/errors.rb

@@ -55,5 +55,13 @@ module Onsi
         @path = path
       end
     end
+
+    ##
+    # Raised when there is an error with pagination
+    #
+    # @author Maddie Schipper
+    # @since 1.4.0
+    class PaginationError < BaseError
+    end
   end
 end

data/lib/onsi/model.rb

@@ -204,6 +204,10 @@ module Onsi
         end
       end
 
+      def legacy_relationship_render!
+        @legacy_relationship_render = true
+      end
+
       private
 
       def render_relationship_entry(object, key, value, rels)
@@ -224,6 +228,30 @@ module Onsi
       end
 
       def format_relationship(relationship, value)
+        if @legacy_relationship_render == true
+          return legacy_format_relationship(relationship, value)
+        end
+
+        case relationship
+        when Enumerable
+          if relationship.empty?
+            return []
+          end
+
+          relationship.map { |v| { 'type' => value[:type].to_s, 'id' => v.to_s } }
+        else
+          unless relationship.to_s.present?
+            return nil
+          end
+
+          {
+            'type' => value[:type].to_s,
+            'id' => relationship.to_s
+          }
+        end
+      end
+
+      def legacy_format_relationship(relationship, value)
         case relationship
         when Array
           relationship.map { |v| { 'type' => value[:type].to_s, 'id' => v.to_s } }

data/lib/onsi/paginate.rb

@@ -0,0 +1,83 @@
+require_relative 'errors'
+
+module Onsi
+  ##
+  # Pagination handles cursor pagination.
+  #
+  # It handles setting up a cursor and ordering the query. The next cursor will be added to the
+  # response's meta object.
+  #
+  # @example Controller Action
+  # def index
+  #   render_resource(Onsi::Paginate.perform(person.messages, 'messages', params))
+  # end
+  #
+  # @author Maddie Schipper
+  # @since 1.4.0
+  class Paginate
+    Result = Struct.new(:query, :params)
+
+    class << self
+      ##
+      # Modify the query based on the pagination options
+      #
+      # @param query [#reorder, #limit, #where, #last] The query to modify
+      #
+      # @param type [#to_s] The type of the pagination. This us used to verify the cursor
+      #
+      # @param params [#fetch] The request params.
+      #
+      # @return [Onsi::Paginate::Result]
+      def perform(query, type, params, options = {})
+        cursor_type = type.to_s
+        cursor_param = options.fetch(:cursor_param, :cursor)
+        max_per_page = options.fetch(:max_per_page, 100)
+        per_page_param = options.fetch(:per_page_param, :per_page)
+        cursor_generator = options.fetch(:cursor, lambda { |query, type| Paginate.cursor_for_query(query, type) })
+        cursor_offset = options.fetch(:offset, lambda { |query, type, cursor| Paginate.cursor_offset(query, type, cursor) })
+        order_by = options.fetch(:order_by, id: :asc)
+
+        per_page = params.fetch(per_page_param, 25).to_i
+        raise Onsi::Errors::PaginationError, "too many objects per page, max #{max_per_page}" if per_page > max_per_page
+
+        query = query.reorder(order_by)
+        query = query.limit(per_page)
+        query = cursor_offset.call(query, cursor_type, params.fetch(cursor_param)) if params.fetch(cursor_param, nil).present?
+
+        response_params = {}.tap do |rp|
+          rp[per_page_param] = per_page
+          value = cursor_generator.call(query, cursor_type)
+          rp[cursor_param] = value unless value.nil?
+        end
+
+        Result.new(query, response_params)
+      end
+
+      ##
+      # @private
+      def cursor_for_query(query, type)
+        obj = query.last
+
+        return nil if obj.nil?
+
+        Base64.strict_encode64([
+          type.to_s,
+          obj.id.to_s
+        ].join(':'))
+      end
+
+      ##
+      # @private
+      def cursor_offset(query, cursor_type, cursor)
+        type, id = Base64.strict_decode64(cursor).split(':', 2)
+        raise Onsi::Errors::PaginationError, 'invalid cursor type' unless cursor_type.to_s == type
+
+        query.where(id: (id.to_i + 1)...Float::INFINITY)
+      rescue ArgumentError => e
+        raise e if e.message.downcase != 'invalid base64'
+
+        raise Onsi::Errors::PaginationError, 'invalid cursor format'
+      end
+    end
+  end
+end

data/lib/onsi/resource.rb

@@ -1,4 +1,5 @@
 require_relative 'errors'
+require_relative 'paginate'
 
 module Onsi
   ##
@@ -71,6 +72,8 @@ module Onsi
         case resource
         when Onsi::Resource
           resource
+        when Onsi::Paginate::Result
+          as_resource(resource.query, version)
         when Enumerable
           resource.map { |res| as_resource(res, version) }
         else
@@ -97,6 +100,9 @@ module Onsi
           end
           root[META_KEY] = {}.tap do |meta|
             meta[:count] = resources.count if resources.respond_to?(:count)
+            if resource.is_a?(Onsi::Paginate::Result)
+              meta[:pagination] = resource.params
+            end
           end
         end
       end

data/lib/onsi/version.rb

@@ -1,5 +1,5 @@
 module Onsi
   ##
   # The current version of Onsi
-  VERSION = '1.3.1'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/onsi.gemspec

@@ -23,14 +23,14 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3'
 
   spec.add_dependency 'addressable', '>= 2.5', '< 3.0'
-  spec.add_dependency 'rails',       '>= 5.0', '< 6.0'
+  spec.add_dependency 'rails',       '>= 5.0', '< 7.0'
 
-  spec.add_development_dependency 'bundler',          '>= 1.16', '< 3.0'
-  spec.add_development_dependency 'database_cleaner', '~> 1.7.0'
-  spec.add_development_dependency 'pry',              '~> 0.11.3'
-  spec.add_development_dependency 'rake',             '~> 10.0'
-  spec.add_development_dependency 'rspec-rails',      '~> 3.7.2'
-  spec.add_development_dependency 'simplecov',        '~> 0.15'
-  spec.add_development_dependency 'sqlite3',          '~> 1.3.10'
-  spec.add_development_dependency 'yard',             '~> 0.9.16'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'simplecov', '< 0.18' # >= .18 breaks the test reporter
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onsi
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Maddie Schipper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2020-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -39,7 +39,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,125 +49,119 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.10
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.10
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: '0'
 description: Format JSON API responses and parse inbound requests.
 email:
 - me@maddiesch.com
@@ -202,6 +196,7 @@ files:
 - lib/onsi/middleware.rb
 - lib/onsi/middleware/cors_headers.rb
 - lib/onsi/model.rb
+- lib/onsi/paginate.rb
 - lib/onsi/params.rb
 - lib/onsi/params_parse_operation.rb
 - lib/onsi/params_parser.rb