light_redis_cache 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83385a0dd07984d31d6c3778313cdd7d6d7ab7eb
-  data.tar.gz: 37996d8e8f61f9b2b98f9fac3c8f9e608aae7ee0
+  metadata.gz: 17d34de15b0df4ade8a71c6147996537cf23683e
+  data.tar.gz: 86bd95b55c56940dcd01b71609b42d9c7b5a0d57
 SHA512:
-  metadata.gz: 6d6bc4946d77e530ac1875de9069964bd3f1c3478b737a5ef547f76aab34fca64f80d3120c13a0c718c9c38991ff407bbd5f04765657c4b4333388c56b253ab0
-  data.tar.gz: d8031143f139039be39422d844c672563637b322c2b3bc6fbf582fe81cd21cb8a9cdcc6f8d4925a3e87e1b23a4c2ec85c2ea4d635e44fd0887ff322b82ae3d4c
+  metadata.gz: 1d4bf4504656880897e3efe1cf4acbd0f2901a0ac8a721aabf2cb409cdeb32f7f29d0f939bc628bbe758434b3936ab3e466f74525ef56d14dae3eb640e0f8282
+  data.tar.gz: abf41096e51c3693a1441452a6a682faca0b9392232efe7590e0078f7f792a2374d955bd6a9fbace8af59e8d9b4d6d9e36691448e3110fec6abc53d706022163

data/README.md

@@ -1,12 +1,13 @@
 # LightRedisCache
 
 
-It is a very basic implementation of a Redis client.
+This gem is a very basic implementation of a Ruby client for Redis.
 
-:warning: **Do not to use it in production !** :warning:
+It is not supposed to be used in production, the aim of this gem is to understand of Redis work and how to implement a Redis client to cache data.
 
-The aim of this gem is to understand of Redis work and how to implement a redis client to cache data.
-It can replace `Rails.cache` to connect to Redis in a Ruby on Rails application.
+It creates a TCP socket between your app and your Redis server. A few methods let you communicate with your Redis server using a protocol called RESP (REdis Serialization Protocol). See https://redis.io/topics/protocol
+
+In a Rails app, just use `LightRedisCache` instead of `Rails.cache`.
 
 ## Installation
 
