moesif_rack 1.3.9 → 1.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5cd1d13df1da4833bc55a10462721bdabae0a09cb6d8ab6398c378bd546975
-  data.tar.gz: ab2e62d3c6c4f76532bf8dbad38b4fdb2747413897e72228dc1ac23265d134c9
+  metadata.gz: 5449e55b2da865cdc2bd4d52eef977b45db5a3e7648ee18f67f93795bf1fcd46
+  data.tar.gz: 930c9fb3a9181eec3b12d5aea8073c12646f94f77d16638dfa0422107b8000f3
 SHA512:
-  metadata.gz: f42082b67c965208ba8d13bb2552a2b44ee08c3930ed58825838804431bfda1655acbcd82099ea0d0baec4573e31c0db4dc91dc95a7c2e7b5f23fb401e5f7076
-  data.tar.gz: ac4f6d15abbb9cce97e8206a158666883a002575d9921b4c64c54a3f38f384034e189c5dbb26ae44ac6636b66fb8a842fee1ad02b09e3c59b9fd9408815f813e
+  metadata.gz: 13012b377dac7ca5da3dcaf1d50ef97e71f6515df9e7f94e61b39746b4f29b134efcbc87eaafcb8dcd04dd67e0e052d8f0c5e9c77dd6ea20a7d997f50df3feb6
+  data.tar.gz: d7499b20fa602a2dd1bde29099b5b11755f36421f79c32f59fc1e1aa7f0e1dce7794b7ed1ca703c74ff07f040492b3ecc12f038eb3f52625348b13ae9becb2ec

data/README.md

@@ -126,12 +126,10 @@ Optional.
 identify_user is a Proc that takes env, headers, and body as arguments and returns a user_id string. This helps us attribute requests to unique users. Even though Moesif can automatically retrieve the user_id without this, this is highly recommended to ensure accurate attribution.
 
 ```ruby
-
 moesif_options['identify_user'] = Proc.new { |env, headers, body|
 
-  #snip
-
-  'my_user_id'
+  # Add your custom code that returns a string for user id
+  '12345'
 }
 
 ```
@@ -145,13 +143,24 @@ identify_company is a Proc that takes env, headers, and body as arguments and re
 
 moesif_options['identify_company'] = Proc.new { |env, headers, body|
 
-  #snip
-
-  'my_company_id'
+  # Add your custom code that returns a string for company id
+  '67890'
 }
 
 ```
 
+#### __`identify_session`__
+
+Optional. A Proc that takes env, headers, body and returns a string.
+
+```ruby
+
+moesif_options['identify_session'] = Proc.new { |env, headers, body|
+    # Add your custom code that returns a string for session/API token
+    'XXXXXXXXX'
+}
+```
+
 #### __`get_metadata`__
 
 Optional.
@@ -162,31 +171,15 @@ metadata to this event.
 ```ruby
 
 moesif_options['get_metadata'] = Proc.new { |env, headers, body|
-
-  #snip
+  # Add your custom code that returns a dictionary
   value = {
-      'foo'  => 'abc',
-      'bar'  => '123'
+      'datacenter'  => 'westus',
+      'deployment_version'  => 'v1.2.3'
   }
-
   value
 }
 ```
 
-#### __`identify_session`__
-
-Optional. A Proc that takes env, headers, body and returns a string.
-
-```ruby
-
-moesif_options['identify_session'] = Proc.new { |env, headers, body|
-
-  #snip
-
-  'the_session_token'
-}
-
-```
 
 #### __`mask_data`__
 
@@ -196,9 +189,8 @@ With mask_data, you can make modifications to headers or body of the event befor
 ```ruby
 
 moesif_options['mask_data'] = Proc.new { |event_model|
-
-  #snip
-
+  # Add your custom code that returns a event_model after modifying any fields
+  event_model.response.body.password = nil
   event_model
 }
 
@@ -213,9 +205,7 @@ Optional. A Proc that takes env, headers, body and returns a boolean.
 ```ruby
 
 moesif_options['skip'] = Proc.new { |env, headers, body|
-
-  #snip
-
+  # Add your custom code that returns true to skip logging the API call
   false
 }
 
@@ -232,7 +222,7 @@ Optional. Boolean. Default false. If true, it will print out debug messages. In
 
 Optional. Boolean. Default true. If false, will not log request and response body to Moesif.
 
-#### __`capture_outoing_requests`__
+#### __`capture_outgoing_requests`__
 Optional. boolean, Default `false`. Set to `true` to capture all outgoing API calls from your app to third parties like Stripe, Github or to your own dependencies while using [Net::HTTP](https://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html) package. The options below is applied to outgoing API calls. When the request is outgoing, for options functions that take request and response as input arguments, the request and response objects passed in are [Request](https://www.rubydoc.info/stdlib/net/Net/HTTPRequest) request and [Response](https://www.rubydoc.info/stdlib/net/Net/HTTPResponse) response objects.
 
 
@@ -245,9 +235,8 @@ identify_user_outgoing is a Proc that takes request and response as arguments an
 
 moesif_options['identify_user_outgoing'] = Proc.new { |request, response|
 
-  #snip
-
-  'the_user_id'
+  # Add your custom code that returns a string for user id
+  '12345'
 }
 
 ```
@@ -261,9 +250,8 @@ identify_company_outgoing is a Proc that takes request and response as arguments
 
 moesif_options['identify_company_outgoing'] = Proc.new { |request, response|
 
-  #snip
-
-  'the_company_id'
+  # Add your custom code that returns a string for company id
+  '67890'
 }
 
 ```
@@ -279,12 +267,11 @@ metadata to this event.
 
 moesif_options['get_metadata_outgoing'] = Proc.new { |request, response|
 
-  #snip
+  # Add your custom code that returns a dictionary
   value = {
-      'foo'  => 'abc',
-      'bar'  => '123'
+      'datacenter'  => 'westus',
+      'deployment_version'  => 'v1.2.3'
   }
-
   value
 }
 ```
@@ -297,9 +284,8 @@ Optional. A Proc that takes request, response and returns a string.
 
 moesif_options['identify_session_outgoing'] = Proc.new { |request, response|
 
-  #snip
-
-  'the_session_token'
+    # Add your custom code that returns a string for session/API token
+    'XXXXXXXXX'
 }
 
 ```
@@ -312,8 +298,7 @@ Optional. A Proc that takes request, response and returns a boolean. If `true` w
 
 moesif_options['skip_outgoing'] = Proc.new{ |request, response|
 
-  #snip
-
+  # Add your custom code that returns true to skip logging the API call
   false
 }
 
@@ -328,8 +313,8 @@ With mask_data_outgoing, you can make modifications to headers or body of the ev
 
 moesif_options['mask_data_outgoing'] = Proc.new { |event_model|
 
-  #snip
-
+  # Add your custom code that returns a event_model after modifying any fields
+  event_model.response.body.password = nil
   event_model
 }
 
@@ -341,32 +326,51 @@ Optional. Boolean. Default true. If false, will not log request and response bod
 
 ## Update User
 
-### update_user method
-A method is attached to the moesif middleware object to update the user profile or metadata.
-The metadata field can be any custom data you want to set on the user. The `user_id` field is required.
+### Update a Single User
+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 `user_id` field is required.
+This method is a convenient helper that calls the Moesif API lib.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-a-user).
 
 ```ruby
-metadata = JSON.parse('{'\
-      '"email": "testrubyapi@user.com",'\
-      '"name": "ruby api user",'\
-      '"custom": "testdata"'\
-    '}')
-
-campaign_model = {"utm_source" => "Newsletter",
-                  "utm_medium" => "Email"}
+metadata => {
+  :email => 'john@acmeinc.com',
+  :first_name => 'John',
+  :last_name => 'Doe',
+  :title => 'Software Engineer',
+  :salesInfo => {
+      :stage => 'Customer',
+      :lifetime_value => 24000,
+      :accountOwner => 'mary@contoso.com',
+  }
+}
 
-user_model = { "user_id" => "12345",
-                "company_id" => "67890",
-                "modified_time" => Time.now.utc.iso8601, 
-                "metadata" => metadata,
-                "campaign" => campaign_model }
+# 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 = 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 = 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 = MoesifRack::MoesifMiddleware.new(@app, @options).update_user(user_model)
 ```
 
-### update_users_batch method
-A method is attached to the moesif middleware object to update the users profile or metadata in batch.
-The metadata field can be any custom data you want to set on the user. The `user_id` field is required.
+### Update Users in Batch
+Similar to update_user, but used to update a list of users in one batch. 
+Only the `user_id` field is required.
+This method is a convenient helper that calls the Moesif API lib.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-users-in-batch).
 
 ```ruby
 metadata = JSON.parse('{'\
@@ -375,49 +379,88 @@ metadata = JSON.parse('{'\
       '"custom": "testdata"'\
     '}')
 
-user_models = []
-
-user_model_A = { "user_id" => "12345",
-                "company_id" => "67890", 
-                "modified_time" => Time.now.utc.iso8601, 
-                "metadata" => metadata }
-
-user_model_B = { "user_id" => "1234", 
-                "company_id" => "6789",
-                "modified_time" => Time.now.utc.iso8601, 
-                "metadata" => metadata }
+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',
+  }
+}
 
