jsender 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6a6f7c896c804935eb73e7be0ebf27a41065fef
-  data.tar.gz: 558767f25b6284dfe5a9939ab909641a0bcbe1dc
+  metadata.gz: 0f0661843afe7b020404bc6a01adc660548d9b55
+  data.tar.gz: 84fcc7dd25a954ccd5e00f9fc7dcdb08627af972
 SHA512:
-  metadata.gz: a0ed92bba9f996ac7d1e2e3b28076411fab1d334c90b96c3e5d5c6816e851b6fd44d3126cd67d6ba0f063375ea6722ad912b2ff63f2c21991fcd6719176692d7
-  data.tar.gz: 109f357e1429d7872873aa1cc63c35b291b3bce9d2f24bb4c15ad202d2de419846d6a98dd62b9679ff417dab6079ac826724a3ec034fb08fa55e7b62df37d3d3
+  metadata.gz: fbec52bcd8f5d0f92b67172eed08bc60161f1a351ad5334a9c564beba963b7e7af3d8d5bad8bcb2e0a84aa11e3aab7867196cb8566ff8723d7d8cec70264a302
+  data.tar.gz: 6a7a53dc0634d2e6c8f63cbceb41b7def6de00a4ded97ea0c3236771893fc777af1444f0d05cc0a49199b7d0e95c2e78d74fd1afa5c818f982f6816cfd662e8d

data/README.md

@@ -1,6 +1,6 @@
 # Jsender
 
-JSender facilitates a simple jsend implementation for ruby. You can report success, 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.
+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'.
 
 ## Installation
 
@@ -25,20 +25,41 @@ Or install it yourself as:
   
   class CodeClass
     include Jsender
-  
-    def action(code)
-      return success if code == 1
-      return success('code 2 selected') if code == 2
-      return success_data({ 'a' => 'A', 'b' => 'B' }) if code == 3
-      return success('some data for you', ['d', 'a', 't', 'a']) if code == 4
-      return fail('code 5 selected') if code == 5
-      return fail_data({ 'a' => 'A', 'b' => 'B' }) if code == 6
-      return fail('some errors for you', ['d', 'a', 't', 'a']) if code == 7
-      return error if code == 8
-      return error('something went wrong') if code == 9
-      fail
-    end
   end
+
+  iut = CodeClass.new
+  iut.success
+  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["success"]}} 
+
+  iut.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')
+  => 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')
+  => true
+  iut.notifications_include?(result, 'ata fo')
+  => true
+
+  iut.error
+  => {"status"=>"error", "message"=>nil} 
+
+  iut.error('something went wrong')
+  => {"status"=>"error", "message"=>"something went wrong"} 
+
+  iut.fail
+  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["fail"]}} 
+
+  iut.fail('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"]}} 
 ```
 
 ```

data/jsender.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+#  spec.add_development_dependency "byebug"
 end

data/lib/jsender/version.rb

@@ -1,3 +1,3 @@
 module Jsender
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsender
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Ernst van Graan