rejson-rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd7a76d54e046c3ba8880b0aaeb7d3df2849b95aad7d5097c321b46d3d82844a
+  data.tar.gz: 371f4e666bb970f311e24cc9b571ba75a76d16d67fd3fe7c5470c85a512538af
+SHA512:
+  metadata.gz: 36a5c940c8efe4c9da419fb23abfdaa5b472bbbc2b87ede905fb74a371d29ab7591c150b43c801cecea8a5b26d78d220594f2dcc28e6fbe3abc82dbcf3aa6ae1
+  data.tar.gz: 3fafa39182f902bcaf469738666da400ba87258c03dbeec3a4426fc4e47687c337a4d06dacd1377cb0bd2a35e77bb5e66366ddbd1700b380346278fc4c794d6f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.idea/
+.vscode/
+.rspec_status

data/.travis.yml

@@ -0,0 +1,22 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+  - 2.6.3
+before_install: gem install bundler -v 2.0.0
+
+install:
+  # Get Redis
+  - git clone --depth=1 https://github.com/antirez/redis.git && cd redis && make && cd ..
+  # Get ReJSON
+  - git clone --depth=1 https://github.com/RedisLabsModules/ReJSON.git && cd ReJSON && make && cd ..
+  # Install dependency gems
+  - bundle install
+
+before_script:
+  - ./redis/src/redis-server --loadmodule ReJSON/src/rejson.so &
+  - bundle install
+
+script:
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vachhanihpavan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rejson-rb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pavan Vachhani
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# RedisJSON Ruby Client [![Build Status](https://travis-ci.com/vachhanihpavan/rejson-rb.svg?token=x85KXUqPs5qJik1EzpyW&branch=master)](https://travis-ci.com/vachhanihpavan/rejson-rb)
+
+rejson-rb is a package that allows storing, updating and querying objects as JSON documents in a [Redis](https://redis.io/) database that is extended with the [ReJSON](https://github.com/RedisJSON/RedisJSON) module. The package extends redis-rb's interface with ReJSON's API, and performs on-the-fly serialization/deserialization of objects to/from JSON.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rejson-rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rejson-rb
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vachhanihpavan/rejson-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).
+
+For complete documentation about ReJSON's commands, refer to ReJSON's website.
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rejson::Rb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vachhanihpavan/rejson-rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rejson/rb"
+
+# 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(__FILE__)

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/lib/rejson.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "rejson/version"
+require "rejson/path"
+require "rejson/client"

