ct-register-microservice 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ce4f0bb7836b0cb9101620a3c7bfbf8d03f9a6d13f67d0a405e8aee8732cf0c
+  data.tar.gz: 5d8195652a1dd84df8e2fcd0fe1a3cbd1d6a23b9283d445331e6b7b0836283a4
+SHA512:
+  metadata.gz: 2c65951b30712b860cad39bebbb464e257c6233ffbbe553c68efda8a2cb9f7000540c0ed3ec66679022dd7ff17d78f7470f46e217e7f079e4e7aa6d84af56aeb
+  data.tar.gz: 9600acc940b55a5b574d1c98da6f7ce00a4398fec41b85c43c76a79693a0797314f7db696340df4be9e4c559c968c1e8e57588a11b3eff178a5e5200dd169343

data/README.md

@@ -0,0 +1,65 @@
+# Control Tower registration Rails engine
+
+Rails engine that integrates your rails-build microservices with [Control Tower](https://github.com/control-tower/control-tower)
+
+[![Build Status](https://travis-ci.org/control-tower/ct-register-microservice-rails.svg?branch=master)](https://travis-ci.org/control-tower/ct-register-microservice-rails)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/85eeb71033246c5c259d/test_coverage)](https://codeclimate.com/github/control-tower/ct-register-microservice-rails/test_coverage)
+
+## Installation
+
+Installing using `bundler` is recommended:
+
+```ruby
+# Gemfile
+
+gem 'ct-register-microservice-rails'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Usage
+
+Create a Rails initializer to define your connection settings and connect to Control Tower. 
+```ruby
+#config/initializers/ct_register_microservice.rb
+CtRegisterMicroservice.configure do |config|
+      config.ct_url = 'http://your-control-tower-url.com'
+      config.url = 'http://your-rails-microservice-url.com'
+      config.ct_token = 'Control Tower auth token'
+      config.swagger = __dir__ + 'path/to/your/CT/registration/json/file'
+      config.name = 'Name of your microservice'
+    end
+```
+
+After the configuration values are defined, use the following code to have your microservice register itself on Control Tower:
+
+ ```ruby
+ct_connection = CtRegisterMicroservice::ControlTower.new()
+ct_connection.register_service()
+```
+
+Keep in mind that this registration process will result in Control Tower contacting your Rails server almost immediately.
+Using it in Rails initializers will trigger it *before* the Rails HTTP server is up, causing the registration process to fail.
+
+For this purpose, this engine also includes a Rake task that can be used to trigger this registration process:
+
+```bash
+rake ct_register_microservice:register
+```
+
+
+## Current methods
+
+This engine currently implements two convenience methods:
+
+- `register_microservice()` registers the current Rails microservice on Control Tower. Is currently full-featured and supported
+- `microservice_request()` makes a request to a different microservice within the CT environment. Currently in development, may not work as expected
+
+## Contributing
+Feel free to contribute, pull requests are welcome.
+
+## License
+The engine is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+load 'lib/tasks/ct_register_microservice.rake'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CtRegisterMicroservice'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/ct_register_microservice_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/ct_register_microservice .js
+//= link_directory ../stylesheets/ct_register_microservice .css

data/app/assets/javascripts/ct_register_microservice/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/ct_register_microservice/info.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/ct_register_microservice/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/ct_register_microservice/info.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/ct_register_microservice/application_controller.rb

@@ -0,0 +1,5 @@
+module CtRegisterMicroservice
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/ct_register_microservice/info_controller.rb

@@ -0,0 +1,18 @@
+require_dependency "ct_register_microservice/application_controller"
+
+module CtRegisterMicroservice
+  class InfoController < ApplicationController
+    def info
+      if CtRegisterMicroservice.config.swagger and File.exist?(CtRegisterMicroservice.config.swagger)
+        @docs = MultiJson.load(File.read(CtRegisterMicroservice.config.swagger))
+        render json: @docs
+      else
+        render json: { success: false, message: 'Could not load info file' }, status: 500
+      end
+    end
+
+    def ping
+      render json: { success: true, message: CtRegisterMicroservice.config.name }, status: 200
+    end
+  end
+end

data/app/helpers/ct_register_microservice/application_helper.rb

@@ -0,0 +1,4 @@
+module CtRegisterMicroservice
+  module ApplicationHelper
+  end
+end

data/app/helpers/ct_register_microservice/info_helper.rb

@@ -0,0 +1,4 @@
+module CtRegisterMicroservice
+  module InfoHelper
+  end
+end

data/app/views/layouts/ct_register_microservice/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Ct register microservice</title>
+  <%= stylesheet_link_tag    "ct_register_microservice/application", media: "all" %>
+  <%= javascript_include_tag "ct_register_microservice/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+CtRegisterMicroservice::Engine.routes.draw do
+  get :info, action: :info, controller: 'info'
+  get :ping, action: :ping, controller: 'info'
+end

data/lib/ct_register_microservice.rb

@@ -0,0 +1,30 @@
+require 'ct_register_microservice/engine'
+require 'ct_register_microservice/control_tower'
+require 'ct_register_microservice/http_service'
+require 'ct_register_microservice/errors'
+require 'multi_json'
+require 'ostruct'
+
+module CtRegisterMicroservice
+  class << self
+    attr_accessor :http_service, :config
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= OpenStruct.new
+    end
+  end
+
+  def self.http_service=(service)
+    @http_service = service
+  end
+
+  def self.make_request(options, credentials = {})
+    http_service.make_request(options, credentials)
+  end
+
+  self.http_service = HTTPService
+end

data/lib/ct_register_microservice/control_tower.rb

@@ -0,0 +1,85 @@
+require 'ct_register_microservice/errors'
+
+module CtRegisterMicroservice
+  class ControlTower
+    def initialize
+      if CtRegisterMicroservice.config.ct_url.nil?
+        raise MissingConfigError, 'Could not register microservice - No Control Tower URL defined'
+      end
+      if CtRegisterMicroservice.config.url.nil?
+        raise MissingConfigError, 'Could not register microservice - No self URL defined'
+      end
+      if CtRegisterMicroservice.config.ct_token.nil?
+        raise MissingConfigError, 'Could not register microservice - No Control Tower auth token found'
+      end
+      if CtRegisterMicroservice.config.swagger.nil?
+        raise MissingConfigError, 'Could not register microservice - No swagger file defined'
+      end
+      if !File.exist?(CtRegisterMicroservice.config.swagger)
+        raise MissingConfigError, 'Could not register microservice - Swagger file path ' + File.absolute_path(CtRegisterMicroservice.config.swagger) + 'does not match a file'
+      end
+      if CtRegisterMicroservice.config.name.nil?
+        raise MissingConfigError, 'Could not register microservice - Microservice name not defined'
+      end
+
+      @options = OpenStruct.new
+    end
+
+    attr_reader :credentials, :options, :response, :ct_url, :swagger, :name, :url
+
+    def register_service(active = true)
+      options.http_method = "post"
+      options.endpoint = "/api/v1/microservice"
+      options.query_string = false
+      options.body = {
+        name: CtRegisterMicroservice.config.name,
+        url: CtRegisterMicroservice.config.url,
+        active: !!active
+      }.to_json
+      result = make_call(options)
+      result
+    end
+
+    # TODO: make sure it works as intended, add unit tests
+    def microservice_request(uri, method, headers = {}, body = nil)
+      options.http_method = method
+      options.endpoint = uri
+      options.headers = headers
+      options.headers['Authentication'] = CtRegisterMicroservice.config.ct_token
+      options.body = body
+      result = make_call(options)
+      result
+    end
+
+    def initialize_options
+      @options = OpenStruct.new
+    end
+
+    private
+
+    def make_call(options)
+      result = CtRegisterMicroservice.make_request(options, credentials)
+      unless check_errors(result.status.to_i, result.body)
+        MultiJson.load("[#{result.body.to_s}]")[0]
+      end
+      initialize_options
+      @response = result.body
+    end
+
+    def check_errors(status, body)
+      case status
+      when 500
+        initialize_options
+        raise CtRegisterMicroservice::ServerError.new(status, body)
+      when 401
+        initialize_options
+        raise CtRegisterMicroservice::NoTokenError.new(status, body)
+      when 404
+        initialize_options
+        raise CtRegisterMicroservice::NotFoundError.new(status, body)
+      else
+        return false
+      end
+    end
+  end
+end

data/lib/ct_register_microservice/engine.rb

@@ -0,0 +1,11 @@
+require 'ct_register_microservice'
+
+module CtRegisterMicroservice
+  class Engine < ::Rails::Engine
+    isolate_namespace CtRegisterMicroservice
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/ct_register_microservice/errors.rb

@@ -0,0 +1,77 @@
+module CtRegisterMicroservice
+
+  class MissingConfigError < StandardError;
+  end
+
+  class CtRegisterMicroserviceError < StandardError;
+  end
+
+  class AppSecretNotDefinedError < ::CtRegisterMicroservice::CtRegisterMicroserviceError;
+  end
+
+  class APIError < ::CtRegisterMicroservice::CtRegisterMicroserviceError
+    attr_accessor :ct_error_type, :ct_error_code, :ct_error_subcode, :ct_error_message,
+                  :ct_error_user_msg, :ct_error_user_title, :http_status, :response_body
+
+
+    def initialize(http_status, response_body, error_message = nil)
+      if response_body
+        self.response_body = response_body.strip
+      else
+        self.response_body = ''
+      end
+      self.http_status = http_status
+
+      if error_message && error_message.is_a?(String)
+        message = error_message
+      else
+        unless error_message
+          begin
+            errors = MultiJson.load(response_body) if response_body
+            error_array = errors['errors'].map { |n| n['detail'] } if errors.key? 'errors'
+          rescue
+          end
+          error_array ||= []
+        end
+
+        if error_array.nil? or error_array.empty?
+          message = self.response_body
+        else
+          message = error_array.join(', ')
+        end
+      end
+
+      super(message)
+    end
+  end
+
+  # CT returned an invalid response body
+  class BadCTResponse < APIError;
+  end
+
+  # CT responded with an error while attempting to request an access token
+  class OAuthTokenRequestError < APIError;
+  end
+
+  # Any error with a 5xx HTTP status code
+  class ServerError < APIError;
+  end
+
+  # Any error with a 4xx HTTP status code
+  class ClientError < APIError;
+  end
+
+  # All API authentication failures.
+  class AuthenticationError < ClientError;
+  end
+
+  # not found
+  class NotFoundError < APIError;
+  end
+
+  # not found
+  class NoTokenError < APIError;
+  end
+
+
+end

data/lib/ct_register_microservice/http_service.rb

@@ -0,0 +1,43 @@
+require 'httparty'
+require 'ct_register_microservice/http_service/response'
+require 'ct_register_microservice/http_service/endpoint'
+
+module CtRegisterMicroservice
+  module HTTPService
+    class << self
+    end
+
+    def self.make_request(options, credentials = {})
+      http_method = options.http_method&.to_sym || :get
+      url = CtRegisterMicroservice.config.ct_url
+      headers = options.headers || {}
+      headers['Content-Type'] = 'application/json' if options.http_method == 'post' || options.http_method == 'put'
+      endpoint = Endpoint.new(options, credentials).get
+      body = options.body
+
+      case http_method
+      when :get
+        response = HTTParty.get(url+endpoint, headers: headers)
+      when :delete
+        response = HTTParty.delete(url+endpoint, headers: headers)
+      when :post
+        response = HTTParty.post(url+endpoint, {
+          headers: headers,
+          body: body
+        })
+      when :put
+        response = HTTParty.put(url+endpoint, {
+          headers: headers,
+          body: body
+        })
+      when :patch
+        response = HTTParty.patch(url+endpoint, {
+          headers: headers,
+          body: body
+        })
+      end
+
+      CtRegisterMicroservice::HTTPService::Response.new(response.code.to_i, response.body, response.headers)
+    end
+  end
+end

data/lib/ct_register_microservice/http_service/endpoint.rb

@@ -0,0 +1,26 @@
+module CtRegisterMicroservice
+  module HTTPService
+    class Endpoint
+
+      attr_reader :options, :credentials
+
+      def initialize(options, credentials = {})
+        @options = options
+        @credentials  = credentials
+      end
+
+      def get
+        endpoint_uri
+      end
+
+      private
+
+      def endpoint_uri
+        options.endpoint
+      end
+
+    end
+  end
+  Endpoint = HTTPService::Endpoint
+end
+

data/lib/ct_register_microservice/http_service/response.rb

@@ -0,0 +1,14 @@
+module CtRegisterMicroservice
+  module HTTPService
+    class Response
+      attr_reader :status, :body, :headers
+
+      def initialize(status, body, headers)
+        @status = status
+        @body = body
+        @headers = headers
+      end
+    end
+  end
+  Response = HTTPService::Response
+end

data/lib/ct_register_microservice/version.rb

@@ -0,0 +1,3 @@
+module CtRegisterMicroservice
+  VERSION = '1.3.0'
+end

data/lib/tasks/ct_register_microservice.rake

@@ -0,0 +1,7 @@
+namespace :ct_register_microservice do
+  desc 'Register microservice on configured Control Tower'
+  task register: [:environment] do
+    ct_connection = CtRegisterMicroservice::ControlTower.new()
+    ct_connection.register_service()
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: ct-register-microservice
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Tiago Garcia
+- Vizzuality
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: multi_json
+  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: rake
+  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: simplecov
+  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: simplecov-console
+  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: webmock
+  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: rspec-rails
+  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: sqlite3
+  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: This gem allows your Rails-built microservice to register itself on Control
+  Tower
+email:
+- info@vizzuality.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/ct_register_microservice_manifest.js
+- app/assets/javascripts/ct_register_microservice/application.js
+- app/assets/javascripts/ct_register_microservice/info.js
+- app/assets/stylesheets/ct_register_microservice/application.css
+- app/assets/stylesheets/ct_register_microservice/info.css
+- app/controllers/ct_register_microservice/application_controller.rb
+- app/controllers/ct_register_microservice/info_controller.rb
+- app/helpers/ct_register_microservice/application_helper.rb
+- app/helpers/ct_register_microservice/info_helper.rb
+- app/views/layouts/ct_register_microservice/application.html.erb
+- config/routes.rb
+- lib/ct_register_microservice.rb
+- lib/ct_register_microservice/control_tower.rb
+- lib/ct_register_microservice/engine.rb
+- lib/ct_register_microservice/errors.rb
+- lib/ct_register_microservice/http_service.rb
+- lib/ct_register_microservice/http_service/endpoint.rb
+- lib/ct_register_microservice/http_service/response.rb
+- lib/ct_register_microservice/version.rb
+- lib/tasks/ct_register_microservice.rake
+homepage: http://vizzuality.com
+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.7.9
+signing_key: 
+specification_version: 4
+summary: Control Tower connector service
+test_files: []