legion-cache 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dab39061de216282a220ec038a80444f3a77238100dc1d6b6ac9ecdf97d0903f
+  data.tar.gz: 5a2ec7633c66a15c34251051c31d12c38ad5a38b7853b1ba51d099a4b88c39a7
+SHA512:
+  metadata.gz: 033b9f8f9dcc1d14b505161207d690481490dbb329a64b9d80078371fafe17d2955479bf3d2e592369803268448f7200f6cd5e9f4151a34b8afc230ca5c8da4b
+  data.tar.gz: '0958bf77c95cd1d7857d384fc3e567dd191b04b294bb8a40865ab7dd7afe752697e6afe8b5fcb93140e168b677300ac5092cdb4529d938a22c5954b9c5768be2'

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.2.1
+
+jobs:
+  "rubocop":
+    docker:
+      - image: circleci/ruby:2.5-node
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - ruby/save-cache
+  "ruby-two-five":
+    docker:
+      - image: circleci/ruby:2.5
+      - image: memcached:1.5-alpine
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - ruby/run-tests
+      - ruby/save-cache
+  "ruby-two-six":
+    docker:
+      - image: circleci/ruby:2.6
+      - image: memcached:1.5-alpine
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - ruby/run-tests
+      - ruby/save-cache
+  "ruby-two-seven":
+    docker:
+      - image: circleci/ruby:2.7
+      - image: memcached:1.5-alpine
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - ruby/run-tests
+      - ruby/save-cache
+
+workflows:
+  version: 2
+  rubocop-rspec:
+    jobs:
+      - rubocop
+      - ruby-two-five:
+          requires:
+            - rubocop
+      - ruby-two-six:
+          requires:
+            - ruby-two-five
+      - ruby-two-seven:
+          requires:
+            - ruby-two-five

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,23 @@
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/ClassLength:
+  Max: 1500
+Metrics/BlockLength:
+  Max: 50
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+Style/SymbolArray:
+  Enabled: true
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Style/Documentation:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.5
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Naming/FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in legion-cache.gemspec
+gemspec
+
+gem 'legion-settings', path: '~/legion-io/legion-settings'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Esity
+
+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,38 @@
+# Legion::Cache
+
+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/legion/cache`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'legion-cache'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install legion-cache
+
+## Usage
+
+
+
+## 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://bitbucket.org/legion-io/legion-cache/issues
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'legion/cache'
+
+# 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/legion-cache.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/legion/cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'legion-cache'
+  spec.version       = Legion::Cache::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'Legion::Cache integration'
+  spec.description   = 'Used to connect Legion with a cache service like memcached'
+  spec.homepage      = 'https://bitbucket.org/legion-io/legion-cache'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://bitbucket.org/legion-io/legion-cache/src'
+  spec.metadata['changelog_uri'] = 'https://bitbucket.org/legion-io/legion-cache/src/master/CHANGELOG.md'
+  spec.metadata['wiki_uri'] = 'https://bitbucket.org/legion-io/legion-cache/wiki'
+  spec.metadata['bug_tracker_uri'] = 'https://bitbucket.org/legion-io/legion-cache/issues'
+
+  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_development_dependency 'bundler'
+  spec.add_development_dependency 'legion-logging'
+  spec.add_development_dependency 'legion-settings'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'connection_pool'
+  spec.add_dependency 'dalli'
+  spec.add_dependency 'redis'
+end

data/lib/legion/cache.rb

@@ -0,0 +1,26 @@
+require_relative 'cache/version'
+require_relative 'cache/settings'
+
+require_relative 'cache/memcached'
+require_relative 'cache/redis'
+
+module Legion
+  module Cache
+    class << self
+      attr_reader :client
+      include Legion::Cache::Memcached if Legion::Settings[:cache][:driver] == 'dalli'
+      include Legion::Cache::Redis if Legion::Settings[:cache][:driver] == 'redis'
+
+      def setup
+        connect
+        Legion::Logging.info 'Legion::Cache connected and enabled'
+      end
+
+      def shutdown
+        Legion::Logging.info 'Shutting down Legion::Cache'
+        close
+        Legion::Settings[:cache][:connected] = false
+      end
+    end
+  end
+end

data/lib/legion/cache/memcached.rb

@@ -0,0 +1,48 @@
+require 'dalli'
+
+module Legion
+  module Cache
+    module Memcached
+      def connect
+        Legion::Logging.debug 'Using Memcached module for Legion::Cache'
+        options = { compress:  true,
+                    serializer: Legion::JSON,
+                    failover:  Legion::Settings[:cache][:failover],
+                    namespace: Legion::Settings[:cache][:namespace], foo: 'test' }
+        Dalli.logger = Legion::Logging
+        @client = Dalli::Client.new(Legion::Settings[:cache][:servers], options)
+        Legion::Logging.debug "Legion::Cache successfully connected to #{Legion::Settings[:cache][:servers]}"
+        Legion::Settings[:cache][:connected] = true
+      end
+
+      def close
+        @client.close
+      end
+
+      def restart
+        close
+        connect
+      end
+
+      def get(key)
+        @client.get(key)
+      end
+
+      def fetch(key, ttl = nil)
+        @client.fetch(key, ttl)
+      end
+
+      def set(key, value, ttl = 180)
+        @client.set(key, value, ttl)
+      end
+
+      def delete(key)
+        @client.delete(key)
+      end
+
+      def flush(delay = 0)
+        @client.flush(delay)
+      end
+    end
+  end
+end

data/lib/legion/cache/redis.rb

@@ -0,0 +1,36 @@
+require 'redis'
+
+module Legion
+  module Cache
+    module Redis
+      def connect
+        @client = Redis.new
+      end
+
+      def close
+        @client.close
+      end
+
+      def restart
+        close
+        connect
+      end
+
+      def get(key)
+        @client[key]
+      end
+
+      def set(key, value)
+        @client[key] = value
+      end
+
+      def delete(key)
+        @client.del key
+      end
+
+      def flush
+        @client.flushdb
+      end
+    end
+  end
+end

data/lib/legion/cache/settings.rb

@@ -0,0 +1,32 @@
+module Legion
+  module Cache
+    module Settings
+      def self.default
+        {
+          driver:     'dalli',
+          servers:    ['127.0.0.1:11211'],
+          connected:  false,
+          enabled:    true,
+          namespace:  'legion',
+          compress:   false,
+          failover:   true,
+          threadsafe: true,
+          expires_in: 0,
+          cache_nils: false,
+          pool_size:  1,
+          serializer: Legion::JSON
+        }
+      end
+
+      def self.driver
+        if Gem::Specification.find_by_name('dalli')
+          'dalli'
+        elsif Gem::Specification.find_by_name('redis')
+          'redis'
+        else
+          raise NameError('Legion::Cache.driver is nil')
+        end
+      end
+    end
+  end
+end

data/lib/legion/cache/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Legion
+  module Cache
+    VERSION = '0.2.0'
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: legion-cache
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Esity
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: legion-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: legion-settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Used to connect Legion with a cache service like memcached
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- legion-cache.gemspec
+- lib/legion/cache.rb
+- lib/legion/cache/memcached.rb
+- lib/legion/cache/redis.rb
+- lib/legion/cache/settings.rb
+- lib/legion/cache/version.rb
+homepage: https://bitbucket.org/legion-io/legion-cache
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://bitbucket.org/legion-io/legion-cache
+  source_code_uri: https://bitbucket.org/legion-io/legion-cache/src
+  changelog_uri: https://bitbucket.org/legion-io/legion-cache/src/master/CHANGELOG.md
+  wiki_uri: https://bitbucket.org/legion-io/legion-cache/wiki
+  bug_tracker_uri: https://bitbucket.org/legion-io/legion-cache/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: Legion::Cache integration
+test_files: []