cloudmersive-dataintegration-api-client 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 997d508810ebae42eee11eab2efe3eb9b591a49f261a4706a331b62d9cc34bc1
+  data.tar.gz: 180ece39415c9c29f6a829207dd1a2237c1fa603c09d86130245b74ae631a622
+SHA512:
+  metadata.gz: f022ed0767a3c0f66b0f4c73354d60c9cd72e51166ec96818a0c8555439c533991efd7e37b95bf12b696303788296c6801628bb02137e7b3d776042b0ce2d882
+  data.tar.gz: 6ff9f38efe436d59add07e116f7faf66a55d6f49b861c01b25f031fa095af136c0a7b00a8d7b899d1e7d88b1d591d9706b00b194b91011039f94d8afc1528786

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,105 @@
+# cloudmersive-dataintegration-api-client
+
+CloudmersiveDataintegrationApiClient - the Ruby gem for the Data Integration API
+
+Easily and directly query database backup files, convert into other file formats.
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.0.1
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build cloudmersive-dataintegration-api-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./cloudmersive-dataintegration-api-client-2.0.1.gem
+```
+(for development, run `gem install --dev ./cloudmersive-dataintegration-api-client-2.0.1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'cloudmersive-dataintegration-api-client', '~> 2.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'cloudmersive-dataintegration-api-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'cloudmersive-dataintegration-api-client'
+
+# Setup authorization
+CloudmersiveDataintegrationApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDataintegrationApiClient::BackupConvertApi.new
+
+opts = { 
+  input_file: File.new('/path/to/file.txt') # File | Input file to perform the operation on
+}
+
+begin
+  #Lists all tables stored in a SQL Server Backup (.BAK) file
+  result = api_instance.dataintegration_backup_convert_mssql_bak_get_tables_post(opts)
+  p result
+rescue CloudmersiveDataintegrationApiClient::ApiError => e
+  puts "Exception when calling BackupConvertApi->dataintegration_backup_convert_mssql_bak_get_tables_post: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CloudmersiveDataintegrationApiClient::BackupConvertApi* | [**dataintegration_backup_convert_mssql_bak_get_tables_post**](docs/BackupConvertApi.md#dataintegration_backup_convert_mssql_bak_get_tables_post) | **POST** /dataintegration/backup/convert/mssql/bak/get/tables | Lists all tables stored in a SQL Server Backup (.BAK) file
+*CloudmersiveDataintegrationApiClient::BackupConvertApi* | [**dataintegration_backup_convert_mssql_bak_to_csv_post**](docs/BackupConvertApi.md#dataintegration_backup_convert_mssql_bak_to_csv_post) | **POST** /dataintegration/backup/convert/mssql/bak/to/csv | Converts a SQL Server Backup (.BAK) file into CSV for a specified table
+
+
+## Documentation for Models
+
+ - [CloudmersiveDataintegrationApiClient::MssqlBakEnumerateTablesResult](docs/MssqlBakEnumerateTablesResult.md)
+ - [CloudmersiveDataintegrationApiClient::MssqlTable](docs/MssqlTable.md)
+
+
+## Documentation for Authorization
+
+
+### Apikey
+
+- **Type**: API key
+- **API key parameter name**: Apikey
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/cloudmersive-dataintegration-api-client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Data Integration API
+
+#Easily and directly query database backup files, convert into other file formats.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudmersive-dataintegration-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudmersive-dataintegration-api-client"
+  s.version     = CloudmersiveDataintegrationApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cloudmersive"]
+  s.email       = [""]
+  s.homepage    = "https://cloudmersive.com/data-integration-api"
+  s.summary     = "Easily and directly query database backup files, convert into other file formats."
+  s.description = "Easily and directly query database backup files, convert into other file formats."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = Dir['./**/*']
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/BackupConvertApi.md

@@ -0,0 +1,120 @@
+# CloudmersiveDataintegrationApiClient::BackupConvertApi
+
+All URIs are relative to *https://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**dataintegration_backup_convert_mssql_bak_get_tables_post**](BackupConvertApi.md#dataintegration_backup_convert_mssql_bak_get_tables_post) | **POST** /dataintegration/backup/convert/mssql/bak/get/tables | Lists all tables stored in a SQL Server Backup (.BAK) file
+[**dataintegration_backup_convert_mssql_bak_to_csv_post**](BackupConvertApi.md#dataintegration_backup_convert_mssql_bak_to_csv_post) | **POST** /dataintegration/backup/convert/mssql/bak/to/csv | Converts a SQL Server Backup (.BAK) file into CSV for a specified table
+
+
+# **dataintegration_backup_convert_mssql_bak_get_tables_post**
+> MssqlBakEnumerateTablesResult dataintegration_backup_convert_mssql_bak_get_tables_post(opts)
+
+Lists all tables stored in a SQL Server Backup (.BAK) file
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-dataintegration-api-client'
+# setup authorization
+CloudmersiveDataintegrationApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDataintegrationApiClient::BackupConvertApi.new
+
+opts = { 
+  input_file: File.new('/path/to/file.txt') # File | Input file to perform the operation on
+}
+
+begin
+  #Lists all tables stored in a SQL Server Backup (.BAK) file
+  result = api_instance.dataintegration_backup_convert_mssql_bak_get_tables_post(opts)
+  p result
+rescue CloudmersiveDataintegrationApiClient::ApiError => e
+  puts "Exception when calling BackupConvertApi->dataintegration_backup_convert_mssql_bak_get_tables_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input_file** | **File**| Input file to perform the operation on | [optional] 
+
+### Return type
+
+[**MssqlBakEnumerateTablesResult**](MssqlBakEnumerateTablesResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/plain, application/json, text/json
+
+
+
+# **dataintegration_backup_convert_mssql_bak_to_csv_post**
+> String dataintegration_backup_convert_mssql_bak_to_csv_post(opts)
+
+Converts a SQL Server Backup (.BAK) file into CSV for a specified table
+
+Input the target table to extract the data as a CSV format file.  Supports a wide array of SQL Server .BAK files and SQL Server backup file versions.  Consumes 1 API call per MB of input data.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-dataintegration-api-client'
+# setup authorization
+CloudmersiveDataintegrationApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveDataintegrationApiClient::BackupConvertApi.new
+
+opts = { 
+  table_name: 'table_name_example', # String | Name of the table to return
+  input_file: File.new('/path/to/file.txt') # File | Input file to perform the operation on
+}
+
+begin
+  #Converts a SQL Server Backup (.BAK) file into CSV for a specified table
+  result = api_instance.dataintegration_backup_convert_mssql_bak_to_csv_post(opts)
+  p result
+rescue CloudmersiveDataintegrationApiClient::ApiError => e
+  puts "Exception when calling BackupConvertApi->dataintegration_backup_convert_mssql_bak_to_csv_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **table_name** | **String**| Name of the table to return | [optional] 
+ **input_file** | **File**| Input file to perform the operation on | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: text/csv
+
+
+

data/docs/MssqlBakEnumerateTablesResult.md

@@ -0,0 +1,9 @@
+# CloudmersiveDataintegrationApiClient::MssqlBakEnumerateTablesResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, False otherwise | [optional] 
+**tables** | [**Array<MssqlTable>**](MssqlTable.md) | SQL Server Tables in the backup file | [optional] 
+
+

data/docs/MssqlTable.md

@@ -0,0 +1,9 @@
+# CloudmersiveDataintegrationApiClient::MssqlTable
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**schema_name** | **String** | Name of the schema containing the table | [optional] 
+**table_name** | **String** | Name of the table | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/cloudmersive-dataintegration-api-client.rb

@@ -0,0 +1,42 @@
+=begin
+#Data Integration API
+
+#Easily and directly query database backup files, convert into other file formats.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+# Common files
+require 'cloudmersive-dataintegration-api-client/api_client'
+require 'cloudmersive-dataintegration-api-client/api_error'
+require 'cloudmersive-dataintegration-api-client/version'
+require 'cloudmersive-dataintegration-api-client/configuration'
+
+# Models
+require 'cloudmersive-dataintegration-api-client/models/mssql_bak_enumerate_tables_result'
+require 'cloudmersive-dataintegration-api-client/models/mssql_table'
+
+# APIs
+require 'cloudmersive-dataintegration-api-client/api/backup_convert_api'
+
+module CloudmersiveDataintegrationApiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   CloudmersiveDataintegrationApiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/cloudmersive-dataintegration-api-client/api/backup_convert_api.rb

@@ -0,0 +1,126 @@
+=begin
+#Data Integration API
+
+#Easily and directly query database backup files, convert into other file formats.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'uri'
+
+module CloudmersiveDataintegrationApiClient
+  class BackupConvertApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Lists all tables stored in a SQL Server Backup (.BAK) file
+    # @param [Hash] opts the optional parameters
+    # @option opts [File] :input_file Input file to perform the operation on
+    # @return [MssqlBakEnumerateTablesResult]
+    def dataintegration_backup_convert_mssql_bak_get_tables_post(opts = {})
+      data, _status_code, _headers = dataintegration_backup_convert_mssql_bak_get_tables_post_with_http_info(opts)
+      data
+    end
+
+    # Lists all tables stored in a SQL Server Backup (.BAK) file
+    # @param [Hash] opts the optional parameters
+    # @option opts [File] :input_file Input file to perform the operation on
+    # @return [Array<(MssqlBakEnumerateTablesResult, Fixnum, Hash)>] MssqlBakEnumerateTablesResult data, response status code and response headers
+    def dataintegration_backup_convert_mssql_bak_get_tables_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BackupConvertApi.dataintegration_backup_convert_mssql_bak_get_tables_post ...'
+      end
+      # resource path
+      local_var_path = '/dataintegration/backup/convert/mssql/bak/get/tables'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'MssqlBakEnumerateTablesResult')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BackupConvertApi#dataintegration_backup_convert_mssql_bak_get_tables_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Converts a SQL Server Backup (.BAK) file into CSV for a specified table
+    # Input the target table to extract the data as a CSV format file.  Supports a wide array of SQL Server .BAK files and SQL Server backup file versions.  Consumes 1 API call per MB of input data.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :table_name Name of the table to return
+    # @option opts [File] :input_file Input file to perform the operation on
+    # @return [String]
+    def dataintegration_backup_convert_mssql_bak_to_csv_post(opts = {})
+      data, _status_code, _headers = dataintegration_backup_convert_mssql_bak_to_csv_post_with_http_info(opts)
+      data
+    end
+
+    # Converts a SQL Server Backup (.BAK) file into CSV for a specified table
+    # Input the target table to extract the data as a CSV format file.  Supports a wide array of SQL Server .BAK files and SQL Server backup file versions.  Consumes 1 API call per MB of input data.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :table_name Name of the table to return
+    # @option opts [File] :input_file Input file to perform the operation on
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def dataintegration_backup_convert_mssql_bak_to_csv_post_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BackupConvertApi.dataintegration_backup_convert_mssql_bak_to_csv_post ...'
+      end
+      # resource path
+      local_var_path = '/dataintegration/backup/convert/mssql/bak/to/csv'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/csv'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+      header_params[:'tableName'] = opts[:'table_name'] if !opts[:'table_name'].nil?
+
+      # form parameters
+      form_params = {}
+      form_params['inputFile'] = opts[:'input_file'] if !opts[:'input_file'].nil?
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BackupConvertApi#dataintegration_backup_convert_mssql_bak_to_csv_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end