ffi-hiredis_vip 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab0b43e5fa778ab53945a79ccb56a3680a845aca
+  data.tar.gz: 13ed771c3c8b05b3d0686318c0bd58178db315a3
+SHA512:
+  metadata.gz: 852d415b1fbee1e6300c10aecd57ef7f04ea45e7e5a03fa70250e96f2372072d9c1cd2dda8e0d19393b7f61316f13974ede5838d9a727c116bf2ef3376e8ea16
+  data.tar.gz: d9868b4248f0f8f1c8e7b6b18d54ae875855a2f3640dfd3d00cecf423f11ee54b759c4d03927b7a02ee85a18795c5785d2e36758f12aff47336c14d2dd424f55

data/.gitignore

@@ -0,0 +1,10 @@
+.ruby-*
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ffi-hiredis_vip.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# Ffi::HiredisVip
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ffi/hiredis_vip`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ffi-hiredis_vip'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ffi-hiredis_vip
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ffi-hiredis_vip.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ffi/hiredis_vip"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ffi-hiredis_vip.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ffi/hiredis_vip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ffi-hiredis_vip"
+  spec.version       = FFI::HiredisVip::VERSION
+  spec.authors       = ["Brandon Dewitt"]
+  spec.email         = ["brandonsdewitt@gmail.com"]
+
+  spec.summary       = %q{ FFI Wrapper around hiredis-vip for Hiredis and cluster support }
+  spec.description   = %q{ FFI Wrapper for hiredis-vip }
+  #spec.homepage      = "url"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "ffi"
+  spec.add_runtime_dependency "ffi-hiredis_vip-core", ">= 0.1.0.pre4"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry"
+end

data/lib/ffi/hiredis_vip.rb

@@ -0,0 +1,6 @@
+require "ffi/hiredis_vip/version"
+require 'rubygems'
+require 'ffi'
+
+require "ffi/hiredis_vip/core"
+require 'ffi/hiredis_vip/client'

data/lib/ffi/hiredis_vip/client.rb

@@ -0,0 +1,635 @@
+require 'ffi/hiredis_vip'
+require 'ffi/hiredis_vip/info'
+require 'ffi/hiredis_vip/exists'
+require 'ffi/hiredis_vip/exists_before_3'
+require 'ffi/hiredis_vip/keys'
+require 'ffi/hiredis_vip/mget'
+require 'ffi/hiredis_vip/persist'
+require 'ffi/hiredis_vip/persist_before_2_2'
+require 'ffi/hiredis_vip/sadd'
+require 'ffi/hiredis_vip/sadd_before_2_4'
+require 'ffi/hiredis_vip/scan'
+require 'ffi/hiredis_vip/scan_before_2_8'
+require 'ffi/hiredis_vip/set'
+require 'ffi/hiredis_vip/set_before_2_6_12'
+require 'ffi/hiredis_vip/sscan'
+require 'ffi/hiredis_vip/sscan_before_2_8'
+require 'ffi/hiredis_vip/touch'
+require 'ffi/hiredis_vip/touch_before_3_2_1'
+require 'monitor'
+
+module FFI
+  module HiredisVip
+    class Client
+      include MonitorMixin
+
+      OK = "OK"
+      PONG = "PONG"
+
+      def initialize(options = {})
+        database = options[:db]
+        host = options[:host]
+        port = options[:port].to_i
+
+        @connection = ::FFI::HiredisVip::Core.connect(host, port)
+
+        super() # MonitorMixin#initialize
+
+        raise "Cannot select database specified" if database && !select?(database)
+
+        set_exists_provider # Changed in Redis3
+        set_persist_provider # Added in Redis2.2
+        set_sadd_provider # Changed in Redis2.4
+        set_scan_provider # Introduced in Redis2.8
+        set_set_provider # Changed in 2.6.12
+        set_sscan_provider # Introduced in Redis2.8
+        set_touch_provider # Introduced in Redis3.2.1
+      end
+
+      def synchronize
+        mon_synchronize { yield(@connection) }
+      end
+
+      def dbsize
+        reply = nil
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, "DBSIZE")
+        end
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def decr(key)
+        reply = nil
+        command = "DECR %b"
+        command_args = [ :string, key, :size_t, key.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def decrby(key, amount)
+        reply = nil
+        _amount = "#{amount}"
+        command = "DECRBY %b %b"
+        command_args = [ :string, key, :size_t, key.size, :string, _amount, :size_t, _amount.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def del(*keys)
+        reply = nil
+        keys = keys.flatten
+        number_of_deletes = keys.size
+        command = "DEL#{' %b' * number_of_deletes}"
+        command_args = []
+        keys.each do |key|
+          command_args << :string << key << :size_t << key.size
+        end
+
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def dump(key)
+        reply = nil
+        command = "DUMP %b"
+        command_args = [ :string, key, :size_t, key.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        else
+          nil
+        end
+      end
+
+      def echo(value)
+        reply = nil
+        command = "ECHO %b"
+        command_args = [ :string, value, :size_t, value.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        when :REDIS_REPLY_NIL
+          nil
+        else
+          nil
+        end
+      end
+
+      def echo?(value)
+        echo(value) == value
+      end
+
+      def exists(*keys)
+        @exists_provider.exists(*keys)
+      end
+
+      def exists?(key)
+        exists(key) == 1
+      end
+
+      def expire(key, seconds)
+        reply = nil
+        time_in_seconds = "#{seconds}"
+        command = "EXPIRE %b %b"
+        command_args = [ :string, key, :size_t, key.size, :string, time_in_seconds, :size_t, time_in_seconds.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        # TODO: should we return a 0 here?
+        return 0 if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def expire?(key, seconds)
+        expire(key, seconds) == 1
+      end
+
+      def expireat(key, unix_time)
+        reply = nil
+        epoch = "#{unix_time}"
+        command = "EXPIREAT %b %b"
+        command_args = [ :string, key, :size_t, key.size, :string, epoch, :size_t, epoch.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return 0 if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def expireat?(key, unix_time)
+        expireat(key, unix_time) == 1
+      end
+
+      def flushall
+        reply = nil
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, "FLUSHALL")
+        end
+
+        return "" if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        else
+          ""
+        end
+      end
+
+      def flushall?
+        flushall == OK
+      end
+
+      def flushdb
+        reply = nil
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, "FLUSHDB")
+        end
+
+        return "" if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        else
+          ""
+        end
+      end
+
+      def flushdb?
+        flushdb == OK
+      end
+
+      def get(key)
+        reply = nil
+        command = "GET %b"
+        command_args = [ :string, key, :size_t, key.size ]
+
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        when :REDIS_REPLY_NIL
+          nil
+        else
+          nil # TODO: should this be empty string?
+        end
+      end
+      alias_method :[], :get
+
+      def incr(key)
+        reply = nil
+        command = "INCR %b"
+        command_args = [ :string, key, :size_t, key.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def incrby(key, amount)
+        reply = nil
+        _amount = "#{amount}"
+        command = "INCRBY %b %b"
+        command_args = [ :string, key, :size_t, key.size, :string, _amount, :size_t, _amount.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        else
+          0
+        end
+      end
+
+      def info
+        reply = nil
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, "INFO")
+        end
+
+        return "" if reply.nil? || reply.null?
+
+        case reply[:type] 
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        else
+          ""
+        end
+      end
+
+      def keys(pattern)
+        @keys_provider ||= ::FFI::HiredisVip::Keys.new(self)
+        @keys_provider.keys(pattern)
+      end
+
+      def mget(*keys)
+        @mget_provider ||= ::FFI::HiredisVip::Mget.new(self)
+        @mget_provider.mget(*keys)
+      end
+
+      def persist(key)
+        @persist_provider.persist(key)
+      end
+
+      def persist?(key)
+        persist(key) == 1 || ttl(key) == -1
+      end
+
+      def ping
+        reply = nil
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, "PING")
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STATUS
+          reply[:str]
+        when :REDIS_REPLY_STRING
+          reply[:str]
+        else
+          ""
+        end
+      end
+
+      def ping?
+        ping == PONG
+      end
+
+      def psetex(key, value, expiry)
+        @set_provider.psetex(key, value, expiry)
+      end
+
+      def reconnect
+        reply = nil
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.redisReconnect(connection)
+        end
+
+        case reply
+        when :REDIS_OK
+          true
+        else
+          false
+        end
+      end
+
+      def sadd(key, *values)
+        @sadd_provider.sadd(key, *values)
+      end
+
+      def scan(cursor, options = {})
+        @scan_provider.scan(cursor, options)
+      end
+
+      def scan_each(options = {}, &block)
+        return to_enum(:scan_each, options) unless block_given?
+
+        cursor = "0"
+        loop do
+          cursor, keys = scan(cursor, options)
+          keys.each(&block)
+          break if cursor == "0"
+        end
+      end
+
+      def sscan(key, cursor, options = {})
+        @sscan_provider.sscan(key, cursor, options)
+      end
+
+      def sscan_each(key, options = {}, &block)
+        return to_enum(:sscan_each, key, options) unless block_given?
+
+        cursor = "0"
+        loop do
+          cursor, values = sscan(key, cursor, options)
+          values.each(&block)
+          break if cursor == "0"
+        end
+      end
+
+      def select(db)
+        reply = nil
+        db = "#{db}"
+        command = "SELECT %b"
+        command_args = [ :string, db, :size_t, db.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type]
+        when :REDIS_REPLY_STATUS
+          reply[:str]
+        else
+          nil
+        end
+      end
+
+      def select?(db)
+        select(db) == OK
+      end
+
+      def set(key, value, options = {})
+        @set_provider.set(key, value, options)
+      end
+      alias_method :[]=, :set
+
+      def set?(key, value, options = {})
+        set(key, value, options) == OK
+      end
+
+      def setex(key, value, expiry)
+        @set_provider.setex(key, value, expiry)
+      end
+
+      def setnx(key, value)
+        @set_provider.setnx(key, value)
+      end
+
+      def supports_persist?
+        @persist_provider.supports_persist?
+      end
+
+      def supports_scan?
+        @scan_provider.supports_scan?
+      end
+
+      def supports_scan_each?
+        @scan_provider.supports_scan?
+      end
+
+      def supports_sscan?
+        @sscan_provider.supports_sscan?
+      end
+
+      def supports_sscan_each?
+        @sscan_provider.supports_sscan?
+      end
+
+      def supports_touch?
+        @touch_provider.supports_touch?
+      end
+
+      def ttl(key)
+        reply = nil
+        command = "TTL %b"
+        command_args = [ :string, key, :size_t, key.size ]
+        synchronize do |connection|
+          reply = ::FFI::HiredisVip::Core.command(connection, command, *command_args)
+        end
+
+        return nil if reply.nil? || reply.null?
+
+        case reply[:type] 
+        when :REDIS_REPLY_INTEGER
+          reply[:integer]
+        end
+      end
+
+      def touch(*keys)
+        @touch_provider.touch(*keys)
+      end
+
+      private
+
+      def redis_info_parsed
+        @redis_info_parsed ||= ::FFI::HiredisVip::Info.new(info)
+      end
+
+      def redis_version_2?
+        return @redis_version_2 unless @redis_version_2.nil?
+
+        @redis_version_2 = redis_info_parsed["redis_version"] &&
+                           redis_info_parsed["redis_version"].start_with?("2")
+      end
+
+      def redis_version_3?
+        return @redis_version_3 unless @redis_version_3.nil?
+
+        @redis_version_3 = redis_info_parsed["redis_version"] &&
+                           redis_info_parsed["redis_version"].start_with?("3")
+      end
+
+      def redis_version_greater_than_2_2?
+        return @redis_version_greater_than_2_2 unless @redis_version_greater_than_2_2.nil?
+
+        @redis_version_greater_than_2_2 = redis_info_parsed["redis_version"] &&
+                                          ::Gem::Version.new(redis_info_parsed["redis_version"]) >= ::Gem::Version.new("2.2.0")
+      end
+
+      def redis_version_greater_than_2_4?
+        return @redis_version_greater_than_2_4 unless @redis_version_greater_than_2_4.nil?
+
+        @redis_version_greater_than_2_4 = redis_info_parsed["redis_version"] &&
+                                          ::Gem::Version.new(redis_info_parsed["redis_version"]) >= ::Gem::Version.new("2.4.0")
+      end
+
+      def redis_version_greater_than_2_6_12?
+        return @redis_version_greater_than_2_6_12 unless @redis_version_greater_than_2_6_12.nil?
+
+        @redis_version_greater_than_2_6_12 = redis_info_parsed["redis_version"] &&
+                                             ::Gem::Version.new(redis_info_parsed["redis_version"]) >= ::Gem::Version.new("2.6.12")
+      end
+
+      def redis_version_greater_than_2_8?
+        return @redis_version_greater_than_2_8 unless @redis_version_greater_than_2_8.nil?
+
+        @redis_version_greater_than_2_8 = redis_info_parsed["redis_version"] &&
+                                          ::Gem::Version.new(redis_info_parsed["redis_version"]) >= ::Gem::Version.new("2.8.0")
+      end
+
+      def redis_version_greater_than_3_2_1?
+        return @redis_version_greater_than_3_2_1 unless @redis_version_greater_than_3_2_1.nil?
+
+        @redis_version_greater_than_3_2_1 = redis_info_parsed["redis_version"] &&
+                                            ::Gem::Version.new(redis_info_parsed["redis_version"]) >= ::Gem::Version.new("3.2.1")
+      end
+
+      def set_exists_provider
+        @exists_provider = case
+                           when redis_version_3?
+                             ::FFI::HiredisVip::Exists.new(self)
+                           else
+                             ::FFI::HiredisVip::ExistsBefore3.new(self)
+                           end
+      end
+
+      def set_persist_provider
+        @persist_provider = case
+                            when redis_version_greater_than_2_2?
+                              ::FFI::HiredisVip::Persist.new(self)
+                            else
+                              ::FFI::HiredisVip::PersistBefore22.new(self)
+                            end
+      end
+
+      def set_sadd_provider
+        @sadd_provider = case
+                         when redis_version_greater_than_2_4?
+                           ::FFI::HiredisVip::Sadd.new(self)
+                         else
+                           ::FFI::HiredisVip::SaddBefore24.new(self)
+                         end
+      end
+
+      def set_scan_provider
+        @scan_provider = case
+                         when redis_version_greater_than_2_8?
+                           ::FFI::HiredisVip::Scan.new(self)
+                         else
+                           ::FFI::HiredisVip::ScanBefore28.new(self)
+                         end
+      end
+
+      def set_set_provider
+        @set_provider = case
+                        when redis_version_greater_than_2_6_12?
+                          ::FFI::HiredisVip::Set.new(self)
+                        else
+                          ::FFI::HiredisVip::SetBefore2612.new(self)
+                        end
+      end
+
+      def set_sscan_provider
+        @sscan_provider = case
+                          when redis_version_greater_than_2_8?
+                            ::FFI::HiredisVip::Sscan.new(self)
+                          else
+                            ::FFI::HiredisVip::SscanBefore28.new(self)
+                          end
+      end
+
+      def set_touch_provider
+        @touch_provider = case
+                          when redis_version_greater_than_3_2_1?
+                            ::FFI::HiredisVip::Touch.new(self)
+                          else
+                            ::FFI::HiredisVip::TouchBefore321.new(self)
+                          end
+      end
+    end # class Client
+  end # module HiredisVip
+end # module FFI