out_put 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4c73462fff9d9db2b30ec89b34b7e9ad841ce75
+  data.tar.gz: 858911a1f597b1f29629e332e3acfbd905b9abca
+SHA512:
+  metadata.gz: 824ec546f4cb9ab74e4dc86b78f64c6375a6955a99a70c77c1144ca8daf8dc5b9490ef820b89988e6728f5ede7658e9db6c4a4601e1c86c8b2376b8e14988260
+  data.tar.gz: 9a7bd278c95b91123f83dec372701ce9d90fa46a32f0cbb50e5ddbf373020864dbb9e30cbab4a879343e46afb358be188a0875328a4c97bd6fa8341ab5015b5c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/*
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

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 zhandao. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in out_put.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    out_put (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  out_put!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 zhandao
+
+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,119 @@
+# OutPut
+
+[![Gem Version](https://badge.fury.io/rb/out_put.svg)](https://badge.fury.io/rb/out_put)
+
+Render JSON response in a unified format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'out_put'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Config
+
+initializers: `out_put.rb`
+
+```ruby
+OutPut::Config.tap do |config|
+  config.project_code = 101000 # MUST padding three zero here
+  config.pagination_for = :list
+end
+```
+
+### Basic
+
+if your controller does **not** inherit from `ActionController::API`:
+
+```ruby
+include OutPut
+```
+
+To render a json response, call `output` method, it's very easy:
+
+```ruby
+output 0, 'success'
+# the same as above:
+output code: 0, msg: 'success'
+# will render by the default format:
+# {
+#   result: { code: 0, message: 'success' }
+# }
+
+ok # => code: 0, message: 'success'
+```
+
+### Response `data` filed
+
+```ruby
+output 0, foo: 'bar', list: [ 1, 2, 3 ]
+# will render by the default format:
+# {
+#   result: { code: 0, message: '' }
+#     data: { foo: 'bar', list: [1,2,3] }
+# }
+
+# or
+ok_with foo: 'bar'
+```
+
+### Set HTTP status
+
+```ruby
+output 0, 'success', http: 200
+```
+
+### Error Response
+
+You don't need to pass your project code like '101', after **config**:
+
+```ruby
+error 700, 'the 7th api error 0' # => the final code will be 101700
+# or
+error_with 700, 'msg', foo: 'bar'
+```
+
+`error` is an alias of `output`
+
+### `output` any objects which have implemented serialization method `info`
+
+```ruby
+BusinessError.record_not_found.info # => { code: ..., msg: ... }
+
+output BusinessError.record_not_found
+```
+
+[About `business_error`](https://github.com/zhandao/business_error/)
+
+### Just render the given data without default format
+
+```ruby
+output only: { foo: 'bar' }
+# will render: { foo: 'bar' }
+
+# response an array
+output only: [ 1, 2, 3 ]
+```
+
+### Other
+
+#### 1. automatically set `total`:
+
+if `config.pagination_for = :list`:
+
+```ruby
+output 0, list: [ 1, 2, 3 ]
+# will render:
+# {
+#   result: { code: 0, message: '' }
+#     data: { total: 3, list: [1,2,3] }
+# }
+```

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "out_put"
+
+# 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/lib/out_put/config.rb

@@ -0,0 +1,9 @@
+module OutPut
+  class Config
+    cattr_accessor :project_code do
+      0
+    end
+
+    cattr_accessor :pagination_for
+  end
+end

data/lib/out_put/version.rb

@@ -0,0 +1,3 @@
+module OutPut
+  VERSION = '2.0.0'
+end

data/lib/out_put.rb

@@ -0,0 +1,101 @@
+require 'out_put/version'
+require 'out_put/config'
+
+module OutPut
+  def output(code = 0, msg = '', only: nil, http: 200, **data)
+    if !code.is_a?(Integer) && code.respond_to?(:info)
+      code, msg, only, http = code.info.slice(:code, :msg, :only, :http).values
+    end
+
+    return render json: only, status: http if only.present?
+
+    code = code.zero? ? 0 : Config.project_code + code
+    msg = 'success' if msg.blank? && code.zero?
+    render json: {
+        result: { code: code, message: msg },
+        data: output_data(data)
+    }, status: http
+  end
+
+  alias ok         output
+  alias ok_with    output
+  alias error      output
+  alias error_with output
+
+  def output_data(data)
+    if data.key?(Config.pagination_for)
+      data.merge!(total: data[Config.pagination_for].size)
+    end
+
+    data
+  end
+end
+
+ActionController::API.include OutPut
+
+__END__
+
+curl -s https://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv | \
+  ruby -ne 'm = /^(\d{3}),(?!Unassigned|\(Unused\))([^,]+)/.match($_) and \
+    puts "#{m[1]} => \x27#{m[2].strip}\x27,"'
+
+100 => 'Continue',
+101 => 'Switching Protocols',
+102 => 'Processing',
+103 => 'Early Hints',
+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 => 'URI Too Long',
+415 => 'Unsupported Media Type',
+416 => 'Range Not Satisfiable',
+417 => 'Expectation Failed',
+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',
+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',
+506 => 'Variant Also Negotiates',
+507 => 'Insufficient Storage',
+508 => 'Loop Detected',
+510 => 'Not Extended',
+511 => 'Network Authentication Required',

data/out_put.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "out_put/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "out_put"
+  spec.version       = OutPut::VERSION
+  spec.authors       = ["zhandao"]
+  spec.email         = ["x@skippingcat.com"]
+
+  spec.summary       = 'Render JSON response in a unified format'
+  spec.description   = 'Render JSON response in a unified format'
+  spec.homepage      = "https://github.com/zhandao/out_put"
+  spec.license       = "MIT"
+
+  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 "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: out_put
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- zhandao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-14 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: 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: Render JSON response in a unified format
+email:
+- x@skippingcat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/out_put.rb
+- lib/out_put/config.rb
+- lib/out_put/version.rb
+- out_put.gemspec
+homepage: https://github.com/zhandao/out_put
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Render JSON response in a unified format
+test_files: []