rw-api-microservice 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6be14b3c6d8e3bce30dd3d2c92000bd085a099edf178616c3d8e6222019bbe9b
+  data.tar.gz: 1254e1a256e2a061717729bc0301d09f8a9000fa9d07ddfa1dac0e3f5b7c93d1
+SHA512:
+  metadata.gz: d1956547a32d879d8518b51eb029dc0ffdaea76b3716d2d16b3638474921397d1d662664ff994518a661d302b3c041b66a9482951f1d59281381ea5ac15af430
+  data.tar.gz: 566ccfca969f57d75c7919756689c9cd8bb1ca3e3fa52d27befcadf09a2566124de7d18415b8c6dd201cb1e8c93eacf964950b05f41c4a47203c7e4f9e8c1d3a

data/README.md

@@ -0,0 +1,53 @@
+# Api Gateway registration Rails engine
+
+Rails engine that integrates your rails-build microservices with the [RW API](https://api.resourcewatch.org/)
+
+[![Build Status](https://travis-ci.org/control-tower/rw-api-microservice-rails.svg?branch=master)](https://travis-ci.org/control-tower/rw-api-microservice-rails)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/85eeb71033246c5c259d/test_coverage)](https://codeclimate.com/github/control-tower/rw-api-microservice-rails/test_coverage)
+
+## Installation
+
+Installing using `bundler` is recommended:
+
+```ruby
+# Gemfile
+
+gem 'rw-api-microservice-rails'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Usage
+
+Create a Rails initializer to define your connection settings to the RW API Gateway 
+
+```ruby
+#config/initializers/rw_api_microservice.rb
+RwApiMicroservice.configure do |config|
+      config.gateway_url = 'http://your-gateway-url.com'
+      config.microservice_token = 'Gateway auth token'
+    end
+```
+
+
+## Current methods
+
+This engine currently implements a convenience method:
+
+- `microservice_request()` makes a request to a different microservice within the RW API environment.
+
+## 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).
+
+
+## Testing
+
+```bash
+bundle exec rspec spec
+```

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/rw_api_microservice.rake'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RwApiMicroservice'
+  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/rw_api_microservice_manifest.js

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

data/app/assets/javascripts/rw_api_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/rw_api_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/rw_api_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/rw_api_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/rw_api_microservice/application_controller.rb

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

data/app/controllers/rw_api_microservice/info_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "rw_api_microservice/application_controller"
+
+module RwApiMicroservice
+  class InfoController < ApplicationController
+    def ping
+      render json: { success: true }, status: 200
+    end
+  end
+end

data/app/helpers/rw_api_microservice/application_helper.rb

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

data/app/helpers/rw_api_microservice/info_helper.rb

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

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

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

data/config/routes.rb

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

data/lib/rw_api_microservice/engine.rb

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

data/lib/rw_api_microservice/errors.rb

@@ -0,0 +1,77 @@
+module RwApiMicroservice
+
+  class MissingConfigError < StandardError;
+  end
+
+  class RwApiMicroserviceError < StandardError;
+  end
+
+  class AppSecretNotDefinedError < ::RwApiMicroservice::RwApiMicroserviceError;
+  end
+
+  class APIError < ::RwApiMicroservice::RwApiMicroserviceError
+    attr_accessor :rw_error_type, :rw_error_code, :rw_error_subcode, :rw_error_message,
+                  :rw_error_user_msg, :rw_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/rw_api_microservice/gateway.rb

@@ -0,0 +1,60 @@
+require 'rw_api_microservice/errors'
+
+module RwApiMicroservice
+  class Gateway
+    def initialize
+      if RwApiMicroservice.config.gateway_url.nil?
+        raise MissingConfigError, 'Could not register microservice - No Gateway URL defined'
+      end
+      if RwApiMicroservice.config.microservice_token.nil?
+        raise MissingConfigError, 'Could not register microservice - No Microservice Token found'
+      end
+
+      @options = OpenStruct.new
+    end
+
+    attr_reader :credentials, :options, :response, :gateway_url
+
+    # 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['authorization'] = 'Bearer '+RwApiMicroservice.config.microservice_token
+      options.body = body
+      result = make_call(options)
+      result
+    end
+
+    def initialize_options
+      @options = OpenStruct.new
+    end
+
+    private
+
+    def make_call(options)
+      result = RwApiMicroservice.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 RwApiMicroservice::ServerError.new(status, body)
+      when 401
+        initialize_options
+        raise RwApiMicroservice::NoTokenError.new(status, body)
+      when 404
+        initialize_options
+        raise RwApiMicroservice::NotFoundError.new(status, body)
+      else
+        return false
+      end
+    end
+  end
+end

data/lib/rw_api_microservice/http_service/endpoint.rb

@@ -0,0 +1,26 @@
+module RwApiMicroservice
+  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/rw_api_microservice/http_service/response.rb

@@ -0,0 +1,14 @@
+module RwApiMicroservice
+  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/rw_api_microservice/http_service.rb

@@ -0,0 +1,43 @@
+require 'httparty'
+require 'rw_api_microservice/http_service/response'
+require 'rw_api_microservice/http_service/endpoint'
+
+module RwApiMicroservice
+  module HTTPService
+    class << self
+    end
+
+    def self.make_request(options, credentials = {})
+      http_method = options.http_method&.to_sym || :get
+      url = RwApiMicroservice.config.gateway_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
+
+      RwApiMicroservice::HTTPService::Response.new(response.code.to_i, response.body, response.headers)
+    end
+  end
+end

data/lib/rw_api_microservice/version.rb

@@ -0,0 +1,3 @@
+module RwApiMicroservice
+  VERSION = '2.0.0'
+end

data/lib/rw_api_microservice.rb

@@ -0,0 +1,30 @@
+require 'rw_api_microservice/engine'
+require 'rw_api_microservice/gateway'
+require 'rw_api_microservice/http_service'
+require 'rw_api_microservice/errors'
+require 'multi_json'
+require 'ostruct'
+
+module RwApiMicroservice
+  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

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: rw-api-microservice
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Tiago Garcia
+- Vizzuality
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+- !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 easily integrate with
+  the RW API
+email:
+- info@vizzuality.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/rw_api_microservice_manifest.js
+- app/assets/javascripts/rw_api_microservice/application.js
+- app/assets/javascripts/rw_api_microservice/info.js
+- app/assets/stylesheets/rw_api_microservice/application.css
+- app/assets/stylesheets/rw_api_microservice/info.css
+- app/controllers/rw_api_microservice/application_controller.rb
+- app/controllers/rw_api_microservice/info_controller.rb
+- app/helpers/rw_api_microservice/application_helper.rb
+- app/helpers/rw_api_microservice/info_helper.rb
+- app/views/layouts/rw_api_microservice/application.html.erb
+- config/routes.rb
+- lib/rw_api_microservice.rb
+- lib/rw_api_microservice/engine.rb
+- lib/rw_api_microservice/errors.rb
+- lib/rw_api_microservice/gateway.rb
+- lib/rw_api_microservice/http_service.rb
+- lib/rw_api_microservice/http_service/endpoint.rb
+- lib/rw_api_microservice/http_service/response.rb
+- lib/rw_api_microservice/version.rb
+homepage: https://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: []
+rubygems_version: 3.3.22
+signing_key:
+specification_version: 4
+summary: RW API connector service
+test_files: []