volatile_wtf 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e782e17afbbc489f5f6c6736539c576c073b43038728eda4a0fcda2858e37398
+  data.tar.gz: 72a91368b25c5397c061b6fffcf7fdc0ae8dad9e1f537f4c32055985a8b9c955
+SHA512:
+  metadata.gz: 0f45924ba8a0426e119f5e347df81c7538f4c67bb13ea85aa2159ef040a09da21e16f146d0f976e356cd3ddeac30ce5f31add10a0dced822489b6d74eed89c6a
+  data.tar.gz: decee9b5e799b5213ff5e26e1d36619786e03b484a6dbb72aff4034a967394627bec6d82c5d11fa432b630e61b0c7c65d5dd0e43d36325e0b067c39c805e7212

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Uladzislau Andreyeu
+
+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,122 @@
+# VolatileWTF
+
+A Ruby wrapper for [Volatile](https://volatile.wtf/), a key-value pair API that everyone can use.
+
+## Installation
+
+`gem install volatile_wtf`
+
+or for a Gemfile:
+
+```ruby
+gem 'volatile_wtf'
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+Don't forget to require the gem:
+
+```ruby
+require 'volatile_wtf'
+```
+
+### Initialize storage object
+
+```ruby
+Storage = Volatile::Storage.new
+```
+
+### Create a key-value pair
+
+```ruby
+Storage['user_name'] = 'Alice' # => 'Alice'
+```
+
+If you want to create a pair independent from your Storage, use `Storage.push`:
+
+```ruby
+Storage.push('random_key', 'random_val')
+```
+
+You can use symbols as keys, but you'll still have to use strings to get values.
+
+### Retrieve a value by key
+
+Using `#[](key)` retrieves a key from current Storage instance:
+
+```ruby
+Storage['user_name'] # => 'Alice'
+```
+
+If you want to retrieve a value by a custom key independent from your Storage, use `Storage.pull`:
+
+```ruby
+Storage.pull('random_key') # => 'random_val'
+```
+
+### `created` and `modified` timestamps
+
+[Volatile](https://volatile.wtf/) allows to get information about when a key-pair was created and modified.
+
+- Created
+  ```ruby
+  Storage.created('user_name') # => 2019-11-12 16:55:45 +0300
+  ```
+- Modified
+
+  ```ruby
+  Storage.modified('user_name') # => 2019-11-12 17:40:45 +0300
+  ```
+
+### Salted keys (or simply key prefixes)
+
+Salt is used for keys to make them trackable within this gem.
+
+#### Passing your own salt
+
+By default, Storage is initialized with salt equal to `SecureRandom.hex[0..5]` and makes keys look like `0123ab_some` instead of just `some`. You can pass your own salt value like this:
+
+```ruby
+Storage = Volatile::Storage.new('my_own_salt')
+```
+
+#### Retrieving a real key name
+
+If you want to get a real (salted) key name, you should use `Storage#real_key`:
+
+```ruby
+Storage.real_key('nice_key') # => '0123ab_nice_key'
+```
+
+Don't forget that every `Volatile::Storage.new` has its own salt value.
+
+### Hash conversion (`#to_h`)
+
+By default, `#to_h` generates a hash with friendly keys without salt:
+
+```ruby
+{
+    "user_name" => "Alice",
+        "email" => "alice@example.com"
+}
+```
+
+To generate a hash with real keys, use `with_real_keys: true` parameter:
+
+```ruby
+Storage.to_h(with_real_keys: true)
+```
+
+This will return the following result:
+
+```ruby
+{
+    "2365fc_user_name" => "Alice",
+        "2365fc_email" => "alice@example.com"
+}
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "volatile_wtf"
+
+# 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/volatile_wtf/manager.rb

@@ -0,0 +1,40 @@
+require 'net/http'
+require 'uri'
+
+module Volatile
+  class Manager
+    def store(key, value)
+      get_from uri_with key, value
+    end
+
+    def retrieve(key)
+      get_from uri_with key
+    end
+
+    def created_at(key)
+      resp = get_from uri_with key, nil, 'created'
+      Time.at(resp.to_i)
+    end
+    alias created created_at
+
+    def updated_at(key)
+      resp = get_from uri_with key, nil, 'modified'
+      Time.at(resp.to_i)
+    end
+    alias modified updated_at
+
+    private
+
+    def get_from(uri)
+      Net::HTTP.get(uri)
+    end
+
+    def uri_with(key = nil, value = nil, modifier = nil)
+      url = "https://volatile.wtf/?key=#{key}"
+      url << "&#{modifier}" if modifier
+      url << "&val=#{value}" if value
+
+      URI(url)
+    end
+  end
+end

data/lib/volatile_wtf/storage.rb

@@ -0,0 +1,53 @@
+require 'securerandom'
+require 'set'
+module Volatile
+  class Storage
+    attr_accessor :salt
+    attr_reader :key, :value
+
+    def initialize(salt = nil)
+      @salt = salt || SecureRandom.hex[0..5]
+      @keys = Set.new
+      @manager = Manager.new
+    end
+
+    def [](key)
+      @manager.retrieve(real_key(key))
+    end
+
+    def []=(key, value)
+      @keys << real_key(key)
+      @manager.store(real_key(key), value)
+    end
+
+    def pull(key)
+      @manager.retrieve(key)
+    end
+
+    def push(key, value)
+      @manager.store(key, value)
+      { key => value }
+    end
+
+    def created(key)
+      @manager.created_at(key)
+    end
+
+    def modified(key)
+      @manager.updated_at(key)
+    end
+
+    def real_key(key)
+      "#{@salt}_#{key}"
+    end
+
+    def to_h(with_real_keys = false)
+      manager = @manager
+
+      @keys.each_with_object({}) do |key, hash|
+        hash_key = with_real_keys ? key : key.sub("#{@salt}_", '')
+        hash[hash_key] = manager.retrieve(key)
+      end
+    end
+  end
+end

data/lib/volatile_wtf/version.rb

@@ -0,0 +1,3 @@
+module VolatileWtf
+  VERSION = "0.0.3"
+end

data/lib/volatile_wtf.rb

@@ -0,0 +1,3 @@
+require 'volatile_wtf/manager'
+require 'volatile_wtf/storage'
+require 'volatile_wtf/version'

data/volatile_wtf.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "volatile_wtf/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "volatile_wtf"
+  spec.version       = VolatileWtf::VERSION
+  spec.authors       = ["Uladzislau Andreyeu"]
+  spec.email         = ["me@vld.by"]
+
+  spec.summary       = %q{A Ruby wrapper for Volatile, a key-value pair API that everyone can use.}
+  spec.homepage      = "https://github.com/vladyio/volatile-wtf-rb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/vladyio/volatile-wtf-rb"
+    spec.metadata["changelog_uri"] = "https://github.com/vladyio/volatile-wtf-rb/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: volatile_wtf
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Uladzislau Andreyeu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- me@vld.by
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/volatile_wtf.rb
+- lib/volatile_wtf/manager.rb
+- lib/volatile_wtf/storage.rb
+- lib/volatile_wtf/version.rb
+- volatile_wtf.gemspec
+homepage: https://github.com/vladyio/volatile-wtf-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/vladyio/volatile-wtf-rb
+  source_code_uri: https://github.com/vladyio/volatile-wtf-rb
+  changelog_uri: https://github.com/vladyio/volatile-wtf-rb/blob/master/CHANGELOG.md
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Volatile, a key-value pair API that everyone can use.
+test_files: []