redis-cluster 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 703b89b40d08e4c0df9bf8eae2ac03add59c8ef6
-  data.tar.gz: b592ec99efaf8aea624538b421c0481d2dc1b42d
+  metadata.gz: aef27de1754b1b2a7106672eeec3073a431d0d8a
+  data.tar.gz: 8762651a0de67037a3118a0b4fbf87fb95d85b36
 SHA512:
-  metadata.gz: 5ef6234f0223f21cc93baa713c732afa01f638b1d7daf7d99d5c7e63d06d04449b837d31b781b7861cfba1d9f0d12fb972409eea9be71620f5c2a45f9977e2e7
-  data.tar.gz: ca36b2b72dd9e41e7a39c6caf5b5b5b1bba62c4048a7ca998702c688924aff9320ffc97bf2f37f1274e25b8e04e2489f469cb242c60fab4a8669a63764c52afd
+  metadata.gz: a23e10568bcf5058159a96a5e838f2b89c74909ae8bf9930f09906f3d4526322415cca104899a164b143af4ce7cb1f1e31e8afcd8c142dc25122521814287682
+  data.tar.gz: 020d80d301681e521ec0aec29031bf1451197c12406b6597a58d404acb92456b95f7895600477cec0c388a396300475a3fd29b6f87dff76e8bf7845b64dcb6a2

data/README.md

@@ -2,35 +2,101 @@
 [![CircleCI](https://circleci.com/gh/bukalapak/redis-cluster.svg?style=shield&circle-token=5ebe750ce74100b7bc18768395ec3e4ebd9f1a43)](https://circleci.com/gh/bukalapak/redis-cluster)
 [![Coverage](https://codecov.io/gh/bukalapak/redis-cluster/branch/master/graph/badge.svg?token=cPZvgDYAft)](https://codecov.io/gh/bukalapak/redis-cluster)
 
-## Getting started
+## Description
 
-Install redis-cluster.
-````ruby
-gem install 'redis-cluster'
-````
+redis-cluster is redis cluster client for ruby that support pipelining.
 
-This will start a redis from seed servers. Currently it only support master read configuration.
-````ruby
-seed = ['127.0.0.1:7001', '127.0.0.1:7002']
-redis = RedisCluster.new(seed, redis_opts: { timeout: 5, connect_timeout: 1 }, cluster_opts: { read_mode: :master_slave, silent: true, logger: Logger.new })
-````
+## Owner
 
-## Configuration
+SRE Bukalapak
+
+## Contact
+
+[Contributors](https://github.com/bukalapak/redis-cluster/graphs/contributors)
+
+## Onboarding and Development Guide
+
+### Getting started
+
+1. Install redis-cluster
+
+   ````ruby
+   gem install 'redis-cluster'
+   ````
+
+2. Start `irb`. This command will start a redis-cluster client from seed servers.
+
+   ````ruby
+   seed = ['127.0.0.1:7001', '127.0.0.1:7002']
+   redis = RedisCluster.new(
+                             seed,
+                             redis_opts: { timeout: 5, connect_timeout: 1 },
+                             cluster_opts: { force_cluster: false, read_mode: :master_slave, silent: true, logger: Logger.new }
+                           )
+   ````
+
+### Development Guide
+
+1. You need [rvm](https://rvm.io) and [bundler](http://bundler.io/) to test.
+   See [here](https://rvm.io/rvm/install) to install `rvm`.
+   And run these commands to install `bundler` and other dependencies
+
+   ````
+   gem install bundler
+   bundle install
+   ````
+
+2. You also need redis binary.
+   See [here](https://redis.io/download) to install `redis`
+
+3. Fork this repo
+
+4. Make your change and it's test.
+
+   ````
+   vim lib/**.rb
+   vim spec/**_spec.rb
+   ````
+
+5. Optionally, run the test in your local
+
+   ````
+   rake # run all test and lint
+   ````
+
+6. Commit and push your change to upstream
+
+   ````
+   git commit -m "message"
+   git push # add "--set-upstream branch_name" after "git push" if you haven't set the upstream
+   ````
+
+7. Open pull request in `Github`
+
+8. If test in CI is success, ask someone to review your code.
+
+9. If review is passed, your pull request can be merged.
+
+### Configuration
+
+#### redis_opts
 
-### redis_opts
 Option for Redis::Client instance. Set timeout, ssl, etc here.
 
-### cluster_opts
+#### cluster_opts
+
 Option for RedisCluster.
+- `force_cluster`: if true, RedisCluster will only work on clustered Redis or otherwise can also work on standalone Redis. The default value is `false`.
 - `read_mode`: for read command, RedisClient can try to read from slave if specified. Supported option is `:master`(default), `:slave`, and `:master_slave`.
 - `silent`: whether or not RedisCluster will raise error.
 - `logger`: if specified. RedisCluster will log all of RedisCluster errors here.
 
-## Limitation
+### Limitation
+
 All multi keys operation, cluster command, multi-exec, and some commands are not supported.
 
-## Pipeline
+### Pipeline
+
 Can be used with same interface as standalone redis client. See [redis pipeline](https://github.com/redis/redis-rb#pipelining)
 
-## Contributing
-[Fork the project](https://github.com/bukalapak/redis-cluster) and send pull requests.
+## FAQ

data/lib/redis-cluster.rb

@@ -15,7 +15,8 @@ class RedisCluster
 
   def initialize(seeds, redis_opts: nil, cluster_opts: nil)
     @options = cluster_opts || {}
-    @cluster = Cluster.new(seeds, redis_opts || {})
+    cluster_options = redis_opts || {}
+    @cluster = Cluster.new(seeds, cluster_options.merge(force_cluster: force_cluster?))
 
     super()
   end
@@ -32,6 +33,10 @@ class RedisCluster
     options[:read_mode] || :master
   end
 
+  def force_cluster?
+    options[:force_cluster]
+  end
+
   def connected?
     cluster.connected?
   end

data/lib/redis_cluster/cluster.rb

@@ -18,6 +18,10 @@ class RedisCluster
       init_client(seeds)
     end
 
+    def force_cluster?
+      options[:force_cluster]
+    end
+
     # Return Redis::Client for a given key.
     # Modified from https://github.com/antirez/redis-rb-cluster/blob/master/cluster.rb#L104-L117
     def slot_for(key)
@@ -75,17 +79,26 @@ class RedisCluster
     def slots_and_clients(client)
       replicas = ::Hash.new{ |h, k| h[k] = [] }
 
-      client.call([:cluster, :slots]).tap do |result|
-        result.each do |arr|
-          arr[2..-1].each_with_index do |a, i|
-            cli = self["#{a[0]}:#{a[1]}"]
-            replicas[arr[0]] << cli
-            cli.call([:readonly]) if i.nonzero?
-          end
-
-          (arr[0]..arr[1]).each do |slot|
-            slots[slot] = replicas[arr[0]]
-          end
+      result = client.call([:cluster, :slots])
+      if result.is_a?(StandardError)
+        if result.message.eql?('ERR This instance has cluster support disabled') &&
+           !force_cluster?
+          host, port = client.url.split(':', 2)
+          result = [[0, HASH_SLOTS - 1, [host, port, nil], [host, port, nil]]]
+        else
+          raise result
+        end
+      end
+
+      result.each do |arr|
+        arr[2..-1].each_with_index do |a, i|
+          cli = self["#{a[0]}:#{a[1]}"]
+          replicas[arr[0]] << cli
+          cli.call([:readonly]) if i.nonzero?
+        end
+
+        (arr[0]..arr[1]).each do |slot|
+          slots[slot] = replicas[arr[0]]
         end
       end
 
@@ -112,7 +125,10 @@ class RedisCluster
 
     def create_client(url)
       host, port = url.split(':', 2)
-      Client.new(options.merge(host: host, port: port))
+      client_options = options.clone.tap do |opts|
+        opts.delete(:force_update)
+      end
+      Client.new(client_options.merge(host: host, port: port))
     end
 
     # -----------------------------------------------------------------------------

data/lib/redis_cluster/function/set.rb

@@ -8,8 +8,8 @@ class RedisCluster
     # see https://redis.io/commands#set. Most of the code are copied from
     # https://github.com/redis/redis-rb/blob/master/lib/redis.rb.
     #
-    # SETTER = [:sadd, :spop, :srem]
-    # GETTER = [:scard, :sismembers, :smembers, :srandmember, :sscan]
+    # SETTER = [:sadd, :spop, :srem, :sdiffstore, :sinterstore, :smove, :sunionstore]
+    # GETTER = [:scard, :sismember, :smembers, :srandmember, :sscan, :sdiff, :sinter, :sunion]
     module Set
 
       # Get the number of members in a set.
@@ -78,6 +78,69 @@ class RedisCluster
       def smembers(key)
         call(key, [:smembers, key], read: true)
       end
+
+      # Subtract multiple sets.
+      #
+      # @param [String, Array<String>] keys keys pointing to sets to subtract
+      # @return [Array<String>] members in the difference
+      def sdiff(*keys)
+        call(keys, [:sdiff] + keys, read: true)
+      end
+
+      # Subtract multiple sets and store the resulting set in a key.
+      #
+      # @param [String] destination destination key
+      # @param [String, Array<String>] keys keys pointing to sets to subtract
+      # @return [Fixnum] number of elements in the resulting set
+      def sdiffstore(destination, *keys)
+        call([keys, destination], [:sdiffstore, destination] + keys)
+      end
+
+      # Intersect multiple sets.
+      #
+      # @param [String, Array<String>] keys keys pointing to sets to intersect
+      # @return [Array<String>] members in the intersection
+      def sinter(*keys)
+        call(keys, [:sinter] + keys, read: true)
+      end
+
+      # Intersect multiple sets and store the resulting set in a key.
+      #
+      # @param [String] destination destination key
+      # @param [String, Array<String>] keys keys pointing to sets to intersect
+      # @return [Fixnum] number of elements in the resulting set
+      def sinterstore(destination, *keys)
+        call([keys, destination], [:sinterstore, destination] + keys)
+      end
+
+      # Move a member from one set to another.
+      #
+      # @param [String] source source key
+      # @param [String] destination destination key
+      # @param [String] member member to move from `source` to `destination`
+      # @return [Boolean]
+      def smove(source, destination, member)
+        call([source, destination],
+             [:smove, source, destination, member],
+             transform: Redis::Boolify)
+      end
+
+      # Add multiple sets.
+      #
+      # @param [String, Array<String>] keys keys pointing to sets to unify
+      # @return [Array<String>] members in the union
+      def sunion(*keys)
+        call(keys, [:sunion] + keys, read: true)
+      end
+
+      # Add multiple sets and store the resulting set in a key.
+      #
+      # @param [String] destination destination key
+      # @param [String, Array<String>] keys keys pointing to sets to unify
+      # @return [Fixnum] number of elements in the resulting set
+      def sunionstore(destination, *keys)
+        call([keys, destination], [:sunionstore, destination] + keys)
+      end
     end
   end
 end

data/lib/redis_cluster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RedisCluster
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Bukalapak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis