repldb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca11f6e1224b47560db11dd0616a9957286bc652ef6bbc7920e759ed7ff144a
-  data.tar.gz: 272ec9182a7e7d527e5dc321310a1b3a37f7b3510f748e39ee93af76167f5c41
+  metadata.gz: e725a97d9fad8f4ecc9a6d369f3928876061ba2df9cbf50c0ed40a57687592a9
+  data.tar.gz: bc2729273d394819373134cd044bbb836ee770020f01bccf8b0fa6b979cbefad
 SHA512:
-  metadata.gz: c14295ccf368ae51c4ef37f4e56ded5dc15662f3f1c0e12967ada4ee61ab680c879eca0495649373e2824f460f346a2dddc1e67fc2978d1a5c0e3ef59ac86950
-  data.tar.gz: 6b5f072be85b2020dfa7b563d9c507709e966ac1de2b5a78c3a7cde5cbe408350670159a71a3f09e5f3277cb5b6646b23b45691ce8535ec5fabc8c36041b60df
+  metadata.gz: 6a18e7feb555265bed09d7b26fced181fa42e43d2b113276dd2c42b1b0984d55fedbffef7317b0c9ba0cca28a0723eb43431a5a1901f3199f8cb43e867f0e562
+  data.tar.gz: 98be4f7bc5d88f78751c53bc33255be4b9c0956261977232492d3d999edb3ec2ecc88c0e2060131a7549bfa6f46903e65c49e482095ac44f0041b30a960b00e4

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Repldb
 The ease of using repldb now meets the ease of developing in Ruby!
-You can learn more about repldb [here](https://docs.replit.com/misc/database)
+You can learn more about repldb [here](https://docs.replit.com/misc/database).
 
 # Usage
 ```rb

data/lib/repldb.rb

@@ -4,19 +4,23 @@ require 'json'
 require 'net/http'
 
 class Client
-  # Change `url` to point to a different path.
+  # Change <tt>url</tt> to point to a different path.
+  # @param url [String, nil]
   def initialize(url = ENV['REPLIT_DB_URL'])
     @url = url
   end
 
-  # Sets `key` to `val`.
+  # Sets <tt>key</tt> to <tt>val</tt>.
+  # @param key [String] the key to set.
+  # @param val [Any] the value.
   def set(key, val)
     post_url(@url.to_s, serialize(key) => JSON.generate(val))
   end
 
-  # Gets `key`.
-  #
-  # If it doesn't exist, `default` will be used.
+  # Gets <tt>key</tt>.
+  # If it doesn't exist, <tt>default<tt> will be used.
+  # @param key [String] the key to get
+  # @param default [Any] the default value if the key doesn't exist.
   def get(key, default = nil)
     val = get_url("#{@url}/#{serialize(key)}")
     if val.body == ''
@@ -31,13 +35,14 @@ class Client
   end
 
   # Get all the keys as an array.
-  #
-  # `prefix` can be used to get all keys with a prefix.
+  # <tt>prefix</tt> can be used to get all keys with a prefix.
+  # @param prefix [String, nil] Get all keys with <tt>prefix</tt> at the start.
   def keys(prefix = '')
     get_url("#{@url}?prefix=#{prefix}").body.split("\n").map { |k| deserialize(k) }
   end
 
-  # Deletes `key`.
+  # Deletes <tt>key</tt>.
+  # @param key [String]
   def del(key)
     uri = URI.parse("#{@url}/#{serialize(key)}")
     req = Net::HTTP::Delete.new(uri.path)
@@ -52,9 +57,9 @@ class Client
     keys.each { |k| del(k) }
   end
 
-  # This will append `hash`.
-  #
+  # This will append <tt>hash</tt>.
   # **This will NOT replace existing keys!**
+  # @param hash [Hash]
   def set_hash(hash)
     if hash.is_a? Hash
       hash.each { |k, v| set(k, v) }
@@ -71,9 +76,10 @@ class Client
     o
   end
 
-  # Check if `key` exists.
+  # Check if <tt>key</tt> exists.
+  # @param key [String]
   def exists?(key)
-    not get(key).nil?
+    !get(key).nil?
   end
 
   # internals

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: repldb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Coder100