airspace 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68fd92350f1c6274af7a30a46918f1b9037ba9d1b0e63b1a88c284a4715f432d
+  data.tar.gz: 8b89696d66ec946c6ee807f86cacd4cdf370057b74f9a06b6cdae1bfbfa2448b
+SHA512:
+  metadata.gz: 7603141412de37754499c6b148ba58c3c80ce4434d9b58f7d8d4a6e4d36de07827810cff6317281f4ab90af180d3464bf377202c4755ec62c4e330855f702fa3
+  data.tar.gz: d0c7cb11e532003bf867fddddc36759bdadd0fd583430b4a1cdbb12e2c2da510c4263fceb824546b1ed33e37cb6a2f9bb74c626616e9f1864c479f09c4279ace

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+/vendor

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 25
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -0,0 +1,22 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=8fdaf7c8198b46ebdb0fc75cc04a85a150af827c5f216e12ab1dc189750a8bff
+services:
+  - redis-server
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0 (February 21, 2019)
+
+Initial Release.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    airspace (1.0.0)
+      redis (>= 3.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  airspace!
+  database_cleaner (~> 1.7)
+  guard-rspec (~> 4.7)
+  pry (~> 0.12)
+  rspec (~> 3.8)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Blue Marble Payroll, LLC
+
+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,220 @@
+# Airspace
+
+[![Gem Version](https://badge.fury.io/rb/airspace.svg)](https://badge.fury.io/rb/airspace) [![Build Status](https://travis-ci.org/bluemarblepayroll/airspace.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/airspace) [![Maintainability](https://api.codeclimate.com/v1/badges/d25bfce65b230ee956df/maintainability)](https://codeclimate.com/github/bluemarblepayroll/airspace/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/d25bfce65b230ee956df/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/airspace/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The general use case for this library is as follows:
+
+I have a materialized/immutable dataset that I wish to temporarily store.  With this temporary storage, I would like to support some level of server-side paging, but I do not need further querying/sorting.
+
+A dataset, in this context, is:
+  1. A collection of generic data (i.e. a Ruby hash or some other object)
+  2. A two-dimensional array of pages and rows.
+
+What this means is: if you can compute a final form of your dataset and it is immutable then you can use Airspace to temporarily store it in Redis.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install airspace
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add airspace
+````
+
+## Examples
+
+### A Basic Example
+
+Say we have the following dataset:
+
+```ruby
+dataset = {
+  movie_name: 'Avengers',
+  rating: 'PG-13',
+  release_date: Date.new(2012, 5, 5),
+  actors: [
+    { id: 1, name: 'Iron Man' },
+    { id: 2, name: 'Hulk' },
+    { id: 3, name: 'Thor' },
+    { id: 4, name: 'Spiderman' },
+    { id: 5, name: 'Captain America' }
+  ]
+}
+```
+
+We could split this data up and also paginate the actors:
+
+```ruby
+data = dataset.slice(:movie_name, :rating, :release_date)
+pages = dataset[:actors].each_slice(2).to_a
+```
+
+We can split out the movie 'data' from the actors 'pages' and store it:
+
+```ruby
+id = ::Airspace.set(Redis.new, data: data pages: pages)
+```
+
+The #set call will return the unique identifier for the stored dataset, which we can now use to retrieve it back:
+
+```ruby
+reader = ::Airspace.get(Redis.new, id)
+```
+
+The #get call will return an ::Airspace::Reader object that contains the data, metadata (page_count, etc...), and methods to retrieve all or one of the pages.  We could access back the data as:
+
+```ruby
+reader.data
+```
+
+or get all the pages:
+
+```ruby
+reader.pages
+```
+
+or just the last page:
+
+```ruby
+reader.page(reader.page_count)
+```
+
+The value here is that the Reader will only load the initial set of data (movie in our case), while the paged data will only load it all if necessary (or one at a time as needed.)
+
+If you are done with the dataset you can delete it:
+
+```ruby
+success = ::Airspace.del(Redis.new, id)
+```
+
+### Customization / Options
+
+There are a few options you can leverage:
+
+* Explicitly Specified ID: If you do not specify an id then one will be assigned for you (SecureRandom.uuid)
+* Key Prefix: Used for key namespace isolation.  For example: [id: 123, prefix: movies] => key: movies:123
+* Custom Serializer: You can pass in your own serializer in case the default methods do not suffice.
+* Automatic Expiration (TTL): By default no expiration is set on keys.  This allows you to set one.
+* Pages Per Chunk: By default 5 pages will be stored per chunk.  If you think this is not the right balance for your needs you can explicitly pass this in.
+
+The most complex option is the custom serializer.  Airspace comes with a default serializer (::Airspace::Serializer) that defaults to the standard Ruby JSON library.  Here is an example of a custom serializer that will store the data and rows as arrays (instead of hashes):
+
+```ruby
+class CustomSerializer < ::Airspace::Serializer
+  def serialize_data(obj)
+    obj = obj.map { |k, v| [k.to_sym, v] }.to_h
+
+    json_serialize(
+      [
+        obj[:movie_name],
+        obj[:release_date].to_s,
+        obj[:rating]
+      ]
+    )
+  end
+
+  def deserialize_data(json)
+    array = json_deserialize(json)
+
+    {
+      movie_name: array[0],
+      release_date: Date.parse(array[1]),
+      rating: array[2]
+    }
+  end
+
+  def serialize_row(obj)
+    obj = obj.map { |k, v| [k.to_sym, v] }.to_h
+
+    json_serialize([obj[:id], obj[:name]])
+  end
+
+  def deserialize_row(json)
+    array = json_deserialize(json)
+
+    {
+      id: array[0],
+      name: array[1]
+    }
+  end
+end
+```
+
+Here is what utilizing all the options would looks like:
+
+```ruby
+set_options = {
+  expires_in_seconds: 60 * 60 * 12, # 12 hours
+  prefix: 'movies',
+  serializer: CustomSerializer.new,
+  pages_per_chunk: 100
+}
+id = ::Airspace.set(Redis.new, data: data pages: pages, options: options)
+
+# Cannot use expires_in_seconds or pages_per_chunk
+# as they are values stored alongside of the dataset.
+get_and_del_options = {
+  prefix: 'movies',
+  serializer: CustomSerializer.new
+}
+reader = ::Airspace.get(Redis.new, id, options: get_options)
+
+success = ::Airspace.del(Redis.new, id, options: get_and_del_options)
+```
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check airspace.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/airspace.git)
+4. Navigate to the root folder (cd airspace)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update the [version number](https://semver.org/) in lib/airspace/version.rb
+3. Bundle
+4. Update CHANGELOG.md
+5. Commit & Push master to remote and ensure CI builds master successfully
+6. Build the project locally: `gem build airspace`
+7. Publish package to NPM: `gem push airspace-X.gem` where X is the version to push
+8. Tag master with new version: `git tag <version>`
+9. Push tags remotely: `git push origin --tags`
+
+## License
+
+This project is MIT Licensed.

data/airspace.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require './lib/airspace/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'airspace'
+  s.version     = Airspace::VERSION
+  s.summary     = 'Redis Dataset Store'
+
+  s.description = <<-DESCRIPTION
+    This library provides a very simple interface for storing/fetching/paging datasets in Redis.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/airspace'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('redis', '>=3.3.0')
+
+  s.add_development_dependency('database_cleaner', '~>1.7')
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry', '~>0.12')
+  s.add_development_dependency('rspec', '~> 3.8')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
+end