dcell-s3-registry 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Joe Hosteny
+
+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,46 @@
+dcell-s3-registry
+=================
+
+This provides an [AWS S3](http://aws.amazon.com/s3/) registry for
+[DCell](https://github.com/celluloid/dcell).
+
+The S3 registry adapter allows DCell to use S3 as a registry instead of Redis, Zookeeper, etc.
+
+## Prerequisites
+
+Please follow the [instructions for DCell](https://github.com/celluloid/dcell).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dcell-s3-adapter'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dcell-s3-adapter
+
+## Usage
+
+```ruby
+require 'dcell'
+require 'dcell/registries/s3_adapter'
+
+DCell.start(registry: { adapter: 's3', bucket: 'bucket-name' })
+```
+
+Please see the DCell documentation for further details.
+
+There is an executable example in `examples/dcell-s3-registry.rb`.
+
+    $ ruby examples/dcell-s3-registry.rb -n master -p 7777 -b your-unique-bucket
+    $ ruby examples/dcell-s3-registry.rb -n node_1 -p 7778 -b your-unique-bucket
+
+## Copyright
+
+Copyright (c) 2013 Joe Hosteny. Distributed under the MIT License.
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dcell-s3-registry.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dcell/s3_registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dcell-s3-registry'
+  spec.version       = DCell::S3Registry::VERSION
+  spec.authors       = ['Joe Hosteny']
+  spec.email         = ['jhosteny@gmail.com']
+  spec.description   = %q{AWS S3 registry for DCell}
+  spec.summary       = %q{An AWS S3 registry for DCell.}
+  spec.homepage      = 'https://github.com/jhosteny/dcell-s3-registry'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'aws-sdk'
+
+  spec.add_runtime_dependency 'dcell'
+end

data/examples/dcell-s3-registry.rb

@@ -0,0 +1,62 @@
+require 'dcell'
+require 'dcell/registries/s3_adapter'
+require 'optparse'
+
+# The DCell node_id
+name = nil
+
+# The local port for the 0MQ communication.
+port = nil
+
+# The S3 bucket
+bucket = nil
+
+OptionParser.new.tap { |options|
+  options.on('-n NAME', 'Node name') do |value|
+    name = value
+  end
+  options.on('-p PORT', 'Node port') do |value|
+    port = value.to_i
+  end
+  options.on('-b BUCKET', 'Bucket name') do |value|
+    bucket = value
+  end
+}.parse(ARGV)
+
+unless bucket and (name or port)
+  puts "Missing options. See -h for available options."
+  exit 1
+end
+
+registry = { :adapter => 's3', :env => 'test', :bucket => bucket }
+
+class TimeServer
+  include Celluloid
+
+  def run
+    "[#{DCell.me.id}] #{Time.now}"
+  end
+end
+
+class StatusServer
+  include Celluloid
+
+  def run
+    "[#{DCell.me.id}] STATUS OK"
+  end
+end
+
+DCell.start(:id => name, :addr => "tcp://127.0.0.1:#{port}", :registry => registry)
+
+if name == 'master'
+  TimeServer.supervise_as :service
+else
+  StatusServer.supervise_as :service
+end
+
+loop do
+  puts DCell::Node.all.inspect
+  puts DCell::Node.all.shuffle.first[:service].run
+
+  sleep 1
+end

data/lib/dcell/registries/s3_adapter.rb

@@ -0,0 +1,109 @@
+require 'aws-sdk'
+
+module DCell
+  module Registry
+    class S3Adapter
+      def initialize(options)
+        # Convert all options to symbols :/
+        options = options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+
+        @env = options[:env] || 'production'
+        bucket = options[:bucket] || "dcell_#{Celluloid.uuid}_#{@env}"
+
+        access_key_id = options[:access_key_id] || ENV['AWS_ACCESS_KEY_ID']
+        secret_access_key = options[:secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
+        s3_opts = { :access_key_id => access_key_id, :secret_access_key => secret_access_key }
+        s3_opts.merge!({ :region => options[:region] }) if options[:region]
+        @s3 = AWS::S3.new(s3_opts)
+
+        @bucket = @s3.buckets[bucket]
+        @bucket = @s3.buckets.create(bucket) unless @bucket.exists?
+
+        @node_registry   = NodeRegistry.new(@bucket)
+        @global_registry = GlobalRegistry.new(@bucket)
+      end
+
+      def clear_nodes
+        @node_registry.clear
+      end
+
+      def clear_globals
+        @global_registry.clear
+      end
+
+      def delete_store
+        @bucket.delete!
+      rescue AWS::S3::Errors::NoSuchBucket
+        Logger.info "Bucket #{@bucket.name} doesn't exist"
+      end
+
+      class NodeRegistry
+        def initialize(bucket)
+          @bucket = bucket
+        end
+
+        def get(node_id)
+          @bucket.objects["nodes/#{node_id}"].read
+        rescue AWS::S3::Errors::NoSuchKey
+          Logger.error "No such node #{node_id}"
+          nil
+        end
+
+        def set(node_id, addr)
+          @bucket.objects["nodes/#{node_id}"].write(addr)
+        end
+
+        def nodes
+          @bucket.objects.with_prefix('nodes/').inject([]) do |arr, elt|
+            elt.key =~ /^nodes\/(.+)$/
+            arr << $1
+          end
+        end
+
+        def clear
+          @bucket.objects.with_prefix('nodes/').map(&:delete)
+        end
+      end
+
+      def get_node(node_id);       @node_registry.get(node_id) end
+      def set_node(node_id, addr); @node_registry.set(node_id, addr) end
+      def nodes;                   @node_registry.nodes end
+
+      class GlobalRegistry
+        def initialize(bucket)
+          @bucket = bucket
+        end
+
+        def get(key)
+          string = @bucket.objects["globals/#{key}"].read
+          Marshal.load string if string
+        rescue AWS::S3::Errors::NoSuchKey
+          Logger.error "No such global key #{key}"
+          nil
+        end
+
+        # Set a global value
+        def set(key, value)
+          string = Marshal.dump value
+          @bucket.objects["globals/#{key}"].write(string)
+        end
+
+        # The keys to all globals in the system
+        def global_keys
+          @bucket.objects.with_prefix('globals/').inject([]) do |arr, elt|
+            elt.key =~ /^globals\/(.+)$/
+            arr << $1
+          end
+        end
+
+        def clear
+          @bucket.objects.with_prefix('globals/').map(&:delete)
+        end
+      end
+
+      def get_global(key);        @global_registry.get(key) end
+      def set_global(key, value); @global_registry.set(key, value) end
+      def global_keys;            @global_registry.global_keys end
+    end
+  end
+end

data/lib/dcell/s3_registry/version.rb

@@ -0,0 +1,5 @@
+module DCell
+  class S3Registry
+    VERSION = '0.0.1'
+  end
+end

data/spec/dcell/registries/s3_adapter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'dcell/registries/s3_adapter'
+
+describe DCell::Registry::S3Adapter do
+  subject { described_class.new(env: 'test') }
+
+  after do
+    subject.delete_store
+  end
+
+  context "node registry" do
+    before :each do
+      subject.clear_nodes
+    end
+
+    it "stores node addresses" do
+      address = "tcp://localhost:7777"
+
+      subject.set_node("foobar", address)
+      subject.get_node("foobar").should == address
+    end
+
+    it "stores the IDs of all nodes" do
+      subject.set_node("foobar", "tcp://localhost:7777")
+      subject.nodes.should include "foobar"
+    end
+  end
+
+  context "global registry" do
+    before :each do
+      subject.clear_globals
+    end
+
+    it "stores values" do
+      subject.set_global("foobar", [1,2,3])
+      subject.get_global("foobar").should == [1,2,3]
+    end
+
+    it "stores the keys of all globals" do
+      subject.set_global("foobar", true)
+      subject.global_keys.should include "foobar"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'dcell'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: dcell-s3-registry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Hosteny
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dcell
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AWS S3 registry for DCell
+email:
+- jhosteny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dcell-s3-registry.gemspec
+- examples/dcell-s3-registry.rb
+- lib/dcell/registries/s3_adapter.rb
+- lib/dcell/s3_registry/version.rb
+- spec/dcell/registries/s3_adapter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jhosteny/dcell-s3-registry
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: An AWS S3 registry for DCell.
+test_files:
+- spec/dcell/registries/s3_adapter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: