sinja 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 851e8f43eabf59529257a1ef2fcc7a6df84f8ea5
-  data.tar.gz: b75968556128599080ba71d790d8b1671cbc89e6
+  metadata.gz: 9054bed54d4dd7bf2e166d3708c3726ba9c92d89
+  data.tar.gz: 1ade5511cf29f452d7f3d4555e1a153ea895c9a7
 SHA512:
-  metadata.gz: 0ddd2782e3e63efab5bfee81ace29615708e08cc9a137ba28451724543f98ee3f2f6d59eda0444a0859ebd9f4b8ccdc26ed661ebde0cbdf9b902e97e18f8d23f
-  data.tar.gz: 1fea65b16d22c9bbb22dc0af0ed4744308eaf5dfe217da0c054da4c57b40ae5d00a36617b06d114ae2a50b324a72ac45a4c17917bd61debed1ed812d35c5e0ef
+  metadata.gz: 8cf864d75cf3232f2ab1f2699ea61e02db3a7503a446b07a6d1fe38261625b911f316e8a8851b44f13b7539d39b96a537699964c516918dd9676af0c6cf98ff0
+  data.tar.gz: 980b31489e1efd32956b33691bf78eb6c8cd1097a76af04cec58ab03abb567f4dd0d59ee42592079de8aa224b70beb29a3e7b6f7ee7bfb56c6453d33b09c056f

data/.travis.yml

@@ -6,9 +6,6 @@ rvm:
   - ruby-head
   - jruby-9.1.7.0
   - jruby-head
-env:
-  - sinatra=1.4.7 rails=4.2.7.1
-  - sinatra=2.0.0.beta2 rails=5.0.1
 jdk:
   - oraclejdk8
 before_install:

data/README.md

@@ -13,7 +13,7 @@
 [![{json:api} version](https://img.shields.io/badge/%7Bjson%3Aapi%7D%20version-1.0-lightgrey.svg)][7]
 [![Chat in #sinja-rb on Gitter](https://badges.gitter.im/sinja-rb/Lobby.svg)](https://gitter.im/sinja-rb/Lobby)
 
-Sinja is a [Sinatra][1] [extension][10] for quickly building [RESTful][11],
+Sinja is a [Sinatra 2.0][1] [extension][10] for quickly building [RESTful][11],
 [{json:api}][2]-compliant web services, leveraging the excellent
 [JSONAPI::Serializers][3] gem for payload serialization. It enhances Sinatra's
 DSL to enable resource-, relationship-, and role-centric API development, and
@@ -40,6 +40,7 @@ framework like [Rails][16]. It's lightweight, ORM-agnostic, and
   - [Configuration](#configuration)
     - [Sinatra](#sinatra)
     - [Sinja](#sinja)
+  - [Resources](#resources)
   - [Resource Locators](#resource-locators)
   - [Action Helpers](#action-helpers)
     - [`resource`](#resource)
@@ -63,6 +64,7 @@ framework like [Rails][16]. It's lightweight, ORM-agnostic, and
   - [Transactions](#transactions)
   - [Side-Unloading Related Resources](#side-unloading-related-resources)
   - [Side-Loading Relationships](#side-loading-relationships)
+    - [Deferring Relationships](#deferring-relationships)
     - [Avoiding Null Foreign Keys](#avoiding-null-foreign-keys)
   - [Coalesced Find Requests](#coalesced-find-requests)
   - [Patchless Clients](#patchless-clients)
@@ -156,6 +158,9 @@ Or install it yourself as:
 $ gem install sinja
 ```
 
+Sinja is not compatible with Sinatra 1.x due to its limitations with nested
+regexp-style namespaces and routes.
+
 ## Ol' Blue Eyes is Back
 
 The "power" so to speak of implementing this functionality as a Sinatra
@@ -341,6 +346,36 @@ FooError` and `c.serializer_opts[:meta] = { foo: 'bar' }`) until you call
 `freeze_jsonapi` to freeze the configuration store. **You should always freeze
 the store after Sinja is configured and all your resources are defined.**
 
+### Resources
+
+Resources declared with the `resource` keyword (and relationships declared with
+the `has_many` and `has_one` keywords) are dasherized and pluralized to match
+the "type" property of JSONAPI::Serializers. For example, `resource :foo_bar`
+would instruct Sinja to draw the appropriate routes under `/foo-bars`. Your
+serializer type(s) should always match your resource (and relationship) names;
+see the relevant [documentation][33] for more information.
+
+The primary key portion of the route is extracted using a regular expression,
+`\d+` by default. To use a different pattern, pass the `:pkre` resource route
+option:
+
+```ruby
+resource :foo_bar, pkre: /\d+-\d+/ do
+  helpers do
+    def find(id)
+      # Look up a FooBar with a composite primary key of two integers.
+      FooBar[id.split('-', 2).map!(&:to_i)]
+    end
+  end
+
+  # ..
+end
+```
+
+This helps Sinja (and Sinatra) disambiguate between standard {json:api} routes
+used to fetch resources (e.g. `GET /foos/1`) and similarly-structured custom
+routes (e.g. `GET /foos/recent`).
+
 ### Resource Locators
 
 Much of Sinja's advanced functionality (e.g. updating and destroying resources,
@@ -1537,7 +1572,7 @@ logic.
 | Feature         | JR                               | Sinja                                             |
 | :-------------- | :------------------------------- | :------------------------------------------------ |
 | Serializer      | Built-in                         | [JSONAPI::Serializers][3]                         |
-| Framework       | Rails                            | Sinatra, but easy to mount within others          |
+| Framework       | Rails                            | Sinatra 2.0, but easy to mount within others      |
 | Routing         | ActionDispatch::Routing          | Mustermann                                        |
 | Caching         | ActiveSupport::Cache             | BYO                                               |
 | ORM             | ActiveRecord/ActiveModel         | BYO                                               |
@@ -1614,3 +1649,4 @@ License](http://opensource.org/licenses/MIT).
 [30]: https://github.com/mwpastore/sinja-sequel
 [31]: http://jsonapi.org/implementations/#server-libraries-ruby
 [32]: http://emberjs.com
+[33]: https://github.com/fotinakis/jsonapi-serializers#more-customizations

data/demo-app/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gem 'jdbc-sqlite3', '~> 3.8', :platform=>:jruby
 gem 'json', '~> 2.0'
-gem 'sequel', '~> 4.43'
+gem 'sequel', '~> 4.44'
 gem 'sinatra', '>= 2.0.0.beta2', '< 3'
 gem 'sinatra-contrib', '>= 2.0.0.beta2', '< 3'
 gem 'sinja',

data/demo-app/app.rb

@@ -10,7 +10,9 @@ require_relative 'classes/comment'
 require_relative 'classes/post'
 require_relative 'classes/tag'
 
-# Freeze database after creating tables and loading models
+Sequel::Model.finalize_associations
+Sequel::Model.freeze
+
 DB.freeze
 
 configure :development do
@@ -34,7 +36,7 @@ end
 
 resource :authors, &AuthorController
 resource :comments, &CommentController
-resource :posts, &PostController
+resource :posts, :pkre=>/[\w-]+/, &PostController
 resource :tags, &TagController
 
 freeze_jsonapi

data/demo-app/classes/author.rb

@@ -55,7 +55,7 @@ AuthorController = proc do
   show
 
   show_many do |ids|
-    Author.where(id: ids.map!(&:to_i)).all
+    Author.where_all(id: ids.map!(&:to_i))
   end
 
   index do

data/demo-app/classes/post.rb

@@ -64,7 +64,7 @@ PostController = proc do
   end
 
   show_many do |slugs|
-    next Post.where(slug: slugs.map!(&:to_s)).all, include: %i[author tags]
+    next Post.where_all(slug: slugs.map!(&:to_s)), include: %i[author tags]
   end
 
   index do

data/lib/sinja.rb

@@ -2,7 +2,6 @@
 require 'set'
 
 require 'active_support/inflector'
-require 'mustermann'
 require 'sinatra/base'
 require 'sinatra/namespace'
 
@@ -22,7 +21,6 @@ module Sinja
     .to_h.freeze
 
   def self.registered(app)
-    app.register Mustermann if Sinatra::VERSION[/^\d+/].to_i < 2
     app.register Sinatra::Namespace
 
     app.disable :protection, :show_exceptions, :static
@@ -102,9 +100,9 @@ module Sinja
           end
         end
 
-        # Sinatra 2.0 re-initializes `params' at namespace boundaries, but
-        # Sinatra 1.4 does not, so we'll reference its object_id in the flag
-        # to make sure we only re-normalize the parameters when necessary.
+        # Sinatra re-initializes `params' at namespace boundaries, so we'll
+        # reference its object_id in the flag to make sure we only re-normalize
+        # the parameters when necessary.
         env['sinja.normalized'] = params.object_id
       end
     end
@@ -313,7 +311,7 @@ module Sinja
     end
   end
 
-  def resource(resource_name, konst=nil, &block)
+  def resource(resource_name, konst=nil, **opts, &block)
     abort "Must supply proc constant or block for `resource'" \
       unless block = (konst if konst.instance_of?(Proc)) || block
 
@@ -328,6 +326,9 @@ module Sinja
     # trigger default procs
     config = _sinja.resource_config[resource_name]
 
+    # incorporate route options
+    config[:route_opts].merge!(opts)
+
     namespace %r{/#{resource_name}(?![^/])} do
       define_singleton_method(:_resource_config) { config }
       define_singleton_method(:resource_config) { config[:resource] }
@@ -338,12 +339,14 @@ module Sinja
         end
       end
 
-      before %r{/(?<id>[^/]+)(?:/.+)?} do |id|
+      before %r{/(#{config[:route_opts][:pkre]})(?:/.*)?} do |id|
         self.resource =
           if env.key?('sinja.resource')
             env['sinja.resource']
           elsif respond_to?(:find)
             find(id)
+          else
+            raise SinjaError, 'Resource locator not defined!'
           end
 
         raise NotFoundError, "Resource '#{id}' not found" unless resource

data/lib/sinja/config.rb

@@ -83,6 +83,7 @@ module Sinja
       }}.curry
 
       @resource_config = Hash.new { |h, k| h[k] = {
+        :route_opts=>{ :pkre=>/\d+/ },
         :resource=>Hash.new(&action_proc[:resource]),
         :has_many=>Hash.new { |rh, rk| rh[rk] = Hash.new(&action_proc[:has_many]) },
         :has_one=>Hash.new { |rh, rk| rh[rk] = Hash.new(&action_proc[:has_one]) }

data/lib/sinja/helpers/serializers.rb

@@ -36,7 +36,12 @@ module Sinja
       end
 
       def serialize_response_body
-        JSON.send settings._sinja.json_generator, response.body
+        case response.content_type[/^[^;]+/]
+        when *[mime_type(:api_json), mime_type(:json), mime_type(:javascript)].freeze
+          JSON.send(settings._sinja.json_generator, response.body)
+        else
+          Array(response.body).map!(&:to_s)
+        end
       rescue JSON::GeneratorError
         raise BadRequestError, 'Unserializable entities in the response body'
       end

data/lib/sinja/resource.rb

@@ -89,7 +89,7 @@ module Sinja
 
         config = _resource_config[rel_type][rel] # trigger default proc
 
-        namespace %r{/[^/]+(?<r>/relationships)?/#{rel}(?![^/])} do
+        namespace %r{/#{_resource_config[:route_opts][:pkre]}(?<r>/relationships)?/#{rel}(?![^/])} do
           define_singleton_method(:resource_config) { config }
 
           helpers Helpers::Nested do

data/lib/sinja/resource_routes.rb

@@ -82,17 +82,19 @@ module Sinja
         end
       end
 
-      app.options '/:id' do
+      pkre = app._resource_config[:route_opts][:pkre]
+
+      app.options %r{/#{pkre}} do
         allow :get=>:show, :patch=>:update, :delete=>:destroy
       end
 
-      app.get '/:id', :qparams=>%i[include fields], :actions=>:show do |id|
+      app.get %r{/(#{pkre})}, :qparams=>%i[include fields], :actions=>:show do |id|
         tmp, opts = show(*[].tap { |a| a << id unless respond_to?(:find) })
         raise NotFoundError, "Resource '#{id}' not found" unless tmp
         serialize_model(tmp, opts)
       end
 
-      app.patch '/:id', :qparams=>%i[include fields], :actions=>:update do |id|
+      app.patch %r{/(#{pkre})}, :qparams=>%i[include fields], :actions=>:update do |id|
         sanity_check!(id)
         tmp, opts = transaction do
           update(attributes).tap do
@@ -103,7 +105,7 @@ module Sinja
         serialize_model?(tmp, opts)
       end
 
-      app.delete '/:id', :actions=>:destroy do |id|
+      app.delete %r{/#{pkre}}, :actions=>:destroy do
         _, opts = destroy
         serialize_model?(nil, opts)
       end

data/lib/sinja/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sinja
-  VERSION = '1.2.4'
+  VERSION = '1.2.5'
 end

data/sinja.gemspec

@@ -37,18 +37,18 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_dependency 'activesupport', ">= #{ENV.fetch('rails', '4.2.7.1')}", '< 6'
+  spec.add_dependency 'activesupport', '>= 4.2.8', '< 6'
   spec.add_dependency 'json', '>= 1.8.3', '< 3'
-  spec.add_dependency 'jsonapi-serializers', '~> 0.16'
-  spec.add_dependency 'mustermann', '>= 1.0.0.beta2', '< 2'
-  spec.add_dependency 'sinatra', ">= #{ENV.fetch('sinatra', '1.4.7')}", '< 3'
-  spec.add_dependency 'sinatra-contrib', ">= #{ENV.fetch('sinatra', '1.4.7')}", '< 3'
+  spec.add_dependency 'jsonapi-serializers', '>= 0.16.2', '< 2'
+  spec.add_dependency 'sinatra', '>= 2.0.0.rc1', '< 3'
+  spec.add_dependency 'sinatra-contrib', '>= 2.0.0.rc1', '< 3'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'jdbc-sqlite3', '~> 3.8' if defined?(JRUBY_VERSION)
   spec.add_development_dependency 'minitest', '~> 5.9'
   spec.add_development_dependency 'minitest-hooks', '~> 1.4'
   #spec.add_development_dependency 'munson', '~> 0.4' # in Gemfile
+  spec.add_development_dependency 'rack-test', '~> 0.6'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'sequel', '~> 4.41'
   #spec.add_development_dependency 'sinja-sequel', '~> 0.1' # in Gemfile

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinja
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Mike Pastore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.7.1
+        version: 4.2.8
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.7.1
+        version: 4.2.8
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
@@ -52,25 +52,11 @@ dependencies:
         version: '3'
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.16'
-- !ruby/object:Gem::Dependency
-  name: mustermann
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 0.16.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -80,7 +66,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 0.16.2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -90,7 +76,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 2.0.0.rc1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -100,7 +86,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 2.0.0.rc1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -110,7 +96,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 2.0.0.rc1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -120,7 +106,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 2.0.0.rc1
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -166,6 +152,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement