redistimeseries 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4af4bf21201c52e7d9341772f9e42ef980bfbfda0e1d9e459d1ad3d6b937cc42
+  data.tar.gz: 5d452593b2532a78b6ed38a11626ddb83fa5f91b5ee821e6f7d40d0769fd8add
+SHA512:
+  metadata.gz: d76f55ae9b6e42ab9f5999db3aa0d1444e668583084f30fe9e4cc868d3cb7ece238cd2916c3ceaff699163ae9f9aaf574fd2472bf046d65ed8c86653440f487a
+  data.tar.gz: 231f52e8ed45b1fe36539ad3e6353541f6d3b6705563f16db2b66600b306014c7133142a81e04f6d390f35742b3eb76c2345b722aa1540dfdafa1a30de924cf5

data/.github/workflows/gempush.yml

@@ -0,0 +1,50 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    services:
+      redistimeseries:
+        image: redislabs/redistimeseries:latest
+        ports:
+          - 6379/tcp
+        # options: --entrypoint redis-server
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+    - name: Debug Info
+      env:
+        REDIS_PORT: ${{ job.services.redistimeseries.ports[6379] }}
+      run: |
+        sudo apt-get install redis-tools
+        redis-cli -p ${REDIS_PORT} info
+        redis-cli -p ${REDIS_PORT} TS.CREATE mytestkey
+    - name: Bundle install
+      run: |
+        gem install bundler:2.1.2
+        bundle install
+    - name: Run specs
+      env:
+        REDIS_URL: redis://localhost:${{ job.services.redistimeseries.ports[6379] }}
+      run: |
+        ./bin/rspec
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - wall-middleware/**/*
+    - node_modules/**/*
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*

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 mail@eaden.net. 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,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redistimeseries.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "redis", "~> 4.1.4"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 0.82.0"
+gem 'sdoc', git: 'https://github.com/p8/sdoc.git', branch: 'without-frames'

data/Gemfile.lock

@@ -0,0 +1,65 @@
+GIT
+  remote: https://github.com/p8/sdoc.git
+  revision: 4c5d4a0863ef1c44a41e828ce621c23a6a2e2712
+  branch: without-frames
+  specs:
+    sdoc (1.1.0)
+      rdoc (>= 5.0)
+
+PATH
+  remote: .
+  specs:
+    redistimeseries (0.1.0)
+      redis (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rdoc (6.2.1)
+    redis (4.1.4)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  redis (~> 4.1.4)
+  redistimeseries!
+  rspec (~> 3.0)
+  rubocop (~> 0.82.0)
+  sdoc!
+
+BUNDLED WITH
+   2.1.2

data/LICENCE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Eaden McKee
+
+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,59 @@
+# Redistimeseries
+
+![Ruby Gem](https://github.com/eadz/redistimeseries/workflows/Ruby%20Gem/badge.svg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redistimeseries'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redistimeseries
+
+## Usage
+
+RedisTimeSeries gem uses Ruby's refinement to add timeseries methods to the Redis gem.
+
+You need to include the line
+
+```ruby
+using Redistimeseries::RedisRefinement
+```
+
+in files which use the redis timeseries functions.
+
+### done
+
+```ruby
+ts_create(key:, retention: nil, uncompressed: false, labels: [])
+ts_add(key:, timestamp: "*", value:, retention: nil, labels: [])
+ts_madd(key:, timestamp: "*", value:)
+ts_range(key:, from: 0, to: nil, count: nil, aggtype: nil, timebucket: nil)
+ts_info(key:)
+```
+
+### todo
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/eadz/redistimeseries.
+
+## Code of Conduct
+
+Everyone interacting in the Redistimeseries project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eadz/redistimeseries/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'sdoc' # and use your RDoc task the same way you used it before
+require 'rdoc/task' # ensure this file is also required in order to use `RDoc::Task`
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'      # name of output directory
+  rdoc.options << '--format=sdoc' # explictly set the sdoc generator
+  rdoc.template = 'rails'         # template used on api.rubyonrails.org
+end

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redistimeseries"
+
+# 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"
+
+require "redis"
+
+using Redistimeseries::RedisRefinement
+
+@redis = Redis.new(host: "recmon.red")
+
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/redistimeseries.rb

@@ -0,0 +1,8 @@
+require 'redis'
+
+require "redistimeseries/redis_refinement"
+require "redistimeseries/version"
+
+module Redistimeseries
+  class Error < StandardError; end
+end

data/lib/redistimeseries/redis_refinement.rb

@@ -0,0 +1,67 @@
+# Redis Timeseries functions for the Redis gem
+module Redistimeseries
+  # refine the Redis class to add ts_* methods
+  module RedisRefinement
+    refine Redis do
+      def ts_create(key:, retention: nil, uncompressed: false, labels: [])
+        cmd = ['TS.CREATE', key]
+        cmd += ['RETENTION', retention] if retention
+        cmd += ['UNCOMPRESSED'] if uncompressed
+        cmd += ['LABELS'] if labels.any?
+        cmd += labels if labels.any?
+        _ts_call(cmd)
+      end
+
+      def ts_add(key:, timestamp: "*", value:, retention: nil, labels: [])
+        cmd = ['TS.ADD', key, timestamp, value]
+        cmd += ['RETENTION', retention] if retention
+        cmd += ['LABELS'] if labels.any?
+        cmd += labels if labels.any?
+        _ts_call(cmd)
+      end
+
+      def ts_madd(key:, timestamp: "*", value:) # TODO make multi
+        cmd = ['TS.MADD', key, timestamp, value]
+        _ts_call(cmd)
+      end
+
+      def ts_incrby; end
+
+      def ts_decrby; end
+
+      def ts_createrule; end
+
+      def ts_deleterule; end
+
+      def ts_range(key:, from: 0, to: nil, count: nil, aggtype: nil, timebucket: nil)
+        to_time = to || (Time.now.to_f * 1000.0).to_i
+        cmd = ['TS.RANGE', key, from, to_time]
+        if count
+          cmd += ['COUNT', count]
+        else
+          cmd += ['AGGREGATION', aggtype, timebucket]
+        end
+        _ts_call(cmd)
+      end
+
+      def ts_mrange; end
+      def ts_get; end
+      def ts_mget; end
+
+      def ts_info(key:)
+        cmd = ["TS.INFO", key]
+        _ts_call(cmd)
+      end
+
+      def ts_queryindex(filter:)
+        cmd = ["TS.QUERYINDEX", filter]
+        _ts_call(cmd)
+      end
+
+      def _ts_call(cmd)
+        # puts "CMD #{cmd.join(' ')}"
+        call cmd
+      end
+    end
+  end
+end

data/lib/redistimeseries/time_refinement.rb

@@ -0,0 +1,7 @@
+module RefineTime
+  refine Time do
+    def to_ms
+      (self.to_f * 1000.0).to_i
+    end
+  end
+end

data/lib/redistimeseries/version.rb

@@ -0,0 +1,3 @@
+module Redistimeseries
+  VERSION = "0.1.0"
+end

data/redistimeseries.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/redistimeseries/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redistimeseries"
+  spec.version       = Redistimeseries::VERSION
+  spec.authors       = ["Eaden McKee (eadz)"]
+  spec.email         = ["mail@eaden.net"]
+
+  spec.summary       = %q{Ruby client for Redis Timeseries.}
+  spec.description   = %q{Ruby client for Redis Timeseries, a redis add-on module.}
+  spec.homepage      = "https://github.com/eadz/redistimeseries"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/eadz/redistimeseries"
+  spec.metadata["changelog_uri"] = "https://github.com/eadz/redistimeseries"
+
+  spec.add_dependency 'redis', '>= 4'
+
+  # 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('..', __FILE__)) 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"]
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: redistimeseries
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eaden McKee (eadz)
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Ruby client for Redis Timeseries, a redis add-on module.
+email:
+- mail@eaden.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENCE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/redistimeseries.rb
+- lib/redistimeseries/redis_refinement.rb
+- lib/redistimeseries/time_refinement.rb
+- lib/redistimeseries/version.rb
+- redistimeseries.gemspec
+homepage: https://github.com/eadz/redistimeseries
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/eadz/redistimeseries
+  source_code_uri: https://github.com/eadz/redistimeseries
+  changelog_uri: https://github.com/eadz/redistimeseries
+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: Ruby client for Redis Timeseries.
+test_files: []