scorpio 0.4.6 → 0.5.0

data/lib/scorpio/resource_base.rb

@@ -423,7 +423,14 @@ module Scorpio
 
       def response_object_to_instances(object, initialize_options = {})
         if object.is_a?(JSI::Base)
-          model = models_by_schema[object.schema]
+          models = object.jsi_schemas.map { |schema| models_by_schema[schema] }
+          if models.size == 0
+            model = nil
+          elsif models.size == 1
+            model = models.first
+          else
+            raise(Scorpio::OpenAPI::Error, "multiple models indicated by response JSI. models: #{models.inspect}; jsi: #{jsi.pretty_inspect.chomp}")
+          end
         end
 
         if object.respond_to?(:to_hash)
@@ -522,6 +529,6 @@ module Scorpio
     def jsi_fingerprint
       {class: self.class, attributes: JSI::Typelike.as_json(@attributes)}
     end
-    include JSI::FingerprintHash
+    include JSI::Util::FingerprintHash
   end
 end

data/lib/scorpio/response.rb

@@ -1,5 +1,7 @@
 module Scorpio
-  class Response < ::Ur::Response
+  Response = Scorpio::Ur.properties['response']
+
+  module Response
     # @return [::JSI::Schema] the schema for this response according to its OpenAPI doc
     def response_schema
       ur.scorpio_request.operation.response_schema(status: status, media_type: media_type)

data/lib/scorpio/ur.rb

@@ -1,5 +1,16 @@
 module Scorpio
-  class Ur < ::Ur
+  # Scorpio::Ur is a JSI Schema module with which scorpio extends the ::Ur schema module
+  Ur = JSI::Schema.new({
+    '$id' => 'https://schemas.jsi.unth.net/ur',
+    'properties' => {
+      'request' => {},
+      'response' => {},
+    }
+  }).jsi_schema_module
+
+  -> { Scorpio::Response }.() # invoke autoload
+
+  module Ur
     attr_accessor :scorpio_request
 
     # raises a subclass of Scorpio::HTTPError if the response has an error status.
@@ -28,19 +39,5 @@ module Scorpio
       end
       nil
     end
-
-    private
-    # overrides JSI::Base#class_for_schema to use Scorpio::Response instead of ::Ur::Response.
-    # maybe a Scorpio::Ur::Request in the future if I need to extend that ... or Scorpio::Request
-    # if I decide to make that subclass ::Ur::Request. not sure if that's a good idea or a terrible
-    # idea.
-    def class_for_schema(schema)
-      jsi_class_for_schema = super
-      if jsi_class_for_schema == ::Ur::Response
-        Scorpio::Response
-      else
-        jsi_class_for_schema
-      end
-    end
   end
 end

data/lib/scorpio/version.rb

@@ -1,3 +1,3 @@
 module Scorpio
-  VERSION = "0.4.6"
+  VERSION = "0.5.0"
 end

data/scorpio.gemspec

@@ -16,14 +16,15 @@ Gem::Specification.new do |spec|
   ignore_files = %w(.gitignore .travis.yml Gemfile test)
   ignore_files_re = %r{\A(#{ignore_files.map { |f| Regexp.escape(f) }.join('|')})(/|\z)}
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(ignore_files_re) }
+  spec.test_files    = `git ls-files -z test`.split("\x0")
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "jsi", "~> 0.3.0"
-  spec.add_dependency "ur", "~> 0.1.0"
+  spec.add_dependency "jsi", "~> 0.4.0"
+  spec.add_dependency "ur", "~> 0.2.0"
   spec.add_dependency "faraday"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-around"
   spec.add_development_dependency "minitest-reporters"

data/test/blog.openapi2.yml

@@ -0,0 +1,113 @@
+---
+swagger: '2.0'
+info:
+  title: Scorpio Blog
+  description: REST service for the Scorpio Blog
+  version: ''
+  contact: {}
+host: blog
+basePath: "/v1"
+schemes: ['https']
+consumes:
+- application/json
+produces:
+- application/json
+paths:
+  "/articles":
+    get:
+      tags:
+      - articles
+      operationId: articles.index
+      responses:
+        default:
+          description: default response
+          schema:
+            type: array
+            items:
+              "$ref": "#/definitions/articles"
+    post:
+      tags:
+      - articles
+      operationId: articles.post
+      parameters:
+      - name: body
+        in: body
+        required: true
+        schema:
+          "$ref": "#/definitions/articles"
+      responses:
+        default:
+          description: default response
+          schema:
+            "$ref": "#/definitions/articles"
+  "/articles_with_root":
+    get:
+      tags:
+      - articles
+      operationId: articles.index_with_root
+      responses:
+        default:
+          description: default response
+          schema:
+            type: object
+            properties:
+              articles:
+                type: array
+                items:
+                  "$ref": "#/definitions/articles"
+              best_article:
+                "$ref": "#/definitions/articles"
+              version:
+                type: string
+  "/articles/{id}":
+    get:
+      tags:
+      - articles
+      operationId: articles.read
+      parameters:
+      - name: id
+        in: path
+        required: true
+        type: string
+      responses:
+        default:
+          description: default response
+          schema:
+            "$ref": "#/definitions/articles"
+    patch:
+      tags:
+      - articles
+      operationId: articles.patch
+      parameters:
+      - name: id
+        in: path
+        required: true
+        type: string
+      - name: body
+        in: body
+        required: true
+        schema:
+          "$ref": "#/definitions/articles"
+      responses:
+        default:
+          description: default response
+          schema:
+            "$ref": "#/definitions/articles"
+  "/clean":
+    post:
+      tags:
+      - clean
+      operationId: clean
+      responses:
+        default:
+          description: default response
+definitions:
+  articles:
+    type: object
+    properties:
+      id:
+        type: integer
+      title:
+        type: string
+      author_id:
+        type: integer

data/test/blog.openapi3.yml

@@ -0,0 +1,131 @@
+openapi: 3.0.0
+servers:
+- url: "{scheme}://{host}:{port}/{basePath}"
+  variables:
+    scheme:
+      default: https
+    host:
+      default: blog.scorpio
+    port:
+      default: '443'
+    basePath:
+      enum:
+        - v1
+      default: v1
+info:
+  title: Scorpio Blog
+  description: REST service for the Scorpio Blog
+  version: ''
+  contact: {}
+paths:
+  /articles:
+    get:
+      tags:
+      - articles
+      operationId: articles.index
+      responses:
+        default:
+          description: default response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/articles'
+    post:
+      tags:
+      - articles
+      operationId: articles.post
+      responses:
+        default:
+          description: default response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/articles'
+      requestBody:
+        $ref: '#/components/requestBodies/articles'
+  /articles_with_root:
+    get:
+      tags:
+      - articles
+      operationId: articles.index_with_root
+      responses:
+        default:
+          description: default response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  articles:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/articles'
+                  best_article:
+                    $ref: '#/components/schemas/articles'
+                  version:
+                    type: string
+  '/articles/{id}':
+    get:
+      tags:
+      - articles
+      operationId: articles.read
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        default:
+          description: default response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/articles'
+    patch:
+      tags:
+      - articles
+      operationId: articles.patch
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        default:
+          description: default response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/articles'
+      requestBody:
+        $ref: '#/components/requestBodies/articles'
+  /clean:
+    post:
+      tags:
+      - clean
+      operationId: clean
+      responses:
+        default:
+          description: default response
+components:
+  requestBodies:
+    articles:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/articles'
+      required: true
+  schemas:
+    articles:
+      type: object
+      properties:
+        id:
+          type: integer
+        title:
+          type: string
+        author_id:
+          type: integer

data/test/blog.rb

@@ -0,0 +1,117 @@
+require 'sinatra'
+require 'api_hammer'
+require 'rack/accept'
+require 'logger'
+
+# app
+
+class Blog < Sinatra::Base
+  include ApiHammer::Sinatra
+  self.supported_media_types = ['application/json']
+  set :static, false
+  disable :protection
+  logpath = Pathname.new('log/test.log')
+  FileUtils.mkdir_p(logpath.dirname)
+  set :logger, ::Logger.new(logpath)
+  logger.level = ::Logger::INFO
+  define_method(:logger) { self.class.logger }
+  use_with_lint ApiHammer::RequestLogger, logger
+
+  # prevent sinatra from using Sinatra::ShowExceptions so we can use ShowTextExceptions instead
+  set :show_exceptions, false
+  # allow errors to bubble past sinatra up to ShowTextExceptions
+  set :raise_errors, true
+  # ShowTextExceptions rescues ruby exceptions and gives a response of 500 with text/plain
+  use_with_lint ApiHammer::ShowTextExceptions, :full_error => true, :logger => logger
+end
+
+# models
+
+require 'active_record'
+ActiveRecord::Base.logger = Blog.logger
+dbpath = Pathname.new('tmp/blog.sqlite3')
+FileUtils.mkdir_p(dbpath.dirname)
+dbpath.unlink if dbpath.exist?
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database  => dbpath
+)
+
+ActiveRecord::Schema.define do
+  create_table :articles do |table|
+    table.column :title, :string
+    table.column :author_id, :integer
+  end
+
+  create_table :authors do |table|
+    table.column :name, :string
+  end
+end
+
+# we will namespace the models under Blog so that the top-level namespace
+# can be used by the scorpio model classes
+class Blog
+  class Article < ActiveRecord::Base
+    # validates_enthusiasm_of :title
+    validate { errors.add(:title, "with gusto!") if title && !title[/!\z/] }
+  end
+  class Author < ActiveRecord::Base
+  end
+end
+
+# controllers
+
+class Blog
+  get '/v1/articles' do
+    check_accept
+
+    articles = Blog::Article.all
+    format_response(200, articles.map(&:serializable_hash))
+  end
+  get '/v1/articles_with_root' do
+    check_accept
+
+    articles = Blog::Article.all
+    body = {
+      # this is on the response schema, an array with items whose id indicates they are articles
+      'articles' => articles.map(&:serializable_hash),
+      # in the response schema, a single article
+      'best_article' => articles.last.serializable_hash,
+      # this is on the response schema, not indicating it is an article
+      'version' => 'v1',
+      # this is not in the response schema at all
+      'note' => 'hi!',
+    }
+    format_response(200, body)
+  end
+  get '/v1/articles/:id' do |id|
+    article = find_or_halt(Blog::Article, id: id)
+    format_response(200, article.serializable_hash)
+  end
+  post '/v1/articles' do
+    article = Blog::Article.create(parsed_body)
+    if article.persisted?
+      format_response(200, article.serializable_hash)
+    else
+      halt_unprocessable_entity(article.errors.messages)
+    end
+  end
+  patch '/v1/articles/:id' do |id|
+    article_attrs = parsed_body
+    article = find_or_halt(Blog::Article, id: id)
+
+    article.assign_attributes(article_attrs)
+    saved = article.save
+    if saved
+      format_response(200, article.serializable_hash)
+    else
+      halt_unprocessable_entity(article.errors.messages)
+    end
+  end
+
+  require 'database_cleaner'
+  post '/v1/clean' do
+    DatabaseCleaner.clean_with(:truncation)
+    format_response(200, nil)
+  end
+end