exosinatra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6783b852edab104742cbc434fc613953c1d39a5a3a520c6faa08939c360a4de6
+  data.tar.gz: 31f05f2cb2e1a963b1c3ebe4372916e1375d43f3f120ed8e57bbd7fb53d14573
+SHA512:
+  metadata.gz: 6f58095393ee0e2afe6ce1c22175f73b423cd04f5831acac0a6ebcfe765188a09229759afdbf6a9c1e07373e5ac39cce909037a530524314cfc460d6294ee319
+  data.tar.gz: 53011372ca9dd75841b2076455cca90f9873d0d26a352896981e0308bd945e1d849efb70fef966a95e8fcf42420943ff87a6bf8a49f88c0a5deb00856af94be9

data/README.md

@@ -0,0 +1,17 @@
+# ExoSinatra
+
+SinatraHelpers: This gem provides helpers for the Sinatra framework in a Ruby project.
+
+  - JSON responses
+
+[reference for gem creation: [newgem-template](https://github.com/wycats/newgem-template)]
+
+[reference for git init: [github init](https://gist.github.com/seankross/8830032)]
+
+
+## Getting started
+
+### Requirements
+
+- Ruby 2.5+
+- Sinatra 2.1.0

data/lib/exosinatra/json_responses.rb

@@ -0,0 +1,227 @@
+require 'json'
+
+module JsonResponses
+  # JSON Responses
+
+  #
+  # resp: response, Hash or Array
+  #
+  def json(resp)
+    headers['Content-Type'] = 'application/json'
+
+    resp.to_json
+  end
+
+  #
+  # code:   error code, Int
+  # errors: specific errors, String or Array of strings (merged as string -with commas- in output)
+  #
+  def json_error(code, errors='')
+    halt(code,
+         {'Content-Type' => 'application/json'},
+         {
+           :code => code,
+           :message => http_status_codes[code],
+           :errors => errors.class == Array ? errors.join(', ') : errors
+         }.to_json)
+  end
+
+  #
+  # code:     status code, Int
+  # warnings: specific warnings,
+  #           String or Array of strings (merged as string -with commas- in output)
+  #
+  def json_warning(code, warnings='')
+    [
+      code,
+      {'Content-Type' => 'application/json'},
+      {
+        :code => code,
+        :message => http_status_codes[code],
+        :warnings => warnings.class == Array ? warnings.join(', ') : warnings
+      }.to_json
+    ]
+  end
+
+  #
+  # code: status code, Int
+  #
+  def json_info(code)
+    [
+      code,
+      {'Content-Type' => 'application/json'},
+      {
+        :code => code,
+        :message => http_status_codes[code]
+      }.to_json
+    ]
+  end
+
+  #
+  # ret: return value, Hash
+  #
+  def json_return(ret)
+    r = ret[:return]
+    case r
+    when -1
+      json_error(400, ret[:errors])
+    when -2
+      json_error(500, ret[:errors])
+    when 0
+      json_warning(204, ret[:warnings])
+    else
+      json(ret[:body])
+    end
+  end
+
+  #
+  # code: status code, Int
+  #
+  def status_of(code)
+    case code
+    when 100..199
+      :info
+    when 200, 201
+      :success_payload
+    when 202..399
+      :success_no_payload
+    when 400..599
+      :error
+    else
+      :other
+    end
+  end
+
+  #
+  # ret: return value, Hash
+  #
+  def status_of_http_return(ret)
+    status_of(ret[:http_return])
+  end
+
+  #
+  # ret: return value, Hash
+  #
+  def json_http_return(ret)
+    r      = ret[:http_return]
+    status = status_of(ret[:http_return])
+    case status
+    when :info
+      json_info(r)
+    when :success_payload
+      json(ret[:body])
+    when :success_no_payload
+      json_warning(r, ret[:warnings])
+    when :error
+      json_error(r, ret[:errors])
+    else
+      json(ret)
+    end
+  end
+
+  #
+  # ret: return value, Hash
+  #
+  def status_of_result(ret)
+    ret[:success]
+  end
+
+  #
+  # ret: return value, Hash
+  #
+  def json_result(ret, err_code)
+    r = ret[:success]
+    if r
+      json(ret)
+    else
+      json_error(err_code, ret[:errors])
+    end
+  end
+
+  #
+  # ret: return value, Boolean
+  #
+  def json_bool(ret)
+    json({
+      :success => ret
+    })
+  end
+
+  #
+  # TODO: Error codes & messages list
+  #
+  # 1xx -> Informational
+  # 2xx -> Success
+  # 3xx -> Redirection
+  # 4xx -> Client Error
+  # 5xx -> Server Error
+  #
+  def http_status_codes
+    {
+      100 => 'Continue',
+      101 => 'Switching Protocols',
+      102 => 'Processing',
+      200 => 'OK',
+      201 => 'Created',
+      202 => 'Accepted',
+      203 => 'Non-authoritative Information',
+      204 => 'No Content',
+      205 => 'Reset Content',
+      206 => 'Partial Content',
+      207 => 'Multi-Status',
+      208 => 'Already Reported',
+      226 => 'IM Used',
+      300 => 'Multiple Choices',
+      301 => 'Moved Permanently',
+      302 => 'Found',
+      303 => 'See Other',
+      304 => 'Not Modified',
+      305 => 'Use Proxy',
+      307 => 'Temporary Redirect',
+      308 => 'Permanent Redirect',
+      400 => 'Bad Request',
+      401 => 'Unauthorized',
+      402 => 'Payment Required',
+      403 => 'Forbidden',
+      404 => 'Not Found',
+      405 => 'Method Not Allowed',
+      406 => 'Not Acceptable',
+      407 => 'Proxy Authentication Required',
+      408 => 'Request Timeout',
+      409 => 'Conflict',
+      410 => 'Gone',
+      411 => 'Length Required',
+      412 => 'Precondition Failed',
+      413 => 'Payload Too Large',
+      414 => 'Request-URI Too Long',
+      415 => 'Unsupported Media Type',
+      416 => 'Requested Range Not Satisfiable',
+      417 => 'Expectation Failed',
+      418 => "I'm a teapot",
+      421 => 'Misdirected Request',
+      422 => 'Unprocessable Entity',
+      423 => 'Locked',
+      424 => 'Failed Dependency',
+      426 => 'Upgrade Required',
+      428 => 'Precondition Required',
+      429 => 'Too Many Requests',
+      431 => 'Request Header Fields Too Large',
+      444 => 'Connection Closed Without Response',
+      451 => 'Unavailable For Legal Reasons',
+      499 => 'Client Closed Request',
+      500 => 'Internal Server Error',
+      501 => 'Not Implemented',
+      502 => 'Bad Gateway',
+      503 => 'Service Unavailable',
+      504 => 'Gateway Timeout',
+      505 => 'HTTP Version Not Supported',
+      506 => 'Variant Also Negotiates',
+      507 => 'Insufficient Storage',
+      508 => 'Loop Detected',
+      510 => 'Not Extended',
+      511 => 'Network Authentication Required',
+      599 => 'Network Connect Timeout Error'
+    }
+  end
+
+end

data/lib/exosinatra/version.rb

@@ -0,0 +1,3 @@
+module ExoSinatra
+  VERSION = "0.1.0"
+end

data/lib/exosinatra.rb

@@ -0,0 +1 @@
+require 'exosinatra/json_responses'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: exosinatra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dionysios Kakolyris
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: exobasic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Exotic Sinatra Helpers
+email:
+- contact@exotic.industries
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/exosinatra.rb
+- lib/exosinatra/json_responses.rb
+- lib/exosinatra/version.rb
+homepage: https://bitbucket.org/vertigoindustries/exotic-sinatra
+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.6
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: SinatraHelpers
+test_files: []