sinja 0.2.0.beta2 → 1.0.0.pre1

data/lib/sinja/relationship_routes/has_one.rb

@@ -3,11 +3,24 @@ module Sinja
   module RelationshipRoutes
     module HasOne
       ACTIONS = %i[pluck prune graft].freeze
-      CONFLICT_ACTIONS = %i[graft].freeze
 
       def self.registered(app)
         app.def_action_helpers(ACTIONS, app)
 
+        app.head '' do
+          unless relationship_link?
+            allow :get=>:pluck
+          else
+            allow :get=>:show, :patch=>[:prune, :graft]
+          end
+        end
+
+        app.get '', :actions=>:show do
+          pass unless relationship_link?
+
+          serialize_linkage
+        end
+
         app.get '', :actions=>:pluck do
           serialize_model(*pluck)
         end

data/lib/sinja/resource.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+require 'active_support/inflector'
+require 'set'
 require 'sinatra/base'
 require 'sinatra/namespace'
 
+require 'sinja/helpers/nested'
 require 'sinja/helpers/relationships'
 require 'sinja/relationship_routes/has_many'
 require 'sinja/relationship_routes/has_one'
@@ -9,36 +12,36 @@ require 'sinja/resource_routes'
 
 module Sinja
   module Resource
-    def def_action_helper(action, context=nil)
-      abort "JSONAPI resource actions can't be HTTP verbs!" \
+    SIDELOAD_ACTIONS = Set.new(%i[graft merge clear]).freeze
+
+    def def_action_helper(action, context)
+      abort "JSONAPI action helpers can't be HTTP verbs!" \
         if Sinatra::Base.respond_to?(action)
 
       context.define_singleton_method(action) do |**opts, &block|
-        can(action, opts[:roles]) if opts.key?(:roles)
+        resource_roles.merge!(action=>opts[:roles]) if opts.key?(:roles)
+        resource_sideload.merge!(action=>opts[:sideload_on]) if opts.key?(:sideload_on)
+
+        return unless block ||=
+          case !method_defined?(action) && action
+          when :show
+            proc { |id| find(id) } if method_defined?(:find)
+          end
 
-        return if block.nil?
+        # TODO: Move this to a constant or configurable?
+        required_arity = {
+          :create=>2,
+          :index=>-1,
+          :fetch=>-1
+        }.freeze[action] || 1
 
         define_method(action) do |*args|
-          send("before_#{action}") if respond_to?("before_#{action}")
-
-          result =
-            begin
-              instance_exec(*args.take(block.arity.abs), &block)
-            rescue Exception=>e
-              halt 409, e.message if settings._sinja.conflict?(action, e.class)
-              #halt 422, resource.errors if settings._sinja.invalid?(action, e.class) # TODO
-              #not_found if settings._sinja.not_found?(action, e.class) # TODO
-              raise
-            end
+          raise ArgumentError, "Unexpected block signature for `#{action}' action helper" \
+            unless args.length == block.arity
 
-          # TODO: Move this to a constant or configurable?
-          required_arity = {
-            :create=>2,
-            :index=>-1,
-            :fetch=>-1
-          }.freeze[action] || 1
+          public_send("before_#{action}", *args) if respond_to?("before_#{action}")
 
-          case result
+          case result = instance_exec(*args, &block)
           when Array
             opts = {}
             if Hash === result.last
@@ -59,7 +62,7 @@ module Sinja
         end
 
         define_singleton_method("remove_#{action}") do
-          remove_method(action)
+          remove_method(action) if respond_to?(action)
         end
       end
     end
@@ -71,18 +74,6 @@ module Sinja
     def self.registered(app)
       app.helpers Helpers::Relationships do
         attr_accessor :resource
-
-        def attributes
-          dedasherize_names(data.fetch(:attributes, {}))
-        end
-
-        def sanity_check!(id=nil)
-          halt 409, 'Resource type in payload does not match endpoint' \
-            if data[:type] != request.path.split('/').last # TODO
-
-          halt 409, 'Resource ID in payload does not match endpoint' \
-            if id && data[:id].to_s != id.to_s
-        end
       end
 
       app.register ResourceRoutes
