gcloud-datastore-activesupport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a6e05b5a4b0d7c14338eda2b9c4c9c6d7c024b474dc25b74b442a0310be86a7
+  data.tar.gz: 5907ca3f944d9a1b6cbde7005c57402b8127f658971452bbe5caad4783e9cb0d
+SHA512:
+  metadata.gz: 0cbc0fc85ff48978e78df5100c2ed2929c4f076932be7a7f438aba64741e297f4c5bed42f26c983274dcc82d0b765fee68c1ee18230c56496058d62a1152e191
+  data.tar.gz: 0a0f39cb67c530ac436337d72858761d427f2db8f318c1336f2b009ba95a78e708d85c4b2eeba4d2f7ebb345f2b3e76b5ea3055dc82b17d9629927deb87923e2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 LeleRed
+
+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,69 @@
+# Gcloud::Datastore::Activesupport
+Use Google Datastore as Cache for Ruby on Rails application.
+
+## Usage
+How to use the plugin:
+
+```ruby
+
+  config.cache_store = :gcloud_datastore
+
+```
+Enviroment variable GOOGLE_CLOUD_PROJECT required.
+
+
+Alternately:
+
+```ruby
+
+  config.cache_store = :gcloud_datastore, {
+      project_id: "gcloud-project-slug-name"
+  }
+
+```
+
+Sometimes credential file is needed (for example in local development):
+
+```ruby
+
+  config.cache_store = :gcloud_datastore, {
+      project_id: "gcloud-project-slug-name",
+      credential_file_json: "/path/to/credential_file.json"
+  }
+
+```
+
+or set enviroment variable: GOOGLE_APPLICATION_CREDENTIALS
+```bash
+export GOOGLE_APPLICATION_CREDENTIALS /path/to/credential_file.json
+```
+
+## Credential file configuration
+
+https://developers.google.com/accounts/docs/application-default-credentials
+
+https://console.cloud.google.com/apis/credentials/serviceaccountkey
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gcloud-datastore-activesupport'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install gcloud-datastore-activesupport
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Gcloud::Datastore::Activesupport'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/active_support/cache/gcloud_datastore.rb

@@ -0,0 +1,88 @@
+# encoding: UTF-8
+require "google/cloud/datastore"
+require "zlib"
+
+
+module ActiveSupport
+  module Cache
+    class GcloudDatastore < Store
+
+      # attr_reader :project_id
+
+      def initialize(*options)
+        super(options)
+        @options = options.extract_options!
+        @project_id = @options[:project_id] || Rails.application.config.database_configuration[Rails.env]["dataset_id"]
+        @credential_file_json = @options[:credential_file_json]
+        @serialize_content_zip_enabled = (@options[:content_zip].blank? || @options[:content_zip]) ? true : false
+        @serialize_content_base64_enabled = (@options[:content_base64].blank? || @options[:content_base64]) ? true : false
+        @datastore_kind_name = @options[:kind_name] || "cache_#{ Rails.env }"
+      end
+
+
+      private
+
+      # Reads an entry from the cache implementation. Subclasses must implement
+      # this method.
+      def read_entry(key, options)
+        query    = Google::Cloud::Datastore::Key.new @datastore_kind_name, key
+        entities = dataset.lookup query
+        return nil unless entities.any?
+        entity   = entities.first
+        entry = deserialize_entry( entity[:_value], entity[:_format] )
+        return entry
+      end
+
+      # Writes an entry to the cache implementation. Subclasses must implement
+      # this method.
+      def write_entry(key, entry, options)
+        value, format = serialize_entry( entry )
+        obj = dataset.entity @datastore_kind_name, key do |t|
+          t["_expires"] = entry.expires_at
+          t["_format"] = format
+          t["_value"] = value
+          t["_json"] = entry.to_json unless Rails.env.production? || entry.to_json.size >= 1500
+        end
+        dataset.save obj
+        return true
+      rescue Exception => e
+        return false
+      end
+
+      # Deletes an entry from the cache implementation. Subclasses must
+      # implement this method.
+      def delete_entry(key, options)
+        dataset.delete Google::Cloud::Datastore::Key.new @datastore_kind_name, key
+      end
+
+      def dataset
+        @dataset ||= Google::Cloud::Datastore.new(
+            project_id: @project_id,
+            credentials: @credential_file_json.blank? ? nil : Google::Cloud::Datastore::Credentials.new( @credential_file_json )
+        )
+      end
+
+      def serialize_entry( entry )
+        format = []
+        entry = Marshal.dump( entry )
+        if @serialize_content_zip_enabled
+          entry = Zlib::Deflate.deflate( entry )
+          format << "zip"
+        end
+        if @serialize_content_base64_enabled
+          entry = Base64.encode64( entry ) if @serialize_content_base64_enabled
+          format << "base64"
+        end
+        return entry, format.join("_")
+      end
+
+      def deserialize_entry( entry, format = nil )
+        format ||= "zip_base64"
+        entry = Base64.decode64( entry ) if format.include? "base64"
+        entry = Zlib::Inflate.inflate( entry ) if format.include? "zip"
+        Marshal.load( entry )
+      end
+
+    end
+  end
+end

data/lib/gcloud/datastore/activesupport.rb

@@ -0,0 +1,9 @@
+require "gcloud/datastore/activesupport/railtie"
+
+module Gcloud
+  module Datastore
+    module Activesupport
+      # Your code goes here...
+    end
+  end
+end

data/lib/gcloud/datastore/activesupport/railtie.rb

@@ -0,0 +1,8 @@
+module Gcloud
+  module Datastore
+    module Activesupport
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/gcloud/datastore/activesupport/version.rb

@@ -0,0 +1,7 @@
+module Gcloud
+  module Datastore
+    module Activesupport
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/tasks/gcloud/datastore/activesupport_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :gcloud_datastore_activesupport do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: gcloud-datastore-activesupport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- LeleRed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+- !ruby/object:Gem::Dependency
+  name: google-cloud-datastore
+  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: sqlite3
+  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'
+description: 'Gcloud::Datastore::Activesupport: Google Datastore as Cache for Ruby
+  on Rails application'
+email:
+- lelered@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/active_support/cache/gcloud_datastore.rb
+- lib/gcloud/datastore/activesupport.rb
+- lib/gcloud/datastore/activesupport/railtie.rb
+- lib/gcloud/datastore/activesupport/version.rb
+- lib/tasks/gcloud/datastore/activesupport_tasks.rake
+homepage: https://github.com/lelered/gcloud-datastore-activesupport
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Google Datastore as Cache for Ruby on Rails application.
+test_files: []