respond 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfc720a10ed57fba538c3bc65bdbc75253118012
+  data.tar.gz: 4d5b9f649fa41039943fb7fb16deab20d2404c8d
+SHA512:
+  metadata.gz: 678a8088d959f7f9fbcaf304c32c676ef856e66d03aaf4e36644e1238c5926fe4fdde9e30bf59a1335bb9b657cd9cd28b9a6fc010040394fd707a95c3777c51f
+  data.tar.gz: 22cc3313fef2e66fd78ad83983580b0f3866f05d8d40de05902eddcbe996347ee8cca26de878226121e8ab94b34bd1677263b9328f3263f6f9845f927c68c841

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Respond.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alireza Josheghani
+
+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,123 @@
+# Rails Respond
+
+This package is provided to be used on rails framework and it gives clean methods to handle json response with specific predetermined messages.
+
+# Requirement
+* Ruby ^1.2
+* Rails ^4.2
+
+**The package is in process.**
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Respond'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Respond
+
+
+## Usage
+
+You can use these methods in deffernt ways:
+
+There are hot ones for quick usage, besides some provided to manage outputs on your own way
+
+require library 
+```ruby
+require 'respond'
+```
+
+create respond instance
+```ruby
+respond = Anetwork::Respond.new
+```
+
+**Some are shown below:**
+
+When request succeeds and contains data to return as a result:
+```ruby
+respond.succeed(data)
+```
+
+When deletion action succeeds:
+```ruby
+respond.delete_succeeded
+```
+
+When updating succeeds:
+```ruby
+respond.update_succeeded
+```
+
+When insertion succeeds:
+```ruby
+respond.insert_succeeded
+```
+
+When deletion action fails:
+```ruby
+respond.delete_faild
+```
+
+When updating fails:
+```ruby
+respond.update_faild
+```
+
+when insertion fails:
+```ruby
+respond.insert_faild
+```
+
+Not Found Error:
+```ruby
+respond.not_found
+```
+
+When db connetion is refused:
+```ruby
+respond.connection_refused
+```
+
+When parameters entered are wrong:
+```ruby
+respond.wrong_parameters
+```
+
+When requested method is not allowed:
+```ruby
+respond.method_not_allowed
+```
+
+```ruby
+respond.request_field_notfound
+```
+
+Validation errors:
+``` php
+respond.validation_errors(data)
+```
+
+###customization
+Set custom message for methods is like this:
+```ruby
+respond.not_found('Leave it empty or enter your custom message here')
+```
+
+And you can do more:
+```ruby
+respond.set_status_code(200).set_status_text('succeed').respond_with_message('Your custom message')
+```
+
+## License
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+

data/Rakefile

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

data/lib/Messages.rb

@@ -0,0 +1,156 @@
+module Anetwork
+
+  class Messages
+
+    attr_accessor :code , :text , :error , :error_code , :headers , :lang , :config
+
+    def initialize
+      @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)
+    end
+
+    def succeed(data)
+      self.set_status_code(200)
+          .set_status_text('success')
+          .respond_with_result(data)
+    end
+
+    def delete_succeeded(message = nil)
+      if message == nil
+        message = @config[:success][:delete]
+      end
+
+      self.set_status_code(200)
+          .set_status_text('success')
+          .respond_with_message(message)
+    end
+
+    def update_succeeded(message = nil)
+      if message == nil
+        message = @config[:success][:update]
+      end
+
+      self.set_status_code(200)
+          .set_status_text('success')
+          .respond_with_message(message)
+    end
+
+    def insert_succeeded(message = nil)
+      if message == nil
+        message = @config[:success][:insert]
+      end
+
+      self.set_status_code(200)
+          .set_status_text('success')
+          .respond_with_message(message)
+    end
+
+    def delete_faild(message = nil)
+      if message == nil
+        message = @config[:fail][:delete]
+      end
+
+      self.set_status_code(447)
+          .set_status_text('fail')
+          .set_error_code(5447)
+          .respond_with_message(message)
+    end
+
+    def update_faild(message = nil)
+      if message == nil
+        message = @config[:fail][:update]
+      end
+
+      self.set_status_code(449)
+          .set_status_text('fail')
+          .set_error_code(5449)
+          .respond_with_message(message)
+    end
+
+    def insert_faild(message = nil)
+      if message == nil
+        message = @config[:fail][:insert]
+      end
+
+      self.set_status_code(448)
+          .set_status_text('fail')
+          .set_error_code(5448)
+          .respond_with_message(message)
+    end
+
+    def connection_refused
+
+      self.set_status_code(445)
+          .set_status_text('fail')
+          .set_error_code(5445)
+          .respond_with_message()
+    end
+
+    def not_found
+
+      self.set_status_code(404)
+          .set_status_text('fail')
+          .set_error_code(5404)
+          .respond_with_message
+    end
+
+    def wrong_parameters
+
+      self.set_status_code(406)
+          .set_status_text('fail')
+          .set_error_code(5406)
+          .respond_with_message
+    end
+
+    def method_not_allowed
+
+      self.set_status_code(405)
+          .set_status_text('fail')
+          .set_error_code(5405)
+          .respond_with_message
+    end
+
+    def validation_errors(message = nil)
+
+      self.set_status_code(420)
+          .set_status_text('fail')
+          .set_error_code(5420)
+          .respond_with_message(message)
+    end
+
+    def request_field_notfound
+
+      self.set_status_code(446)
+          .set_status_text('fail')
+          .set_error_code(1001)
+          .respond_with_message
+    end
+
+    def request_field_duplicated
+
+      self.set_status_code(400)
+          .set_status_text('fail')
+          .set_error_code(1004)
+          .respond_with_message
+    end
+
+    def error(code)
+
+      self.set_status_code(400)
+          .set_status_text('fail')
+          .set_error_code(code)
+          .respond_with_message
+    end
+
+  end
+
+end
+

data/lib/Respond/version.rb

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

data/lib/Respond.rb

@@ -0,0 +1,47 @@
+require 'Messages'
+
+module Anetwork
+
+  class Respond < Messages
+
+    def set_status_code(code)
+      @code = code
+      self
+    end
+
+    def set_status_text(text)
+      @text = text
+      self
+    end
+
+    def respond_with_message(message = nil)
+      result = { :status => @text , :message => message }
+
+      if message == nil
+        result['message'] = @error[:message]
+      end
+
+      if @error_code
+        result['error'] = @error_code
+      end
+
+      result
+    end
+
+    def respond_with_result(data)
+      { :status => @text, :result => data }
+    end
+
+    def set_error_code(error_code)
+      @error_code = error_code
+      @error = @config[error_code]
+      self
+    end
+
+    def set_headers(headers)
+      @headers = headers
+    end
+
+  end
+
+end

data/respond.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Respond/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'respond'
+  spec.version       = Anetwork::Respond::VERSION
+  spec.authors       = ['Alireza Josheghani']
+  spec.email         = ['a.josheghani@anetwork.ir']
+
+  spec.summary       = 'Easy peasy json response for ruby on rails!'
+  spec.description   = 'This package is provided to be used on rails framework and it gives clean methods to handle json response with specific predetermined messages.'
+  spec.homepage      = 'https://github.com/anetwork'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: respond
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alireza Josheghani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: This package is provided to be used on rails framework and it gives clean
+  methods to handle json response with specific predetermined messages.
+email:
+- a.josheghani@anetwork.ir
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/Messages.rb
+- lib/Respond.rb
+- lib/Respond/version.rb
+- respond.gemspec
+homepage: https://github.com/anetwork
+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.3
+signing_key: 
+specification_version: 4
+summary: Easy peasy json response for ruby on rails!
+test_files: []