@@ -26,7 +27,16 @@ Or install it yourself as:
 $ gem install light_redis_cache
 ```
 
-## Usage
+## Configuration
+Add this block, with the configuration of your Redis server, in your code :
+
+```ruby
+LightRedisCache.configure do |config|
+  config.hostname = 'MY_HOSTNAME' # default: 'localhost'
+  config.port = 'MY_PORT' # default: '6379'
+end
+```
+If you have a Rails app, it should go in `config/initializers/light_redis_cache.rb`
 
 ## Development
 
@@ -35,5 +45,3 @@ After checking out the repo, run `bin/setup` to install dependencies.
 Set the config of the local redis server you want to use for the tests in `spec/local_redis_server.rb`.
 
 Then, run `rake spec` to run the tests.
-
-In your Rails app, replace `Rails.cache` by `LightRedisCache::Client.new(hostname: [YOUR_HOSTNAME], port: [YOURPORT])`

data/lib/light_redis_cache.rb

@@ -1,33 +1,56 @@
 require 'light_redis_cache/version'
+require 'light_redis_cache/configuration'
 require 'socket'
 require 'json'
-require 'date'
 
 module LightRedisCache
-  class Client
+
+  class << self
     attr_accessor :socket
 
-    def initialize hostname:, port:
-      @hostname = hostname
-      @port = port
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= LightRedisCache::Configuration.new
     end
 
+    # Get the value of a key
+    #
+    # @param [String] key
+    # @return [String, Integer, Array, Hash] value
+    # @see https://redis.io/commands/get GET command
     def get key
       open_socket
-      @socket.puts("GET #{ key }")
-      value = @socket.gets == "$-1\r\n" ? nil : JSON.parse(@socket.gets.gsub(/\$\d+/, "").gsub("\r\n", ""))
+      @socket.write("*2\r\n$3\r\nGET\r\n$#{ key.length }\r\n#{ key }\r\n")
+      value = @socket.gets == "$-1\r\n" ? nil : JSON.parse((@socket.gets).gsub("\r\n", "").force_encoding("iso-8859-1").encode!("utf-8"))
       close_socket
       value
     end
 
-    def set key, value, expires_in:
+    # Set key to hold the value
+    #
+    # @param [String] key
+    # @param [String, Integer, Array, Hash] value
+    # @param [Integer] expires_in - default value : 86400 seconds (1 day)
+    # @return [nil]
+    # @see https://redis.io/commands/set SET command
+    def set key, value, expires_in: 86400
       open_socket
-      value = value.to_json
+      value = value.to_json.encode("iso-8859-1").force_encoding("utf-8")
       @socket.write("*3\r\n$3\r\nSET\r\n$#{ key.length }\r\n#{ key }\r\n$#{ value.length }\r\n#{ value }\r\n")
       @socket.write("*3\r\n$6\r\nEXPIRE\r\n$#{ key.length }\r\n#{ key }\r\n$#{ expires_in.to_s.length }\r\n#{ expires_in }\r\n")
       close_socket
     end
 
+    # Get the value of a key. If the key does not exist,
+    # call a block, set the result and return it
+    #
+    # @param [String] key
+    # @param [Integer] expires_in - default value : 86400 seconds (1 day)
+    # @param [Proc] block
+    # @return [void]
     def fetch key, expires_in: 86400, &block
       result = get(key)
       if result == nil
@@ -39,8 +62,30 @@ module LightRedisCache
       end
     end
 
+    # Remove keys corresponding to matcher
+    #
+    # @param [String] matcher
+    # @return [void, nil]
     def delete_matched matcher
-      #get matched keys
+      matched_keys = get_matched_keys matcher
+
+      delete matched_keys if matched_keys
+    end
+
+    # Get keys corresponding to matcher
+    #
+    # Supported glob-style patterns:
+    #
+    # h?llo matches hello, hallo and hxllo
+    # h*llo matches hllo and heeeello
+    # h[ae]llo matches hello and hallo, but not hillo
+    # h[^e]llo matches hallo, hbllo, ... but not hello
+    # h[a-b]llo matches hallo and hbllo
+    #
+    # @param [String] matcher
+    # @return [Array<String>]
+    # @see https://redis.io/commands/keys KEYS command
+    def get_matched_keys matcher
       open_socket
       @socket.puts("KEYS #{ matcher }")
       first_result = @socket.gets
@@ -55,19 +100,32 @@ module LightRedisCache
             @socket.gets
           end
         end
+      end
+      close_socket
+      keys
+    end
 
-        #delete keys
-        request = ""
-        request_length = 0
-        keys.each do |key|
-          request.insert(-1, "$#{ key.length }\r\n#{ key }\r\n")
-          request_length +=1
-        end
-        @socket.write("*#{ request_length + 1 }\r\n$3\r\nDEL\r\n#{ request }")
+    # Delete keys
+    #
+    # @param [Array] keys
+    # @return [void]
+    # @see https://redis.io/commands/del DEL command
+    def delete keys
+      open_socket
+      request = ""
+      request_length = 0
+      keys.each do |key|
+        request.insert(-1, "$#{ key.length }\r\n#{ key }\r\n")
+        request_length +=1
       end
+      @socket.write("*#{ request_length + 1 }\r\n$3\r\nDEL\r\n#{ request }")
       close_socket
     end
 
+    # Clear database
+    #
+    # @return [void]
+    # @see https://redis.io/commands/flushall FLUSHALL command
     def clear
       open_socket
       @socket.puts("FLUSHALL")
@@ -77,7 +135,7 @@ module LightRedisCache
     private
 
     def open_socket
-      @socket = TCPSocket.new(@hostname, @port)
+      @socket = TCPSocket.new(@configuration.hostname, @configuration.port)
     end
 
     def close_socket

data/lib/light_redis_cache/configuration.rb

@@ -0,0 +1,11 @@
+module LightRedisCache
+  class Configuration
+    attr_accessor :hostname
+    attr_accessor :port
+
+    def initialize
+      @hostname = nil
+      @port = nil
+    end
+  end
+end

data/lib/light_redis_cache/version.rb

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

data/light_redis_cache.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Eric Leroy-Terquem"]
   spec.email         = ["ericleroyterquem@gmail.com"]
 
-  spec.summary       = %q{A simple redis cache}
+  spec.summary       = %q{A basic Ruby client for Redis}
   spec.homepage      = "https://github.com/E-L-T/light_redis_cache"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light_redis_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Leroy-Terquem
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - bin/console
 - bin/setup
 - lib/light_redis_cache.rb
+- lib/light_redis_cache/configuration.rb
 - lib/light_redis_cache/version.rb
 - light_redis_cache.gemspec
 homepage: https://github.com/E-L-T/light_redis_cache
@@ -96,5 +97,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: A simple redis cache
+summary: A basic Ruby client for Redis
 test_files: []