raas-client-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 94c1331c5b736d7cec268742acd323958041d1a1ee484a5064594e8329ac9898
+  data.tar.gz: aaef60ac317c3ede890f2558f22e1887ddc209390856d54231c180239acf1013
+SHA512:
+  metadata.gz: 0b3b5c343c7b6be739cb2ebadeca642767370e0daa73820c9f6784ea23a21d94779b061674ec8a97c22ef2c1f582b44df85512718f4e621d840972a5f8d1b943
+  data.tar.gz: 5c2e4dd67fd2d05ceb8c82df9016ed6c4d60162db928027f4ac8adff044c5646c6d22ef3ecc8c62d590b3dce7bd00c53bdf80a50ad302e34854382a987c38460

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Yasuhiro Miyake
+
+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,48 @@
+# Raas::Client::Rails
+
+Adding extra endpoints to access RaaS. These endpoints allows you to fetch external token to access RaaS or enables you to invoke specific functions through them.
+
+## Usage
+
+### Set your Credentials
+
+`landscape`, `application`, `token` should be set correctly. 
+You can manage these variables by adding external files such as **RaaS.yml** on your parents app. Of course, you can directly hard code these values on you app as follows.
+These credentials are provided by SuTech. Please, ask [SuTech](https://www.sutech.co.jp/) adminisators for further inquiries.
+
+```ruby
+ Raas::Client::Rails::Engine.config.raas_client_rails.landscape   = 'LANDSCAPE'
+ Raas::Client::Rails::Engine.config.raas_client_rails.application = 'APP'
+ Raas::Client::Rails::Engine.config.raas_client_rails.token = 'TOKEN VALUE'
+```
+
+This condifuration is **mandatory** please, do not forget before you start interacting with APIs below.
+
+### APIs
+
+Once you install your gem, your application has several extra endpoints to interact with RaaS.
+
+- `/raas/report/session` : Generate external session by using your credentials for report
+- `/raas/datatraveler/session` : Generate external session by using your credentials for report
+- `/raas/health` : Ask RaaS to get current health condition
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "raas-client-rails"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install raas-client-rails
+```
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/raas_client_rails_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/raas/client/rails .css

data/app/assets/stylesheets/raas/client/rails/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/controllers/raas/client/rails/application_controller.rb

@@ -0,0 +1,8 @@
+module Raas
+  module Client
+    module Rails
+      class ApplicationController < ActionController::Base
+      end
+    end
+  end
+end

data/app/controllers/raas/client/rails/raas_controller.rb

@@ -0,0 +1,135 @@
+module Raas::Client::Rails
+  
+  require_relative 'rest_client'
+
+  class RaasController < ApplicationController
+
+    MSA_REPORT = "report";
+    MSA_DT = "datatraveler";
+
+    #/raas/health
+    def health()
+      prepare(params)
+      render plain: "Moving #{@tenant}/#{@subsystem}";
+    end
+
+    def prepare(params)
+      # seven arguments are needed to make this work
+      application = Raas::Client::Rails::Engine.config.raas_client_rails.landscape
+      landscape = Raas::Client::Rails::Engine.config.raas_client_rails.application
+      token = Raas::Client::Rails::Engine.config.raas_client_rails.token
+      @backUrl = params[:backUrl]
+      @subUrl = params[:subUrl]
+      @tenant = params[:tenant]
+      @subsystem = params[:sub]
+      @restClient = RestClient.new(application,landscape,token)
+    end
+
+    def report_session()
+      Rails.logger.warn("session parameter=#{params}");
+      prepare(params)
+      response = @restClient.createExternalSession(MSA_REPORT,@backUrl,@subUrl,@tenant,@subsystem)
+      render json: response.body
+    end
+    
+    def datatraveler_session()
+      Rails.logger.warn("session parameter=#{params}")
+      prepare(params)
+      response = @restClient.createExternalSession(MSA_DT,@backUrl,@subUrl,@tenant,@subsystem)
+      render json: response.body
+    end
+
+    MIME_TYPE_HTML = "html"
+    MIME_TYPE_FILE  = "file"
+    MIME_TYPE_JSON = "json"
+
+    #/raas/get
+    def get()
+      prepare(params)
+      path = params[:path]
+      parameters = params[:parameters]
+      mimeType = params[:mimeType]
+      fileName = params[:fileName]
+      type = params[:type]
+      #by default return HTML
+      if mimeType.nil?
+        mimeType = MIME_TYPE_HTML
+      end
+      #by default return download.pdf
+      if fileName.nil?
+        fileName = "download"
+      end
+      if type.nil?
+        type = "application/pdf"
+      end
+      #by default empty Hash if nothing is assigned
+      if parameters.nil?
+        payload = Hash.new
+      else
+        payload = parameters
+      end
+      Rails.logger.warn("get path=#{path} parameters=#{payload}");
+      response = @restClient.get(path,payload,@tenant,@subsystem)
+      handleMime(mimeType, fileName, type, response)
+    end
+
+    # How you return the value? This can be changed by passing mimeType through parameter
+    def handleMime(mimeType, fileName,type, response)
+      case mimeType
+      when MIME_TYPE_HTML
+        #sanitize response automatically
+        render html: response.body
+      when MIME_TYPE_JSON
+        render json: response.body
+      when MIME_TYPE_FILE
+        send_data(response, filename: fileName, type: type)
+      end
+      # p "#{fileName} #{type} #{mimeType}"
+    end
+
+    #/raas/delete
+    def delete()
+      prepare(params)
+      path = params[:path]
+      parameters = params[:parameters]
+      if parameters.nil?
+        payload = nil
+      else
+        payload = JSON.parse(parameters)
+      end      
+      Rails.logger.warn("delete path=#{path} parameters=#{parameters}");
+      return @restClient.delete(path,payload,@tenant,@subsystem)
+    end
+
+    #/raas/post
+    def post()
+      prepare(params)
+      path = params[:path]
+      requestBody = params[:requestbody]
+      if requestBody.nil?
+        payload = nil
+      else
+        payload = JSON.parse(requestBody)
+      end      
+      Rails.logger.warn("post path=#{path} requestBody=#{requestBody}");
+      response = @restClient.post(path,payload,@tenant,@subsystem)
+      return response.body;
+    end
+
+    #/raas/put
+    def put()
+      prepare(params)
+      path = params[:path]
+      requestBody = params[:requestbody]
+      if requestBody.nil?
+        payload = nil
+      else
+        payload = JSON.parse(requestBody)
+      end      
+      Rails.logger.warn("post path=#{path} requestBody=#{requestBody}");
+      response = @restClient.put(path,payload,@tenant,@subsystem)
+      return response.body;
+    end
+
+  end
+end

data/app/controllers/raas/client/rails/rest_client.rb

@@ -0,0 +1,160 @@
+module Raas::Client::Rails
+    require 'net/http'
+    require 'uri'
+    require 'json'
+    require 'securerandom'
+
+    # Rest Client for RaaS
+    class RestClient
+        GET =  "get"
+        POST = "post"
+        PUT = "put"
+        DELETE = "delete"
+        APEX_DOMAIN = "functions.asaservice.inc";
+
+        def initialize(application,landscape,token)
+            @application = application
+            @landscape = landscape
+            @token = token
+        end
+
+        # ResponseEntity<String> resp = raasClient.createExternalSession(Constant.MSA_REPORT,req.getBackUrl(),req.getSubUrl(), saasContextProvider.getTenant(), saasContextProvider.getSub());
+
+
+        def createExternalSession(msa,backUrl,subUrl,tenant,subsystem)
+            body = Hash.new
+            body["backUrl"] = backUrl
+            body["subUrl"] = subUrl
+            body["tenant"] = tenant
+            body["sub"] = subsystem
+            return proxy(body,POST,"/#{msa}/external/session",nil,@token)
+        end
+
+        def getUserToken()
+            #No  trace level... so that adding [TRACE] for filtering
+            Rails.logger.debug("[TRACE] getUserToken is started");        
+            #Use Rails default cache system, this simply use cache otherwise fetch and store
+            Rails.logger.debug("Attempt to recycle token");
+            cacheName = "#{@tenant}+++#{@sub}"
+            @@t = @tenant
+            @@s = @sub
+            Rails.logger.debug("Cache name is #{cacheName}")
+            # p cacheName
+            return token = Rails.cache.fetch(cacheName) do
+                Rails.logger.debug("No cache found, fetch it by api");
+                Rails.logger.debug("tenant #=> #{@@t} / sub #=> #{@@s}")
+                response = getUserTokenImpl( "report" , @@t , @@s);
+                Rails.logger.debug(response.body)
+                return JSON.parse(response.body);
+            end
+        end
+
+        # fetch token from RaaS because no cache
+        def getUserTokenImpl(msa,tenant,sub)
+            body = Hash.new
+            body["tenant"] = tenant
+            body["sub"] = sub
+            response = proxy(body,POST,"/#{msa}/external/token",nil,@token);
+        end
+
+        def get(requestUrl, params,tenant,sub)
+            @tenant = tenant
+            @sub = sub
+            json = getUserToken()
+            return proxy(nil, GET,requestUrl,params,json["token"]);
+        end
+
+        def delete(requestUrl, params,tenant,sub)
+            @tenant = tenant
+            @sub = sub
+            json = getUserToken()
+            return proxy(nil, DELETE,requestUrl,params,json["token"]);
+        end
+
+        def put(requestUrl,body,tenant,sub)
+            @tenant = tenant
+            @sub = sub
+            json = getUserToken()
+            return proxy(body , PUT,requestUrl,nil,json["token"]);
+        end
+
+        def post(requestUrl,body,tenant,sub)
+            @tenant = tenant
+            @sub = sub
+            json = getUserToken()
+            return proxy(body , POST,requestUrl,nil,json["token"]);
+        end
+
+        def proxy(body,method,requestUrl,params,token)
+            Rails.logger.warn("method:#{method} url:#{requestUrl} token:#{token} params:#{params}" );
+            #TraceID seems to be different... is it OK!?
+            traceId = SecureRandom.uuid;
+            Rails.logger.debug("[TRACE] traceId=#{traceId}")
+            # p "token: #{token}"
+            domain = decideDomain();
+            uri = "https://#{domain}#{requestUrl}"
+            url = URI.parse(uri)
+            unless params.nil?
+                #should I do like this!?
+                parameters_hash = params.to_unsafe_h
+                url.query = URI.encode_www_form(parameters_hash) unless params.nil?
+            end
+            # replacing context path form urI to match actual gateway URI
+            headers = {
+                'TRACE'  => traceId,
+                'Content-Type' => 'application/json',
+                'Accept' => 'application/json',
+                'Authorization' => "Bearer #{token}"
+            }
+            #restTemplate.exchange alternative
+            case method
+            when GET
+                httpEntity = Net::HTTP::Get.new(url.to_s,headers)
+            when POST
+                httpEntity = Net::HTTP::Post.new(url.to_s,headers)
+            when DELETE
+                httpEntity = Net::HTTP::Delete.new(url.to_s,headers)
+            when PUT
+                httpEntity = Net::HTTP::Put.new(url.to_s,headers)
+            else
+                puts "method is not be defined..."
+            end
+            httpEntity['Accept-Encoding'] = '' #delete acceptEncoding here
+            httpEntity.body = body.to_json if body
+            retry_count = 0
+            max_retries = 4
+            host = URI(url.to_s).host
+            port = URI(url.to_s).port
+            begin
+                Rails.logger.debug(url.to_s);
+                Rails.logger.debug(body);
+                Rails.logger.debug(httpEntity);
+                http = Net::HTTP.new(host,port)
+                http.use_ssl = true
+                # p url.to_s
+                response = http.request(httpEntity)
+                Rails.logger.debug(response);
+                return response;
+            rescue => e
+                retry_count += 1
+                if retry_count <= max_retries
+                    Rails.logger.debug("Retry attempt #{retry_count}")
+                    sleep(4) #wait 4 seconds
+                    retry
+                else
+                    Rails.logger.error("retry method for the following url #{uri} has failed #{e}");
+                    Rails.logger.error(e.backtrace);
+                    raise e
+                end
+            end
+        end
+
+        def decideDomain()
+            if "prod" == @landscape then
+                return "#{@application}.#{APEX_DOMAIN}"
+            else
+                return "#{@application}.#{@landscape}.#{APEX_DOMAIN}"
+            end
+        end
+    end
+end

data/app/helpers/raas/client/rails/application_helper.rb

@@ -0,0 +1,8 @@
+module Raas
+  module Client
+    module Rails
+      module ApplicationHelper
+      end
+      end
+    end
+end

data/app/helpers/raas/client/rails/raa_s_helper.rb

@@ -0,0 +1,4 @@
+module Raas::Client::Rails
+  module RaaSHelper
+  end
+end

data/app/jobs/raas/client/rails/application_job.rb

@@ -0,0 +1,8 @@
+module Raas
+  module Client
+    module Rails
+      class ApplicationJob < ActiveJob::Base
+      end
+    end
+  end
+end

data/app/mailers/raas/client/rails/application_mailer.rb

@@ -0,0 +1,10 @@
+module Raas
+  module Client
+    module Rails
+      class ApplicationMailer < ActionMailer::Base
+        default from: "from@example.com"
+        layout "mailer"
+      end
+    end
+  end
+end

data/app/models/raas/client/rails/application_record.rb

@@ -0,0 +1,9 @@
+module Raas
+  module Client
+    module Rails
+      class ApplicationRecord < ActiveRecord::Base
+        self.abstract_class = true
+      end
+    end
+  end
+end

data/app/views/layouts/raas/client/rails/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Raas client rails</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "raas/client/rails/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,9 @@
+Raas::Client::Rails::Engine.routes.draw do
+    get '/raas/health', to: 'raas#health'
+    post '/raas/report/session', to: 'raas#report_session'
+    post '/raas/datatraveler/session', to: 'raas#datatraveler_session'
+    get '/raas', to: 'raas#get'
+    delete '/raas', to: 'raas#delete'
+    post '/raas', to: 'raas#post'
+    put '/raas', to: 'raas#put'
+end  

data/lib/raas/client/rails/engine.rb

@@ -0,0 +1,16 @@
+puts "Loading Raas::Client::Rails::Engine..."
+module Raas
+  module Client
+    module Rails
+      class Engine < ::Rails::Engine
+        isolate_namespace Raas::Client::Rails
+        config.raas_client_rails = Configuration.new
+        config.autoload_paths << File.expand_path('lib', __dir__)
+      end
+    
+      class Configuration
+        attr_accessor :landscape, :application, :token
+      end
+    end
+  end
+end

data/lib/raas/client/rails/version.rb

@@ -0,0 +1,7 @@
+module Raas
+  module Client
+    module Rails
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/raas/client/rails.rb

@@ -0,0 +1,9 @@
+require "raas/client/rails/version"
+require "raas/client/rails/engine"
+module Raas
+  module Client
+    module Rails
+      # Your code goes here...
+    end
+  end
+end

data/lib/tasks/raas/client/rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :raas_client_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: raas-client-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sunao Suzuki
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.7
+description: Enable your app to interact with RaaS
+email:
+- sunao@sutech.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/raas_client_rails_manifest.js
+- app/assets/stylesheets/raas/client/rails/application.css
+- app/controllers/raas/client/rails/application_controller.rb
+- app/controllers/raas/client/rails/raas_controller.rb
+- app/controllers/raas/client/rails/rest_client.rb
+- app/helpers/raas/client/rails/application_helper.rb
+- app/helpers/raas/client/rails/raa_s_helper.rb
+- app/jobs/raas/client/rails/application_job.rb
+- app/mailers/raas/client/rails/application_mailer.rb
+- app/models/raas/client/rails/application_record.rb
+- app/views/layouts/raas/client/rails/application.html.erb
+- config/routes.rb
+- lib/raas/client/rails.rb
+- lib/raas/client/rails/engine.rb
+- lib/raas/client/rails/version.rb
+- lib/tasks/raas/client/rails_tasks.rake
+homepage: https://www.sutech.co.jp/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.sutech.co.jp/
+  source_code_uri: https://github.com/SuTechDevelop/raas-client-for-rails
+  changelog_uri: https://github.com/SuTechDevelop/raas-client-for-rails/activity
+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.2.15
+signing_key:
+specification_version: 4
+summary: Summary
+test_files: []