respond 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfc720a10ed57fba538c3bc65bdbc75253118012
-  data.tar.gz: 4d5b9f649fa41039943fb7fb16deab20d2404c8d
+  metadata.gz: 352adcac52d4b34276f8cd432701327c578d336d
+  data.tar.gz: 848d13e7175827ce16723774572abca3b0e0e1cf
 SHA512:
-  metadata.gz: 678a8088d959f7f9fbcaf304c32c676ef856e66d03aaf4e36644e1238c5926fe4fdde9e30bf59a1335bb9b657cd9cd28b9a6fc010040394fd707a95c3777c51f
-  data.tar.gz: 22cc3313fef2e66fd78ad83983580b0f3866f05d8d40de05902eddcbe996347ee8cca26de878226121e8ab94b34bd1677263b9328f3263f6f9845f927c68c841
+  metadata.gz: bcc467f8450226252fc93bdc9f0fe6a4763c9cd97bd4ee7f3b7b4cd132f7a2cfde9de55e7205ffb5cd670e06583bacb1b9ee6ecd3e701caede40b6189afa3335
+  data.tar.gz: 43e7ef3da39d79d6af8468b81d85118d99499e8c82ca11a22b6430d77a255f931f54eaaffa8f8a5a8536b106b2bb3fb5ef726bf746bb0bf5c557c85dd7e0ff4d

data/lib/Messages.rb

@@ -2,27 +2,46 @@ module Anetwork
 
   class Messages
 
+    # setter and getter varibules
     attr_accessor :code , :text , :error , :error_code , :headers , :lang , :config
 
-    def initialize
+    ##
+    # initialize method
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
+    # @param [String] lang
+    def initialize(lang = 'en')
       @lang = I18n.locale
-      lang = 'en'
 
       if @lang != '' || @lang != nil
         lang = @lang
       end
 
-      @config = eval(File.open(Rails.root.join(
-          'config/respond/errors', "#{lang}.rb"
-      )).read)
+      @config = eval(File.open(__dir__ + "/errors/#{lang}.rb").read)
     end
 
+    ##
+    # Request succeeded and contains json result
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [Object] data
+    # @return [Object]
     def succeed(data)
       self.set_status_code(200)
           .set_status_text('success')
           .respond_with_result(data)
     end
 
+    ##
+    # Delete action is succeed
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def delete_succeeded(message = nil)
       if message == nil
         message = @config[:success][:delete]
@@ -33,6 +52,13 @@ module Anetwork
           .respond_with_message(message)
     end
 
+    ##
+    # Update action is succeed
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def update_succeeded(message = nil)
       if message == nil
         message = @config[:success][:update]
@@ -43,6 +69,13 @@ module Anetwork
           .respond_with_message(message)
     end
 
+    ##
+    # Insert action is succeed
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def insert_succeeded(message = nil)
       if message == nil
         message = @config[:success][:insert]
@@ -53,6 +86,13 @@ module Anetwork
           .respond_with_message(message)
     end
 
+    ##
+    # Delete action is faild
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def delete_faild(message = nil)
       if message == nil
         message = @config[:fail][:delete]
@@ -64,6 +104,13 @@ module Anetwork
           .respond_with_message(message)
     end
 
+    ##
+    # Update action is succeed
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def update_faild(message = nil)
       if message == nil
         message = @config[:fail][:update]
@@ -75,6 +122,13 @@ module Anetwork
           .respond_with_message(message)
     end
 
+    ##
+    # Insert action is faild
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def insert_faild(message = nil)
       if message == nil
         message = @config[:fail][:insert]
@@ -86,64 +140,105 @@ module Anetwork
           .respond_with_message(message)
     end
 
+    ##
+    # Database connection is refused
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def connection_refused
-
       self.set_status_code(445)
           .set_status_text('fail')
           .set_error_code(5445)
-          .respond_with_message()
+          .respond_with_message
     end
 
+    ##
+    # Page requested is not found
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def not_found
-
       self.set_status_code(404)
           .set_status_text('fail')
           .set_error_code(5404)
           .respond_with_message
     end
 
+    ##
+    # Wrong parameters are entered
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def wrong_parameters
-
       self.set_status_code(406)
           .set_status_text('fail')
           .set_error_code(5406)
           .respond_with_message
     end
 
+    ##
+    # Method is not allowed
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def method_not_allowed
-
       self.set_status_code(405)
           .set_status_text('fail')
           .set_error_code(5405)
           .respond_with_message
     end
 
+    ##
+    # There ara validation errors
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def validation_errors(message = nil)
-
       self.set_status_code(420)
           .set_status_text('fail')
           .set_error_code(5420)
           .respond_with_message(message)
     end
 
+    ##
+    # The request field is not found
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def request_field_notfound
-
       self.set_status_code(446)
           .set_status_text('fail')
           .set_error_code(1001)
           .respond_with_message
     end
 
+    ##
+    # The request field is duplicated
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @return [Object]
     def request_field_duplicated
-
       self.set_status_code(400)
           .set_status_text('fail')
           .set_error_code(1004)
           .respond_with_message
     end
 
+    ##
+    # The error message
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [Object] code
+    # @return [Object]
     def error(code)
-
       self.set_status_code(400)
           .set_status_text('fail')
           .set_error_code(code)

data/lib/Respond/version.rb

@@ -1,5 +1,5 @@
 module Anetwork
   class Respond
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/Respond.rb

@@ -4,16 +4,37 @@ module Anetwork
 
   class Respond < Messages
 
+    ##
+    # set status code of respond
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [Integer] code
+    # @return [Object]
     def set_status_code(code)
       @code = code
       self
     end
 
+    ##
+    # set status text of respond
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] text
+    # @return [Object]
     def set_status_text(text)
       @text = text
       self
     end
 
+    ##
+    # get respond with message
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [String] message
+    # @return [Object]
     def respond_with_message(message = nil)
       result = { :status => @text , :message => message }
 
@@ -28,16 +49,37 @@ module Anetwork
       result
     end
 
+    ##
+    # get respond with result
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [Object] data
+    # @return [Object]
     def respond_with_result(data)
       { :status => @text, :result => data }
     end
 
+    ##
+    # set error code and get details from lang file
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [Integer] error_code
+    # @return [Object]
     def set_error_code(error_code)
       @error_code = error_code
       @error = @config[error_code]
       self
     end
 
+    ##
+    # set headers for response
+    #
+    # @author Alireza Josheghani <a.josheghani@anetwork.ir>
+    # @since 1 Dec 2016
+    # @param [Object] headers
+    # @return [Object]
     def set_headers(headers)
       @headers = headers
     end

data/lib/errors/en.rb

@@ -0,0 +1,185 @@
+{
+    :success => {
+        :insert	=> 'The requested parameter is Added successfully!',
+        :delete	=> 'The requested parameter is deleted successfully!',
+        :update	=> 'The requested parameter is updated successfully!'
+    },
+
+    :fail => {
+        :insert => 'The requested parameter is not Added!',
+        :delete => 'The requested parameter is not deleted!',
+        :update => 'The requested parameter is not updated!'
+    },
+
+    1001 => {
+        :message => 'Oops... Requested field is not found!',
+        :type => 'error'
+    },
+
+    1002 => {
+        :message => 'Oops... Requested User does not exists!',
+        :type => 'error'
+    },
+
+    1003 => {
+        :message => 'Oops... Client type is not entered!',
+        :type => 'error'
+    },
+
+    1004 => {
+        :message => 'Failed because of duplicate',
+        :type => 'error'
+    },
+
+    1005 => {
+        :message => 'Failed because of dablicated user role',
+        :type => 'error'
+    },
+
+    3001 => {
+        :message => 'You are not logged on',
+        :type => 'error',
+        :cat => 'auth',
+        :short => 'not-logged-on'
+    },
+
+    3002 => {
+        :message => 'Application token did not generated successfully',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3003 =>{
+        :message => 'User token did not generated successfully',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3004 => {
+        :message => 'Request token have no agency access',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3005 => {
+        :message => 'Request token did not contains user information',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3006 => {
+        :message => 'Did not set request token',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3007 => {
+        :message => 'can not decode the token',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3008 => {
+        :message => 'can not generate token for authentication',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3009 => {
+        :message => 'can not create token',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3010 => {
+        :message => 'Token expired!',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3011 => {
+        :message => 'Token is invalid!',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3012 => {
+        :message => 'Token Blacklisted',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3013 => {
+        :message => 'Payload invalid!',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3014 => {
+        :message => 'Claim Invalid',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3015 => {
+        :message => 'An error occurred on token validation',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3016 => {
+
+        :message => 'This domain has been blocked',
+        :type => 'error'
+    },
+
+    5401 => {
+        :message => 'Authentication unauthorized...',
+        :type => 'error'
+    },
+
+    5404 => {
+        :message => 'Oops... The requested page not found!',
+        :type => 'error'
+    },
+
+    5405 => {
+        :message => 'Oops... The method you requested is not allowed!',
+        :type => 'error'
+    },
+
+    5406 => {
+        :message => 'Oops... The parameters you entered are wrong!',
+        :type => 'error'
+    },
+
+    5420 => {
+        :message => 'Validation Error',
+        :type => 'error'
+    },
+
+    5422 => {
+        :message => 'Token is not valid',
+        :type => 'error'
+    },
+
+    5445 => {
+        :message => 'Oops... Database connection refused',
+        :type => 'error'
+    },
+
+    5448 => {
+        :message => 'Oops... Insert action was not successfully executed',
+        :type => 'error'
+    },
+
+    5447 => {
+        :message => 'Oops... Delete action was not successfully executed',
+        :type => 'error'
+    },
+
+    5449 => {
+        :message => 'Oops... Update action was not successfully executed',
+        :type => 'error'
+    }
+}

data/lib/errors/fa.rb

@@ -0,0 +1,179 @@
+{
+    :success => {
+        :insert => '.درخواست با موفقیت درج شده است',
+        :delete => '.درخواست با موفقیت پاک شده است',
+        :update => '.درخواست با موفقیت ویرایش  شده است'
+    },
+
+    :fail => {
+        :insert	=> '.درخواست با موفقیت درج نشد',
+        :delete	=> '.درخواست با موفقیت پاک نشد',
+        :update	=> '.درخواست با موفقیت ویرایش  نشد'
+    },
+
+    1001 => {
+        :message => '.درخواست مورد نظر پیدا نشده است',
+        :type => 'error'
+    },
+
+    1002 => {
+        :message => '.کاربر مورد نظر موجود نیست',
+        :type => 'error'
+    },
+
+    1003 => {
+        :message => '.نوع کاربری وارد نشده است',
+        :type => 'error'
+    },
+
+    1004 => {
+        :message => '.ورودی مورد نظر تکراری است',
+        :type => 'error'
+    },
+
+    1005 => {
+        :message => '.نقش کاربر مورد نظر تکراری است',
+        :type => 'error'
+    },
+
+    3001 => {
+        :message => '.شما به سیستم وارد نشده اید',
+        :type => 'error',
+        :cat => 'auth',
+        :short => 'not-logged-on'
+    },
+
+    3002 => {
+        :message => '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3003 =>{
+        :message => '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3004 => {
+        :message => '.هیچ آژانسی به نشان شناسایی دسترسی ندارد',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3005 => {
+        :message => '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3006 => {
+        :message => '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3007 => {
+        :message => '.نشان شناسایی شما نمایش داده نمیشود',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3008 => {
+        :message => '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3009 => {
+        :message => '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3010 => {
+        :message => '.زمان استفاده از نشان شناسایی شما گذشته است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3011 => {
+        :message =>  '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3012 => {
+        :message =>  '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3013 => {
+        :message => '.Payload معتبر نیست',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3014 => {
+        :message => '.Claim معتبر نیست',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    3015 => {
+        :message =>  '.نشان شناسایی شما نامعتبر است',
+        :type => 'error',
+        :cat => 'auth'
+    },
+
+    5401 => {
+        :message => '.شناسایی کاربر نامعتبر است',
+        :type => 'error'
+    },
+
+    5404 => {
+        :message => '.صفحه درخواست شده پیدا نمیشود',
+        :type => 'error'
+    },
+
+    5405 => {
+        :message => '.شما به درخواستی که داده اید دسترسی ندارید',
+        :type => 'error'
+    },
+
+    5406 => {
+        :message => '.پارامترهایی که شما وارد کرده اید نا معتبر است',
+        :type => 'error'
+    },
+
+    5420 => {
+        :message => '.خطای اعتبار سنجی',
+        :type => 'error'
+    },
+
+    5422 => {
+        :message =>  '.نشان شناسایی شما نامعتبر است',
+        :type => 'error'
+    },
+
+    5445 => {
+        :message => '.ارتباط با پایگاه داده مشکل دارد',
+        :type => 'error'
+    },
+
+    5448 => {
+        :message => '.عملیات درج درست اجرا نشده است',
+        :type => 'error'
+    },
+
+    5447 => {
+        :message => '.عملیات پاک کردن درست اجرا نشده است',
+        :type => 'error'
+    },
+
+    5449 => {
+        :message => '.عملیات ویرایش درست اجرا نشده است',
+        :type => 'error'
+    }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: respond
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alireza Josheghani
@@ -54,6 +54,8 @@ files:
 - lib/Messages.rb
 - lib/Respond.rb
 - lib/Respond/version.rb
+- lib/errors/en.rb
+- lib/errors/fa.rb
 - respond.gemspec
 homepage: https://github.com/anetwork
 licenses: