scorpio 0.5.0 → 0.6.0

data/test/blog.rb

@@ -1,117 +0,0 @@
-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

data/test/blog.rest_description.yml

@@ -1,67 +0,0 @@
-discoveryVersion: v1
-name: blog
-title: "Scorpio Blog"
-description: "REST service for the Scorpio Blog"
-documentationLink: https://github.com/notEthan/scorpio
-servicePath: /v1
-resources:
-  articles:
-    methods:
-      index:
-        path: articles
-        httpMethod: GET
-        response:
-          type: array
-          items:
-            $ref: https://blog.example.com/schemas/articles/v1.0.0
-      index_with_root:
-        path: articles_with_root
-        httpMethod: GET
-        response:
-          type: object
-          properties:
-            articles:
-              type: array
-              items:
-                $ref: https://blog.example.com/schemas/articles/v1.0.0
-            best_article:
-              $ref: https://blog.example.com/schemas/articles/v1.0.0
-            version:
-              type: string
-      read:
-        path: articles/{id}
-        httpMethod: GET
-        response:
-          $ref: https://blog.example.com/schemas/articles/v1.0.0
-      post:
-        path: articles
-        httpMethod: POST
-        request:
-          $ref: https://blog.example.com/schemas/articles/v1.0.0
-        response:
-          $ref: https://blog.example.com/schemas/articles/v1.0.0
-      patch:
-        path: articles/{id}
-        httpMethod: PATCH
-        request:
-          $ref: https://blog.example.com/schemas/articles/v1.0.0
-        response:
-          $ref: https://blog.example.com/schemas/articles/v1.0.0
-  clean:
-    methods:
-      clean:
-        path: clean
-        httpMethod: POST
-        response:
-          {}
-schemas:
-  articles:
-    id: https://blog.example.com/schemas/articles/v1.0.0
-    type: object
-    properties:
-      id:
-        type: integer
-      title:
-        type: string
-      author_id:
-        type: integer

data/test/blog_scorpio_models.rb

@@ -1,49 +0,0 @@
-require 'logger'
-require 'api_hammer'
-
-# this is a virtual model to parent models representing resources of the blog. it sets
-# up connection information including base url, custom middleware or adapter for faraday.
-# it describes the API by setting the API document, but this class itself represents no
-# resources - it sets no resource_name and defines no schema_keys.
-class BlogModel < Scorpio::ResourceBase
-  define_inheritable_accessor(:logger)
-  logpath = Pathname.new('log/test.log')
-  FileUtils.mkdir_p(logpath.dirname)
-  self.logger = ::Logger.new(logpath)
-
-  if ENV['SCORPIO_API_DESCRIPTION_FORMAT'] == 'rest_description'
-    self.openapi_document = Scorpio::Google::RestDescription.new_jsi(YAML.load_file('test/blog.rest_description.yml')).to_openapi_document
-    self.base_url = File.join("http://localhost:#{$blog_port || raise(Bug)}/", openapi_document.basePath)
-  elsif ENV['SCORPIO_API_DESCRIPTION_FORMAT'] == 'openapi2'
-    self.openapi_document = YAML.load_file('test/blog.openapi2.yml')
-    self.base_url = File.join("http://localhost:#{$blog_port || raise(Bug)}/", openapi_document.basePath)
-  elsif ENV['SCORPIO_API_DESCRIPTION_FORMAT'] == 'openapi3' || ENV['SCORPIO_API_DESCRIPTION_FORMAT'].nil?
-    self.openapi_document = YAML.load_file('test/blog.openapi3.yml')
-    self.server_variables = {
-      'scheme' => 'http',
-      'host' => 'localhost',
-      'port' => $blog_port || raise(Bug, '$blog_port is nil'),
-    }
-  else
-    abort("bad SCORPIO_API_DESCRIPTION_FORMAT")
-  end
-  self.faraday_builder = -> (conn) {
-    conn.request(:api_hammer_request_logger, logger)
-  }
-end
-
-# this is a model of Article, a resource of the blog API. it sets the resource_name
-# to the key of the 'resources' section of the API (described by the api document
-# specified to BlogModel) 
-class Article < BlogModel
-  self.tag_name = 'articles'
-  if openapi_document.v2?
-    self.represented_schemas = [openapi_document.definitions['articles']]
-  else
-    self.represented_schemas = [openapi_document.components.schemas['articles']]
-  end
-end
-
-class BlogClean < BlogModel
-  self.tag_name = 'clean'
-end

data/test/scorpio_test.rb

@@ -1,105 +0,0 @@
-require_relative 'test_helper'
-
-class ScorpioTest < Minitest::Test
-  def test_that_it_has_a_version_number
-    refute_nil ::Scorpio::VERSION
-  end
-end
-
-describe 'blog' do
-  let(:blog_article) { Article.post('title' => "sports!") }
-
-  it 'indexes articles' do
-    blog_article
-
-    articles = Article.index
-
-    assert_equal(1, articles.size)
-    article = articles[0]
-    assert_equal(1, article['id'])
-    assert(article.is_a?(Article))
-    assert_equal('sports!', article['title'])
-    assert_equal('sports!', article.title)
-  end
-  it 'indexes articles with root' do
-    blog_article
-
-    articles = Article.index_with_root
-    assert_respond_to(articles, :to_hash)
-    assert_equal('v1', articles['version'])
-    assert_equal('hi!', articles['note'])
-    assert_instance_of(Article, articles['best_article'])
-    assert_equal(articles['articles'].last, articles['best_article'])
-    assert_equal(1, articles['articles'].size)
-    article = articles['articles'][0]
-    assert_equal(1, article['id'])
-    assert(article.is_a?(Article))
-    assert_equal('sports!', article['title'])
-    assert_equal('sports!', article.title)
-  end
-  it 'reads an article' do
-    blog_article
-    article = Article.read(id: blog_article.id)
-    assert(article.is_a?(Article))
-    assert_equal('sports!', article['title'])
-    assert_equal('sports!', article.title)
-  end
-  it 'tries to read an article without a required path variable' do
-    blog_article
-    e = assert_raises(ArgumentError) do
-      Article.read({})
-    end
-    assert_equal('path /articles/{id} for operation articles.read requires path_params which were missing: ["id"]',
-      e.message)
-    e = assert_raises(ArgumentError) do
-      Article.read({id: ''})
-    end
-    assert_equal('path /articles/{id} for operation articles.read requires path_params which were empty: ["id"]',
-      e.message)
-  end
-  it 'tries to read a nonexistent article' do
-    err = assert_raises(Scorpio::NotFound404Error) do
-      Article.read(id: 99)
-    end
-    assert_equal({"article" => ["Unknown article! id: 99"]}, JSI::Typelike.as_json(err.response_object['errors']))
-    assert_match(/Unknown article! id: 99/, err.message)
-  end
-  it 'updates an article on the class' do
-    blog_article
-    Article.patch({id: blog_article.id, title: 'politics!'})
-    assert_equal('politics!', Article.read(id: blog_article.id).title)
-  end
-  it 'updates an article on the instance' do
-    blog_article
-    article = Article.read(id: blog_article.id)
-    article.title = 'politics!'
-    article.patch
-    assert_equal('politics!', Article.read(id: blog_article.id).title)
-  end
-  it 'updates an article with an unsuccessful response' do
-    blog_article
-    err = assert_raises(Scorpio::UnprocessableEntity422Error) do
-      Article.patch({id: blog_article.id, title: 'politics?'})
-    end
-    assert_equal({"title" => ["with gusto!"]}, JSI::Typelike.as_json(err.response_object['errors']))
-    assert_match(/with gusto!/, err.message)
-    assert_equal('sports!', Article.read(id: blog_article.id).title)
-  end
-  it 'instantiates an article with bad argument' do
-    assert_raises(ArgumentError) { Article.new("foo") }
-  end
-  it 'reports schema failure when the request does not match the request schema' do
-    # TODO handle blame
-    assert_raises(Scorpio::HTTPErrors::UnprocessableEntity422Error) do
-      # title is supposed to be a string
-      Article.post('title' => {'music' => '!'})
-    end
-  end
-  it 'checks equality' do
-    assert_equal(Article.read(id: blog_article.id), Article.read(id: blog_article.id))
-  end
-  it 'consistently keys a hash' do
-    hash = {Article.read(id: blog_article.id) => 0}
-    assert_equal(0, hash[Article.read(id: blog_article.id)])
-  end
-end

data/test/test_helper.rb

@@ -1,86 +0,0 @@
-require 'coveralls'
-if Coveralls.will_run?
-  Coveralls.wear!
-end
-
-require 'simplecov'
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'scorpio'
-
-require 'bundler/setup'
-
-# NO EXPECTATIONS 
-ENV["MT_NO_EXPECTATIONS"] = ''
-
-require 'minitest/autorun'
-require 'minitest/around/spec'
-require 'minitest/reporters'
-
-Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
-
-require 'byebug'
-
-class ScorpioSpec < Minitest::Spec
-  if ENV['SCORPIO_TEST_ALPHA']
-    # :nocov:
-    define_singleton_method(:test_order) { :alpha }
-    # :nocov:
-  end
-
-  around do |test|
-    test.call
-    BlogClean.clean
-  end
-
-  def assert_equal exp, act, msg = nil
-    msg = message(msg, E) { diff exp, act }
-    assert exp == act, msg
-  end
-end
-
-# register this to be the base class for specs instead of Minitest::Spec
-Minitest::Spec.register_spec_type(//, ScorpioSpec)
-
-# boot the blog application in a different process
-
-# find a free port
-server = TCPServer.new(0)
-$blog_port = server.addr[1]
-server.close
-
-$blog_pid = fork do
-  require_relative 'blog'
-
-  STDOUT.reopen(Scorpio.root.join('log/blog_webrick_stdout.log').open('a'))
-  STDERR.reopen(Scorpio.root.join('log/blog_webrick_stderr.log').open('a'))
-
-  trap('INT') { ::Rack::Handler::WEBrick.shutdown }
-
-  ::Rack::Handler::WEBrick.run(::Blog, Port: $blog_port)
-end
-
-# wait for the server to become responsive 
-running = false
-started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-timeout = 30
-while !running
-  require 'socket'
-  begin
-    sock=TCPSocket.new('localhost', $blog_port)
-    running = true
-    sock.close
-  rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE
-    if Process.clock_gettime(Process::CLOCK_MONOTONIC) > started + timeout
-      raise $!.class, "Failed to connect to the server on port #{$blog_port} after #{timeout} seconds.\n\n#{$!.message}", $!.backtrace
-    end
-    sleep 2**-2
-    STDOUT.write('.')
-  end
-end
-
-Minitest.after_run do
-  Process.kill('INT', $blog_pid)
-  Process.waitpid
-end
-
-require_relative 'blog_scorpio_models'