sinja 0.1.0.beta1 → 0.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8ac4687f2a8eea409209c9da5ac107ccdb2b886
-  data.tar.gz: c5e3e902e1e54a0e93a0888411d09e8046e80a20
+  metadata.gz: 56256224f31086937e46be0e727db8ec8ae05cc7
+  data.tar.gz: a9216fc46b80a2d4aede971848d749859f7358f1
 SHA512:
-  metadata.gz: 370e3e8f1f13a4ee3f216a1d3bf92c16b0fbf343e317d7774f45b6287479be69d59055ae690266ac8f570d514e60ae7c5051fa534af8f6ecb2fd13eae13105ec
-  data.tar.gz: 823218b82a74b85566d10a3df1d1ac7ef92ffb3b110c19f739dd5eec39c53d289df4a23e101ba29ff3f3cbc59fff702c64f0db00de5b57d72a183907756085c6
+  metadata.gz: d6045cbbca2b859e33bc66730139b1e8fc6fe3fa5a95004c138c4d1f739a876148ea0eff2da525ab9a064fccee2e8d5aa0be5452d084f99b9fb2a9b5cb233ea6
+  data.tar.gz: e2bc9f2014b3ebc582705f636943f543a6e5ce096ca3916d631a77f8b7c1fe3582499deebc096504872ad9732f996027f954fd676e11e565049c2cab11a998af

data/README.md

@@ -81,6 +81,9 @@ resource :posts do
   create do |attr|
     Post.create(attr)
   end
+
+  has_one :author
+  has_many :comments
 end
 
 freeze_jsonapi
@@ -92,6 +95,10 @@ all other JSON:API endpoints returning 404 or 405):
 
 * `GET /posts`
 * `GET /posts/<id>`
+* `GET /posts/<id>/author`
+* `GET /posts/<id>/comments`
+* `GET /posts/<id>/relationships/author`
+* `GET /posts/<id>/relationships/comments`
 * `POST /posts`
 
 Of course, "modular"-style Sinatra aplications require you to register the
@@ -267,6 +274,15 @@ end
   and returns a serialized collection if non-empty, or the root metadata if
   present, or a HTTP status 204.
 
+**dedasherize**
+: Takes a string or symbol and returns the string or symbol with any and all
+  dashes transliterated to underscores.
+
+**dedasherize_names**
+: Takes a hash and returns the hash with its keys dedasherized (deeply).
+  Useful for fixing up the hashes of attributes passed to the `create` and
+  `update` action helpers before they are passed on to ORM methods.
+
 ### Performance
 
 Although there is some heavy metaprogramming happening at boot time, the end
@@ -384,7 +400,8 @@ below. Implicitly return the expected values as described below (as an array if
 necessary) or use the `next` keyword (instead of `return` or `break`) to exit
 the action helper. Return values marked with a question mark below may be
 omitted entirely. Any helper may additionally return an options hash to pass
-along to JSONAPI::Serializers.
+along to JSONAPI::Serializer.serialize (will be merged into the global
+`serializer_opts` described above).
 
 The `:include` and `:fields` query parameters are automatically passed through
 to JSONAPI::Serializers. You may also use the special `:exclude` option to

data/lib/sinatra/jsonapi/helpers/sequel.rb

@@ -26,36 +26,38 @@ module Sinatra::JSONAPI
         [resource.pk, resource, opts]
       end
 
-      def add_missing(association, *args)
-        meth = "add_#{singularize(association)}".to_sym
-        transaction do
-          resource.lock!
-          venn(:-, association, *args) do |subresource|
-            resource.send(meth, subresource)
-          end
-          resource.reload
-        end
+      # <= association, rios, extra_keys
+      def add_missing(*args)
+        add_remove(:add, :-, *args)
+      end
+
+      # <= association, rios, extra_keys
+      def remove_present(*args)
+        add_remove(:remove, :&, *args)
       end
 
-      def remove_present(association, *args)
-        meth = "remove_#{singularize(association)}".to_sym
+      private
+
+      def add_remove(meth_prefix, operator, association, rios)
+        meth = "#{meth_prefix}_#{singularize(association)}".to_sym
         transaction do
           resource.lock!
-          venn(:&, association, *args) do |subresource|
-            resource.send(meth, subresource)
+          venn(operator, association, rios) do |subresource, rio|
+            args = [subresource]
+            args.push(yield(rio)) if block_given?
+            resource.send(meth, *args)
           end
           resource.reload
         end
       end
 
-      private
-
       def venn(operator, association, rios)
-        klass = resource.class.association_reflection(association) # get e.g. ProductType for :types
         dataset = resource.send("#{association}_dataset")
-        rios.map { |rio| rio[:id] }.tap(&:uniq!) # unique PKs in request payload
-          .send(operator, dataset.select_map(klass.primary_key)) # set operation with existing PKs in dataset
-          .each { |id| yield klass.with_pk!(id) } # TODO: return 404 if not found?
+        klass = resource.class.association_reflection(association)
+        rios = rios.map { |rio| [rio[:id], rio] }.to_h
+        rios.keys.send(operator, dataset.select_map(klass.primary_key)).each do |id|
+          yield klass.with_pk!(id), rios[id]
+        end
       end
     end
   end

data/lib/sinatra/jsonapi/helpers/serializers.rb

@@ -6,8 +6,24 @@ require 'set'
 module Sinatra::JSONAPI
   module Helpers
     module Serializers
+      def dedasherize(s=nil)
+        s.to_s.tr('-', '_').send(Symbol === s ? :to_sym : :itself)
+      end
+
+      def dedasherize_names(*args)
+        _dedasherize_names(*args).to_h
+      end
+
+      private def _dedasherize_names(hash={})
+        return enum_for(__callee__) unless block_given?
+
+        hash.each do |k, v|
+          yield dasherize(k), Hash === v ? dedasherize_names(v) : v
+        end
+      end
+
       def deserialized_request_body
-        return {} unless request.body.respond_to?(:size) && request.body.size > 0
+        return {} unless content?
 
         request.body.rewind
         JSON.parse(request.body.read, :symbolize_names=>true)
@@ -40,6 +56,8 @@ module Sinatra::JSONAPI
       def serialize_model(model=nil, options={})
         options[:is_collection] = false
         options[:skip_collection_check] = defined?(::Sequel) && model.is_a?(::Sequel::Model)
+        # TODO: This should allow a default include, take the param value if
+        # present, and support disabling passthru.
         options[:include] ||= params[:include] unless params[:include].empty?
         options[:fields] ||= params[:fields] unless params[:fields].empty?
 
@@ -61,6 +79,8 @@ module Sinatra::JSONAPI
 
       def serialize_models(models=[], options={})
         options[:is_collection] = true
+        # TODO: This should allow a default include, take the param value if
+        # present, and support disabling passthru.
         options[:include] ||= params[:include] unless params[:include].empty?
         options[:fields] ||= params[:fields] unless params[:fields].empty?
 
@@ -108,7 +128,7 @@ module Sinatra::JSONAPI
         elsif detail = [*body].first
         end
 
-        { title: title, detail: detail }
+        { :title=>title, :detail=>detail }
       end
 
       def error_hash(title: nil, detail: nil, source: nil)

data/lib/sinatra/jsonapi/resource.rb

@@ -111,7 +111,7 @@ module Sinatra::JSONAPI
           end
 
           before do
-            not_found unless resource
+            not_found 'Parent resource not found' unless resource
           end
 
           get '' do

data/lib/sinatra/jsonapi/resource_routes.rb

@@ -13,7 +13,7 @@ module Sinatra::JSONAPI
 
       app.get '/:id', :actions=>:show do |id|
         self.resource, opts = show(id)
-        not_found unless resource
+        not_found "Resource '#{id}' not found" unless resource
         serialize_model(resource, opts)
       end
 
@@ -44,7 +44,7 @@ module Sinatra::JSONAPI
       app.patch '/:id', :actions=>%i[show update] do |id|
         sanity_check!(id)
         self.resource, = show(id)
-        not_found unless resource
+        not_found "Resource '#{id}' not found" unless resource
         serialize_model?(transaction do
           update(data.fetch(attributes, {})).tap do
             dispatch_relationship_requests!(id, :method=>:patch)
@@ -54,7 +54,7 @@ module Sinatra::JSONAPI
 
       app.delete '/:id', :actions=>%i[show destroy] do |id|
         self.resource, = show(id)
-        not_found unless resource
+        not_found "Resource '#{id}' not found" unless resource
         _, opts = destroy
         serialize_model?(nil, opts)
       end

data/lib/sinatra/jsonapi.rb

@@ -78,6 +78,10 @@ module Sinatra::JSONAPI
         roles.nil? || roles.empty? || Set[*role].intersect?(roles)
       end
 
+      def content?
+        request.body.respond_to?(:size) && request.body.size > 0
+      end
+
       def data
         @data ||= deserialized_request_body[:data]
       end
@@ -104,8 +108,11 @@ module Sinatra::JSONAPI
 
     app.before do
       halt 406 unless request.preferred_type.entry == MIME_TYPE
-      halt 415 unless request.media_type == MIME_TYPE
-      halt 415 if request.media_type_params.keys.any? { |k| k != 'charset' }
+
+      if content?
+        halt 415 unless request.media_type == MIME_TYPE
+        halt 415 if request.media_type_params.keys.any? { |k| k != 'charset' }
+      end
 
       content_type :api_json
 

data/lib/sinja/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: false
 module Sinatra
   module JSONAPI
-    VERSION = '0.1.0.beta1'.freeze
+    VERSION = '0.1.0.beta2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinja
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0.beta2
 platform: ruby
 authors:
 - Mike Pastore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json