-user_models << user_model_A << user_model_B
-response = MoesifRack::MoesifMiddleware.new(@app, @options).update_users_batch(user_models)
+# 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 = 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 = 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
+
+response = MoesifRack::MoesifMiddleware.new(@app, @options).update_users_batch(users)
 ```
 
 ## Update Company
 
-### update_company method
-A method is attached to the moesif middleware object to update the company profile or metadata.
-The metadata field can be any custom data you want to set on the company. The `company_id` field is required.
+### Update a Single Company
+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 `company_id` field is required.
+This method is a convenient helper that calls the Moesif API lib.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-a-company).
 
 ```ruby
-metadata = JSON.parse('{'\
-      '"email": "testrubyapi@company.com",'\
-      '"name": "ruby api company",'\
-      '"custom": "testdata"'\
-    '}')
-
-campaign_model = {"utm_source" => "Adwords",
-                  "utm_medium" => "Twitter"}
+metadata => {
+  :org_name => 'Acme, Inc',
+  :plan_name => 'Free',
+  :deal_stage => 'Lead',
+  :mrr => 24000,
+  :demographics => {
+      :alexa_ranking => 500000,
+      :employee_count => 47
+  }
+}
 
-company_model = { "company_id" => "12345", 
-                  "company_domain" => "acmeinc.com",
-                  "metadata" => metadata,
-                  "campaign" => campaign_model }
+# 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 = 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 = 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 = MoesifRack::MoesifMiddleware.new(@app, @options).update_company(company_model)
 ```
 
-### update_companies_batch method
-A method is attached to the moesif middleware object to update the companies profile or metadata in batch.
-The metadata field can be any custom data you want to set on the company. The `company_id` field is required.
+### Update Companies in Batch
+Similar to update_company, but used to update a list of companies in one batch. 
+Only the `company_id` field is required.
+This method is a convenient helper that calls the Moesif API lib.
+For details, visit the [Ruby API Reference](https://www.moesif.com/docs/api?ruby#update-companies-in-batch).
 
 ```ruby
 metadata = JSON.parse('{'\
@@ -426,18 +469,38 @@ metadata = JSON.parse('{'\
       '"custom": "testdata"'\
     '}')
 
-company_models = []
+companies = []
 
-company_model_A = { "company_id" => "12345",
-                    "company_domain" => "nowhere.com", 
-                "metadata" => metadata }
-
-company_model_B = { "company_id" => "67890",
-                    "company_domain" => "acmeinc.com",
-                "metadata" => metadata }
+metadata => {
+  :org_name => 'Acme, Inc',
+  :plan_name => 'Free',
+  :deal_stage => 'Lead',
+  :mrr => 24000,
+  :demographics => {
+      :alexa_ranking => 500000,
+      :employee_count => 47
+  }
+}
 
-company_models << company_model_A << company_model_B
-response = MoesifRack::MoesifMiddleware.new(@app, @options).update_companies_batch(company_models)
+# 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 = 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 = 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
+response = MoesifRack::MoesifMiddleware.new(@app, @options).update_companies_batch(companies)
 ```
 
 ## How to test

data/lib/moesif_rack/moesif_middleware.rb

@@ -45,7 +45,8 @@ module MoesifRack
         end
       end
       @capture_outoing_requests = options['capture_outoing_requests']
-      if @capture_outoing_requests
+      @capture_outgoing_requests = options['capture_outgoing_requests']
+      if @capture_outoing_requests || @capture_outgoing_requests
         if @debug
           puts 'Start Capturing outgoing requests'
         end

data/test/moesif_rack_test.rb

@@ -10,7 +10,7 @@ class MoesifRackTest < Test::Unit::TestCase
     @options = { 'application_id' => 'Your Moesif Application Id',
     'debug' => true,
     'disable_transaction_id' => true,
-    'capture_outoing_requests' => true,
+    'capture_outgoing_requests' => true,
     'get_metadata' => Proc.new {|request, response|
       {
         'foo'  => 'abc',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.3.10
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2019-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit