jsender 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b62a31ce56dd2516721b7070dbd1bc81c339f9
-  data.tar.gz: d039fdf0e6881ef6b4ade78b48ffb523b5ff38a1
+  metadata.gz: e13bd362c7cce69c241a3a1446528392474d7a80
+  data.tar.gz: 504901bd1605a457aa7024450df95a90dd689d9d
 SHA512:
-  metadata.gz: c98e1dcb3ad482bc61b430b159b55904175cf488022b4e4319701e871ece9bea7b243481fe59819f8a755829e14124b85d90c60c9426f8700644e419747a90f2
-  data.tar.gz: c3095381172fd77341a75f079fc12e58001e965b9a34389d8b281438e4dbd5404de1d7ee55bf4f73c16537a5c55b53e3ecfaed3620d19f44874d4810d8be1ec1
+  metadata.gz: 915f383ac9d8a6376d08593d62ef4c98fd8748bc9d20c0f4960691b74b2cdc134dbf42f9a8afeeec15a614946886ad4af1e92ae8f8030421f55cc107369d1a4a
+  data.tar.gz: 076433744e0a3135623ea77ef34b9f9d6723b03ab8eb4e40204af74dcfdf39141dd8ca808a2b5988866f9b233a9cea98ea3e528ed85492f693ea612a58b4b88c

data/README.md

@@ -20,6 +20,54 @@ Or install it yourself as:
 
 ## Usage
 
+```
+  require 'jsender'
+  
+  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
+      fail
+    end
+  end
+```
+
+```
+  iut = CodeClass.new
+```
+
+```
+  iut.action(1)
+  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["success"]}} 
+
+  iut.action(2)
+  => {"status"=>"success", "data"=>{"result"=>nil, "notifications"=>["code 2 selected"]}} 
+
+  iut.action(3)
+  => {"status"=>"success", "data"=>{"a"=>"A", "b"=>"B", "notifications"=>["success"]}} 
+
+  iut.action(4)
+  => {"status"=>"success", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["some data for you"]}} 
+
+  iut.action(5)
+  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["code 5 selected"]}} 
+
+  iut.action(6)
+  => {"status"=>"fail", "data"=>{"a"=>"A", "b"=>"B", "notifications"=>["fail"]}} 
+
+  iut.action(7)
+  => {"status"=>"fail", "data"=>{"result"=>["d", "a", "t", "a"], "notifications"=>["some errors for you"]}} 
+
+  iut.action(0)
+  => {"status"=>"fail", "data"=>{"result"=>nil, "notifications"=>["fail"]}} 
+```
 
 ## Development
 
@@ -29,7 +77,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsender. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hetznerZA/jsender. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/jsender/version.rb

@@ -1,3 +1,3 @@
 module Jsender
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

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