moesif_api 1.2.10 → 1.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43981a5b44ddf9cbc3b2226ebd30a418210bccc073c6a01267f9ce230a2922d
-  data.tar.gz: c57f5863e79923cbb9d63b857016686284d410dfe700f8dfc8d08e0e22caf8bd
+  metadata.gz: c4c04a384626a3dc2b02d2e7f0ab9737dc50d78cb2f564f57b6a9ca4f478a516
+  data.tar.gz: cbe67532493cade527fcbc0909d54d53e29e738b9f7419c9c4e9f0b864b4b99d
 SHA512:
-  metadata.gz: 840305f5334181f9d6e0ac53539d014f71e7a27fe4e5af65da326595064965ca9c6d31c0cd85a2c2c6cb1c7c508af84b75d462dd603d71f7378e46c67010a14a
-  data.tar.gz: 003be8e28d2b6b4b251523550e8d164309876caa46cedf513ea1b781edb8d14c2ae4c38982b6a7c0bdc957dc1be107de09215d87611e03e4a3e12659daade576
+  metadata.gz: 0bbe517499c6d03fe02dfbd00b802ad52ef312fb1f50e6673c37067c0faf241afbe439235433904153cc0a0647bb126d14731cdec97b7be85b1b6a4f9f2b9ae0
+  data.tar.gz: 8e6ec1b3f88515a00b3a1cc873271fa3da87b55feb4b834a5fa1a1a1d4687d89bb13621f6160def2fb157b502469817ab6d38026db1e5e05dd8072697413c5a6

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/README.md

@@ -114,62 +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"'\
-'}')
-
-campaign_model = CampaignModel.new()
-campaign_model.utm_source = "Newsletter"
-campaign_model.utm_medium = "Email"
+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
-user_model.campaign = campaign_model
+## 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"'\
-'}')
 
-campaign_model = CampaignModel.new()
-campaign_model.utm_source = "Adwords"
-campaign_model.utm_medium = "Twitter"
+## Update Companies in Batch
 
-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
+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).
 
-# Perform the API call through the SDK function
-response = api_controller.update_company(company_model)
+```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:
@@ -196,7 +311,7 @@ Note: You will need to have internet access for this step.
 You can test the generated SDK and the server with automatically generated test
 cases as follows:
 
-  1. Add your Moesif application id to 'test/controllers/controller_test_base'. You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Top Right Menu_ -> _Installation_
+  1. Add your Moesif application id to 'test/controllers/controller_test_base'. You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Bottom Left Menu_ -> _Installation_
   2. From terminal/cmd navigate to the root directory of the SDK.
   3. Invoke: `bundle exec rake`
 

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.10'
+    @version = '1.2.12'
 
     # create the getters and setters
     class << self

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/event_model.rb

@@ -34,6 +34,10 @@ module MoesifApi
     # @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?
@@ -46,6 +50,7 @@ module MoesifApi
         @hash["company_id"] = "company_id"
         @hash["metadata"] = "metadata"
         @hash["direction"] = "direction"
+        @hash["weight"] = "weight"
       end
       @hash
     end
@@ -57,7 +62,8 @@ module MoesifApi
                    user_id = nil,
                    company_id = nil,
                    metadata = nil,
-                   direction = nil)
+                   direction = nil,
+                   weight = nil)
       @request = request
       @response = response
       @session_token = session_token
@@ -66,6 +72,7 @@ module MoesifApi
       @company_id = company_id
       @metadata = metadata
       @direction = direction
+      @weight = weight
     end
 
     # Creates an instance of the object from a hash
@@ -82,6 +89,7 @@ module MoesifApi
         company_id = hash["company_id"]
         metadata = hash["metadata"]
         direction = hash["direction"]
+        weight = hash["weight"]
 
         # Create object from extracted values
         EventModel.new(request,
@@ -91,7 +99,8 @@ module MoesifApi
                              user_id,
                              company_id,
                              metadata,
-                             direction)
+                             direction,
+                             weight)
       end
     end
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: moesif_api
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.2.14
 platform: ruby
 authors:
 - Moesif, Inc
 - Derric Gilling
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -17,33 +17,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.5
-  type: :runtime
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: moesif_unirest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: 1.1.6
 - !ruby/object:Gem::Dependency
   name: json_mapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
   type: :runtime
@@ -51,6 +60,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.1
 description: Collection/Data Ingestion API
@@ -94,13 +106,13 @@ homepage: https://moesif.com
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -109,9 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: moesif_api
 test_files: []