hyperender 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 349e1b66ef23157c3d9e14458cbe53d0742b3fe2
+  data.tar.gz: ccfb20b5ad551b40769fd15392eb4f8d5cc43e6d
+SHA512:
+  metadata.gz: 5ba3eadf91f11d4729b8f29d77ed818a8695a8161cb273118f1445ebe658439a72ac2687464f264a42355db46c325d43feca4ae3734d9d2d66e84eceadee1ebf
+  data.tar.gz: 11e03fa0ff5e4c90040eaf79f2552ef35529cb0c29da6e0ee9556a2fdb84596fbabdd5604e3a3184979f5e3e1126e89496e0df87a279e632d3d6967c555654fe

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tunnm@topica.edu.vn. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nguyễn Nhật Minh Tú
+
+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,65 @@
+# Hyperender
+
+HATEOAS-like rendering layout for Rails Applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyperender'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hyperender
+
+## Usage
+
+Add this line to your application's controller:
+
+```ruby
+include Hyperender::Action
+```
+
+All of the functions below support a variety of functions independent on the arguments passed to it:
+
+```ruby
+hateoas_data *args		# add data for rendering
+hateoas_error *args		# add error for rendering
+hateoas_params *args	# add parameters for rendering
+```
+
+And without arguments passed, return variables:
+
+```ruby
+hateoas_data			# return data
+hateoas_error			# return error
+hateoas_params			# return parameters
+hateoas_message			# return message
+hateoas_status			# return status
+hateoas_request			# return request
+hateoas_render			# return the HATEOAS-like JSON value
+```
+
+To render HATEOAS-like JSON value:
+
+```ruby
+hateoas_rendering 		# render json: hateoas_render
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on Edumall Gitlab at https://git.edumall.io/minhtu/hyperender. This project is intended with all TST Team to be a safe, welcoming space for collaboration, and contributors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hyperender"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/hyperender.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hyperender/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hyperender"
+  spec.version       = Hyperender::VERSION
+  spec.authors       = ["Nguyễn Nhật Minh Tú"]
+  spec.email         = ["tunnm@topica.edu.vn"]
+
+  spec.summary       = "HATEOAS-like rendering layout for Rails Applications"
+  spec.description   = "This gem offers the standard hateoas render solution for rails applications"
+  spec.homepage      = "https://git.edumall.io/minhtu/hyperender"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/gems/hyperender"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails" ,"~> 4"
+end

data/lib/hyperender.rb

@@ -0,0 +1,148 @@
+require "hyperender/version"
+
+module Hyperender
+
+  HATEOAS_MSG = {
+    100 => "Continue",
+    101 => "Switching Protocols",
+    200 => "OK",
+    201 => "Created",
+    202 => "Accepted",
+    203 => "Non-Authoritative Information",
+    204 => "No Content",
+    205 => "Reset Content",
+    206 => "Partial Content",
+    300 => "Multiple Choices",
+    301 => "Moved Permanently",
+    302 => "Found",
+    303 => "See Other",
+    304 => "Not Modified",
+    307 => "Temporary Redirect",
+    308 => "Permanent Redirect",
+    400 => "Bad Request",
+    401 => "Unauthorized",
+    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 => "URI Too Long",
+    415 => "Unsupported Media Type",
+    416 => "Range Not Satisfiable",
+    417 => "Expectation Failed",
+    426 => "Upgrade Required",
+    428 => "Precondition Required",
+    429 => "Too Many Requests",
+    431 => "Request Header Fields Too Large",
+    451 => "Unavailable For Legal Reasons",
+    500 => "Internal Server Error",
+    501 => "Not Implemented",
+    502 => "Bad Gateway",
+    503 => "Service Unavailable",
+    504 => "Gateway Timeout",
+    505 => "HTTP Version Not Supported",
+    511 => "Network Authentication Required"
+  }
+
+  def self.render data, errors, parameters, message, status, request
+    {
+      data:               (Hyperender.generated_data data, errors),
+      query_parameters:   parameters,
+      response: {
+        message:          message,
+        status:           status
+      },
+      request: {
+        url:              request.original_url,
+        method:           request.request_method,
+        headers:          (Hyperender.generated_headers request),
+      }
+    }
+  end
+
+  def self.generated_data data, errors
+    data[:errors] = errors unless errors.blank?
+    data
+  end
+
+  def self.generated_headers request
+    enviroment = [
+      #Server specific variables
+      # "SERVER_SOFTWARE", "SERVER_NAME", "GATEWAY_INTERFACE",
+      #Request specific variables
+     "SERVER_PROTOCOL", "SERVER_PORT", "REQUEST_METHOD", "PATH_INFO", "PATH_TRANSLATED", "SCRIPT_NAME", "QUERY_STRING", "REMOTE_HOST", "REMOTE_ADDR", "AUTH_TYPE", "REMOTE_USER", "REMOTE_IDENT", "CONTENT_TYPE", "CONTENT_LENGTH", "HTTP_USER_AGENT", "X_CUSTOM_HEADER"
+    ]
+    headers = {}
+    enviroment.each do |env|
+      attribute = request.headers[env]
+      headers[env.downcase] = attribute unless attribute.blank?
+    end
+    headers
+  end
+
+  module Action
+    def self.included(base)
+      base.class_eval do
+        def hateoas_data *args
+          case args.count
+          when 0 then @hateoas_data_render ||= {}
+          when 1 then @hateoas_data_render = args[0]
+          else        @hateoas_data_render = args
+          end
+          @hateoas_data_render
+        end
+
+        def hateoas_error *args
+          case args.count
+          when 0 then @errors ||= {}
+          when 1 then @errors = args[0]
+          else        @errors = args
+          end
+          @errors
+        end
+
+        def hateoas_params *args
+          case args.count
+          when 0 then @params ||= request.query_parameters
+          when 1 then @params = args[0]
+          else        @params = args
+          end
+          params_class = @params.class.to_s rescue nil
+          unless params_class.in? ["Hash","Array","String"]
+            @params = (@params.as_json rescue (@params.to_s rescue "not renderable"))
+          end
+          @params
+        end
+
+        def hateoas_message
+          @message ||= HATEOAS_MSG[response.status]
+          @message
+        end
+
+        def hateoas_status
+          @status ||= response.status
+          @status
+        end
+
+        def hateoas_request
+          @request ||= request
+          @request
+        end
+
+        def hateoas_render
+          Hyperender.render (hateoas_data), (hateoas_error), (hateoas_params), (hateoas_message), (hateoas_status), (hateoas_request)
+        end
+
+        def hateoas_rendering
+          render json: hateoas_render
+        end
+      end
+    end
+  end
+end

data/lib/hyperender/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: hyperender
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nguyễn Nhật Minh Tú
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: This gem offers the standard hateoas render solution for rails applications
+email:
+- tunnm@topica.edu.vn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hyperender.gemspec
+- lib/hyperender.rb
+- lib/hyperender/version.rb
+homepage: https://git.edumall.io/minhtu/hyperender
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/gems/hyperender
+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.11
+signing_key: 
+specification_version: 4
+summary: HATEOAS-like rendering layout for Rails Applications
+test_files: []