moesif_api 1.2.8 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c634394e829a513470949c40b4bc20708a9964226230dbaa3426cbde75c2e50
-  data.tar.gz: f9d9c8d20b406e3c7aeb7babb6a3db9836a45f27bda57140c60a25a6a534c295
+  metadata.gz: 515b439ebaf44ad2255a72fdad2b14de33ec05701f7f9ff0c0163344f095a692
+  data.tar.gz: 57916ad763a1823e9b2cd48aaa826a4d5ba06513c350c276a2440f8b82326899
 SHA512:
-  metadata.gz: b18941a1bff1df72bdd28125125300c497bf733abb3b0d5ca164e180b1e7b09e6379e716a93a39ce1af2580fe1e355ede89a012fdbebddf946e7d061d388860d
-  data.tar.gz: ad384326772cf63e2e18a5abc7cdf1ccc57e4371bf42bcbead3ec14db3ddea51638dcc5c881c7e8f31056f1204cb08d7c679a56a43794f892e42cf4d311f35b7
+  metadata.gz: 7e536c2f0cb842846eb1a4497a8c2a6f01e075702a6d7edac0d7c5a59fe4cc932c7be4ba973801ea4d2a0a943ba344e1903fc9cc7056f841bc1ef915ee78029a
+  data.tar.gz: e8b3d22df3b8976b902529f251b00eafcc00386c9c8999ad46945b276ed37b3c11297f35636be8c8bd0c4bd39e9b7d4f33624f459b64b8e6f3649ea3815ac349

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Moesif, Inc
+Copyright (c) 2021 Moesif, Inc
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/LICENSE~

@@ -0,0 +1,216 @@
+Copyright (c) 2018 Moesif, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -30,8 +30,15 @@ gem install moesif_api
 
 After having installed the gem, you can easily use the SDK following these steps.
 
-  1. Create a "moesif_api_test.rb" file in the root directory.
-  2. Use any controller as follows:
+Your Moesif Application Id can be found in the [_Moesif Portal_](https://www.moesif.com/).
+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_](https://www.moesif.com/), click on the top right menu,
+and then clicking _Installation_.
+
+### Create Event
+
 ```ruby
 require 'moesif_api'
 
@@ -81,7 +88,7 @@ metadata = JSON.parse('{'\
 '}')
 
 event_req = EventRequestModel.new()
-event_req.time = "2016-09-09T04:45:42.914"
+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"
@@ -90,7 +97,7 @@ event_req.headers = req_headers
 event_req.body = req_body
 
 event_rsp = EventResponseModel.new()
-event_rsp.time = "2016-09-09T04:45:42.914"
+event_rsp.time = "2019-09-09T04:45:42.914"
 event_rsp.status = 500
 event_rsp.headers = rsp_headers
 event_rsp.body = rsp_body
@@ -107,52 +114,177 @@ event_model.metadata = metadata
 response = api_controller.create_event(event_model)
 ```
 
-### update user
+## Update a Single User
 
-You can also update the metadata for each user. The only required field is user_id
+Create or update a user profile in Moesif.
+The metadata field can be any customer demographic or other info you want to store.
+Only the `userId` field is required.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-a-user).
 
 ```ruby
-api_client = MoesifApi::MoesifAPIClient.new(my_application_id)
-api_controller = api_client.api
-
-metadata = JSON.parse('{'\
-  '"email": "testrubyapi@user.com",'\
-  '"name": "ruby api user",'\
-  '"custom": "testdata"'\
-'}')
+api_client = MoesifApi::MoesifAPIClient.new('YOUR_COLLECTOR_APPLICATION_ID').api
+
+metadata = {
+  :email => 'john@acmeinc.com',
+  :first_name => 'John',
+  :last_name => 'Doe',
+  :title => 'Software Engineer',
+  :salesInfo => {
+      :stage => 'Customer',
+      :lifetime_value => 24000,
+      :accountOwner => 'mary@contoso.com',
+  }
+}
+
+# Campaign object is optional, but useful if you want to track ROI of acquisition channels
+# See https://www.moesif.com/docs/api#users for campaign schema
+campaign = MoesifApi::CampaignModel.new()
+campaign.utm_source = "google"
+campaign.utm_medium = "cpc"
+campaign.utm_campaign = "adwords"
+campaign.utm_term = "api+tooling"
+campaign.utm_content = "landing"
+
+# Only user_id is required.
+# metadata can be any custom object
+user = MoesifApi::UserModel.new()
+user.user_id = "12345"
+user.company_id = "67890" # If set, associate user with a company object
+user.campaign = campaign
+user.metadata = metadata
+
+update_user = api_client.update_user(user)
+```
 
-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
+## Update Users in Batch
 
-# Perform the API call through the SDK function
-response = api_controller.update_user(user_model)
+Similar to UpdateUser, but used to update a list of users in one batch. 
+Only the `userId` field is required.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-users-in-batch).
 
+```ruby
+api_client = MoesifApi::MoesifAPIClient.new('YOUR_COLLECTOR_APPLICATION_ID').api
+
+users = []
+
+metadata = {
+  :email => 'john@acmeinc.com',
+  :first_name => 'John',
+  :last_name => 'Doe',
+  :title => 'Software Engineer',
+  :salesInfo => {
+      :stage => 'Customer',
+      :lifetime_value => 24000,
+      :accountOwner => 'mary@contoso.com',
+  }
+}
+
+# Campaign object is optional, but useful if you want to track ROI of acquisition channels
+# See https://www.moesif.com/docs/api#users for campaign schema
+campaign = MoesifApi::CampaignModel.new()
+campaign.utm_source = "google"
+campaign.utm_medium = "cpc"
+campaign.utm_campaign = "adwords"
+campaign.utm_term = "api+tooling"
+campaign.utm_content = "landing"
+
+# Only user_id is required.
+# metadata can be any custom object
+user = MoesifApi::UserModel.new()
+user.user_id = "12345"
+user.company_id = "67890" # If set, associate user with a company object
+user.campaign = campaign
+user.metadata = metadata
+
+users << user
+
+api_client = api_controller.update_users_batch(user_model)
 ```
 
-### update company
+## Update a Single Company
 
-You can also update the metadata for each company. The only required field is company_id
+Create or update a company profile in Moesif.
+The metadata field can be any company demographic or other info you want to store.
+Only the `companyId` field is required.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-a-company).
 
 ```ruby
-api_client = MoesifApi::MoesifAPIClient.new(my_application_id)
-api_controller = api_client.api
+api_client = MoesifApi::MoesifAPIClient.new('YOUR_COLLECTOR_APPLICATION_ID').api
+
+metadata = {
+  :org_name => 'Acme, Inc',
+  :plan_name => 'Free',
+  :deal_stage => 'Lead',
+  :mrr => 24000,
+  :demographics => {
+      :alexa_ranking => 500000,
+      :employee_count => 47
+  }
+}
+
+# Campaign object is optional, but useful if you want to track ROI of acquisition channels
+# See https://www.moesif.com/docs/api#update-a-company for campaign schema
+campaign = MoesifApi::CampaignModel.new()
+campaign.utm_source = "google"
+campaign.utm_medium = "cpc"
+campaign.utm_campaign = "adwords"
+campaign.utm_term = "api+tooling"
+campaign.utm_content = "landing"
+
+# Only company_id is required.
+# metadata can be any custom object
+company = MoesifApi::CompanyModel.new()
+company.company_id = "67890"
+company.company_domain = "acmeinc.com" # If domain is set, Moesif will enrich your profiles with publicly available info 
+company.campaign = campaign
+company.metadata = metadata
+
+update_company = api_client.update_company(company)
+```
 
-metadata = JSON.parse('{'\
-  '"email": "testrubyapi@user.com",'\
-  '"name": "ruby api user",'\
-  '"location": "United States"'\
-'}')
 
-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
+## Update Companies in Batch
 
