raas-client-rails 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b6a84b9056a678c04d3ccda0b3e9e51f088ce762ff66f220290759dfa68581
-  data.tar.gz: 1078171ee29459bca2475b20b36e1aa4ec66ca12aeb1f6a9c261d3d325dedc25
+  metadata.gz: a39abf6c7b41855d8d3bfe4fd8c8a61aea4dd633d13097b755a75b4d708e3bfc
+  data.tar.gz: 66b9408baac8b9a1b5defa77b4bf867596539830f99989b74438693359864f5c
 SHA512:
-  metadata.gz: a29156150876b44a236747e93ed2a0cd7b673dc3db0d432edf1213fdf63045f1811932c8f398a7f73b9049fa7e3e52f5bdc7965e78da34213e96fb73d0597010
-  data.tar.gz: d8c97c5576fca515e38ac04ebcd17df908bff8d323c673f1d39293e7467f21b25136b197b4a1cb4b21e29ccac23ed88ff265651198abcce1de32e9d8d6e609ca
+  metadata.gz: 64bba5b9c2d08770c9b3483a5c70d8951f1c46c2c07dbe171a39b69ec62d1f76400ecb4af38c3cc79d32df69450a69d419974e5e3a40158c8cc9cc69a7292def
+  data.tar.gz: 37fe0b7bead310581f1a3eeffc1f2b7e4eec625da1aff7130b3dc0c8941b376ade9bf65c6cd5ea16630bde1cf429f75ba5050ff58b10b15086e1bfe2000d12d2

data/README.md

@@ -1,6 +1,6 @@
 # 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.
+Adding client to access Raas. This client allows you to call Raas API.
 
 ## Usage
 
@@ -21,11 +21,10 @@ This condifuration is **mandatory** please, do not forget before you start inter
 
 ### APIs
 
-Once you install your gem, your application has several extra endpoints to interact with RaaS.
+Once you install gem and set it up, 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
+- `/raas/datatraveler/session` : Generate external session by using your credentials for datatraveler
 
 ## Installation
 
@@ -44,17 +43,34 @@ gem "raas-client-rails"
 $ bundle install
 ```
 
-3. mount endPoint on `config/routes.rb`
+3. implement raas_controller.rb
 
 ```ruby
-  mount Raas::Client::Rails::Engine => "[PATH]"
+class RaasController < Raas::Client::Rails::RaasController
+    skip_before_action :verify_authenticity_token
+
+    def prepare_tenant_and_sub
+        super
+
+        @tenant = "xxxxx"
+        @sub = "xxxx"
+      end
+end
+```
+
+3. add endPoint on `config/routes.rb`
+
+```ruby
+  post '/raas/datatraveler/session', to: 'raas#datatraveler_session'
+  post '/raas/report/session', to: 'raas#report_session'
 ```
 
 4. Launch your rails server
 
 5. then you can use this with...
 
-`/PATH/raas/endPointList`
+`/raas/datatraveler/session`
+`/raas/report/session`
 
 ## License
 All the patents belong to SuTech

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

@@ -1,136 +1,8 @@
 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}/#{@sub}";
-    end
-
-    def prepare(params)
-      @backUrl = params[:backUrl]
-      @subUrl = params[:subUrl]
-      prepare_tenant_and_sub()
-      @restClient = RestClient.new(@tenant, @sub)
-    end
-
-    def prepare_tenant_and_sub()
-      # For Overload
-      @tenant = params[:tenant]
-      @sub = params[:sub]
-    end
-
-    def report_session()
-      Rails.logger.warn("session parameter=#{params}");
-      prepare(params)
-      response = @restClient.createExternalSession(MSA_REPORT,@backUrl,@subUrl)
-      render json: response.body
-    end
-    
-    def datatraveler_session()
-      Rails.logger.warn("session parameter=#{params}")
-      prepare(params)
-      response = @restClient.createExternalSession(MSA_DT,@backUrl,@subUrl)
-      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)
-      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)
-    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)
-      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)
-      return response.body;
-    end
+  require_relative 'raas_controller_module'
 
+  class RaasController < ApplicationController
+    include RaasControllerModule
   end
 end

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

@@ -0,0 +1,136 @@
+module Raas::Client::Rails
+  
+  require_relative 'rest_client'
+
+  module RaasControllerModule
+
+    MSA_REPORT = "report";
+    MSA_DT = "datatraveler";
+
+    #/raas/health
+    def health()
+      prepare(params)
+      render plain: "Moving #{@tenant}/#{@sub}";
+    end
+
+    def prepare(params)
+      @backUrl = params[:backUrl]
+      @subUrl = params[:subUrl]
+      prepare_tenant_and_sub()
+      @restClient = RestClient.new(@tenant, @sub)
+    end
+
+    def prepare_tenant_and_sub()
+      # For Overload
+      @tenant = params[:tenant]
+      @sub = params[:sub]
+    end
+
+    def report_session()
+      Rails.logger.warn("session parameter=#{params}");
+      prepare(params)
+      response = @restClient.createExternalSession(MSA_REPORT,@backUrl,@subUrl)
+      render json: response.body
+    end
+    
+    def datatraveler_session()
+      Rails.logger.warn("session parameter=#{params}")
+      prepare(params)
+      response = @restClient.createExternalSession(MSA_DT,@backUrl,@subUrl)
+      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)
+      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)
+    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)
+      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)
+      return response.body;
+    end
+
+  end
+end

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

@@ -1,7 +1,7 @@
 module Raas
   module Client
     module Rails
-      VERSION = "0.1.3"
+      VERSION = "0.1.5"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raas-client-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Sunao Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-20 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,7 @@ files:
 - 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/raas_controller_module.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