MoesifApi Lib for Ruby

Check out Moesif's Developer Documentation and Ruby API Reference to learn more

How to configure:

The generated code might need to be configured with your API credentials. To do that, open the file "configuration.rb" and edit it's contents.

Alternatively, you can modify the Configuration parameters at run-time through the following:

MoesifApi::Configuration.your_paramater = YOUR_VALUE

Install from RubyGems

gem install moesif_api

How to use:

After having installed the gem, you can easily use the SDK following these steps.

Your Moesif Application Id can be found in the Moesif Portal. After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps.

You can always find your Moesif Application Id at any time by logging into the Moesif Portal, click on the top right menu, and then clicking Installation.

Create Event

require 'moesif_api'

api_client = MoesifApi::MoesifAPIClient.new(my_application_id)
api_controller = api_client.api

req_headers = JSON.parse('{'\
  '"Host": "api.acmeinc.com",'\
  '"Accept": "*/*",'\
  '"Connection": "Keep-Alive",'\
  '"User-Agent": "Dalvik/2.1.0 (Linux; U; Android 5.0.2; C6906 Build/14.5.A.0.242)",'\
  '"Content-Type": "application/json",'\
  '"Content-Length": "126",'\
  '"Accept-Encoding": "gzip"'\
'}')

req_body = JSON.parse( '{'\
  '"items": ['\
    '{'\
      '"type": 1,'\
      '"id": "fwfrf"'\
    '},'\
    '{'\
      '"type": 2,'\
      '"id": "d43d3f"'\
    '}'\
  ']'\
'}')

rsp_headers = JSON.parse('{'\
  '"Date": "Tue, 20 Aug 2019 23:46:49 GMT",'\
                '"Vary": "Accept-Encoding",'\
  '"Pragma": "no-cache",'\
  '"Expires": "-1",'\
  '"Content-Type": "application/json; charset=utf-8",'\
                '"Cache-Control": "no-cache"'\
'}')

rsp_body = JSON.parse('{'\
  '"Error": "InvalidArgumentException",'\
  '"Message": "Missing field field_a"'\
'}')

metadata = JSON.parse('{'\
  '"foo": "rubytestmeta",'\
  '"bar": "rubytestmedat2"'\
'}')

event_req = EventRequestModel.new()
event_req.time = "2019-09-09T04:45:42.914"
event_req.uri = "https://api.acmeinc.com/items/reviews/"
event_req.verb = "PATCH"
event_req.api_version = "1.1.0"
event_req.ip_address = "61.48.220.123"
event_req.headers = req_headers
event_req.body = req_body

event_rsp = EventResponseModel.new()
event_rsp.time = "2019-09-09T04:45:42.914"
event_rsp.status = 500
event_rsp.headers = rsp_headers
event_rsp.body = rsp_body

event_model = EventModel.new()
event_model.request = event_req
event_model.response = event_rsp
event_model.user_id ="my_user_id"
event_model.company_id = "my_company_id"
event_model.session_token = "23jdf0owekfmcn4u3qypxg09w4d8ayrcdx8nu2ng]s98y18cx98q3yhwmnhcfx43f"
event_model.metadata = metadata

# Perform the API call through the SDK function
response = api_controller.create_event(event_model)

Update User

You can also update the metadata for each user. The only required field is user_id

api_client = MoesifApi::MoesifAPIClient.new(my_application_id)
api_controller = api_client.api

metadata = JSON.parse('{'\
  '"email": "[email protected]",'\
  '"name": "ruby api user",'\
  '"custom": "testdata"'\
'}')

campaign_model = CampaignModel.new()
campaign_model.utm_source = "Newsletter"
campaign_model.utm_medium = "Email"

user_model = UserModel.new()
user_model.modified_time = Time.now.utc.iso8601  # option, default now.
user_model.user_id = "12345"  #only required field.
user_model.company_id = "67890"
user_model.metadata = metadata
user_model.campaign = campaign_model

# Perform the API call through the SDK function
response = api_controller.update_user(user_model)

Update Company

You can also update the metadata for each company. The only required field is company_id

api_client = MoesifApi::MoesifAPIClient.new(my_application_id)
api_controller = api_client.api

metadata = JSON.parse('{'\
  '"email": "[email protected]",'\
  '"name": "ruby api user",'\
  '"location": "United States"'\
'}')

campaign_model = CampaignModel.new()
campaign_model.utm_source = "Adwords"
campaign_model.utm_medium = "Twitter"

company_model = CompanyModel.new()
company_model.modified_time = Time.now.utc.iso8601 # option, default now.
company_model.company_id = "12345" #only required field.
company_model.metadata = metadata
company_model.campaign = campaign_model

# Perform the API call through the SDK function
response = api_controller.update_company(company_model)

How to build and install manually:

The generated code depends on a few Ruby gems. The references to these gems are added in the gemspec file. The easiest way to resolve the dependencies, build the gem and install it is through Rake:

Install Rake if not already installed: gem install rake
Install Bundler if not already installed: gem install bundler
From terminal/cmd navigate to the root directory of the SDK.
Invoke: rake install

Alternatively, you can build and install the gem manually:

From terminal/cmd navigate to the root directory of the SDK.
Run the build command: gem build moesif_api.gemspec
Run the install command: gem install ./moesif_api-1.0.0.gem

Note: You will need to have internet access for this step.

How to test:

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

Add your Moesif application id to 'test/controllers/controller_test_base'. You can find your Application Id from Moesif Dashboard -> Top Right Menu -> Installation
From terminal/cmd navigate to the root directory of the SDK.
Invoke: bundle exec rake