-# Perform the API call through the SDK function
-response = api_controller.update_company(company_model)
+Similar to updateCompany, but used to update a list of companies in one batch. 
+Only the `companyId` field is required.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-companies-in-batch).
+
+```ruby
+api_client = MoesifApi::MoesifAPIClient.new('YOUR_COLLECTOR_APPLICATION_ID').api
+
+companies = []
+
+metadata = {
+  :org_name => 'Acme, Inc',
+  :plan_name => 'Free',
+  :deal_stage => 'Lead',
+  :mrr => 24000,
+  :demographics => {
+      :alexa_ranking => 500000,
+      :employee_count => 47
+  }
+}
+
+# Campaign object is optional, but useful if you want to track ROI of acquisition channels
+# See https://www.moesif.com/docs/api#update-a-company for campaign schema
+campaign = MoesifApi::CampaignModel.new()
+campaign.utm_source = "google"
+campaign.utm_medium = "cpc"
+campaign.utm_campaign = "adwords"
+campaign.utm_term = "api+tooling"
+campaign.utm_content = "landing"
+
+# Only company_id is required.
+# metadata can be any custom object
+company = MoesifApi::CompanyModel.new()
+company.company_id = "67890"
+company.company_domain = "acmeinc.com" # If domain is set, Moesif will enrich your profiles with publicly available info 
+company.campaign = campaign
+company.metadata = metadata
+
+companies << company
+
+update_company = api_client.update_companies(companies)
 ```
 
 ## How to build and install manually:

data/lib/moesif_api.rb

@@ -28,6 +28,7 @@ require_relative 'moesif_api/models/event_response_model.rb'
 require_relative 'moesif_api/models/status_model.rb'
 require_relative 'moesif_api/models/user_model.rb'
 require_relative 'moesif_api/models/company_model.rb'
+require_relative 'moesif_api/models/campaign_model.rb'
 
 # Controllers
 require_relative 'moesif_api/controllers/base_controller.rb'

data/lib/moesif_api/configuration.rb

@@ -8,7 +8,7 @@ module MoesifApi
     # Your Application Id for authentication/authorization
     @application_id = 'SET_ME'
 
-    @version = '1.2.8'
+    @version = '1.2.12'
 
     # create the getters and setters
     class << self

data/lib/moesif_api/configuration.rb~

@@ -0,0 +1,20 @@
+
+
+module MoesifApi
+  class Configuration
+    # The base Uri for API calls
+    @base_uri = 'https://api.moesif.net'
+
+    # Your Application Id for authentication/authorization
+    @application_id = 'SET_ME'
+
+    @version = '1.2.2'
+
+    # create the getters and setters
+    class << self
+      attr_accessor :base_uri
+      attr_accessor :application_id
+      attr_accessor :version
+    end
+  end
+end

data/lib/moesif_api/controllers/api_controller.rb

@@ -1,4 +1,5 @@
-
+require 'zlib'
+require 'net/http'
 
 module MoesifApi
   class ApiController < BaseController
@@ -8,6 +9,43 @@ module MoesifApi
       @@instance
     end
 
+    # API Call to send data to Moesif 
+    # @param [EventModel] body Required [Hash] headers Required [String] url Required
+    # @return response and context from the API call
+    def send_moesif(url, headers, body)
+      begin
+        # Gzip the body
+        gzip = Zlib::GzipWriter.new(StringIO.new)
+        gzip << body.to_json
+        gzip_body = gzip.close.string
+
+        # Add Content-Encoding header
+        headers['Content-Encoding'] = 'gzip'
+         # Gzip payload
+         _request_body = gzip_body
+      rescue => e
+         # Json payload
+         _request_body = body.to_json
+      end
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post url, headers: headers, parameters: _request_body
+
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      return _response, _context
+    end
+
     # Add Single API Event Call
     # @param [EventModel] body Required parameter: Example:
     # @return void response from the API call
@@ -28,20 +66,8 @@ module MoesifApi
         'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
+      _response, _context = send_moesif(_query_url, _headers, body)
 
       # Global error handling using HTTP status codes.
       validate_response(_context)
@@ -70,20 +96,8 @@ module MoesifApi
         'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
+      _response, _context = send_moesif(_query_url, _headers, body)
 
       # Global error handling using HTTP status codes.
       validate_response(_context)
@@ -112,20 +126,8 @@ module MoesifApi
         'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
