kjson-roda 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aecd0fd2eb4fa562138cf9932ea18dcd54c8a5f9
+  data.tar.gz: 2a1baf15dabf93d3ccbee63d2cf37eb48b6e29a4
+SHA512:
+  metadata.gz: 30a2e3d70de27a1820d343f9bddc2905e1ce306a430a0483d3d193e7d9ccc9e6de7c0aa542ebf08dff00dda24b3f90c4c621af4dc030c658893cb30df9537395
+  data.tar.gz: 4c9feb1d648ad101cdc61bf0cbb3bf445c0ce613364804cb90507729f03616d30781ea909beabeab4b19186f265f471df4b6e563a52422c4b0771c3a6dfef2e3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,59 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  # Make it large for now
+  Max: 40
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  # Make it large for now
+  Max: 20
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  IgnoredMethods:
+    - lambda
+    - proc
+    - it
+    - Form
+    - Schema
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/IndentationWidth:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Style/MethodName:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/StabbyLambdaParentheses:
+  EnforcedStyle: require_no_parentheses
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInLiteral:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kjson-roda.gemspec
+gemspec
+
+group :test do
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Maksim V
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# Kjson
+
+# Usage
+
+```ruby
+require 'roda'
+
+class App < Roda
+  route do |r|
+    r.plugin :kjson
+
+    r.api do
+      r.endpoint "user" do
+        r.endpoint "new" do
+          r.success {"name": "Emmy"}
+        end
+      end
+    end
+  end
+end
+
+run App.freeze.new
+```
+
+# Create a successful response
+
+```ruby
+r.api do
+  r.success
+end
+```
+
+An alternative way is,
+
+```ruby
+class AlwaysSuccessService
+  def call
+    throw :success
+  end
+end
+
+r.api do
+  r.endpoint "always_success" do
+    service = AlwaysSuccessService.new
+    service.()
+  end
+end
+```
+
+It will generate,
+
+```json
+{
+  "data": null
+  "error": null
+}
+```
+
+# Fill data in response
+
+```ruby
+r.api do
+  r.success data
+end
+```
+
+Or,
+
+```ruby
+r.api do
+  throw :success, data
+end
+```
+
+# A complex endpoint
+
+For request {"endpoint":"part.value","data":null},
+
+```ruby
+r.api do
+  r.endpoint "part" do
+    puts r.endpoint # "value"
+  end
+end
+```
+
+# An arbitrary exception
+
+```ruby
+r.api do
+  raise "Something went wrong."
+end
+```
+
+Response will look as:
+
+```json
+{
+  "data": null,
+  "error": {
+    "type": "SERVICE_ERROR",
+    "message": "INTERNAL",
+    "cause": {
+      "message": "Something went wrong."
+    }
+  }
+}
+```
+
+# A service exception
+
+```ruby
+r.api do
+  throw :error, "RESOURCE_EXHAUSTED"
+end
+```
+
+Response will look as:
+
+```json
+{
+  "data": null,
+  "error": {
+    "type": "SERVICE_ERROR",
+    "message": "RESOURCE_EXHAUSTED"
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kjson-roda"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kjson-roda.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kjson/roda/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kjson-roda"
+  spec.version       = Kjson::Roda::VERSION
+  spec.authors       = ["Maksim V."]
+  spec.email         = ["inre.storm@gmail.com"]
+
+  spec.summary       = "KJson Roda plugin"
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/inre"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oj", "~> 2"
+  spec.add_dependency "roda", "~> 2"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kjson-roda.rb

@@ -0,0 +1 @@
+require "kjson/roda"

data/lib/kjson/roda.rb

@@ -0,0 +1,186 @@
+require "oj"
+require "roda"
+
+module Kjson
+  module Roda
+    OPTS = {}.freeze
+    JSON_PARAMS_KEY = "roda.json_params".freeze
+    INPUT_KEY = "rack.input".freeze
+    CONTENT_TYPE_MATCH = /json/
+    ENDPOINT_SEPARATOR = "."
+    JSON_ENCODER = Oj.method(:dump)
+    JSON_DECODER = Oj.method(:load)
+    JSON_OPTIONS = {
+      mode: :strict,
+      quirks_mode: false
+    }.freeze
+    KJSON_REQUEST_KEY = "kjson.request".freeze
+    KJSON_RESPONSE_KEY = "kjson.response".freeze
+
+    REQUEST_ERROR = "REQUEST_ERROR".freeze
+    SERVICE_ERROR = "SERVICE_ERROR".freeze
+    RESPONSE_ERROR = "RESPONSE_ERROR".freeze
+
+    TIMEOUT = "TIMEOUT".freeze
+    CLOSED = "CLOSED".freeze
+    TRANSPORT = "TRANSPORT".freeze
+    UNAVAILABLE = "UNAVAILABLE".freeze
+    BAD_REQUEST = "BAD_REQUEST".freeze
+    INVALID_FORMAT = "INVALID_FORMAT".freeze
+    UNIMPLEMENTED = "UNIMPLEMENTED".freeze
+
+    UNAUTHENTICATED = "UNAUTHENTICATED".freeze
+    NO_DATA = "NO_DATA".freeze
+
+    INTERNAL = "INTERNAL".freeze
+    PARSE_ERROR_HANDLER = proc { |r| r.halt [400, {}, [Oj.dump({ data: nil, error: { type: REQUEST_ERROR, message: UNIMPLEMENTED } }, JSON_OPTIONS).freeze]] }
+
+    # Handle options for the kjson plugin:
+    def self.configure(app, opts = OPTS)
+      app.opts[:kjson_error_handler] = opts[:error_handler] || app.opts[:kjson_error_handler] || PARSE_ERROR_HANDLER
+      app.opts[:kjson_content_type] = opts[:content_type] || app.opts[:kjson_content_type] || CONTENT_TYPE_MATCH
+      app.opts[:kjson_encoder] = opts[:json_encoder] || app.opts[:kjson_json_encoder] || JSON_ENCODER
+      app.opts[:kjson_decoder] = opts[:json_decoder] || app.opts[:kjson_json_decoder] || JSON_DECODER
+      app.opts[:kjson_options] = opts[:json_options] || app.opts[:kjson_json_options] || JSON_OPTIONS
+    end
+
+    module RequestMethods
+
+      def api(&_b)
+        return unless kjson?
+        catch_error do
+          catch_success do
+            kjson_parse
+            kjson_api
+            yield
+            throw :error, [UNIMPLEMENTED, REQUEST_ERROR]
+          end
+        end
+      end
+
+      def endpoint(path=nil, &_b)
+        return @remaining_endpoints.join(ENDPOINT_SEPARATOR) unless path
+        path = path.to_s.split(ENDPOINT_SEPARATOR)
+        index = @remaining_endpoints.zip(path).index{|z| z.first == z.last}
+        if index && index == path.size - 1
+          stored_endpoints = @remaining_endpoints
+          @remaining_endpoints = @remaining_endpoints.drop(path.size)
+          if @remaining_endpoints.empty?
+            block_result(yield)
+            throw :error, [NO_DATA, RESPONSE_ERROR] if @remaining_endpoints.empty?
+          else
+            yield
+          end
+          @remaining_endpoints = stored_endpoints
+        end
+      end
+
+      def success(data=nil)
+        throw :success, data
+      end
+
+      def error(msg=INTERNAL)
+        throw :error, msg
+      end
+
+      def auth
+        env[KJSON_REQUEST_KEY]["auth"]
+      end
+
+      def data
+        env[KJSON_REQUEST_KEY]["data"]
+      end
+
+      def kjson?
+        post? && content_type =~ roda_class.opts[:kjson_content_type]
+      end
+
+      private
+
+      def kjson_parse
+        input = env[INPUT_KEY]
+        str = input.read
+        input.rewind
+        return super if str.empty?
+        env[KJSON_REQUEST_KEY] = kjson_decode(str)
+      rescue
+        roda_class.opts[:kjson_error_handler].call(self)
+      end
+
+      def kjson_api
+        kjson_request = env[KJSON_REQUEST_KEY]
+        throw :error, [BAD_REQUEST, REQUEST_ERROR] unless kjson_request["endpoint"].is_a?(String)
+        @remaining_endpoints = kjson_request["endpoint"].split(ENDPOINT_SEPARATOR)
+      end
+
+      def catch_success(&_b)
+        data = catch(:success) {
+          yield
+        }
+        response.data(data)
+        throw :halt, response.finish
+      end
+
+      def catch_error(&_b)
+        error = catch(:error) {
+          begin
+            yield
+          rescue
+            [INTERNAL, SERVICE_ERROR, $!]
+          end
+        }
+        error = [error] unless error.is_a?(Array)
+        response.error(*error)
+        throw :halt, response.finish
+      end
+
+      def kjson_decode(str)
+        roda_class.opts[:kjson_decoder].call(str, roda_class.opts[:kjson_options])
+      end
+    end
+
+    module ResponseMethods
+      def data(dt)
+        @kjson_response = true
+        @data = dt
+        nil
+      end
+
+      def error(message, type=SERVICE_ERROR, cause=nil)
+        @kjson_response = true
+        @error = {
+          "type" => type,
+          "message" => message
+        }
+        case cause
+        when Exception
+          @error["cause"] = {
+            "message" => cause.message,
+            "backtrace" => cause.backtrace
+          }
+        when Hash
+          @error["cause"] = cause
+        end
+        nil
+      end
+
+      def finish
+        if @kjson_response
+          @body = [kjson_encode(
+            "data" => @data,
+            "error" => @error
+          )]
+        end
+        super
+      end
+
+      private
+
+      def kjson_encode(obj)
+        roda_class.opts[:kjson_encoder].call(obj, roda_class.opts[:kjson_options])
+      end
+    end
+  end
+end
+
+Roda::RodaPlugins.register_plugin(:kjson, Kjson::Roda)

data/lib/kjson/roda/version.rb

@@ -0,0 +1,5 @@
+module Kjson
+  module Roda
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: kjson-roda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maksim V.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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:
+- inre.storm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kjson-roda.gemspec
+- lib/kjson-roda.rb
+- lib/kjson/roda.rb
+- lib/kjson/roda/version.rb
+homepage: https://github.com/inre
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: KJson Roda plugin
+test_files: []