scorpio 0.4.6 → 0.5.0

data/test/blog.rest_description.yml

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

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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorpio
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsi
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: ur
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -283,6 +283,13 @@ files:
 - lib/scorpio/version.rb
 - resources/icons/AGPL-3.0.png
 - scorpio.gemspec
+- test/blog.openapi2.yml
+- test/blog.openapi3.yml
+- test/blog.rb
+- test/blog.rest_description.yml
+- test/blog_scorpio_models.rb
+- test/scorpio_test.rb
+- test/test_helper.rb
 homepage: https://github.com/notEthan/scorpio
 licenses:
 - AGPL-3.0
@@ -306,4 +313,11 @@ rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Scorpio REST client
-test_files: []
+test_files:
+- test/blog.openapi2.yml
+- test/blog.openapi3.yml
+- test/blog.rb
+- test/blog.rest_description.yml
+- test/blog_scorpio_models.rb
+- test/scorpio_test.rb
+- test/test_helper.rb