+      _response, _context = send_moesif(_query_url, _headers, body)
 
       # Global error handling using HTTP status codes.
       validate_response(_context)
@@ -152,20 +154,8 @@ module MoesifApi
         'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
+      _response, _context = send_moesif(_query_url, _headers, body)
 
       # Global error handling using HTTP status codes.
       validate_response(_context)
@@ -232,20 +222,8 @@ module MoesifApi
         'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
+      _response, _context = send_moesif(_query_url, _headers, body)
 
       # Global error handling using HTTP status codes.
       validate_response(_context)
@@ -271,20 +249,8 @@ module MoesifApi
         'User-Agent' => 'moesifapi-ruby/' +  Configuration.version
       }
 
-      # Create the HttpRequest object for the call
-      _request = @http_client.post _query_url, headers: _headers, parameters: body.to_json
-
-      # Call the on_before_request callback
-      @http_call_back.on_before_request(_request) if @http_call_back
-
-      # Invoke the API call and get the response
-      _response = @http_client.execute_as_string(_request)
-
-      # Wrap the request and response in an HttpContext object
-      _context = HttpContext.new(_request, _response)
-
-      # Call the on_after_response callback
-      @http_call_back.on_after_response(_context) if @http_call_back
+      # Create the HttpRequest object for the call, fetch and wrap the respone in a HttpContext object
+      _response, _context = send_moesif(_query_url, _headers, body)
 
       # Global error handling using HTTP status codes.
       validate_response(_context)

data/lib/moesif_api/models/base_model.rb

@@ -8,21 +8,27 @@ module MoesifApi
       self.instance_variables.each do |name|
         value = self.instance_variable_get(name)
         name = name[1..-1]
-        key = self.class.names.key?(name) ? self.class.names[name] : name
+        key = clean_str(self.class.names.key?(name) ? self.class.names[name] : name)
         if value.instance_of? Array
-          hash[key] = value.map{|v| v.kind_of?(BaseModel) ? v.to_hash : v}
+          hash[key] = value.map{|v| 
+            v.kind_of?(BaseModel) ? v.to_hash : clean_str(v)
+          }
         elsif value.instance_of? Hash
           hash[key] = {}
           value.each do |k, v|
-            hash[key][k] = v.kind_of?(BaseModel) ? v.to_hash : v
+            hash[key][k] = v.kind_of?(BaseModel) ? v.to_hash : clean_str(v)
           end
         else
-          hash[key] = value.kind_of?(BaseModel) ? value.to_hash : value
+          hash[key] = value.kind_of?(BaseModel) ? value.to_hash : clean_str(value)
         end
       end
       hash
     end
 
+    def clean_str(x)
+      x.is_a?(String) ? x.encode(Encoding::UTF_8, Encoding::UTF_8, :invalid => :replace): x
+    end
+
     # Returns a JSON representation of the curent object
     def to_json(options = {})
       hash = to_hash

data/lib/moesif_api/models/campaign_model.rb

@@ -0,0 +1,98 @@
+
+module MoesifApi
+  class CampaignModel < BaseModel
+
+    # the utm source
+    # @return [String]
+    attr_accessor :utm_source
+
+    # the utm medium
+    # @return [String]
+    attr_accessor :utm_medium
+
+    # the utm campaign
+    # @return [String]
+    attr_accessor :utm_campaign
+
+    # the utm term
+    # @return [String]
+    attr_accessor :utm_term
+
+    # the utm content
+    # @return [String]
+    attr_accessor :utm_content
+
+    # the referrer
+    # @return [String]
+    attr_accessor :referrer
+
+    # the referring domain
+    # @return [String]
+    attr_accessor :referring_domain
+
+    # the gclid
+    # @return [String]
+    attr_accessor :gclid
+
+    # A mapping from model property names to API property names
+    def self.names
+      if @hash.nil?
+        @hash = {}
+        @hash["utm_source"] = "utm_source"
+        @hash["utm_medium"] = "utm_medium"
+        @hash["utm_campaign"] = "utm_campaign"
+        @hash["utm_term"] = "utm_term"
+        @hash["utm_content"] = "utm_content"
+        @hash["referrer"] = "referrer"
+        @hash["referring_domain"] = "referring_domain"
+        @hash["gclid"] = "gclid"
+      end
+      @hash
+    end
+
+    def initialize(utm_source = nil,
+            utm_medium = nil,
+            utm_campaign = nil,
+            utm_term = nil,
+            utm_content = nil,
+            referrer = nil,
+            referring_domain = nil,
+            gclid = nil)
+      @utm_source = utm_source
+      @utm_medium = utm_medium
+      @utm_campaign = utm_campaign
+      @utm_term = utm_term
+      @utm_content = utm_content
+      @referrer = referrer
+      @referring_domain = referring_domain
+      @gclid = gclid
+    end
+
+    # Creates an instance of the object from a hash
+    def self.from_hash(hash)
+      if hash == nil
+        nil
+      else
+        # Extract variables from the hash
+        utm_source = hash["utm_source"]
+        utm_medium = hash["utm_medium"]
+        utm_campaign = hash["utm_campaign"]
+        utm_term = hash["utm_term"]
+        utm_content = hash["utm_content"]
+        referrer = hash["referrer"]
+        referring_domain = hash["referring_domain"]
+        gclid = hash["gclid"]
+
+        # Create object from extracted values
+        CampaignModel.new(utm_source,
+                        utm_medium,
+                        utm_campaign,
+                        utm_term,
+                        utm_content,
+                        referrer,
+                        referring_domain,
+                        gclid)
+      end
+    end
+  end
+end

data/lib/moesif_api/models/company_model.rb

@@ -28,6 +28,10 @@ module MoesifApi
     # @return [Object]
     attr_accessor :metadata
 
+    # campaign object
+    # @return [CampaignModel]
+    attr_accessor :campaign
+
     # A mapping from model property names to API property names
     def self.names
       if @hash.nil?
@@ -38,6 +42,7 @@ module MoesifApi
         @hash["session_token"] = "session_token"
         @hash["company_domain"] = "company_domain"
         @hash["metadata"] = "metadata"
+        @hash["campaign"] = "campaign"
       end
       @hash
     end
@@ -47,13 +52,15 @@ module MoesifApi
                    ip_address = nil,
                    session_token = nil,
                    company_domain = nil,
-                   metadata = nil)
+                   metadata = nil,
+                   campaign = nil)
       @company_id = company_id
       @modified_time = modified_time
       @ip_address = ip_address
       @session_token = session_token
       @company_domain = company_domain
       @metadata = metadata
+      @campaign = campaign
     end
 
     # Creates an instance of the object from a hash
@@ -68,6 +75,7 @@ module MoesifApi
         session_token = hash["session_token"]
         company_domain = hash["company_domain"]
         metadata = hash["metadata"]
+        campaign = CampaignModel.from_hash(hash["campaign"]) if hash["campaign"]
 
         # Create object from extracted values
         CompanyModel.new(company_id,
@@ -75,7 +83,8 @@ module MoesifApi
                       ip_address,
                       session_token,
                       company_domain,
-                      metadata)
+                      metadata,
+                      campaign)
       end
     end
   end

data/lib/moesif_api/models/event_model.rb

@@ -30,6 +30,14 @@ module MoesifApi
     # @return [Hash]
     attr_accessor :metadata
 
+    # direction string
+    # @return [String]
+    attr_accessor :direction
+
+    # Weight of an API call
+    # @return [Integer]
+    attr_accessor :weight
+
     # A mapping from model property names to API property names
     def self.names
       if @hash.nil?
@@ -41,6 +49,8 @@ module MoesifApi
         @hash["user_id"] = "user_id"
         @hash["company_id"] = "company_id"
         @hash["metadata"] = "metadata"
+        @hash["direction"] = "direction"
+        @hash["weight"] = "weight"
       end
       @hash
     end
@@ -51,7 +61,9 @@ module MoesifApi
                    tags = nil,
                    user_id = nil,
                    company_id = nil,
-                   metadata = nil)
+                   metadata = nil,
+                   direction = nil,
+                   weight = nil)
       @request = request
       @response = response
       @session_token = session_token
@@ -59,6 +71,8 @@ module MoesifApi
       @user_id = user_id
       @company_id = company_id
       @metadata = metadata
+      @direction = direction
+      @weight = weight
     end
 
     # Creates an instance of the object from a hash
@@ -74,6 +88,8 @@ module MoesifApi
         user_id = hash["user_id"]
         company_id = hash["company_id"]
         metadata = hash["metadata"]
+        direction = hash["direction"]
+        weight = hash["weight"]
 
         # Create object from extracted values
         EventModel.new(request,
@@ -82,7 +98,9 @@ module MoesifApi
                              tags,
                              user_id,
                              company_id,
-                             metadata)
+                             metadata,
+                             direction,
+                             weight)
       end
     end
   end

data/lib/moesif_api/models/user_model.rb

@@ -32,6 +32,10 @@ module MoesifApi
     # @return [Object]
     attr_accessor :metadata
 
+    # campaign object
+    # @return [CampaignModel]
+    attr_accessor :campaign
+
     # A mapping from model property names to API property names
     def self.names
       if @hash.nil?
@@ -43,6 +47,7 @@ module MoesifApi
         @hash["session_token"] = "session_token"
         @hash["user_agent_string"] = "user_agent_string"
         @hash["metadata"] = "metadata"
+        @hash["campaign"] = "campaign"
       end
       @hash
     end
@@ -53,7 +58,8 @@ module MoesifApi
                    ip_address = nil,
                    session_token = nil,
                    user_agent_string = nil,
-                   metadata = nil)
+                   metadata = nil,
+                   campaign = nil)
       @user_id = user_id
       @company_id = company_id
       @modified_time = modified_time
@@ -61,6 +67,7 @@ module MoesifApi
       @session_token = session_token
       @user_agent_string = user_agent_string
       @metadata = metadata
+      @campaign = campaign
     end
 
     # Creates an instance of the object from a hash
@@ -76,6 +83,7 @@ module MoesifApi
         session_token = hash["session_token"]
         user_agent_string = hash["user_agent_string"]
         metadata = hash["metadata"]
+        campaign = CampaignModel.from_hash(hash["campaign"]) if hash["campaign"]
 
         # Create object from extracted values
         UserModel.new(user_id,
@@ -84,7 +92,8 @@ module MoesifApi
                       ip_address,
                       session_token,
                       user_agent_string,
-                      metadata)
+                      metadata,
+                      campaign)
       end
     end
   end

data/test/controllers/test_api_controller.rb

@@ -113,11 +113,16 @@ class ApiControllerTests < ControllerTestBase
       '"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
     user_model.user_id = "12345"
     user_model.company_id = "67890"
     user_model.metadata = metadata
+    user_model.campaign = campaign_model
 
     # Perform the API call through the SDK function
     self.class.controller.update_user(user_model)
@@ -171,9 +176,14 @@ class ApiControllerTests < ControllerTestBase
   def test_update_company()
     # Parameters for the API call
 
+    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
     company_model.company_id = "12345"
+    company_model.campaign = campaign_model
 
     # Perform the API call through the SDK function
     self.class.controller.update_company(company_model)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: moesif_api
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.13
 platform: ruby
 authors:
 - Moesif, Inc
 - Derric Gilling
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2021-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -60,10 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- LICENSE~
 - README.md
 - lib/moesif_api.rb
 - lib/moesif_api/api_helper.rb
 - lib/moesif_api/configuration.rb
+- lib/moesif_api/configuration.rb~
 - lib/moesif_api/controllers/api_controller.rb
 - lib/moesif_api/controllers/base_controller.rb
 - lib/moesif_api/controllers/health_controller.rb
@@ -76,6 +78,7 @@ files:
 - lib/moesif_api/http/http_response.rb
 - lib/moesif_api/http/unirest_client.rb
 - lib/moesif_api/models/base_model.rb
+- lib/moesif_api/models/campaign_model.rb
 - lib/moesif_api/models/company_model.rb
 - lib/moesif_api/models/event_model.rb
 - lib/moesif_api/models/event_request_model.rb
@@ -91,7 +94,7 @@ homepage: https://moesif.com
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: moesif_api
 test_files: []