instructure_registrar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc88e07ee4ce4cc7a4fbfc01474bdb2e91843bc1
+  data.tar.gz: 6549dee7f8367c8eee4551b07e38f120c05a75ef
+SHA512:
+  metadata.gz: 817721f2a1393db6902b0d69fa29387bb6f4ae4d70d6cff3e2ca9f41942fcc513c0ad69627d1357ec6c3d71bbfd0648effbd4cc9e564edb9114f3a64c428ffb7
+  data.tar.gz: 2d7f4714c5a0288ab1e0a6e1595a0f0f18738abeabd7628396c3832d2f53406d3f48d63deb5b9d91777dab7085dfe0aac04bbb1ce450436447c6298894aff7e7

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,65 @@
+# InstructureRegistrar
+
+InstructureRegistrar is a Ruby library for registering and retrieving service
+information from a central etcd service registry.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'instructure_registrar'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Make sure that the following environment variables are set with the appropriate
+information for your local etcd instance:
+
+    REGISTRY_HOST
+    REGISTRY_PORT
+
+### Integrating with a service
+
+In your service's project folder, create a configuration file with the following contents:
+
+    #/config/instructure_registrar.rb
+    require 'dotenv'
+    Dotenv.load
+    require 'instructure_registrar'
+
+    InstructureRegistrar.configure do |config|
+      config.registry_host = ENV.fetch('REGISTRY_HOST') || "http://instructure-etcd.docker"
+      config.registry_port = ENV.fetch("REGISTRY_PORT") || 12379
+      config.service_name  = "my.service.name"
+      config.service_host  = ENV.fetch("SERVICE_HOST") || "http://localhost/"
+      config.service_port  = ENV.fetch("SERVICE_PORT") || 3000
+    end
+
+    InstructureRegistrar.register
+    at_exit { InstructureRegistrar.unregister }
+
+### Looking up a service
+
+Note that your client application will need a config file similar to that in the section above, but
+unless you plan on registering your app as a service your config file will be simpler:
+
+    #/config/instructure_registrar.rb
+    require 'dotenv'
+    Dotenv.load
+    require 'instructure_registrar'
+
+    InstructureRegistrar.configure do |config|
+      config.registry_host = ENV.fetch('REGISTRY_HOST') || "http://instructure-etcd.docker"
+      config.registry_port = ENV.fetch("REGISTRY_PORT") || 12379
+    end
+
+Then, to fetch connection information for a given service:
+
+    require 'instructure_registrar'
+    @some_service_url = InstructureRegistrar.get_service('some_service_name')
+

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,14 @@
+require 'dotenv'
+Dotenv.load
+require 'concierge_service'
+
+InstructureRegistrar.configure do |config|
+  config.registry_host = ENV.fetch('REGISTRY_HOST') || "http://instructure-etcd.docker"
+  config.registry_port = ENV.fetch("REGISTRY_PORT") || 12379
+  config.service_name  = "my.service.name"
+  config.service_host  = "localhost"
+  config.service_port  = "3000"
+end
+
+InstructureRegistrar.register
+at_exit { InstructureRegistrar.unregister }

data/instructure_registrar.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instructure_registrar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "instructure_registrar"
+  spec.version       = InstructureRegistrar::VERSION
+  spec.authors       = ["CoralineAda"]
+  spec.email         = ["coraline@idolhands.com"]
+
+  spec.summary       = %q{Client for registering an Instructure service via etcd.}
+  spec.description   = %q{Client for registering an Instructure service via etcd.}
+  spec.homepage      = "https://github.com/CoralineAda/instructure_registrar"
+
+  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_dependency "dotenv"
+  spec.add_dependency "etcd", "~> 0.3"
+  spec.add_dependency "require_all"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/instructure_registrar/client.rb

@@ -0,0 +1,28 @@
+module InstructureRegistrar
+  class Client
+
+    def lookup(service_name)
+      client.get(service_name).value || "unknown"
+    end
+
+    def register
+      client.set(
+        InstructureRegistrar.config.service_name,
+        "#{InstructureRegistrar.service_host}:#{InstructureRegistrar.config.service_port}"
+      )
+    end
+
+    def unregister
+      client.delete(InstructureRegistrar.config.service_name)
+    end
+
+    private
+
+    def client
+      @client ||= Etcd.client(
+        host: InstructureRegistrar.config.registry_host,
+        port: InstructureRegistrar.config.registry_port
+      )
+    end
+  end
+end

data/lib/instructure_registrar/version.rb

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

data/lib/instructure_registrar.rb

@@ -0,0 +1,37 @@
+require 'require_all'
+require_rel 'instructure_registrar'
+
+module InstructureRegistrar
+
+  def self.get_service(service_name)
+    InstructureRegistrar::Client.new.lookup(service_name)
+  end
+
+  def self.register
+    InstructureRegistrar::Client.new.register
+  end
+
+  def self.unregister
+    InstructureRegistrar::Client.new.unregister
+  end
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure(&block)
+    @config = Configuration.new
+    yield(config)
+  end
+
+  def self.config
+    @config || Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :registry_host, :registry_port
+    attr_accessor :service_name, :service_host, :service_port
+  end
+
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: instructure_registrar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CoralineAda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: etcd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: Client for registering an Instructure service via etcd.
+email:
+- coraline@idolhands.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/instructure_registrar.rb
+- instructure_registrar.gemspec
+- lib/instructure_registrar.rb
+- lib/instructure_registrar/client.rb
+- lib/instructure_registrar/version.rb
+homepage: https://github.com/CoralineAda/instructure_registrar
+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.6
+signing_key: 
+specification_version: 4
+summary: Client for registering an Instructure service via etcd.
+test_files: []
+has_rdoc: