swarmclient 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 896a19138be9eaac88bc4817295d0549b019ae8f
+  data.tar.gz: 8472d806fba9fcf2e4bb94a118de8bdb838409ad
+SHA512:
+  metadata.gz: 2b591c078a7fe50a131766e16b9c59740a48d8c8a26b80dd5e9c71da70a4af8fe12020bec1094fcff5f4363533a88549e2758d13459dc5aa3362f375d4e725af
+  data.tar.gz: 3a3d221ea3eb8f15cab47c0025d0595a3c1832bec4dd09d670e5babc848698e9536eee02da2523ce0cd0bedc6723ec305753ce170ecc9dcaca1c82c060295e72

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wlwanpan@uwaterloo.ca. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in swarmclient.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Warren
+
+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,96 @@
+# Swarmclient-rb
+
+- Bluzelle Hackathon 2018
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swarmclient'
+```
+
+And then execute:
+
+    $ bundle
+
+Or build and install from src:
+
+    $ git clone https://github.com/wlwanpan/swarmclient-rb.git
+    $ gem build swarmclient.gemspec
+    $ gem install swarmclient-0.1.0.gem
+
+## Communication API (Swarmclient::Communication)
+
+Require and Initialize
+```
+require 'swarmclient'
+
+bluzelle = Swarmclient::Communication.new endpoint: "ws://127.0.0.1", port: 50001, uuid: "80174b53-2dda-49f1-9d6a-6a780d4"
+```
+
+Note: The uuid is the uniq id of a referenced db hosted in the swarm.
+Generate a new one to generate a new store.
+Refer to https://bluzelle.github.io/api/ for more info.
+
+Create New Entry (key-value)
+```
+bluzelle.create key: 'myKey', value: 'Your Value'
+```
+
+Read Key
+```
+res = bluzelle.read 'myKey'
+puts res
+```
+- Result
+```
+=> {:data=>{:value=>"Your Value"}, :"request-id"=>0.5304515448110283}
+```
+
+Update Key value
+```
+bluzelle.update 'myKey', 'New Value'
+```
+
+Remove Key
+```
+bluzelle.remove 'myKey'
+```
+
+Check if key exist
+```
+res = bluzelle.has 'myKey'
+puts res
+```
+- Result
+```
+=> {:data=>{:"key-exists"=>true}, :"request-id"=>0.7938161241077408}
+```
+
+Read all keys stored
+```
+bluzelle.keys
+```
+- Result
+```
+ => {:data=>{:keys=>["myKey"]}, :"request-id"=>0.7472509525271954}
+```
+
+## Pubsub (Swarmclient::Pubsub)
+
+For data streaming -> WIP
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wlwanpan/swarmclient-rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,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 "swarmclient"
+
+# 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/swarmclient/communication.rb

@@ -0,0 +1,121 @@
+require 'faye/websocket'
+require 'eventmachine'
+require 'websocket-client-simple'
+require 'json'
+
+DEFAULT_IP = '127.0.0.1'
+DEFAULT_PORT = 8080
+
+module Swarmclient
+
+  class Communication
+
+    @req_id_range = 100
+
+    def initialize endpoint:, port:, uuid:
+
+      @_endpoint = endpoint || DEFAULT_IP
+      @_port = port || DEFAULT_PORT
+      @_uuid = uuid
+
+    end
+
+    def create key, value
+      send cmd: 'create', data: { key: key, value: value }
+    end
+
+    def read key
+      send cmd: 'read', data: { key: key }
+    end
+
+    def update key, value
+      send cmd: 'update', data: { key: key }
+    end
+
+    def remove key
+      send cmd: 'delete', data: { key: key }
+    end
+
+    def has key
+      send cmd: 'has', data: { key: key }
+    end
+
+    def keys
+      send cmd: 'keys', data: nil
+    end
+
+  private
+
+    def send cmd:, data:
+
+      endpoint, req = [
+        [@_endpoint, ':', @_port.to_s].join(''),
+        { "bzn-api": "crud", "cmd": cmd, "data": data, "db-uuid": @_uuid, "request-id": rand(@req_id_range) }
+      ]
+
+      raw_data = get endpoint: endpoint, req: req
+      err, res = raw_data.map { |data| data ? eval(data.gsub(/\s+/, "")) : false }
+
+      if res
+        case res[:error]
+          when 'NOT_THE_LEADER'
+
+            @_endpoint, @_port = [
+              "ws://#{res[:data][:'leader-host']}",
+              res[:data][:'leader-port']
+            ]
+
+            return send cmd: cmd, data: data
+
+          when "RECORD_EXISTS", "RECORD_NOT_FOUND"
+
+            return res[:error]
+
+          when nil
+
+            return res
+
+          else
+
+            return res[:error]
+
+          end
+      else
+        return err
+      end
+    end
+
+    def get req:, endpoint:
+
+      res, err = [nil, nil]
+
+      EventMachine.run do
+
+        ws = WebSocket::Client::Simple.connect endpoint
+
+        ws.on :message do |msg|
+          res = msg.data
+          EventMachine::stop_event_loop
+        end
+
+        ws.on :open do
+          ws.send req.to_json
+        end
+
+        ws.on :close do |e|
+          EventMachine::stop_event_loop
+        end
+
+        ws.on :error do |e|
+          err = e
+          EventMachine::stop_event_loop
+        end
+
+      end
+
+      [err, res]
+    end
+
+  end
+
+end

data/lib/swarmclient/pubsub.rb

@@ -0,0 +1,18 @@
+
+module Swarmclient
+
+  class Communication
+
+    # To continue here
+    def initialize
+    end
+
+    def subscribe
+    end
+
+    def unsubscribe
+    end
+
+  end
+
+end

data/lib/swarmclient/version.rb

@@ -0,0 +1,3 @@
+module Swarmclient
+  VERSION = "0.1.0"
+end

data/lib/swarmclient.rb

@@ -0,0 +1,5 @@
+require "swarmclient/version"
+require "swarmclient/communication"
+
+module Swarmclient
+end

data/swarmclient.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "swarmclient/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "swarmclient"
+  spec.version       = Swarmclient::VERSION
+  spec.authors       = ["Warren"]
+  spec.email         = ["wlwanpan@uwaterloo.ca"]
+
+  spec.summary       = %q{A gem for the bluzele SwarmDB}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/wlwanpan/swarmclient-rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "faye-websocket", "~> 0.10"
+  spec.add_development_dependency "eventmachine", "~> 1.2"
+  spec.add_development_dependency "json", "~> 2.1"
+  spec.add_development_dependency "websocket-client-simple", "~> 0.3"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: swarmclient
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Warren
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 
+email:
+- wlwanpan@uwaterloo.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/swarmclient.rb
+- lib/swarmclient/communication.rb
+- lib/swarmclient/pubsub.rb
+- lib/swarmclient/version.rb
+- swarmclient.gemspec
+homepage: https://github.com/wlwanpan/swarmclient-rb
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A gem for the bluzele SwarmDB
+test_files: []