error_response 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8b74fbfc00dab269f2d31e3eeeb0ad1a6b621c36e6973f7b2496e7b058b307
-  data.tar.gz: 667bded93a36377a778a63478807d7f5f2730eb130ab89e548b05c71eb77aa96
+  metadata.gz: 18ed19028d5a135d6c8f15aa20530917d29d7f11328afe2217deba0d7538eaf9
+  data.tar.gz: a032a65ea3a258b7bfab2d59f6c8b084e8a0ba1dd5443b607fa55b24f44f0fc2
 SHA512:
-  metadata.gz: 7f627379bdac72e455bc5d8a1ac405569702fff59d57e8d99782b721b840effaa83a25a7e9ae4dd2cf1ccaefcfc564beba2af823d3ea8b65b23fa2ef1b226ea7
-  data.tar.gz: 4fa9e8b21f30134dc9b7c9f6220355b8b894b3b987df7137633ccb452e950593f7ccb34fc2e84fc2332a6c94f27cb834b80c087dbbab4e62258cc5b8017145ca
+  metadata.gz: 5966f694761d1a78e76b9ded6486da61a09735260a4f64c7037bbaedc5b12203625bd245cd316031615c442863dd033a6227623c1cc77d5da36b8122cf54d2f9
+  data.tar.gz: 7d15799ea089125be1173dba842e27492ffef77cd3bebbc0bd645281b1225c6da9f15a9b40ac964ece769866f05f9f288278ce24eede7a666ec35a637653df60

data/README.md

@@ -0,0 +1,42 @@
+# Error Response
+
+### Installation
+
+```
+gem 'error_response'
+```
+
+### Use it perfectly with error_response
+
+define a error_response method in Api::ApplicationController
+
+```
+def error_response(key)
+  render ErrorResponse.api_format(key)
+end
+```
+
+simeply use it where you want
+
+```
+return error_reponse(:wrong_email) if @user.nil
+```
+
+the response will look like this
+
+```
+{
+  status: 403,
+  json:
+    {
+      error_code: 403004,
+      error_message: 'third-party provider is not allow'
+    }
+}
+```
+
+### Update
+
+Update the error_code.yml if you want new error_code
+
+Send Pull Request after update

data/lib/error_response.rb

@@ -1,6 +1,6 @@
 require 'settingslogic'
 class ErrorResponse < Settingslogic
-  source "lib/error_code.yml"
+  source "lib/error_response.yml"
 
   def call(key, message=nil)
     error_data = send(key)

data/lib/error_response.yml

@@ -0,0 +1,45 @@
+wrong_email:
+  error_code: '400_001'
+  error_message: user email not correct
+wrong_password:
+  error_code: '400_002'
+  error_message: user password not correct
+verify_receipt_failed:
+  error_code: '400_003'
+  error_message: receipt verify failed
+resend_confirmation_failed:
+  error_code: '400_004'
+  error_message: confirmation mail resend failed
+reset_password_failed:
+  error_code: '400_005'
+  error_message: reset password failed
+upload_video_failed:
+  error_code: '400_060'
+  error_message: upload video failed
+theme_not_found:
+  error_code: '400_061'
+  error_message: current theme is not found
+client_not_found:
+  error_code: '403_001'
+  error_message: door_keeper client not found
+access_token_invalid:
+  error_code: '403_002'
+  error_message: door_keeper access_token invalid
+user_forbidden:
+  error_code: '403_003'
+  error_message: not enough privilege to access data
+provider_not_allow:
+  error_code: '403_004'
+  error_message: third-party provider is not allow
+third_party_missing_email:
+  error_code: '403_005'
+  error_message: third party login is missing email
+email_existed:
+  error_code: '409_001'
+  error_message: email already existed
+email_confirmed:
+  error_code: '409_002'
+  error_message: email already confirmed
+preview_processing:
+  error_code: '418_001'
+  error_message: preview processing, please try it later

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: error_response
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - jameslee
@@ -14,15 +14,19 @@ description: use for error_response
 email: jameslee@kdanmobile.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - lib/error_response.rb
+- lib/error_response.yml
 homepage: https://github.com/kdan-mobile-software-ltd/error_response
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--charset=URF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement