Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.rubocop.yml
LICENSE
README.md
Rakefile
securitytext_org_api.gemspec

README.md

Getting started

An API for securitytext.org

How to Build

This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.

  1. Open the command line interface or the terminal and navigate to the folder containing the source code.
  2. Run gem build securitytext_org_api.gemspec to build the gem.
  3. Once built, the gem can be installed on the current work environment using gem install securitytext_org_api-1.0.0.gem

Building Gem

How to Use

The following section explains how to use the SecuritytextOrgApi Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

1. Starting a new project

Close any existing projects in RubyMine™ by selecting File -> Close Project. Next, click on Create New Project to create a new project from scratch.

Create a new project in RubyMine

Next, provide TestApp as the project name, choose Rails Application as the project type, and click OK.

Create a new Rails Application in RubyMine - step 1

In the next dialog make sure that correct Ruby SDK is being used (minimum 2.0.0) and click OK.

Create a new Rails Application in RubyMine - step 2

This will create a new Rails Application project with an existing set of files and folder.

2. Add reference of the gem

In order to use the SecuritytextOrgApi gem in the new project we must add a gem reference. Locate the Gemfile in the Project Explorer window under the TestApp project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: gem 'securitytext_org_api', '~> 1.0.0'

Add references of the Gemfile

3. Adding a new Rails Controller

Once the TestApp project is created, a folder named controllers will be visible in the Project Explorer under the following path: TestApp > app > controllers. Right click on this folder and select New -> Run Rails Generator....

Run Rails Generator on Controllers Folder

Selecting the said option will popup a small window where the generator names are displayed. Here, select the controller template.

Create a new Controller

Next, a popup window will ask you for a Controller name and included Actions. For controller name provide Hello and include an action named Index and click OK.

Add a new Controller

A new controller class anmed HelloController will be created in a file named hello_controller.rb containing a method named Index. In this method, add code for initialization and a sample for its usage.

Initialize the library

How to Test

You can test the generated SDK and the server with automatically generated test cases as follows:

  1. From terminal/cmd navigate to the root directory of the SDK.
  2. Invoke: bundle exec rake

Initialization

API client can be initialized as following.

client = SecuritytextOrgApi::SecuritytextOrgApiClient.new

The added initlization code can be debugged by putting a breakpoint in the Index method and running the project in debug mode by selecting Run -> Debug 'Development: TestApp'.

Debug the TestApp

Class Reference

List of Controllers

Class: WhoisController

Get singleton instance

The singleton instance of the WhoisController class can be accessed from the API Client.

whois_controller = client.whois

Method: create_api_whois_query

Tags: Skips Authentication

Query the server for a Domain object

def create_api_whois_query(body); end

Parameters

Parameter Tags Description
body Required Body of API request

Example Usage

body = RequestsQueryModel.new

result = whois_controller.create_api_whois_query(body)

Errors

Error Code Error Description
400 Bad Request
406 Not Acceptable
500 Internal Server Error

Back to List of Controllers