data/lib/rejson/client.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "redis"
+require "json"
+
+# Extends Redis class to add JSON functions
+class Redis
+  def json_set(key, path, data, options = {})
+    pieces = [key, str_path(path), json_encode(data)]
+    options[:nx] ||= false if options.dig(:nx)
+
+    options[:xx] ||= false if options.dig(:xx)
+
+    if options[:nx] && options[:xx]
+      raise Exception, "nx and xx are mutually exclusive: use one, the other or neither - but not both"
+    elsif options[:nx]
+      pieces.append("NX")
+    elsif options[:xx]
+      pieces.append("XX")
+    end
+
+    call_client(:set, pieces)
+  end
+
+  def json_get(key, *args)
+    pieces = [key]
+
+    if args.empty?
+      pieces.append(str_path(Rejson::Path.root_path))
+    else
+      args.each do |arg|
+        pieces.append(str_path(arg))
+      end
+    end
+
+    begin
+      json_decode call_client(:get, pieces)
+    rescue TypeError
+      nil
+    end
+  end
+
+  def json_mget(key, *args)
+    pieces = [key]
+
+    if args.empty?
+      raise ArgumentError "Invalid arguments"
+    else
+      pieces.append(args)
+    end
+
+    json_bulk_decode call_client(:mget, pieces)
+  end
+
+  def json_del(key, *args)
+    pieces = [key]
+    pieces.append(str_path(args))
+    call_client(:del, pieces).to_i
+  end
+
+  alias json_forget json_del
+
+  def json_type(key, *args)
+    pieces = [key]
+    pieces.append(str_path(args))
+    call_client(:type, pieces).to_s
+  end
+
+  def json_numincrby(key, path, number)
+    pieces = [key, str_path(path), number]
+    call_client(:numincrby, pieces).to_i
+  end
+
+  def json_nummultby(key, path, number)
+    pieces = [key, str_path(path), number]
+    call_client(:nummultby, pieces).to_i
+  end
+
+  def json_strappend(key, string, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path), json_encode(string)]
+    call_client(:strappend, pieces).to_i
+  end
+
+  def json_strlen(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
+    call_client(:strlen, pieces).to_i
+  end
+
+  def json_arrappend(key, path, json, *args)
+    json_objs = [json_encode(json)]
+    args.each { |arg| json_objs.append(json_encode(arg)) }
+    pieces = [key, str_path(path), json_objs]
+    call_client(:arrappend, pieces).to_i
+  end
+
+  def json_arrindex(key, path, scalar, start = 0, stop = 0)
+    pieces = [key, str_path(path), scalar, start, stop]
+    call_client(:arrindex, pieces).to_i
+  end
+
+  def json_arrinsert(key, path, index, *args)
+    json_objs = []
+    args.each { |arg| json_objs.append(json_encode(arg)) }
+    pieces = [key, str_path(path), index, json_objs]
+    call_client(:arrinsert, pieces).to_i
+  end
+
+  def json_arrlen(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
+    call_client(:arrlen, pieces).to_i
+  end
+
+  def json_arrpop(key, path = Rejson::Path.root_path, index = -1)
+    pieces = [key, str_path(path), index]
+    call_client(:arrpop, pieces).to_s
+  end
+
+  def json_arrtrim(key, path, start, stop)
+    pieces = [key, str_path(path), start, stop]
+    call_client(:arrtrim, pieces).to_i
+  end
+
+  def json_objkeys(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
+    call_client(:objkeys, pieces).to_a
+  end
+
+  def json_objlen(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
+    call_client(:objlen, pieces).to_i
+  end
+
+  def json_resp(key, path = Rejson::Path.root_path)
+    pieces = [key, str_path(path)]
+    call_client(:resp, pieces)
+  end
+
+  private
+
+  def str_path(p)
+    if p.instance_of?(Rejson::Path)
+      p.str_path
+    else
+      p
+    end
+  end
+
+  def json_encode(obj)
+    JSON.generate(obj)
+  end
+
+  def json_decode(obj)
+    JSON.parse(obj)
+  end
+
+  def json_bulk_decode(obj)
+    res = []
+    obj.to_a.each do |o|
+      if o.nil?
+        res.append(nil)
+      else
+        res.append(JSON.parse(o))
+      end
+    end
+    res
+  end
+
+  def call_client(cmd, pieces)
+    pieces.prepend("JSON.#{cmd.upcase}").join(" ")
+    client.call pieces
+  end
+end

data/lib/rejson/path.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rejson
+  # Represents a Path in JSON value
+  class Path
+    attr_accessor :str_path
+
+    def self.root_path
+      root = Path.new(".")
+      root
+    end
+
+    def initialize(path)
+      @str_path = path
+    end
+  end
+end

data/lib/rejson/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rejson
+  VERSION = "1.0.0"
+end

data/rejson-rb.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "./lib/rejson/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rejson-rb"
+  spec.version       = Rejson::VERSION
+  spec.authors       = ["Pavan Vachhani"]
+  spec.email         = ["vachhanihpavan@gmail.com"]
+
+  spec.summary       = "Redis JSON Ruby Client"
+  spec.description   = "rejson-rb is a package that allows storing, updating and querying objects as JSON documents in Redis database that is intended with RedisJSON module."
+  spec.homepage      = "https://github.com/vachhanihpavan/rejson-rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/vachhanihpavan/rejson-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/vachhanihpavan/rejson-rb"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 "redis",        "~> 3.0"
+  spec.add_runtime_dependency "json",         "~> 2.0"
+  spec.add_development_dependency "bundler",  "~> 2.0"
+  spec.add_development_dependency "rspec",    "~> 3.0"
+  spec.add_development_dependency "simplecov","~> 0.17"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rejson-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pavan Vachhani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: rejson-rb is a package that allows storing, updating and querying objects
+  as JSON documents in Redis database that is intended with RedisJSON module.
+email:
+- vachhanihpavan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rejson.rb
+- lib/rejson/client.rb
+- lib/rejson/path.rb
+- lib/rejson/version.rb
+- rejson-rb.gemspec
+homepage: https://github.com/vachhanihpavan/rejson-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vachhanihpavan/rejson-rb
+  source_code_uri: https://github.com/vachhanihpavan/rejson-rb
+  changelog_uri: https://github.com/vachhanihpavan/rejson-rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Redis JSON Ruby Client
+test_files: []