jsender 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2acb391e06eb12f23352d1c7b017b09538828282
-  data.tar.gz: 0253f70375bb46d49e165e0d835162f040714324
+  metadata.gz: 902e95a805b56e2a64d7f1dfa6aa7c984009dac2
+  data.tar.gz: 34e846f2222977c836dcaaa34b8b1d8076fd5c3d
 SHA512:
-  metadata.gz: 99623c31d8a4f30a296db362519d4dd98e818cbbd23f538cf5193741fdb5fd53c9afef5dfc27efc8c8da0a6115a325a6c78d0665b4f43a7374f2181ce7aedc5f
-  data.tar.gz: fdb7501284928a127dd81f0e076a3c0cd568ec513f19063d6341c4f9c9b731ee8882a8c98047f957f7c95c0b3351e945aeedb146df8d37944a621b82ab282494
+  metadata.gz: 70cdc0e0ef0c43ce996b296bade3dd631b9fc55224a7a9a415b876d5e968c447df7e73fa4685b555bb8cc9904f581fd0aa6ef0f85bf4c15b26f3e7f12f0c2c93
+  data.tar.gz: 9221522c0aa8157438ea17c02edb017f6831bdb6fad0c648c5dba245c94c6d156adc26ae54cec6b05aaa3042a26329208648d63f585134833843558c2779ed12

data/README.md

@@ -32,6 +32,7 @@ Or install it yourself as:
   iut = CodeClass.new
 ```
 
+### Returns Ruby Hash
 
 ```
   iut.success
@@ -68,6 +69,38 @@ Or install it yourself as:
   => {"status"=>"fail", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["a failure occurred"]}} 
 ```
 
+### Returns JSON
+
+```
+  iut.success_json
+  => "{\"status\":\"success\", \"data\": null}"
+
+  iut.succes_json({:key1 => 'value1'})
+  => "{\"status\":\"success\",\"data\":{\"key1\":\"value1\"}}"
+
+  iut.fail_json
+  => "{\"status\": \"fail\", \"data\": null}"
+
+  iut.fail_json({:key1 => "value1"})
+  => "{\"status\":\"fail\",\"data\":{\"key1\":\"value1\"}}"
+
+  iut.error_json
+  => ArgumentError, 'Missing required argument message'
+
+  iut.error_json('My little error')
+  => "{\"status\":\"error\", \"message\":\"My little error\"}"
+
+  iut.error_json('Another little error', 401)
+  => "{\"status\":\"error\",\"message\":\"Another little error\",\"code\":401}"
+
+  iut.error_json('Another little error', 401, {:key1 => 'cause of another little error'})
+  => "{\"status\":\"error\",\"message\":\"Another little error\",\"code\":401,\"data\":{\"key1\":\"cause of another little error\"}}"
+
+  iut.error_json('Another little error', {:key1 => 'cause of another little error'})
+  => "{\"status\":\"error\",\"message\":\"Another little error\",\"data\":{\"key1\":\"cause of another little error\"}}"
+```
+
+
 ## 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.

data/jsender.gemspec

@@ -6,12 +6,12 @@ require 'jsender/version'
 Gem::Specification.new do |spec|
   spec.name          = "jsender"
   spec.version       = Jsender::VERSION
-  spec.authors       = ["Ernst van Graan"]
-  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+  spec.authors       = ["Ernst van Graan", "Charles Mulder"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za", "charles.mulder@hetzner.co.za"]
 
   spec.summary       = %q{JSender facilitates a simple jsend implementation for ruby}
   spec.description   = %q{JSender facilitates a simple jsend implementation for ruby}
-  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.homepage      = "https://rubygems.org/gems/jsender"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/jsender/version.rb

@@ -1,3 +1,3 @@
 module Jsender
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/jsender.rb

@@ -1,6 +1,7 @@
-require "jsender/version"
+require 'jsender/version'
 
 module Jsender
+
   def report(status, message, result = nil)
     return { 'status' => 'error', 'message' => message } if status == 'error'
     data = compile_data(result)
@@ -42,6 +43,47 @@ module Jsender
     result['data']['notifications'].to_s.include?(pattern)
   end
 
+  ##
+  # @param data optional [Hash]
+  # @return [String] jsend json
+  def success_json(data = nil)
+    raise ArgumentError, 'Optional data argument should be of type Hash' if not data.is_a? Hash and not data.nil?
+    return JSON.generate({
+      :status => 'success',
+      :data => data
+    })
+  end
+
+  ##
+  # @param data optional [Hash]
+  # @return [String] jsend json
+  def fail_json(data = nil)
+    raise ArgumentError, 'Optional data argument should be of type Hash' if not data.is_a? Hash and not data.nil?
+    return JSON.generate({
+      :status => 'fail',
+      :data => data
+    })
+  end
+
+  ##
+  # @param msg [String]
+  # @param code optional [Integer]
+  # @param data optional [Hash]
+  # @return [String] jsend json
+  def error_json(msg, code = nil, data = nil)
+    raise ArgumentError, 'Missing required message of type String' if msg.empty? or not msg.is_a? String
+    code, data  = nil, code if not code.is_a? Integer and code.is_a? Hash and data.nil?
+    raise ArgumentError, 'Optional data argument should be of type Hash' if not data.nil? and not data.is_a? Hash
+    raise ArgumentError, 'Optional code argument should be of type Integer' if not code.nil? and not code.is_a? Integer
+    jsend = {
+      :status => 'error',
+      :message => msg
+    }
+    jsend['code'] = code if not code.nil?
+    jsend['data'] = data if not data.nil?
+    return JSON.generate(jsend)
+  end
+
   private
 
   def compile_data(result)

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jsender
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Ernst van Graan
+- Charles Mulder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +56,7 @@ dependencies:
 description: JSender facilitates a simple jsend implementation for ruby
 email:
 - ernst.van.graan@hetzner.co.za
+- charles.mulder@hetzner.co.za
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -72,7 +74,7 @@ files:
 - jsender.gemspec
 - lib/jsender.rb
 - lib/jsender/version.rb
-homepage: 
+homepage: https://rubygems.org/gems/jsender
 licenses:
 - MIT
 metadata: {}