Merge branch 'master' of github.com:docusign/code-examples-ruby-private

Author: karissarjacobsen

Gemfile

@@ -67,7 +67,7 @@ group :test do
 end
 
 gem 'docusign_esign', '~> 3.15.0'
-gem 'docusign_monitor', '~> 1.0.0'
+gem 'docusign_monitor', '~> 1.1.0'
 gem 'docusign_rooms', '~> 1.2.0.rc1'
 gem 'docusign_click', '~> 1.0.0'
 gem 'docusign_admin', '~> 1.0.0'

Gemfile.lock

@@ -97,12 +97,12 @@ GEM
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_esign (3.14.0)
+    docusign_esign (3.15.0)
       addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
-    docusign_monitor (1.0.0)
+    docusign_monitor (1.1.0)
       addressable (~> 2.7, >= 2.7.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
@@ -307,8 +307,8 @@ DEPENDENCIES
   coffee-rails (~> 5.0.0)
   docusign_admin (~> 1.0.0)
   docusign_click (~> 1.0.0)
-  docusign_esign (~> 3.14.0)
-  docusign_monitor (~> 1.0.0)
+  docusign_esign (~> 3.15.0)
+  docusign_monitor (~> 1.1.0)
   docusign_rooms (~> 1.2.0.rc1)
   jbuilder (~> 2.10.0)
   listen (> 3.2.1)

app/controllers/monitor_api/eg001_get_monitoring_dataset_controller.rb

@@ -10,9 +10,9 @@ def create
 
     results = MonitorApi::Eg001GetMonitoringDatasetService.new(args).worker
 
-    @title = "Monitoring data result"
-    @h1 = "Monitoring data result"
-    @message = "Results from DataSet:GetStreamForDataset method:"
+    @title = "Get monitoring data"
+    @h1 = "Get monitoring data"
+    @message = "Results from DataSet:getStream method:"
     @json = results.to_json.to_json
 
     render 'ds_common/example_done'

app/controllers/monitor_api/eg002_post_web_query_controller.rb

@@ -0,0 +1,23 @@
+class MonitorApi::Eg002PostWebQueryController < EgController
+  before_action :check_auth
+
+  def create
+    args = {
+      access_token: session[:ds_access_token],
+      data_set_name: 'monitor',
+      account_id: session['ds_account_id'],
+      version: '2.0',
+      start_date: params[:start_date],
+      end_date: params[:end_date]
+    }
+
+    results = MonitorApi::Eg002PostWebQueryService.new(args).worker
+
+    @title = "Query monitoring data with filters"
+    @h1 = "Query monitoring data with filters"
+    @message = "Results from DataSet:postWebQuery method:"
+    @json = results.to_json.to_json
+
+    render 'ds_common/example_done'
+  end
+end

app/services/monitor_api/eg002_post_web_query_service.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class MonitorApi::Eg002PostWebQueryService
+  attr_reader :args
+
+  def initialize(args)
+    @args = args
+  end
+
+  def worker
+    # step 2 start
+    configuration = DocuSign_Monitor::Configuration.new
+    configuration.host = Rails.configuration.monitor_host
+    configuration.debugging = true
+    api_client = DocuSign_Monitor::ApiClient.new configuration
+    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
+    # step 2 end
+
+    # step 3 start
+    monitor_api = DocuSign_Monitor::DataSetApi.new(api_client)
+    @response = monitor_api.post_web_query(args[:data_set_name], args[:version], get_query)
+
+    # step 3 end
+    
+    Rails.logger.info "Responses for loops are displayed here. Only the final loop is displayed on the response page"
+    Rails.logger.info @response.inspect
+
+    return @response
+  end
+
+  def get_query
+    return {
+      "filters": [
+        {
+          "FilterName": "Time",
+          "BeginTime": args[:start_date],
+          "EndTime": args[:end_date]
+        },
+        {
+          "FilterName": "Has",
+          "ColumnName": "AccountId",
+          "Value": args[:account_id]
+        }
+      ],
+      "aggregations": [
+        {
+          "aggregationName": "Raw",
+          "limit": "1",
+          "orderby": [
+            "Timestamp, desc"
+          ]
+        }
+      ]
+    }
+  end
+end

app/views/.DS_Store

@@ -0,0 +1,25 @@
+<h4>2. Query monitoring data with filters</h4>
+<p>Demonstrates how to query an organization's data based on specified filters and aggregations.</p>
+
+<p>API method used:
+  <a target='_blank' href="https://developers.docusign.com/docs/monitor-api/reference/monitor/dataset/postwebquery/">DataSet:postWebQuery</a>.
+</p>
+
+<p>
+  View source file <a target="_blank" href="<%= @source_url %>"><%= @source_file %></a> on GitHub.
+</p>
+
+<p>
+  Please select start and end dates.
+</p>
+<form class="eg" action="" method="post" data-busy="form">
+  <div class="form-group">
+    <label for="start_date">Start date</label>
+    <input type="date" class="form-control" id="start_date" name="start_date" value=<%= Time.now - 10.days %> max=<%= Time.now %>>
+  </div>
+  <div class="form-group">
+    <label for="end_date">End date</label>
+    <input type="date" class="form-control" id="end_date" name="end_date" value=<%= Time.now %> max=<%= Time.now %>>
+  </div>
+  <button type="submit" class="btn btn-docu">Continue</button>
+</form>

app/views/monitor_api/eg002_post_web_query/get.html.erb

@@ -5,7 +5,7 @@
       <tr>
         <td>
           <h1 class="display-4">Ruby Launcher</h1>
-          <p class="Xlead">Welcome to the Ruby code examples for DocuSign Monitor API with JWT Grant authentication</p>
+          <p class="Xlead">Run and explore Monitor API code examples with JWT Grant authentication</p>
         </td>
         <td>
           <img src="banner-code.png" />
@@ -22,8 +22,6 @@
   <p><a target='_blank' href='<%= :documentation %>'>Documentation</a> on using JWT Authorization from a Ruby Rails application.</p>
   <% end %>
 
-  <h2>Monitor API Code examples</h2>
-
   <h4 id="get_stream_for_dataset">1. <a href="eg001">Get monitoring data</a></h4>
   <p>
     Demonstrates how to get and display all of your organization’s monitoring data.
@@ -33,7 +31,16 @@
     <a target='_blank' href="https://developers.docusign.com/docs/monitor-api/reference/monitor/dataset/getstream/">DataSet:GetStream</a>
   </p>
 
+  <h4 id="post_web_query">2. <a href="eg002">Query monitoring data with filters</a></h4>
+  <p>
+    Demonstrates how to query an organization's data based on specified filters and aggregations.
+  </p>
+  <p>
+    API method used:
+    <a target='_blank' href="https://developers.docusign.com/docs/monitor-api/reference/monitor/dataset/postwebquery/">DataSet:postWebQuery</a>.
+  </p>
+
 </div>
 <!-- anchor-js is only for the index page -->
 <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.1/anchor.min.js"></script>
-<script>anchors.options.placement = 'left'; anchors.add('h4')</script>
+<script>anchors.options.placement = 'left'; anchors.add('h4')</script>

app/views/monitor_api/index.html.erb

@@ -54,6 +54,8 @@
     scope module: 'monitor_api' do
       get 'eg001' => 'eg001_get_monitoring_dataset#get'
       post 'eg001' => 'eg001_get_monitoring_dataset#create'
+      get 'eg002' => 'eg002_post_web_query#get'
+      post 'eg002' => 'eg002_post_web_query#create'
     end
   end
   constraints lambda { |req| req.session[:examples_API] == "Admin" } do