moesif_api 1.2.8 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c634394e829a513470949c40b4bc20708a9964226230dbaa3426cbde75c2e50
-  data.tar.gz: f9d9c8d20b406e3c7aeb7babb6a3db9836a45f27bda57140c60a25a6a534c295
+  metadata.gz: b1f73da8a0a7ab951367a0bdeca1043aa8daaf0d64991967257dd58aa1543bf2
+  data.tar.gz: d4f70c81fd5f3b6e7a7b8e37663be2f3370fb8064e8de5ecb2e4c7c042713acc
 SHA512:
-  metadata.gz: b18941a1bff1df72bdd28125125300c497bf733abb3b0d5ca164e180b1e7b09e6379e716a93a39ce1af2580fe1e355ede89a012fdbebddf946e7d061d388860d
-  data.tar.gz: ad384326772cf63e2e18a5abc7cdf1ccc57e4371bf42bcbead3ec14db3ddea51638dcc5c881c7e8f31056f1204cb08d7c679a56a43794f892e42cf4d311f35b7
+  metadata.gz: b17284c40ccadd2859b73d71af0bfdb71b23bef6b05018ccd210788d2cae0ac06ac00e6b9f1b79c5f35917fc4edf795edd09bbe93e64b4219f73df4f51533a03
+  data.tar.gz: 02d6c4aaf81b237347104567f8f9c5388ae16416f93523797a650acbe788f5fe266e0e20f9f52650fc38c3a15b2cedf435929c2c64066e10e11ce078b65599fc

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,7 +114,7 @@ event_model.metadata = metadata
 response = api_controller.create_event(event_model)
 ```
 
-### update user
+### Update User
 
 You can also update the metadata for each user. The only required field is user_id
 
@@ -121,18 +128,23 @@ metadata = JSON.parse('{'\
   '"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
+### Update Company
 
 You can also update the metadata for each company. The only required field is company_id
 
@@ -146,10 +158,15 @@ metadata = JSON.parse('{'\
   '"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)

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.9'
 
     # 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/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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_api
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2019-11-15 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
@@ -106,7 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: moesif_api