jsender 0.2.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41dc1af6a6d32c30e127c4a4839762530dfd09e8
-  data.tar.gz: 7079f464d53d03346ecc2de6679e64e525da1fa6
+  metadata.gz: 2e4c38c81ff6bb317e2715c8df12d0c983c83a96
+  data.tar.gz: e6df08c2c1f7fefb0b45cb5e6f7b51f36157638c
 SHA512:
-  metadata.gz: a1e1f9361c31c0a95a6e438293b8334527b60e5aff5ec6301b4650f506d4c958585b68aad362b10e68f00f23d283158f652f84702aa585fbbc4c173ea99023e5
-  data.tar.gz: f3fdcbb00665b7347dacc6eb1d833ff746926832a4dc20a8b96fb775698ff9a3259bd98c0a317d1e3481e006b16bbfb864bfffc4bacf762a9feafd1205ed4b36
+  metadata.gz: 8c72f304dd65b6eddd5fe69c4aa0649b972d6be0bb4f10def994f78e86054aca0125fdb8c6d33be030a5ecf998523efcc2d45b2bdce3f21ae7e4188a9b99ea34
+  data.tar.gz: bc9f62329360394a99a6a5c71fc5119d6c7715d4f88e3cb3e554100c1b95588dee4e0fd01c1f5d3857c2bda5ac9330f49dd3247435952929c25fc493e142218f

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
+.byebug_history

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.3
+  - 2.4
+before_install:

data/README.md

@@ -1,9 +1,14 @@
 # Jsender
 
 [![Gem Version](https://badge.fury.io/rb/jsender.png)](https://badge.fury.io/rb/jsender)
+[![Build Status](https://travis-ci.org/hetznerZA/jsender.svg?branch=master)](https://travis-ci.org/hetznerZA/jsender)
+[![Coverage Status](https://coveralls.io/repos/github/hetznerZA/jsender/badge.svg?branch=master)](https://coveralls.io/github/hetznerZA/jsender?branch=master)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2823754c19964ba698f0a90167583d94)](https://www.codacy.com/app/ernst-van-graan/jsender?utm_source=github.com&utm_medium=referral&utm_content=hetznerZA/jsender&utm_campaign=Badge_Grade)
 
 JSender facilitates a simple jsend implementation for ruby. You can report success, error, fail, success with data, fail with data. The jsend response contains 'status' and 'data'. 'data' contains what-ever you put in it, as well as a 'notifications' array. Helpers are provided to check whether a notification is present and whether a specific data key is present. On error the response contains 'message'.
 
+For more info about JSend refer to https://labs.omniti.com/labs/jsend
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,84 +26,71 @@ Or install it yourself as:
     $ gem install jsender
 
 ## Usage
-
-```
-  require 'jsender'
-  
-  class CodeClass
-    include Jsender
-  end
-```
-
-```
-  iut = CodeClass.new
-```
-
 ### Returns Ruby Hash
 
 ```
-  iut.success
-  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["success"]}} 
+  Jsender.success
+  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["success"]}}
 
-  iut.success('happy day')
-  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["happy day"]}} 
+  Jsender.success('happy day')
+  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["happy day"]}}
 
-  result = iut.success_data({ 'a' => 'A', 'b' => 'B' })
-  => {"status"=>"success", "data"=>{"a"=>"A", "b"=>"B", "notifications"=>["success"]}} 
-  iut.has_data?(result, 'b')
+  result = Jsender.success_data({ 'a' => 'A', 'b' => 'B' })
+  => {"status"=>"success", "data"=>{"a"=>"A", "b"=>"B", "notifications"=>["success"]}}
+  Jsender.has_data?(result, 'b')
   => true
 
-  result = iut.success('some data for you', ['d', 'a', 't', 'a'])
-  => {"status"=>"success", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["some data for you"]}} 
-  iut.has_data?(result, 'result')
+  result = Jsender.success('some data for you', ['d', 'a', 't', 'a'])
+  => {"status"=>"success", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["some data for you"]}}
+  Jsender.has_data?(result, 'result')
   => true
-  iut.notifications_include?(result, 'ata fo')
+  Jsender.notifications_include?(result, 'ata fo')
   => true
 
-  iut.error
-  => {"status"=>"error", "message"=>nil} 
+  Jsender.error
+  => {"status"=>"error", "message"=>nil}
 
-  iut.error('something went wrong')
-  => {"status"=>"error", "message"=>"something went wrong"} 
+  Jsender.error('something went wrong')
+  => {"status"=>"error", "message"=>"something went wrong"}
 
-  iut.fail
-  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["fail"]}} 
+  Jsender.failure
+  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["fail"]}}
 
-  iut.fail('a failure occurred')
-  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["a failure occurred"]}} 
+  Jsender.failure('a failure occurred')
+  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["a failure occurred"]}}
 
-  iut.fail('a failure occurred', ['d', 'a', 't', 'a'])
-  => {"status"=>"fail", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["a failure occurred"]}} 
+  Jsender.failure('a failure occurred', ['d', 'a', 't', 'a'])
+  => {"status"=>"fail", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["a failure occurred"]}}
 ```
 
 ### Returns JSON
 
 ```
-  iut.success_json
+  Jsender.success_json
   => "{\"status\":\"success\", \"data\": null}"
 
-  iut.success_json({:key1 => 'value1'})
+  Jsender.success_json({:key1 => 'value1'})
   => "{\"status\":\"success\",\"data\":{\"key1\":\"value1\"}}"
 
-  iut.fail_json
+  Jsender.fail_json
   => "{\"status\": \"fail\", \"data\": null}"
 
-  iut.fail_json({:key1 => "value1"})
+  Jsender.fail_json({:key1 => "value1"})
   => "{\"status\":\"fail\",\"data\":{\"key1\":\"value1\"}}"
 
-  iut.error_json
+  Jsender.error_json
   => ArgumentError, 'Missing required argument message'
 
-  iut.error_json('My little error')
+  Jsender.error_json('My little error')
   => "{\"status\":\"error\", \"message\":\"My little error\"}"
 
-  iut.error_json('Another little error', 401)
+  Jsender.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'})
+  Jsender.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'})
+  Jsender.error_json('Another little error', {:key1 => 'cause of another little error'})
   => "{\"status\":\"error\",\"message\":\"Another little error\",\"data\":{\"key1\":\"cause of another little error\"}}"
 ```
 
@@ -116,4 +108,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/hetzne
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+task :default => :test
 
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+task :test do
+  sh %{bundle install}
+  sh %{bundle exec rspec -cfd spec}
+end

data/jsender.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ['>=2.0.0']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.5.0"
-#  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'byebug'
 end

data/lib/jsender.rb

@@ -1,25 +1,26 @@
 require 'jsender/version'
 
 module Jsender
+  extend self
 
   def report(status, message, result = nil)
-    return { 'status' => 'error', 'message' => message } if status == 'error'
+    return {'status' => 'error', 'message' => message} if status == 'error'
     data = compile_data(result)
-    data['notifications'] = message.is_a?(Array) ? message : [ message ] 
-    { 'status' => status, 'data' => data }
+    data['notifications'] = message.is_a?(Array) ? message : [message]
+    {'status' => status, 'data' => data}
   end
 
   def error(message = nil)
     report('error', message)
   end
 
-  def fail(message = nil, data = nil)
+  def failure(message = nil, data = nil)
     message ||= 'fail'
     report('fail', message, data)
   end
 
   def fail_data(data = nil)
-    fail(nil, data)
+    failure(nil, data)
   end
 
   def success_data(data = nil)
@@ -39,7 +40,7 @@ module Jsender
   end
 
   def notifications_include?(result, pattern)
-    return false if not has_data?(result, 'notifications')
+    return false unless has_data?(result, 'notifications')
     result['data']['notifications'].to_s.include?(pattern)
   end
 
@@ -47,22 +48,22 @@ module Jsender
   # @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?
+    raise ArgumentError, 'Optional data argument should be of type Hash' if invalid_hash?(data)
     return JSON.generate({
-      :status => 'success',
-      :data => data
-    })
+                             :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?
+    raise ArgumentError, 'Optional data argument should be of type Hash' if invalid_hash?(data)
     return JSON.generate({
-      :status => 'fail',
-      :data => data
-    })
+                             :status => 'fail',
+                             :data => data
+                         })
   end
 
   ##
@@ -71,27 +72,65 @@ module Jsender
   # @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
+    code, data = validate_and_sanitize(msg, code, data)
     jsend = {
-      :status => 'error',
-      :message => msg
+        :status => 'error',
+        :message => msg
     }
-    jsend['code'] = code if not code.nil?
-    jsend['data'] = data if not data.nil?
-    return JSON.generate(jsend)
+    generate_error_json(jsend, code, data)
   end
 
   private
 
+  def invalid_integer?(value)
+    (not value.nil?) and (not value.is_a? Integer)
+  end
+
+  def invalid_hash?(data)
+    if not data.nil?
+      return true if not data.is_a? Hash
+    end
+    false
+  end
+
+  def generate_error_json(jsend, code, data)
+    jsend['code'] = code unless code.nil?
+    jsend['data'] = data unless data.nil?
+    return JSON.generate(jsend)
+  end
+
+  def validate_and_sanitize(msg, code, data)
+    validate_message(msg)
+    code, data = set_code_and_data(code, data)
+    validate_data(data)
+    validate_code(code)
+    return code, data
+  end
+
+  def set_code_and_data(code, data)
+    code, data = nil, code if not code.is_a? Integer and code.is_a? Hash and data.nil?
+    return code, data
+  end
+
+  def validate_message(msg)
+    raise ArgumentError, 'Missing required message of type String' if msg.empty? or not msg.is_a? String
+  end
+
+  def validate_data(data)
+    raise ArgumentError, 'Optional data argument should be of type Hash' if invalid_hash?(data)
+  end
+
+  def validate_code(code)
+    raise ArgumentError, 'Optional code argument should be of type Integer' if invalid_integer?(code)
+  end
+
   def compile_data(result)
     data ||= {}
-    result = { 'result' => result} if not result.is_a? Hash
+    result = {'result' => result} unless result.is_a? Hash
     result.each do |key, value|
       data[key] = value
     end
     data
   end
+
 end

data/lib/jsender/version.rb

@@ -1,3 +1,3 @@
 module Jsender
-  VERSION = "0.2.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsender
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Ernst van Graan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,42 +17,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
 description: JSender facilitates a simple jsend implementation for ruby
 email:
 - ernst.van.graan@hetzner.co.za
@@ -94,9 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: JSender facilitates a simple jsend implementation for ruby
 test_files: []
-has_rdoc: