sinja 0.1.0.beta1

data/lib/sinatra/jsonapi/relationship_routes/has_many.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module Sinatra::JSONAPI
+  module RelationshipRoutes
+    module HasMany
+      ACTIONS = %i[fetch clear merge subtract].freeze
+      CONFLICT_ACTIONS = %i[merge].freeze
+
+      def self.registered(app)
+        app.def_action_helpers(ACTIONS, app)
+
+        app.get '', :actions=>:fetch do
+          serialize_models(*fetch)
+        end
+
+        app.patch '', :nullif=>proc(&:empty?), :actions=>:clear do
+          serialize_linkages?(*clear)
+        end
+
+        app.patch '', :actions=>%i[clear merge] do
+          clear_updated, clear_opts = clear
+          merge_updated, merge_opts = merge(data)
+          serialize_linkages?(clear_updated||merge_updated, clear_opts.merge(merge_opts)) # TODO: DWIM?
+        end
+
+        app.post '', :actions=>%i[merge] do
+          serialize_linkages?(*merge(data))
+        end
+
+        app.delete '', :actions=>%i[subtract] do
+          serialize_linkages?(*subtract(data))
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/jsonapi/relationship_routes/has_one.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Sinatra::JSONAPI
+  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.get '', :actions=>:pluck do
+          serialize_model(*pluck)
+        end
+
+        app.patch '', :nullif=>proc(&:nil?), :actions=>:prune do
+          serialize_linkage?(*prune)
+        end
+
+        app.patch '', :actions=>:graft do
+          serialize_linkage?(*graft(data))
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/jsonapi/resource.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+require 'sinatra/base'
+require 'sinatra/namespace'
+
+require 'sinatra/jsonapi/helpers/relationships'
+require 'sinatra/jsonapi/relationship_routes/has_many'
+require 'sinatra/jsonapi/relationship_routes/has_one'
+require 'sinatra/jsonapi/resource_routes'
+
+module Sinatra::JSONAPI
+  module Resource
+    def def_action_helper(action, context=nil)
+      abort "JSONAPI resource actions 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)
+
+        if block.nil?
+          if respond_to?(action)
+            # TODO: Is this safe?
+            remove_method(action)
+            return
+          else
+            # TODO: Throw an error?
+          end
+        end
+
+        define_method(action) do |*args|
+          result =
+            begin
+              instance_exec(*args.take(block.arity.abs), &block)
+            rescue Exception=>e
+              halt 409, e.message if settings.sinja_config.conflict?(action, e.class)
+              #halt 422, resource.errors if settings.sinja_config.invalid?(action, e.class) # TODO
+              #not_found if settings.sinja_config.not_found?(action, e.class) # TODO
+              raise
+            end
+
+          # TODO: Move this to a constant or configurable?
+          required_arity = {
+            :create=>2,
+            :index=>-1,
+            :fetch=>-1
+          }.freeze[action] || 1
+
+          case result
+          when Array
+            opts = {}
+            if Hash === result.last
+              opts = result.pop
+            elsif required_arity < 0 && !(Array === result.first)
+              result = [result]
+            end
+
+            raise ActionHelperError, "Unexpected return value(s) from `#{action}' action helper" \
+              unless result.length == required_arity.abs
+
+            result.push(opts)
+          when Hash
+            Array.new(required_arity.abs).push(result)
+          else
+            [result, nil].take(required_arity.abs).push({})
+          end
+        end
+      end
+    end
+
+    def def_action_helpers(actions, context=nil)
+      [*actions].each { |action| def_action_helper(action, context) }
+    end
+
+    def self.registered(app)
+      app.helpers Helpers::Relationships do
+        attr_accessor :resource
+
+        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
+    end
+
+    %i[has_one has_many].each do |rel_type|
+      define_method(rel_type) do |rel, &block|
+        rel_path = rel.to_s.tr('_', '-')
+
+        namespace %r{/(?<resource_id>[^/]+)(?<r>/relationships)?/#{rel_path}}, :actions=>:show do
+          helpers do
+            def relationship_link?
+              !params[:r].nil?
+            end
+
+            def resource
+              super || self.resource = show(params[:resource_id]).first
+            end
+
+            def sanity_check!
+              super(params[:resource_id])
+            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]
+            end
+          end
+
+          before do
+            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
+
+          if rel_type == :has_one
+            pluck { resource.send(rel) }
+          elsif rel_type == :has_many
+            fetch { resource.send(rel) }
+          end
+
+          instance_eval(&block) if block
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/jsonapi/resource_routes.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+module Sinatra::JSONAPI
+  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.get '', :actions=>:index do
+        serialize_models(*index)
+      end
+
+      app.get '/:id', :actions=>:show do |id|
+        self.resource, opts = show(id)
+        not_found unless resource
+        serialize_model(resource, opts)
+      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(data.fetch(:attributes, {}), data[:id]).tap do |id, *|
+            dispatch_relationship_requests!(id, :method=>:patch)
+          end
+        end
+
+        if resource
+          content = serialize_model(resource, opts)
+          if content.respond_to?(:dig) && self_link = content.dig(*%w[data links self])
+            headers 'Location'=>self_link
+          end
+          [201, content]
+        elsif data[:id]
+          204
+        else
+          raise ActionHelperError, "Unexpected return value(s) from `create' action helper"
+        end
+      end
+
+      app.patch '/:id', :actions=>%i[show update] do |id|
+        sanity_check!(id)
+        self.resource, = show(id)
+        not_found unless resource
+        serialize_model?(transaction do
+          update(data.fetch(attributes, {})).tap do
+            dispatch_relationship_requests!(id, :method=>:patch)
+          end
+        end)
+      end
+
+      app.delete '/:id', :actions=>%i[show destroy] do |id|
+        self.resource, = show(id)
+        not_found unless resource
+        _, opts = destroy
+        serialize_model?(nil, opts)
+      end
+    end
+  end
+end

data/lib/sinja.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Sinatra
+  module JSONAPI
+    MIME_TYPE = 'application/vnd.api+json'
+
+    SinjaError = Class.new(StandardError)
+    ActionHelperError = Class.new(SinjaError)
+  end
+end
+
+Sinja = Sinatra::JSONAPI
+
+require 'sinatra/jsonapi'

data/lib/sinja/version.rb

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

data/sinja.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinja/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sinja'
+  spec.version       = Sinatra::JSONAPI::VERSION
+  spec.authors       = ['Mike Pastore']
+  spec.email         = ['mike@oobak.org']
+
+  spec.summary       = 'RESTful, JSON:API-compliant web services in Sinatra'
+  spec.homepage      = 'https://github.com/mwpastore/sinja'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  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.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: sinja
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- Mike Pastore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mike@oobak.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sinatra/jsonapi.rb
+- lib/sinatra/jsonapi/config.rb
+- lib/sinatra/jsonapi/helpers/relationships.rb
+- lib/sinatra/jsonapi/helpers/sequel.rb
+- lib/sinatra/jsonapi/helpers/serializers.rb
+- lib/sinatra/jsonapi/relationship_routes/has_many.rb
+- lib/sinatra/jsonapi/relationship_routes/has_one.rb
+- lib/sinatra/jsonapi/resource.rb
+- lib/sinatra/jsonapi/resource_routes.rb
+- lib/sinja.rb
+- lib/sinja/version.rb
+- sinja.gemspec
+homepage: https://github.com/mwpastore/sinja
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: RESTful, JSON:API-compliant web services in Sinatra
+test_files: []