@@ -90,38 +81,28 @@ module Sinja
 
     %i[has_one has_many].each do |rel_type|
       define_method(rel_type) do |rel, &block|
-        rel_path = rel.to_s.tr('_', '-')
+        rel_path = rel.to_s
+          .send(rel_type == :has_one ? :singularize : :pluralize)
+          .dasherize
+          .to_sym
 
-        namespace %r{/(?<resource_id>[^/]+)(?<r>/relationships)?/#{rel_path}}, :actions=>:show do
-          helpers do
-            def relationship_link?
-              !params[:r].nil?
-            end
+        _resource_roles[rel_type][rel.to_sym] # trigger default proc
 
-            def resource
-              super || self.resource = show(params[:resource_id]).first
-            end
+        namespace %r{/[^/]+(?<r>/relationships)?/#{rel_path}} do
+          define_singleton_method(:resource_roles) do
+            _resource_roles[rel_type][rel.to_sym]
+          end
 
-            def sanity_check!
-              super(params[:resource_id])
+          helpers Helpers::Nested do
+            define_method(:can?) do |*args|
+              super(*args, rel_type, rel.to_sym)
             end
 
-            define_method(:linkage) do
-              # TODO: This is extremely wasteful. Refactor JAS to expose the linkage serializer?
-              serialize_model(resource, :include=>rel_path)['data']['relationships'][rel_path]
+            define_method(:serialize_linkage) do |*args|
+              super(resource, rel_path, *args)
             end
           end
 
-          before do
-            not_found 'Parent resource not found' unless resource
-          end
-
-          get '' do
-            pass unless relationship_link?
-
-            serialize_linkage
-          end
-
           register RelationshipRoutes.const_get \
             rel_type.to_s.split('_').map(&:capitalize).join.to_sym
 

data/lib/sinja/resource_routes.rb

@@ -2,45 +2,57 @@
 module Sinja
   module ResourceRoutes
     ACTIONS = %i[index show create update destroy].freeze
-    CONFLICT_ACTIONS = %i[create update].freeze
 
     def self.registered(app)
       app.def_action_helpers(ACTIONS, app)
 
+      app.head '', :pfilters=>:id do
+        allow :get=>:show
+      end
+
       app.get '', :pfilters=>:id, :actions=>:show do
         ids = params['filter'].delete('id')
         ids = ids.split(',') if ids.respond_to?(:split)
 
         opts = {}
         resources = [*ids].tap(&:uniq!).map! do |id|
-          self.resource, opts = show(id)
-          not_found "Resource '#{id}' not found" unless resource
-          resource
+          tmp, opts = show(id)
+          raise NotFoundError, "Resource '#{id}' not found" unless tmp
+          tmp
         end
 
         # TODO: Serialize collection with opts from last model found?
         serialize_models(resources, opts)
       end
 
-      app.get '', :actions=>:index do
-        serialize_models(*index)
+      app.head '' do
+        allow :get=>:index, :post=>:create
       end
 
-      app.get '/:id', :actions=>:show do |id|
-        self.resource, opts = show(id)
-        not_found "Resource '#{id}' not found" unless resource
-        serialize_model(resource, opts)
+      app.get '', :actions=>:index do
+        serialize_models(*index)
       end
 
       app.post '', :actions=>:create do
         sanity_check!
-        halt 403, 'Client-generated IDs not supported' \
-          if data[:id] && method(:create).arity != 2
 
-        _, self.resource, opts = transaction do
-          create(attributes, data[:id]).tap do |id, *|
-            dispatch_relationship_requests!(id, :method=>:patch)
-          end
+        opts = {}
+        transaction do
+          id, self.resource, opts =
+            begin
+              args = [attributes]
+              args << data[:id] if data.key?(:id)
+              create(*args)
+            rescue ArgumentError
+              if data.key?(:id)
+                raise ForbiddenError, 'Client-generated ID not supported'
+              else
+                raise ForbiddenError, 'Client-generated ID not provided'
+              end
+            end
+
+          dispatch_relationship_requests!(id, :from=>:create, :methods=>{ :has_many=>:post })
+          validate! if respond_to?(:validate!)
         end
 
         if resource
@@ -49,27 +61,35 @@ module Sinja
             headers 'Location'=>self_link
           end
           [201, content]
-        elsif data[:id]
+        elsif data.key?(:id)
           204
         else
           raise ActionHelperError, "Unexpected return value(s) from `create' action helper"
         end
       end
 
-      app.patch '/:id', :actions=>%i[show update] do |id|
+      app.head '/:id' do
+        allow :get=>:show, :patch=>:update, :delete=>:destroy
+      end
+
+      app.get '/:id', :actions=>:show do |id|
+        tmp, opts = show(id)
+        raise NotFoundError, "Resource '#{id}' not found" unless tmp
+        serialize_model(tmp, opts)
+      end
+
+      app.patch '/:id', :actions=>:update do |id|
         sanity_check!(id)
-        self.resource, = show(id)
-        not_found "Resource '#{id}' not found" unless resource
-        serialize_model?(transaction do
+        tmp, opts = transaction do
           update(attributes).tap do
-            dispatch_relationship_requests!(id, :method=>:patch)
+            dispatch_relationship_requests!(id, :from=>:update)
+            validate! if respond_to?(:validate!)
           end
-        end)
+        end
+        serialize_model?(tmp, opts)
       end
 
-      app.delete '/:id', :actions=>%i[show destroy] do |id|
-        self.resource, = show(id)
-        not_found "Resource '#{id}' not found" unless resource
+      app.delete '/:id', :actions=>:destroy do |id|
         _, opts = destroy
         serialize_model?(nil, opts)
       end

data/lib/sinja/version.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 module Sinja
-  VERSION = '0.2.0.beta2'.freeze
+  VERSION = '1.0.0.pre1'
 end

data/sinja.gemspec

@@ -18,13 +18,24 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = %w[lib]
 
-  # TODO: relax these dependencies
-  spec.add_dependency 'json', '~> 2.0.1'
-  spec.add_dependency 'jsonapi-serializers', '~> 0.16.0'
-  spec.add_dependency 'sinatra', '~> 2.0.0.beta2'
-  spec.add_dependency 'sinatra-contrib', '~> 2.0.0.beta2'
+  spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_dependency 'activesupport', ">= #{ENV.fetch('rails', '4.2.7.1')}", '< 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_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'minitest', '~> 5.9'
+  spec.add_development_dependency 'minitest-hooks', '~> 1.4'
+  #spec.add_development_dependency 'munson', '~> 0.4'
   spec.add_development_dependency 'rake', '~> 11.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sequel', '~> 4.38'
+  if defined?(JRUBY_VERSION)
+    spec.add_development_dependency 'jdbc-sqlite3', '~> 3.8'
+  else
+    spec.add_development_dependency 'sqlite3', '~> 1.3'
+  end
 end

metadata

@@ -1,85 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: sinja
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta2
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - Mike Pastore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-20 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.7.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +181,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '11.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.38'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.3'
 description: 
 email:
 - mike@oobak.org
@@ -124,16 +224,28 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/role_list.rb
+- demo-app/Gemfile
+- demo-app/app.rb
+- demo-app/base.rb
+- demo-app/boot.rb
+- demo-app/classes/author.rb
+- demo-app/classes/comment.rb
+- demo-app/classes/post.rb
+- demo-app/classes/tag.rb
+- demo-app/database.rb
+- demo-app/test.rb
 - lib/sinatra/jsonapi.rb
 - lib/sinja.rb
 - lib/sinja/config.rb
+- lib/sinja/errors.rb
+- lib/sinja/extensions/sequel.rb
+- lib/sinja/helpers/nested.rb
 - lib/sinja/helpers/relationships.rb
 - lib/sinja/helpers/sequel.rb
 - lib/sinja/helpers/serializers.rb
+- lib/sinja/method_override.rb
 - lib/sinja/relationship_routes/has_many.rb
 - lib/sinja/relationship_routes/has_one.rb
-- lib/sinja/relationship_routes/sequel.rb
 - lib/sinja/resource.rb
 - lib/sinja/resource_routes.rb
 - lib/sinja/version.rb
@@ -150,7 +262,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -158,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: RESTful, JSON:API-compliant web services in Sinatra