ejabberd_http_client 1.0.0

data/docs/VcardApi.md

@@ -0,0 +1,456 @@
+# EjabberdHttpClient::VcardApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_vcard**](VcardApi.md#get_vcard) | **POST** /api/get_vcard | Get content from a vCard field. |
+| [**get_vcard2**](VcardApi.md#get_vcard2) | **POST** /api/get_vcard2 | Get content from a vCard subfield. |
+| [**get_vcard2_multi**](VcardApi.md#get_vcard2_multi) | **POST** /api/get_vcard2_multi | Get multiple contents from a vCard field. |
+| [**set_nickname**](VcardApi.md#set_nickname) | **POST** /api/set_nickname | Set nickname in a user's vCard. |
+| [**set_vcard**](VcardApi.md#set_vcard) | **POST** /api/set_vcard | Set content in a vCard field. |
+| [**set_vcard2**](VcardApi.md#set_vcard2) | **POST** /api/set_vcard2 | Set content in a vCard subfield. |
+| [**set_vcard2_multi**](VcardApi.md#set_vcard2_multi) | **POST** /api/set_vcard2_multi | Set multiple contents in a vCard subfield. |
+
+
+## get_vcard
+
+> <GetVcard200Response> get_vcard(get_vcard_request)
+
+Get content from a vCard field.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+get_vcard_request = EjabberdHttpClient::GetVcardRequest.new # GetVcardRequest |
+
+begin
+  # Get content from a vCard field.
+  result = api_instance.get_vcard(get_vcard_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->get_vcard: #{e}"
+end
+```
+
+#### Using the get_vcard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetVcard200Response>, Integer, Hash)> get_vcard_with_http_info(get_vcard_request)
+
+```ruby
+begin
+  # Get content from a vCard field.
+  data, status_code, headers = api_instance.get_vcard_with_http_info(get_vcard_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetVcard200Response>
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->get_vcard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_vcard_request** | [**GetVcardRequest**](GetVcardRequest.md) |  |  |
+
+### Return type
+
+[**GetVcard200Response**](GetVcard200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_vcard2
+
+> <GetVcard200Response> get_vcard2(get_vcard2_request)
+
+Get content from a vCard subfield.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+get_vcard2_request = EjabberdHttpClient::GetVcard2Request.new # GetVcard2Request |
+
+begin
+  # Get content from a vCard subfield.
+  result = api_instance.get_vcard2(get_vcard2_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->get_vcard2: #{e}"
+end
+```
+
+#### Using the get_vcard2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetVcard200Response>, Integer, Hash)> get_vcard2_with_http_info(get_vcard2_request)
+
+```ruby
+begin
+  # Get content from a vCard subfield.
+  data, status_code, headers = api_instance.get_vcard2_with_http_info(get_vcard2_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetVcard200Response>
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->get_vcard2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_vcard2_request** | [**GetVcard2Request**](GetVcard2Request.md) |  |  |
+
+### Return type
+
+[**GetVcard200Response**](GetVcard200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_vcard2_multi
+
+> Array&lt;String&gt; get_vcard2_multi(get_vcard2_multi_request)
+
+Get multiple contents from a vCard field.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+get_vcard2_multi_request = EjabberdHttpClient::GetVcard2MultiRequest.new # GetVcard2MultiRequest |
+
+begin
+  # Get multiple contents from a vCard field.
+  result = api_instance.get_vcard2_multi(get_vcard2_multi_request)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->get_vcard2_multi: #{e}"
+end
+```
+
+#### Using the get_vcard2_multi_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> get_vcard2_multi_with_http_info(get_vcard2_multi_request)
+
+```ruby
+begin
+  # Get multiple contents from a vCard field.
+  data, status_code, headers = api_instance.get_vcard2_multi_with_http_info(get_vcard2_multi_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->get_vcard2_multi_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_vcard2_multi_request** | [**GetVcard2MultiRequest**](GetVcard2MultiRequest.md) |  |  |
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_nickname
+
+> Integer set_nickname(opts)
+
+Set nickname in a user's vCard.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+opts = {
+  set_nickname_request: EjabberdHttpClient::SetNicknameRequest.new # SetNicknameRequest |
+}
+
+begin
+  # Set nickname in a user's vCard.
+  result = api_instance.set_nickname(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_nickname: #{e}"
+end
+```
+
+#### Using the set_nickname_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> set_nickname_with_http_info(opts)
+
+```ruby
+begin
+  # Set nickname in a user's vCard.
+  data, status_code, headers = api_instance.set_nickname_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_nickname_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set_nickname_request** | [**SetNicknameRequest**](SetNicknameRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_vcard
+
+> Integer set_vcard(opts)
+
+Set content in a vCard field.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+opts = {
+  set_vcard_request: EjabberdHttpClient::SetVcardRequest.new # SetVcardRequest |
+}
+
+begin
+  # Set content in a vCard field.
+  result = api_instance.set_vcard(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_vcard: #{e}"
+end
+```
+
+#### Using the set_vcard_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> set_vcard_with_http_info(opts)
+
+```ruby
+begin
+  # Set content in a vCard field.
+  data, status_code, headers = api_instance.set_vcard_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_vcard_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set_vcard_request** | [**SetVcardRequest**](SetVcardRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_vcard2
+
+> Integer set_vcard2(opts)
+
+Set content in a vCard subfield.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+opts = {
+  set_vcard2_request: EjabberdHttpClient::SetVcard2Request.new # SetVcard2Request |
+}
+
+begin
+  # Set content in a vCard subfield.
+  result = api_instance.set_vcard2(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_vcard2: #{e}"
+end
+```
+
+#### Using the set_vcard2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> set_vcard2_with_http_info(opts)
+
+```ruby
+begin
+  # Set content in a vCard subfield.
+  data, status_code, headers = api_instance.set_vcard2_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_vcard2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set_vcard2_request** | [**SetVcard2Request**](SetVcard2Request.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_vcard2_multi
+
+> Integer set_vcard2_multi(opts)
+
+Set multiple contents in a vCard subfield.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ejabberd_http_client'
+
+api_instance = EjabberdHttpClient::VcardApi.new
+opts = {
+  set_vcard2_multi_request: EjabberdHttpClient::SetVcard2MultiRequest.new # SetVcard2MultiRequest |
+}
+
+begin
+  # Set multiple contents in a vCard subfield.
+  result = api_instance.set_vcard2_multi(opts)
+  p result
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_vcard2_multi: #{e}"
+end
+```
+
+#### Using the set_vcard2_multi_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Integer, Integer, Hash)> set_vcard2_multi_with_http_info(opts)
+
+```ruby
+begin
+  # Set multiple contents in a vCard subfield.
+  data, status_code, headers = api_instance.set_vcard2_multi_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Integer
+rescue EjabberdHttpClient::ApiError => e
+  puts "Error when calling VcardApi->set_vcard2_multi_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set_vcard2_multi_request** | [**SetVcard2MultiRequest**](SetVcard2MultiRequest.md) |  | [optional] |
+
+### Return type
+
+**Integer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/ejabberd_http_client.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#OpenAPI Documentation for Ejabberd HTTP APIs
+
+#APIs for managing Ejabberd server
+
+The version of the OpenAPI document: 1.0.0
+
+OpenAPI Generator version: 7.0.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "ejabberd_http_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ejabberd_http_client"
+  s.version     = EjabberdHttpClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors = ["Arjun Verma"]
+  s.email = ["arjun.verma@hetu-labs.com"]
+  s.homepage    = "https://rubygems.org/gems/ejabberd_http_client"
+  s.summary     = "OpenAPI Documentation for Ejabberd HTTP APIs Ruby Gem"
+  s.description = "APIs for managing Ejabberd server"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+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://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${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://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'