kuby-memcached 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18c78462d9458158c3f3c28d7d4cc4533b95c8301d9a84a1c302476e0b93fe86
+  data.tar.gz: ff1b2da7749baef450a98b770db68ffd4be020b0065b0f97212dfe6a0a4d1975
+SHA512:
+  metadata.gz: e634f9348db6ba094481ede3be2fe5139edfe3e2bbb760d4712ba039414750d4e570a457fb8a26e7004f92d16f8b745e2d31d674f3e7753a993a5176ec3e9f04
+  data.tar.gz: 88d33ff7b693573716c3c166ae0ba2492f5c800c5e5eadb03fbca8422d672ff6343df9157ecd25578797cdc403123a22d4fbb461d2bb368e702d3cd39d3fe8fa

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+* Birthday!

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'kuby-core', path: '../kuby-core'
+gem 'kube-dsl', path: '../kube-dsl'
+
+group :development, :test do
+  gem 'pry-byebug'
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Cameron Dutro
+
+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,97 @@
+## kuby-memcached
+
+Memcached plugin for [Kuby](https://github.com/getkuby/kuby-core).
+
+## Intro
+
+The memcached plugin provides the ability to stand up arbitrary memcached instances. Behind the scenes it uses the excellent [kubedb](https://kubedb.com/) Kubernetes operator.
+
+## Configuration
+
+Add the kuby-memcached gem to your Gemfile, then add a memcached instance like this:
+
+```ruby
+require 'kuby/memcached'
+
+Kuby.define(:production) do
+  kubernetes do
+
+    add_plugin(:memcached) do
+      instance(:my_rails_cache)
+    end
+
+  end
+end
+```
+
+The kuby-memcached plugin allows a number of additional configuration options too:
+
+```ruby
+Kuby.define(:production) do
+  kubernetes do
+
+    add_plugin(:memcached) do
+      instance(:my_rails_cache) do
+        # set the version of memcached you want to use
+        version '1.5.4-v1'  # this is the default version
+
+        # set the port memcached listen on and that you'll
+        # use to connect to the instance
+        port 11211  # this is the default port
+      end
+    end
+
+  end
+end
+```
+
+Get a list of the memcached versions your cluster supports by running:
+
+```bash
+bundle exec kuby -e production kubectl -- get memcachedversions
+```
+
+## Usage
+
+Memcached instances defined in your Kuby config respond to `#hostname`, `#port`, and `#url` methods to help point at them in your Rails configuration. The `#url` method returns a complete URL to the memcached instance, including the host and port.
+
+### Rails Cache
+
+In your Rails config (eg. config/environments/production.rb), point your cache store at your memcached instance like so:
+
+
+```ruby
+Kuby.load!
+
+url = Kuby.environment.kubernetes
+  .plugin(:memcached)
+  .instance(:my_rails_cache)
+  .url
+
+config.cache_store = :mem_cache_store, url
+```
+
+### Dalli
+
+You can also use a memcached client like the [Dalli gem](https://github.com/petergoldstein/dalli) directly:
+
+```ruby
+require 'dalli'
+
+url = Kuby.environment.kubernetes
+  .plugin(:memcached)
+  .instance(:my_rails_cache)
+  .url
+
+dc = Dalli::Client.new(url)
+dc.set('abc', 123)
+value = dc.get('abc')
+```
+
+## License
+
+Licensed under the MIT license. See LICENSE for details.
+
+## Authors
+
+* Cameron C. Dutro: http://github.com/camertron

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require 'kuby/memcached'
+
+Bundler::GemHelper.install_tasks
+
+task default: :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/kuby-memcached.gemspec

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'kuby/memcached/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'kuby-memcached'
+  s.version  = ::Kuby::Memcached::VERSION
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'http://github.com/getkuby/kuby-memcached'
+
+  s.description = s.summary = 'Memcached plugin for Kuby.'
+
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'kuby-kube-db', '~> 0.4'
+  s.add_dependency 'kube-dsl', '~> 0.4'
+
+  s.require_path = 'lib'
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'LICENSE', 'CHANGELOG.md', 'README.md', 'Rakefile', 'kuby-memcached.gemspec']
+end

data/lib/kuby/memcached.rb

@@ -0,0 +1,10 @@
+require 'kuby'
+require 'kuby/memcached/plugin'
+
+module Kuby
+  module Memcached
+    autoload :Instance, 'kuby/memcached/instance'
+  end
+end
+
+Kuby.register_plugin(:memcached, Kuby::Memcached::Plugin)

data/lib/kuby/memcached/instance.rb

@@ -0,0 +1,65 @@
+require 'kube-dsl'
+
+module Kuby
+  module Memcached
+    class Instance
+      extend ::KubeDSL::ValueFields
+
+      attr_reader :name, :environment
+
+      value_field :version, default: '1.5.4-v1'
+      value_field :port, default: 11211
+
+      def initialize(name, environment)
+        @name = name
+        @environment = environment
+      end
+
+      def resources
+        @resources ||= [memcached]
+      end
+
+      def hostname
+        name
+      end
+
+      def url
+        @url ||= "#{hostname}:#{port}"
+      end
+
+      def memcached(&block)
+        context = self
+
+        @memcached ||= Kuby::KubeDB.memcached do
+          api_version 'kubedb.com/v1alpha1'
+
+          metadata do
+            name "#{context.name}-memcached"
+            namespace context.kubernetes.namespace.metadata.name
+          end
+
+          spec do
+            version context.version
+
+            service_template do
+              spec do
+                type 'NodePort'
+                port do
+                  name 'redis'
+                  port context.port
+                end
+              end
+            end
+          end
+        end
+
+        @memcached.instance_eval(&block) if block
+        @memcached
+      end
+
+      def kubernetes
+        environment.kubernetes
+      end
+    end
+  end
+end

data/lib/kuby/memcached/plugin.rb

@@ -0,0 +1,27 @@
+require 'kuby'
+
+module Kuby
+  module Memcached
+    class Plugin < ::Kuby::Plugin
+      def configure(&block)
+        instance_eval(&block) if block
+      end
+
+      def instance(name, &block)
+        instances[name] ||= Instance.new(name, environment)
+        instances[name].instance_eval(&block) if block
+        instances[name]
+      end
+
+      def resources
+        instances.flat_map { |_, instance| instance.resources }
+      end
+
+      private
+
+      def instances
+        @instances ||= {}
+      end
+    end
+  end
+end

data/lib/kuby/memcached/version.rb

@@ -0,0 +1,5 @@
+module Kuby
+  module Memcached
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: kuby-memcached
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kuby-kube-db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: kube-dsl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Memcached plugin for Kuby.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- kuby-memcached.gemspec
+- lib/kuby/memcached.rb
+- lib/kuby/memcached/instance.rb
+- lib/kuby/memcached/plugin.rb
+- lib/kuby/memcached/version.rb
+homepage: http://github.com/getkuby/kuby-memcached
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Memcached plugin for Kuby.
+test_files: []