wolas_channel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8f4ebe2708a9d2083113f4f0013c7d0afaf3693
+  data.tar.gz: 90712491e1867b08e2f0661963be3c803aef08f1
+SHA512:
+  metadata.gz: 62ddafe52275d7ba7a1013edcd4df50041a586dd2f7cbff4c723d85dd7197ccb7dfd005bb6fb4b2004f643262f61436d19ea79cd265093471e655341572c994d
+  data.tar.gz: f2e309aafaf0c587a0fcefd6631c3953970a02ac73bbe767c055dc5ba6529d6e088cfb948f8ed621af45121210daa7ddc24eef89dff98d8149bbafa13c89f890

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in channel.gemspec
+gemspec

data/README.md

@@ -0,0 +1,164 @@
+# WOLAS Channel Service
+
+The WOLAS Channel Service creates, stores and updates channel entries for each tenant. As the table structure of this service is a key-value store, each entry into a channel can have unique fields. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wolas_channel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wolas_channel
+
+## Service Overview
+
+### Data Structure
+
+The services implements only two tables for all tenants. These tables are in their own schema and are structured as follows.
+
+**Channels Table**
+
+| id 	| channel_id 	| tenant_id | type 	|
+| ---	| --- 			| --- 		| --- 	|
+| 1 | 78ceb188-0090-4877-af5b-c01f2a222966 | 1 | Communication 	|
+| 2 | f2531651-8a74-4c2c-b655-fd8281165cc0 | 2 | Logs 			|
+| 3 | 1e972a64-1f88-4158-891a-3483c4fbe4d9 | 3 | Chat Room 		|
+
+**Data Table**
+
+| id  | channel_id 	| entity_id | key | value 	|
+| --- | --- 		| --- 		| --- | --- 	|
+| 1   | 78ceb188-0090-4877-af5b-c01f2a222966 | 06f26d46-73ef-4c0e-9d8a-013f8862a81a | author 	| John 							|
+| 2   | 78ceb188-0090-4877-af5b-c01f2a222966 | 06f26d46-73ef-4c0e-9d8a-013f8862a81a | message 	| This is a message for Banjo 	|
+| 3   | 78ceb188-0090-4877-af5b-c01f2a222966 | 1493437a-d12b-4832-a715-b475c8b4ddd1 | author 	| Banjo 						|
+| 4   | 78ceb188-0090-4877-af5b-c01f2a222966 | 1493437a-d12b-4832-a715-b475c8b4ddd1 | message 	| Thanks for the message John 	|
+
+### Permissions
+
+Each tenant only has access to channels to which they belong, as defined in the Channels table.
+
+If a tenant tries to access a channel to which they do not belong, the service throws a PermissionFailure error.
+
+### Methods
+
+#### Instantiate Gem 
+```ruby
+require 'wolas_channel'
+channel = WolasChannel.new(tenant_id)
+```
+
+#### Add Channel
+
+The *add_channel* method allows a tenant to create a new channel for their tenancy. This method creates a single entry in the channels table.
+
+```ruby
+args = ('Name for new channel')
+
+channel.add_channel('Activities')
+=> { channel_created: '92f02e83-b7d4-460c-90bd-f2f2b0a32a6e', channel_type: 'Activities' }
+```
+
+#### Get Entity
+
+The *get_entity* method allows a tenant to return an entry from a channel, as long as they are the owner of the channel to which the entry belongs.
+```ruby
+args = ('entity_id')
+
+channel.get_entity('06f26d46-73ef-4c0e-9d8a-013f8862a81a')
+=> 	{ 
+		author: 'John', 
+		message: 'This is a message for Banjo',
+		entity_id: '06f26d46-73ef-4c0e-9d8a-013f8862a81a',
+		channel_id: '78ceb188-0090-4877-af5b-c01f2a222966',
+		type: 'Communication'
+	}
+```
+
+#### Get Channel
+
+The *get_channel* method allows a tenant to return all entries from a channel, as long as they are the owner of the channel.
+```ruby
+args = ('channel_id')
+
+channel.get_channel('78ceb188-0090-4877-af5b-c01f2a222966')
+=> 	[
+		{ 
+			author: 'John', 
+			message: 'This is a message for Banjo',
+			entity_id: '06f26d46-73ef-4c0e-9d8a-013f8862a81a',
+			channel_id: '78ceb188-0090-4877-af5b-c01f2a222966',
+			type: 'Communication'
+		},
+		{ 
+			author: 'Banjo', 
+			message: 'Thanks for the message John',
+			entity_id: '1493437a-d12b-4832-a715-b475c8b4ddd1',
+			channel_id: '78ceb188-0090-4877-af5b-c01f2a222966',
+			type: 'Communication'
+		},
+	]
+```
+
+#### Insert Entity
+
+The *insert_entity* method allows a tenant to the create a new entry against a channel, as long as they are the owner of the channel to which they are trying to post the entry.
+
+```ruby
+args = ('entity_id', 'key', 'value')
+
+object = { hello: 'world' }
+channel.insert_entity('78ceb188-0090-4877-af5b-c01f2a222966', object)
+=> 	
+	{ 
+		entity_id: '06f26d46-73ef-4c0e-9d8a-013f8862a81a', 
+		insert: 'SUCCESS'
+	}
+```
+
+#### Update Entity
+
+The *update_entity* method allows a tenant to the create update an entry in a channel, as long as they are the owner of the channel to which the entry belongs. 
+
+This method accepts a key and value for the entry to be updated. If the entry already has a matching key to that of the update request, the value of the key is updated in the table. If however the key does not already exist for the entry, it is created instead.
+
+```ruby
+args = ('channel_id', 'object_to_insert')
+
+# Existing entity
+{ 
+	author: 'John', 
+	message: 'This is a message for Banjo',
+	entity_id: '06f26d46-73ef-4c0e-9d8a-013f8862a81a',
+	channel_id: '78ceb188-0090-4877-af5b-c01f2a222966',
+	type: 'Communication'
+}
+
+# Updating an existing key
+channel.update_entity('06f26d46-73ef-4c0e-9d8a-013f8862a81a', 'author', 'Sarah')
+=> 	{ 
+		author: 'Sarah', 
+		message: 'This is a message for Banjo',
+		entity_id: '06f26d46-73ef-4c0e-9d8a-013f8862a81a',
+		channel_id: '78ceb188-0090-4877-af5b-c01f2a222966',
+		type: 'Communication'
+	}
+
+# Adding a new key
+channel.update_entity('06f26d46-73ef-4c0e-9d8a-013f8862a81a', 'field', 'oval')
+=> 	{ 
+		author: 'Sarah', 
+		message: 'This is a message for Banjo',
+		field: 'oval'
+		entity_id: '06f26d46-73ef-4c0e-9d8a-013f8862a81a',
+		channel_id: '78ceb188-0090-4877-af5b-c01f2a222966',
+		type: 'Communication'
+	}
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/connection.rb

@@ -0,0 +1,20 @@
+require 'mysql2'
+# Establish connection to mysql2
+class Connection
+  def open
+    @connection = Mysql2::Client.new(
+      :host => '127.0.0.1', 
+      :username => "root",
+      :connect_timeout => 20
+    )
+  end
+
+  def prepare(code)
+    result = @connection.prepare(code)
+    return result
+  end
+
+  def close
+    @connection.close
+  end
+end

data/lib/wolas_channel/version.rb

@@ -0,0 +1,3 @@
+class WolasChannel
+  VERSION = "0.1.0"
+end

data/lib/wolas_channel.rb

@@ -0,0 +1,258 @@
+require 'wolas_channel/version'
+require 'connection'
+require 'byebug'
+require 'securerandom'
+
+# This module contains all the error handling classes
+module ErrorHandling
+  # This error is raised when a tenant requests a channel that does not belong
+  # to their tenant id
+  class PermissionFailure < StandardError; end
+end
+
+# This class handles mapping the channel items from and to the database
+class WolasChannel
+  # Initialize a tenant_id when the channel service is instantiated
+  def initialize(tenant_id)
+    @tenant_id = tenant_id
+  end
+
+  # This method allows a tenant to add a channel to their tenancy
+  def add_channel(type = 'Not Specified')
+    begin
+      # Connect to the database
+      connect = Connection.new.open
+      # Generate a UUID for the new channel
+      channel_id = SecureRandom.uuid
+
+      insert = "INSERT INTO `channel`.`channels` (`channel_id`, `tenant_id`, `type`) VALUES (?, ?, ?)"
+      # This method performs the insert. Mysql2 does not return an object on a successful
+      # insert
+      prepare_exe(connect, insert, channel_id, @tenant_id, type)
+
+      return { channel_created: channel_id, channel_type: type }
+    ensure
+      connect.close
+    end
+  end
+
+  # This method returns an entity based off an id. If the channel id of the 
+  # entity does not match that of the tenant making the request, an error is raised
+  def get_entity(entity_id)
+    begin
+      # Connect to the database. Instance variable used to pass the connection to
+      # private methods
+      @connect = Connection.new.open
+      # Determine if the tenant is able to view this entity based off the
+      # channel and return the type of the entity
+      check = tenant_entity(entity_id)
+      type = check[0]
+      return nil if check == [nil, nil]
+      
+      # Now the entity is requested
+      entity = entity_construct(entity_id, type)
+      return entity
+    ensure
+      @connect.close
+    end
+  end
+
+  # This method returns all entries in a channel.
+  # If the channel id of the entity returned does not match that of the tenant making
+  # the request, an error is raised
+  def get_channel(channel_id)
+    begin
+      # Connect to the database. Instance variable used to pass connection to
+      # private methods
+      @connect = Connection.new.open
+      # Determine if this channel is valid for the tenant and returns its type
+      type = tenant_channel(channel_id)
+      return nil if type == nil
+      
+      # Now the entities are requested
+      ent_q = "SELECT * FROM `channel`.`data` WHERE `data`.`channel_id` = ?"
+      ent = prepare_exe(@connect, ent_q, channel_id)
+
+      # Return nil if nothing is returned from the select
+      return nil if ent.count == 0
+
+      # Construct the object requested using the generic method
+      entitys = object_constructor(ent)
+
+      # Apply the type to each object constructed
+      entitys.each do |ents|
+        ents[:type] = type
+      end
+      return entitys
+    ensure
+      @connect.close
+    end
+  end
+
+  # This method allows the creation of a new entity against a channel. The tenant
+  # id must match the id of the channel passed or an error is raised
+  def insert_entity(channel_id, obj)
+    begin
+      # Connect to the database. Instance variable used to pass connection to
+      # private methods
+      @connect = Connection.new.open
+      # Determine if the tenant has access to the channel requested
+      tenant_channel(channel_id)
+
+      # Assign a UUID for the new entity
+      entity_id = SecureRandom.uuid
+      # Now we construct the key / value insert for each pair in the object
+      # passed to the method
+      obj.each do |key, value|
+        insert = "INSERT INTO `channel`.`data` (`channel_id`, `key`, `value`, `entity_id`)\ 
+        VALUES (?, ?, ?, ?)"
+        # This method performs the insert. Mysql2 does not return an object on a successful
+        # insert
+        prepare_exe(@connect, insert, channel_id, key.to_s, value, entity_id)
+      end
+      return { entity_id: entity_id, insert: 'SUCCESS' }
+    ensure
+      @connect.close
+    end
+  end
+
+  # This method allows the update of an entity
+  def update_entity(entity_id, key, value)
+    begin
+      # Connect to the database. Instance variable used to pass connection to
+      # private methods
+      @connect = Connection.new.open
+      # Determine if the tenant has access to the entity requested
+      check = tenant_entity(entity_id)
+      type = check[0]
+      channel_id = check[1]
+
+      # Lookup the key to be changed on the entity, insert it if it doesn't exist
+      ent_q = "SELECT * FROM `channel`.`data` WHERE `data`.`entity_id` = ? AND `data`.`key` = ?"
+      ent = prepare_exe(@connect, ent_q, entity_id, key)
+
+      if ent.count != 0
+        # update the existing key value
+        update = "UPDATE `channel`.`data` SET `data`.`value`= ? \
+        WHERE `data`.`entity_id` = ? AND `data`.`key` = ?"
+        prepare_exe(@connect, update, value, entity_id, key.to_s)
+
+        # Now that the insert has been completed, the entire object is returned
+        # from the database and constructed to return to the user
+        entity = entity_construct(entity_id, type)
+      else
+        # insert the new key as it does not exist for the entity
+        insert = "INSERT INTO `channel`.`data` (`channel_id`, `key`, `value`, `entity_id`)\
+        VALUES (?, ?, ?, ?)"
+        prepare_exe(@connect, insert, key.to_s, value, entity_id)
+
+        # Now that the insert has been completed, the entire object is returned
+        # from the database and constructed to return to the user
+        entity = entity_construct(entity_id, type)
+      end
+
+      return entity
+    ensure
+      @connect.close
+    end
+  end
+
+  private
+  # This method constructs a single object from key-values returned from a 
+  # query
+  def object_constructor(ent)
+    # ent is a mysql2 object. This generic map returns an array of the rows
+    entity_raw = ent.map{ |e| e }
+    entity = []
+    @init = false
+    entity_h = {}
+    # This method identifies when the entity id changes, pushes the built hash
+    # to the array and starts a new hash for the new entity id
+    entity_raw.each do |hash|
+      if hash['entity_id'] != @init && @init != false
+        entity_h[:channel_id] = @channel_id
+        entity_h[:entity_id] = @init
+        entity << entity_h
+        entity_h = {}
+      end
+      entity_h[hash['key'].to_sym] = hash['value']
+      # Init is used to determine when to push to the array
+      @init = hash['entity_id']
+      # The resource_id for the current hash is stored and added to the entity
+      # hash before it is finalised and pushed to an array
+      @channel_id = hash['channel_id']
+    end
+    # Push the last built hash to the array
+    entity_h[:channel_id] = @channel_id
+    entity_h[:entity_id] = @init
+    entity << entity_h
+    return entity
+  end
+
+  # This method determines the if the channel on an entity is availble to the tenant
+  # and returns the type of channel
+  def tenant_entity(entity_id)
+    res_q = "SELECT * FROM `channel`.`channels` \
+    INNER JOIN `channel`.`data` ON `channels`.`channel_id` = `data`.`channel_id` \
+    WHERE `data`.`entity_id` = ?"
+    res = prepare_exe(@connect, res_q, entity_id)
+    return [nil, nil] if res.count == 0
+
+    # Check the tenant_id on each row returned. They should all be the same as they
+    # will all join to the same row on the channels table
+    channels = res.map{ |a| a }
+    channels.each do |check|
+      unless check['tenant_id'] == @tenant_id
+        raise ErrorHandling::PermissionFailure, 'You do not have permission to access information for this tenant'
+      end
+      @type = check['type']
+      @channel_id = check['channel_id']
+    end
+    return @type, @channel_id
+  end
+
+  # This method determines if the channel requested is available to the tenant
+  # and returns its type
+  def tenant_channel(channel_id)
+    res_q = "SELECT * FROM `channel`.`channels` WHERE `channels`.`channel_id` = ?"
+    res = prepare_exe(@connect, res_q, channel_id)
+    return nil if res.count == 0
+
+    # Check the tenant_id on each row returned. They should all be the same, and in this
+    # instance their should only be one row.
+    channels = res.map{ |a| a }
+    channels.each do |check|
+      unless check['tenant_id'] == @tenant_id
+        raise ErrorHandling::PermissionFailure, 'You do not have permission to access information for this tenant'
+      end
+      @type = check['type']
+      @channel_id = check['channel_id']
+    end
+    return @type
+  end
+
+  # This method returns a constructed entity from an entity id
+  def entity_construct(entity_id, type)
+    ent_q = "SELECT * FROM `channel`.`data` WHERE `entity_id` = ?"
+    ent = prepare_exe(@connect, ent_q, entity_id)
+
+    # Return nil if nothing is returned from the select
+    return nil if ent.count == 0
+
+    # Construct the object requested using the generic method. 
+    entity = object_constructor(ent)[0]
+
+    # Apply the type to the entity
+    entity[:type] = type
+    return entity
+  end
+
+  # This method prepares and executes code from the two methods defined by the
+  # connection call
+  def prepare_exe(connection, statement, *inputs)
+    sqlobj = connection.prepare(statement)
+    result = sqlobj.execute(*inputs)
+    return result
+  end
+end
+

data/wolas_channel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wolas_channel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wolas_channel'
+  spec.version       = WolasChannel::VERSION
+  spec.authors       = ['WOLAS']
+  spec.email         = ['sjeston@wolas.com.au']
+
+  spec.summary       = 'WOLAS Channel Service'
+  spec.description   = 'Enables key-value storage of channel items (communication, change logs etc)'
+  spec.homepage      = 'https://bitbucket.org/wolas-revolution/srvc-channel'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'mysql2'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: wolas_channel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- WOLAS
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: mysql2
+  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: Enables key-value storage of channel items (communication, change logs
+  etc)
+email:
+- sjeston@wolas.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/connection.rb
+- lib/wolas_channel.rb
+- lib/wolas_channel/version.rb
+- wolas_channel.gemspec
+homepage: https://bitbucket.org/wolas-revolution/srvc-channel
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: WOLAS Channel Service
+test_files: []