Merge pull request #207 from docusign/feature/add-http-info

Add http info output

Author: balaji1103

app/services/admin_api/eg001_create_user_service.rb

@@ -1,25 +1,36 @@
-# frozen_string_literal: true
-
-class AdminApi::Eg001CreateUserService
-  attr_reader :args, :user_data
-
-  def initialize(args, user_data)
-    @args = args
-    @user_data = user_data
-  end
-
-  def worker
-    #ds-snippet-start:Admin1Step2
-    configuration = DocuSign_Admin::Configuration.new
-    configuration.host = Rails.configuration.admin_host
-
-    api_client = DocuSign_Admin::ApiClient.new(configuration)
-    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
-    #ds-snippet-end:Admin1Step2
-
-    #ds-snippet-start:Admin1Step6
-    users_api = DocuSign_Admin::UsersApi.new(api_client)
-    users_api.create_user(args[:organization_id], user_data)
-    #ds-snippet-end:Admin1Step6
-  end
-end
+# frozen_string_literal: true
+
+class AdminApi::Eg001CreateUserService
+  attr_reader :args, :user_data
+
+  def initialize(args, user_data)
+    @args = args
+    @user_data = user_data
+  end
+
+  def worker
+    #ds-snippet-start:Admin1Step2
+    configuration = DocuSign_Admin::Configuration.new
+    configuration.host = Rails.configuration.admin_host
+
+    api_client = DocuSign_Admin::ApiClient.new(configuration)
+    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
+    #ds-snippet-end:Admin1Step2
+
+    #ds-snippet-start:Admin1Step6
+    users_api = DocuSign_Admin::UsersApi.new(api_client)
+    results, _status, headers = users_api.create_user_with_http_info(args[:organization_id], user_data)
+
+    remaining = headers['X-RateLimit-Remaining']
+    reset = headers['X-RateLimit-Reset']
+
+    if remaining && reset
+      reset_date = Time.at(reset.to_i).utc
+      puts "API calls remaining: #{remaining}"
+      puts "Next Reset: #{reset_date}"
+    end
+    #ds-snippet-end:Admin1Step6
+
+    results
+  end
+end

app/services/admin_api/eg002_create_active_clm_esign_user_service.rb

@@ -1,51 +1,62 @@
-# frozen_string_literal: true
-
-class AdminApi::Eg002CreateActiveClmEsignUserService
-  attr_reader :args
-
-  def initialize(args)
-    @args = args
-  end
-
-  def worker
-    configuration = DocuSign_Admin::Configuration.new
-    configuration.host = Rails.configuration.admin_host
-
-    api_client = DocuSign_Admin::ApiClient.new(configuration)
-    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
-
-    #ds-snippet-start:Admin2Step6
-    users_api = DocuSign_Admin::UsersApi.new(api_client)
-    users_api.add_or_update_user(args[:organization_id], args[:account_id], body(args))
-    #ds-snippet-end:Admin2Step6
-  end
-
-  private
-
-  #ds-snippet-start:Admin2Step5
-  def body(args)
-    {
-      user_name: args[:user_name],
-      first_name: args[:first_name],
-      last_name: args[:last_name],
-      email: args[:email],
-      auto_activate_memberships: true,
-      product_permission_profiles: [
-        {
-          permission_profile_id: args[:esign_permission_profile_id],
-          product_id: args[:esign_product_id]
-        },
-        {
-          permission_profile_id: args[:clm_permission_profile_id],
-          product_id: args[:clm_product_id]
-        }
-      ],
-      ds_groups: [
-        {
-          ds_group_id: args[:ds_group_id]
-        }
-      ]
-    }
-  end
-  #ds-snippet-end:Admin2Step5
-end
+# frozen_string_literal: true
+
+class AdminApi::Eg002CreateActiveClmEsignUserService
+  attr_reader :args
+
+  def initialize(args)
+    @args = args
+  end
+
+  def worker
+    configuration = DocuSign_Admin::Configuration.new
+    configuration.host = Rails.configuration.admin_host
+
+    api_client = DocuSign_Admin::ApiClient.new(configuration)
+    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
+
+    #ds-snippet-start:Admin2Step6
+    users_api = DocuSign_Admin::UsersApi.new(api_client)
+    results, _status, headers = users_api.add_or_update_user_with_http_info(args[:organization_id], args[:account_id], body(args))
+
+    remaining = headers['X-RateLimit-Remaining']
+    reset = headers['X-RateLimit-Reset']
+
+    if remaining && reset
+      reset_date = Time.at(reset.to_i).utc
+      puts "API calls remaining: #{remaining}"
+      puts "Next Reset: #{reset_date}"
+    end
+    #ds-snippet-end:Admin2Step6
+
+    results
+  end
+
+  private
+
+  #ds-snippet-start:Admin2Step5
+  def body(args)
+    {
+      user_name: args[:user_name],
+      first_name: args[:first_name],
+      last_name: args[:last_name],
+      email: args[:email],
+      auto_activate_memberships: true,
+      product_permission_profiles: [
+        {
+          permission_profile_id: args[:esign_permission_profile_id],
+          product_id: args[:esign_product_id]
+        },
+        {
+          permission_profile_id: args[:clm_permission_profile_id],
+          product_id: args[:clm_product_id]
+        }
+      ],
+      ds_groups: [
+        {
+          ds_group_id: args[:ds_group_id]
+        }
+      ]
+    }
+  end
+  #ds-snippet-end:Admin2Step5
+end

app/services/admin_api/eg003_bulk_export_user_data_service.rb

@@ -1,63 +1,91 @@
-class AdminApi::Eg003BulkExportUserDataService
-  attr_reader :bulk_exports_api, :args
-
-  def initialize(args)
-    @args = args
-  end
-
-  def worker
-    #ds-snippet-start:Admin3Step2
-    configuration = DocuSign_Admin::Configuration.new
-    configuration.host = Rails.configuration.admin_host
-
-    api_client = DocuSign_Admin::ApiClient.new(configuration)
-    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
-    #ds-snippet-end:Admin3Step2
-
-    #ds-snippet-start:Admin3Step3
-    @bulk_exports_api = DocuSign_Admin::BulkExportsApi.new(api_client)
-    response = bulk_exports_api.create_user_list_export(args[:organization_id], args[:request_body])
-    #ds-snippet-end:Admin3Step3
-
-    #ds-snippet-start:Admin3Step4
-    retry_count = 5
-    while retry_count >= 0
-      if response.results
-        get_exported_user_data(args, response.id)
-        break
-      else
-        retry_count -= 1
-        sleep(5)
-        response = bulk_exports_api.get_user_list_export(args[:organization_id], response.id)
-      end
-    end
-    #ds-snippet-end:Admin3Step4
-
-    response
-  end
-
-  private
-
-  #ds-snippet-start:Admin3Step5
-  def get_exported_user_data(args, export_id)
-    bulk_export_response = bulk_exports_api.get_user_list_export(args[:organization_id], export_id)
-    data_url = bulk_export_response.results[0].url
-
-    uri = URI(data_url)
-
-    req = Net::HTTP::Get.new(uri)
-    req['Authorization'] = "Bearer #{args[:access_token]}"
-
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true
-
-    http.request(req) do |response|
-      File.open(args[:file_path], 'w') do |file|
-        response.read_body do |chunk|
-          file.write(chunk)
-        end
-      end
-    end
-  end
-  #ds-snippet-end:Admin3Step5
-end
+class AdminApi::Eg003BulkExportUserDataService
+  attr_reader :bulk_exports_api, :args
+
+  def initialize(args)
+    @args = args
+  end
+
+  def worker
+    #ds-snippet-start:Admin3Step2
+    configuration = DocuSign_Admin::Configuration.new
+    configuration.host = Rails.configuration.admin_host
+
+    api_client = DocuSign_Admin::ApiClient.new(configuration)
+    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
+    #ds-snippet-end:Admin3Step2
+
+    #ds-snippet-start:Admin3Step3
+    @bulk_exports_api = DocuSign_Admin::BulkExportsApi.new(api_client)
+    response, _status, headers = bulk_exports_api.create_user_list_export_with_http_info(args[:organization_id], args[:request_body])
+
+    remaining = headers['X-RateLimit-Remaining']
+    reset = headers['X-RateLimit-Reset']
+
+    if remaining && reset
+      reset_date = Time.at(reset.to_i).utc
+      puts "API calls remaining: #{remaining}"
+      puts "Next Reset: #{reset_date}"
+    end
+    #ds-snippet-end:Admin3Step3
+
+    #ds-snippet-start:Admin3Step4
+    retry_count = 5
+    while retry_count >= 0
+      if response.results
+        get_exported_user_data(args, response.id)
+        break
+      else
+        retry_count -= 1
+        sleep(5)
+        response, _status, headers = bulk_exports_api.get_user_list_export_with_http_info(args[:organization_id], response.id)
+
+        remaining = headers['X-RateLimit-Remaining']
+        reset = headers['X-RateLimit-Reset']
+
+        if remaining && reset
+          reset_date = Time.at(reset.to_i).utc
+          puts "API calls remaining: #{remaining}"
+          puts "Next Reset: #{reset_date}"
+        end
+      end
+    end
+    #ds-snippet-end:Admin3Step4
+
+    response
+  end
+
+  private
+
+  #ds-snippet-start:Admin3Step5
+  def get_exported_user_data(args, export_id)
+    bulk_export_response, _status, headers = bulk_exports_api.get_user_list_export_with_http_info(args[:organization_id], export_id)
+
+    remaining = headers['X-RateLimit-Remaining']
+    reset = headers['X-RateLimit-Reset']
+
+    if remaining && reset
+      reset_date = Time.at(reset.to_i).utc
+      puts "API calls remaining: #{remaining}"
+      puts "Next Reset: #{reset_date}"
+    end
+
+    data_url = bulk_export_response.results[0].url
+
+    uri = URI(data_url)
+
+    req = Net::HTTP::Get.new(uri)
+    req['Authorization'] = "Bearer #{args[:access_token]}"
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    http.request(req) do |response|
+      File.open(args[:file_path], 'w') do |file|
+        response.read_body do |chunk|
+          file.write(chunk)
+        end
+      end
+    end
+  end
+  #ds-snippet-end:Admin3Step5
+end

app/services/admin_api/eg004_import_user_service.rb

@@ -1,25 +1,36 @@
-class AdminApi::Eg004ImportUserService
-  attr_reader :args
-
-  def initialize(args)
-    @args = args
-  end
-
-  def worker
-    #ds-snippet-start:Admin4Step2
-    configuration = DocuSign_Admin::Configuration.new
-    configuration.host = Rails.configuration.admin_host
-
-    api_client = DocuSign_Admin::ApiClient.new(configuration)
-    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
-    #ds-snippet-end:Admin4Step2
-
-    #ds-snippet-start:Admin4Step3
-    csv_file_data = File.open(args[:csv_file_path]).read
-    csv_file_data = csv_file_data.gsub('{account_id}', args[:account_id])
-
-    @bulk_imports_api = DocuSign_Admin::BulkImportsApi.new(api_client)
-    @bulk_imports_api.create_bulk_import_add_users_request(args[:organization_id], csv_file_data)
-    #ds-snippet-end:Admin4Step3
-  end
-end
+class AdminApi::Eg004ImportUserService
+  attr_reader :args
+
+  def initialize(args)
+    @args = args
+  end
+
+  def worker
+    #ds-snippet-start:Admin4Step2
+    configuration = DocuSign_Admin::Configuration.new
+    configuration.host = Rails.configuration.admin_host
+
+    api_client = DocuSign_Admin::ApiClient.new(configuration)
+    api_client.set_default_header('Authorization', "Bearer #{args[:access_token]}")
+    #ds-snippet-end:Admin4Step2
+
+    #ds-snippet-start:Admin4Step3
+    csv_file_data = File.open(args[:csv_file_path]).read
+    csv_file_data = csv_file_data.gsub('{account_id}', args[:account_id])
+
+    @bulk_imports_api = DocuSign_Admin::BulkImportsApi.new(api_client)
+    results, _status, headers = @bulk_imports_api.create_bulk_import_add_users_request_with_http_info(args[:organization_id], csv_file_data)
+
+    remaining = headers['X-RateLimit-Remaining']
+    reset = headers['X-RateLimit-Reset']
+
+    if remaining && reset
+      reset_date = Time.at(reset.to_i).utc
+      puts "API calls remaining: #{remaining}"
+      puts "Next Reset: #{reset_date}"
+    end
+    #ds-snippet-end:Admin4Step3
+
+    results
+  end
+end