moesif_api 1.2.8 → 1.2.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE~ +216 -0
- data/README.md +23 -6
- data/lib/moesif_api.rb +1 -0
- data/lib/moesif_api/configuration.rb +1 -1
- data/lib/moesif_api/configuration.rb~ +20 -0
- data/lib/moesif_api/models/campaign_model.rb +98 -0
- data/lib/moesif_api/models/company_model.rb +11 -2
- data/lib/moesif_api/models/user_model.rb +11 -2
- data/test/controllers/test_api_controller.rb +10 -0
- metadata +7 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b1f73da8a0a7ab951367a0bdeca1043aa8daaf0d64991967257dd58aa1543bf2
|
4
|
+
data.tar.gz: d4f70c81fd5f3b6e7a7b8e37663be2f3370fb8064e8de5ecb2e4c7c042713acc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b17284c40ccadd2859b73d71af0bfdb71b23bef6b05018ccd210788d2cae0ac06ac00e6b9f1b79c5f35917fc4edf795edd09bbe93e64b4219f73df4f51533a03
|
7
|
+
data.tar.gz: 02d6c4aaf81b237347104567f8f9c5388ae16416f93523797a650acbe788f5fe266e0e20f9f52650fc38c3a15b2cedf435929c2c64066e10e11ce078b65599fc
|
data/LICENSE~
ADDED
@@ -0,0 +1,216 @@
|
|
1
|
+
Copyright (c) 2018 Moesif, Inc
|
2
|
+
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
you may not use this file except in compliance with the License.
|
5
|
+
You may obtain a copy of the License at
|
6
|
+
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
See the License for the specific language governing permissions and
|
13
|
+
limitations under the License.
|
14
|
+
|
15
|
+
|
16
|
+
Apache License
|
17
|
+
Version 2.0, January 2004
|
18
|
+
http://www.apache.org/licenses/
|
19
|
+
|
20
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
21
|
+
|
22
|
+
1. Definitions.
|
23
|
+
|
24
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
25
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
26
|
+
|
27
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
28
|
+
the copyright owner that is granting the License.
|
29
|
+
|
30
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
31
|
+
other entities that control, are controlled by, or are under common
|
32
|
+
control with that entity. For the purposes of this definition,
|
33
|
+
"control" means (i) the power, direct or indirect, to cause the
|
34
|
+
direction or management of such entity, whether by contract or
|
35
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
36
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
37
|
+
|
38
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
39
|
+
exercising permissions granted by this License.
|
40
|
+
|
41
|
+
"Source" form shall mean the preferred form for making modifications,
|
42
|
+
including but not limited to software source code, documentation
|
43
|
+
source, and configuration files.
|
44
|
+
|
45
|
+
"Object" form shall mean any form resulting from mechanical
|
46
|
+
transformation or translation of a Source form, including but
|
47
|
+
not limited to compiled object code, generated documentation,
|
48
|
+
and conversions to other media types.
|
49
|
+
|
50
|
+
"Work" shall mean the work of authorship, whether in Source or
|
51
|
+
Object form, made available under the License, as indicated by a
|
52
|
+
copyright notice that is included in or attached to the work
|
53
|
+
(an example is provided in the Appendix below).
|
54
|
+
|
55
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
56
|
+
form, that is based on (or derived from) the Work and for which the
|
57
|
+
editorial revisions, annotations, elaborations, or other modifications
|
58
|
+
represent, as a whole, an original work of authorship. For the purposes
|
59
|
+
of this License, Derivative Works shall not include works that remain
|
60
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
61
|
+
the Work and Derivative Works thereof.
|
62
|
+
|
63
|
+
"Contribution" shall mean any work of authorship, including
|
64
|
+
the original version of the Work and any modifications or additions
|
65
|
+
to that Work or Derivative Works thereof, that is intentionally
|
66
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
67
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
68
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
69
|
+
means any form of electronic, verbal, or written communication sent
|
70
|
+
to the Licensor or its representatives, including but not limited to
|
71
|
+
communication on electronic mailing lists, source code control systems,
|
72
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
73
|
+
Licensor for the purpose of discussing and improving the Work, but
|
74
|
+
excluding communication that is conspicuously marked or otherwise
|
75
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
76
|
+
|
77
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
78
|
+
on behalf of whom a Contribution has been received by Licensor and
|
79
|
+
subsequently incorporated within the Work.
|
80
|
+
|
81
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
82
|
+
this License, each Contributor hereby grants to You a perpetual,
|
83
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
84
|
+
copyright license to reproduce, prepare Derivative Works of,
|
85
|
+
publicly display, publicly perform, sublicense, and distribute the
|
86
|
+
Work and such Derivative Works in Source or Object form.
|
87
|
+
|
88
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
89
|
+
this License, each Contributor hereby grants to You a perpetual,
|
90
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
91
|
+
(except as stated in this section) patent license to make, have made,
|
92
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
93
|
+
where such license applies only to those patent claims licensable
|
94
|
+
by such Contributor that are necessarily infringed by their
|
95
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
96
|
+
with the Work to which such Contribution(s) was submitted. If You
|
97
|
+
institute patent litigation against any entity (including a
|
98
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
99
|
+
or a Contribution incorporated within the Work constitutes direct
|
100
|
+
or contributory patent infringement, then any patent licenses
|
101
|
+
granted to You under this License for that Work shall terminate
|
102
|
+
as of the date such litigation is filed.
|
103
|
+
|
104
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
105
|
+
Work or Derivative Works thereof in any medium, with or without
|
106
|
+
modifications, and in Source or Object form, provided that You
|
107
|
+
meet the following conditions:
|
108
|
+
|
109
|
+
(a) You must give any other recipients of the Work or
|
110
|
+
Derivative Works a copy of this License; and
|
111
|
+
|
112
|
+
(b) You must cause any modified files to carry prominent notices
|
113
|
+
stating that You changed the files; and
|
114
|
+
|
115
|
+
(c) You must retain, in the Source form of any Derivative Works
|
116
|
+
that You distribute, all copyright, patent, trademark, and
|
117
|
+
attribution notices from the Source form of the Work,
|
118
|
+
excluding those notices that do not pertain to any part of
|
119
|
+
the Derivative Works; and
|
120
|
+
|
121
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
122
|
+
distribution, then any Derivative Works that You distribute must
|
123
|
+
include a readable copy of the attribution notices contained
|
124
|
+
within such NOTICE file, excluding those notices that do not
|
125
|
+
pertain to any part of the Derivative Works, in at least one
|
126
|
+
of the following places: within a NOTICE text file distributed
|
127
|
+
as part of the Derivative Works; within the Source form or
|
128
|
+
documentation, if provided along with the Derivative Works; or,
|
129
|
+
within a display generated by the Derivative Works, if and
|
130
|
+
wherever such third-party notices normally appear. The contents
|
131
|
+
of the NOTICE file are for informational purposes only and
|
132
|
+
do not modify the License. You may add Your own attribution
|
133
|
+
notices within Derivative Works that You distribute, alongside
|
134
|
+
or as an addendum to the NOTICE text from the Work, provided
|
135
|
+
that such additional attribution notices cannot be construed
|
136
|
+
as modifying the License.
|
137
|
+
|
138
|
+
You may add Your own copyright statement to Your modifications and
|
139
|
+
may provide additional or different license terms and conditions
|
140
|
+
for use, reproduction, or distribution of Your modifications, or
|
141
|
+
for any such Derivative Works as a whole, provided Your use,
|
142
|
+
reproduction, and distribution of the Work otherwise complies with
|
143
|
+
the conditions stated in this License.
|
144
|
+
|
145
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
146
|
+
any Contribution intentionally submitted for inclusion in the Work
|
147
|
+
by You to the Licensor shall be under the terms and conditions of
|
148
|
+
this License, without any additional terms or conditions.
|
149
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
150
|
+
the terms of any separate license agreement you may have executed
|
151
|
+
with Licensor regarding such Contributions.
|
152
|
+
|
153
|
+
6. Trademarks. This License does not grant permission to use the trade
|
154
|
+
names, trademarks, service marks, or product names of the Licensor,
|
155
|
+
except as required for reasonable and customary use in describing the
|
156
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
157
|
+
|
158
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
159
|
+
agreed to in writing, Licensor provides the Work (and each
|
160
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
161
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
162
|
+
implied, including, without limitation, any warranties or conditions
|
163
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
164
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
165
|
+
appropriateness of using or redistributing the Work and assume any
|
166
|
+
risks associated with Your exercise of permissions under this License.
|
167
|
+
|
168
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
169
|
+
whether in tort (including negligence), contract, or otherwise,
|
170
|
+
unless required by applicable law (such as deliberate and grossly
|
171
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
172
|
+
liable to You for damages, including any direct, indirect, special,
|
173
|
+
incidental, or consequential damages of any character arising as a
|
174
|
+
result of this License or out of the use or inability to use the
|
175
|
+
Work (including but not limited to damages for loss of goodwill,
|
176
|
+
work stoppage, computer failure or malfunction, or any and all
|
177
|
+
other commercial damages or losses), even if such Contributor
|
178
|
+
has been advised of the possibility of such damages.
|
179
|
+
|
180
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
181
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
182
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
183
|
+
or other liability obligations and/or rights consistent with this
|
184
|
+
License. However, in accepting such obligations, You may act only
|
185
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
186
|
+
of any other Contributor, and only if You agree to indemnify,
|
187
|
+
defend, and hold each Contributor harmless for any liability
|
188
|
+
incurred by, or claims asserted against, such Contributor by reason
|
189
|
+
of your accepting any such warranty or additional liability.
|
190
|
+
|
191
|
+
END OF TERMS AND CONDITIONS
|
192
|
+
|
193
|
+
APPENDIX: How to apply the Apache License to your work.
|
194
|
+
|
195
|
+
To apply the Apache License to your work, attach the following
|
196
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
197
|
+
replaced with your own identifying information. (Don't include
|
198
|
+
the brackets!) The text should be enclosed in the appropriate
|
199
|
+
comment syntax for the file format. We also recommend that a
|
200
|
+
file or class name and description of purpose be included on the
|
201
|
+
same "printed page" as the copyright notice for easier
|
202
|
+
identification within third-party archives.
|
203
|
+
|
204
|
+
Copyright [yyyy] [name of copyright owner]
|
205
|
+
|
206
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
207
|
+
you may not use this file except in compliance with the License.
|
208
|
+
You may obtain a copy of the License at
|
209
|
+
|
210
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
211
|
+
|
212
|
+
Unless required by applicable law or agreed to in writing, software
|
213
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
214
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
215
|
+
See the License for the specific language governing permissions and
|
216
|
+
limitations under the License.
|
data/README.md
CHANGED
@@ -30,8 +30,15 @@ gem install moesif_api
|
|
30
30
|
|
31
31
|
After having installed the gem, you can easily use the SDK following these steps.
|
32
32
|
|
33
|
-
|
34
|
-
|
33
|
+
Your Moesif Application Id can be found in the [_Moesif Portal_](https://www.moesif.com/).
|
34
|
+
After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps.
|
35
|
+
|
36
|
+
You can always find your Moesif Application Id at any time by logging
|
37
|
+
into the [_Moesif Portal_](https://www.moesif.com/), click on the top right menu,
|
38
|
+
and then clicking _Installation_.
|
39
|
+
|
40
|
+
### Create Event
|
41
|
+
|
35
42
|
```ruby
|
36
43
|
require 'moesif_api'
|
37
44
|
|
@@ -81,7 +88,7 @@ metadata = JSON.parse('{'\
|
|
81
88
|
'}')
|
82
89
|
|
83
90
|
event_req = EventRequestModel.new()
|
84
|
-
event_req.time = "
|
91
|
+
event_req.time = "2019-09-09T04:45:42.914"
|
85
92
|
event_req.uri = "https://api.acmeinc.com/items/reviews/"
|
86
93
|
event_req.verb = "PATCH"
|
87
94
|
event_req.api_version = "1.1.0"
|
@@ -90,7 +97,7 @@ event_req.headers = req_headers
|
|
90
97
|
event_req.body = req_body
|
91
98
|
|
92
99
|
event_rsp = EventResponseModel.new()
|
93
|
-
event_rsp.time = "
|
100
|
+
event_rsp.time = "2019-09-09T04:45:42.914"
|
94
101
|
event_rsp.status = 500
|
95
102
|
event_rsp.headers = rsp_headers
|
96
103
|
event_rsp.body = rsp_body
|
@@ -107,7 +114,7 @@ event_model.metadata = metadata
|
|
107
114
|
response = api_controller.create_event(event_model)
|
108
115
|
```
|
109
116
|
|
110
|
-
###
|
117
|
+
### Update User
|
111
118
|
|
112
119
|
You can also update the metadata for each user. The only required field is user_id
|
113
120
|
|
@@ -121,18 +128,23 @@ metadata = JSON.parse('{'\
|
|
121
128
|
'"custom": "testdata"'\
|
122
129
|
'}')
|
123
130
|
|
131
|
+
campaign_model = CampaignModel.new()
|
132
|
+
campaign_model.utm_source = "Newsletter"
|
133
|
+
campaign_model.utm_medium = "Email"
|
134
|
+
|
124
135
|
user_model = UserModel.new()
|
125
136
|
user_model.modified_time = Time.now.utc.iso8601 # option, default now.
|
126
137
|
user_model.user_id = "12345" #only required field.
|
127
138
|
user_model.company_id = "67890"
|
128
139
|
user_model.metadata = metadata
|
140
|
+
user_model.campaign = campaign_model
|
129
141
|
|
130
142
|
# Perform the API call through the SDK function
|
131
143
|
response = api_controller.update_user(user_model)
|
132
144
|
|
133
145
|
```
|
134
146
|
|
135
|
-
###
|
147
|
+
### Update Company
|
136
148
|
|
137
149
|
You can also update the metadata for each company. The only required field is company_id
|
138
150
|
|
@@ -146,10 +158,15 @@ metadata = JSON.parse('{'\
|
|
146
158
|
'"location": "United States"'\
|
147
159
|
'}')
|
148
160
|
|
161
|
+
campaign_model = CampaignModel.new()
|
162
|
+
campaign_model.utm_source = "Adwords"
|
163
|
+
campaign_model.utm_medium = "Twitter"
|
164
|
+
|
149
165
|
company_model = CompanyModel.new()
|
150
166
|
company_model.modified_time = Time.now.utc.iso8601 # option, default now.
|
151
167
|
company_model.company_id = "12345" #only required field.
|
152
168
|
company_model.metadata = metadata
|
169
|
+
company_model.campaign = campaign_model
|
153
170
|
|
154
171
|
# Perform the API call through the SDK function
|
155
172
|
response = api_controller.update_company(company_model)
|
data/lib/moesif_api.rb
CHANGED
@@ -28,6 +28,7 @@ require_relative 'moesif_api/models/event_response_model.rb'
|
|
28
28
|
require_relative 'moesif_api/models/status_model.rb'
|
29
29
|
require_relative 'moesif_api/models/user_model.rb'
|
30
30
|
require_relative 'moesif_api/models/company_model.rb'
|
31
|
+
require_relative 'moesif_api/models/campaign_model.rb'
|
31
32
|
|
32
33
|
# Controllers
|
33
34
|
require_relative 'moesif_api/controllers/base_controller.rb'
|
@@ -0,0 +1,20 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
module MoesifApi
|
4
|
+
class Configuration
|
5
|
+
# The base Uri for API calls
|
6
|
+
@base_uri = 'https://api.moesif.net'
|
7
|
+
|
8
|
+
# Your Application Id for authentication/authorization
|
9
|
+
@application_id = 'SET_ME'
|
10
|
+
|
11
|
+
@version = '1.2.2'
|
12
|
+
|
13
|
+
# create the getters and setters
|
14
|
+
class << self
|
15
|
+
attr_accessor :base_uri
|
16
|
+
attr_accessor :application_id
|
17
|
+
attr_accessor :version
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,98 @@
|
|
1
|
+
|
2
|
+
module MoesifApi
|
3
|
+
class CampaignModel < BaseModel
|
4
|
+
|
5
|
+
# the utm source
|
6
|
+
# @return [String]
|
7
|
+
attr_accessor :utm_source
|
8
|
+
|
9
|
+
# the utm medium
|
10
|
+
# @return [String]
|
11
|
+
attr_accessor :utm_medium
|
12
|
+
|
13
|
+
# the utm campaign
|
14
|
+
# @return [String]
|
15
|
+
attr_accessor :utm_campaign
|
16
|
+
|
17
|
+
# the utm term
|
18
|
+
# @return [String]
|
19
|
+
attr_accessor :utm_term
|
20
|
+
|
21
|
+
# the utm content
|
22
|
+
# @return [String]
|
23
|
+
attr_accessor :utm_content
|
24
|
+
|
25
|
+
# the referrer
|
26
|
+
# @return [String]
|
27
|
+
attr_accessor :referrer
|
28
|
+
|
29
|
+
# the referring domain
|
30
|
+
# @return [String]
|
31
|
+
attr_accessor :referring_domain
|
32
|
+
|
33
|
+
# the gclid
|
34
|
+
# @return [String]
|
35
|
+
attr_accessor :gclid
|
36
|
+
|
37
|
+
# A mapping from model property names to API property names
|
38
|
+
def self.names
|
39
|
+
if @hash.nil?
|
40
|
+
@hash = {}
|
41
|
+
@hash["utm_source"] = "utm_source"
|
42
|
+
@hash["utm_medium"] = "utm_medium"
|
43
|
+
@hash["utm_campaign"] = "utm_campaign"
|
44
|
+
@hash["utm_term"] = "utm_term"
|
45
|
+
@hash["utm_content"] = "utm_content"
|
46
|
+
@hash["referrer"] = "referrer"
|
47
|
+
@hash["referring_domain"] = "referring_domain"
|
48
|
+
@hash["gclid"] = "gclid"
|
49
|
+
end
|
50
|
+
@hash
|
51
|
+
end
|
52
|
+
|
53
|
+
def initialize(utm_source = nil,
|
54
|
+
utm_medium = nil,
|
55
|
+
utm_campaign = nil,
|
56
|
+
utm_term = nil,
|
57
|
+
utm_content = nil,
|
58
|
+
referrer = nil,
|
59
|
+
referring_domain = nil,
|
60
|
+
gclid = nil)
|
61
|
+
@utm_source = utm_source
|
62
|
+
@utm_medium = utm_medium
|
63
|
+
@utm_campaign = utm_campaign
|
64
|
+
@utm_term = utm_term
|
65
|
+
@utm_content = utm_content
|
66
|
+
@referrer = referrer
|
67
|
+
@referring_domain = referring_domain
|
68
|
+
@gclid = gclid
|
69
|
+
end
|
70
|
+
|
71
|
+
# Creates an instance of the object from a hash
|
72
|
+
def self.from_hash(hash)
|
73
|
+
if hash == nil
|
74
|
+
nil
|
75
|
+
else
|
76
|
+
# Extract variables from the hash
|
77
|
+
utm_source = hash["utm_source"]
|
78
|
+
utm_medium = hash["utm_medium"]
|
79
|
+
utm_campaign = hash["utm_campaign"]
|
80
|
+
utm_term = hash["utm_term"]
|
81
|
+
utm_content = hash["utm_content"]
|
82
|
+
referrer = hash["referrer"]
|
83
|
+
referring_domain = hash["referring_domain"]
|
84
|
+
gclid = hash["gclid"]
|
85
|
+
|
86
|
+
# Create object from extracted values
|
87
|
+
CampaignModel.new(utm_source,
|
88
|
+
utm_medium,
|
89
|
+
utm_campaign,
|
90
|
+
utm_term,
|
91
|
+
utm_content,
|
92
|
+
referrer,
|
93
|
+
referring_domain,
|
94
|
+
gclid)
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
@@ -28,6 +28,10 @@ module MoesifApi
|
|
28
28
|
# @return [Object]
|
29
29
|
attr_accessor :metadata
|
30
30
|
|
31
|
+
# campaign object
|
32
|
+
# @return [CampaignModel]
|
33
|
+
attr_accessor :campaign
|
34
|
+
|
31
35
|
# A mapping from model property names to API property names
|
32
36
|
def self.names
|
33
37
|
if @hash.nil?
|
@@ -38,6 +42,7 @@ module MoesifApi
|
|
38
42
|
@hash["session_token"] = "session_token"
|
39
43
|
@hash["company_domain"] = "company_domain"
|
40
44
|
@hash["metadata"] = "metadata"
|
45
|
+
@hash["campaign"] = "campaign"
|
41
46
|
end
|
42
47
|
@hash
|
43
48
|
end
|
@@ -47,13 +52,15 @@ module MoesifApi
|
|
47
52
|
ip_address = nil,
|
48
53
|
session_token = nil,
|
49
54
|
company_domain = nil,
|
50
|
-
metadata = nil
|
55
|
+
metadata = nil,
|
56
|
+
campaign = nil)
|
51
57
|
@company_id = company_id
|
52
58
|
@modified_time = modified_time
|
53
59
|
@ip_address = ip_address
|
54
60
|
@session_token = session_token
|
55
61
|
@company_domain = company_domain
|
56
62
|
@metadata = metadata
|
63
|
+
@campaign = campaign
|
57
64
|
end
|
58
65
|
|
59
66
|
# Creates an instance of the object from a hash
|
@@ -68,6 +75,7 @@ module MoesifApi
|
|
68
75
|
session_token = hash["session_token"]
|
69
76
|
company_domain = hash["company_domain"]
|
70
77
|
metadata = hash["metadata"]
|
78
|
+
campaign = CampaignModel.from_hash(hash["campaign"]) if hash["campaign"]
|
71
79
|
|
72
80
|
# Create object from extracted values
|
73
81
|
CompanyModel.new(company_id,
|
@@ -75,7 +83,8 @@ module MoesifApi
|
|
75
83
|
ip_address,
|
76
84
|
session_token,
|
77
85
|
company_domain,
|
78
|
-
metadata
|
86
|
+
metadata,
|
87
|
+
campaign)
|
79
88
|
end
|
80
89
|
end
|
81
90
|
end
|
@@ -32,6 +32,10 @@ module MoesifApi
|
|
32
32
|
# @return [Object]
|
33
33
|
attr_accessor :metadata
|
34
34
|
|
35
|
+
# campaign object
|
36
|
+
# @return [CampaignModel]
|
37
|
+
attr_accessor :campaign
|
38
|
+
|
35
39
|
# A mapping from model property names to API property names
|
36
40
|
def self.names
|
37
41
|
if @hash.nil?
|
@@ -43,6 +47,7 @@ module MoesifApi
|
|
43
47
|
@hash["session_token"] = "session_token"
|
44
48
|
@hash["user_agent_string"] = "user_agent_string"
|
45
49
|
@hash["metadata"] = "metadata"
|
50
|
+
@hash["campaign"] = "campaign"
|
46
51
|
end
|
47
52
|
@hash
|
48
53
|
end
|
@@ -53,7 +58,8 @@ module MoesifApi
|
|
53
58
|
ip_address = nil,
|
54
59
|
session_token = nil,
|
55
60
|
user_agent_string = nil,
|
56
|
-
metadata = nil
|
61
|
+
metadata = nil,
|
62
|
+
campaign = nil)
|
57
63
|
@user_id = user_id
|
58
64
|
@company_id = company_id
|
59
65
|
@modified_time = modified_time
|
@@ -61,6 +67,7 @@ module MoesifApi
|
|
61
67
|
@session_token = session_token
|
62
68
|
@user_agent_string = user_agent_string
|
63
69
|
@metadata = metadata
|
70
|
+
@campaign = campaign
|
64
71
|
end
|
65
72
|
|
66
73
|
# Creates an instance of the object from a hash
|
@@ -76,6 +83,7 @@ module MoesifApi
|
|
76
83
|
session_token = hash["session_token"]
|
77
84
|
user_agent_string = hash["user_agent_string"]
|
78
85
|
metadata = hash["metadata"]
|
86
|
+
campaign = CampaignModel.from_hash(hash["campaign"]) if hash["campaign"]
|
79
87
|
|
80
88
|
# Create object from extracted values
|
81
89
|
UserModel.new(user_id,
|
@@ -84,7 +92,8 @@ module MoesifApi
|
|
84
92
|
ip_address,
|
85
93
|
session_token,
|
86
94
|
user_agent_string,
|
87
|
-
metadata
|
95
|
+
metadata,
|
96
|
+
campaign)
|
88
97
|
end
|
89
98
|
end
|
90
99
|
end
|
@@ -113,11 +113,16 @@ class ApiControllerTests < ControllerTestBase
|
|
113
113
|
'"custom": "testdata"'\
|
114
114
|
'}')
|
115
115
|
|
116
|
+
campaign_model = CampaignModel.new()
|
117
|
+
campaign_model.utm_source = "Newsletter"
|
118
|
+
campaign_model.utm_medium = "Email"
|
119
|
+
|
116
120
|
user_model = UserModel.new()
|
117
121
|
user_model.modified_time = Time.now.utc.iso8601
|
118
122
|
user_model.user_id = "12345"
|
119
123
|
user_model.company_id = "67890"
|
120
124
|
user_model.metadata = metadata
|
125
|
+
user_model.campaign = campaign_model
|
121
126
|
|
122
127
|
# Perform the API call through the SDK function
|
123
128
|
self.class.controller.update_user(user_model)
|
@@ -171,9 +176,14 @@ class ApiControllerTests < ControllerTestBase
|
|
171
176
|
def test_update_company()
|
172
177
|
# Parameters for the API call
|
173
178
|
|
179
|
+
campaign_model = CampaignModel.new()
|
180
|
+
campaign_model.utm_source = "Adwords"
|
181
|
+
campaign_model.utm_medium = "Twitter"
|
182
|
+
|
174
183
|
company_model = CompanyModel.new()
|
175
184
|
company_model.modified_time = Time.now.utc.iso8601
|
176
185
|
company_model.company_id = "12345"
|
186
|
+
company_model.campaign = campaign_model
|
177
187
|
|
178
188
|
# Perform the API call through the SDK function
|
179
189
|
self.class.controller.update_company(company_model)
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: moesif_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.2.
|
4
|
+
version: 1.2.9
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Moesif, Inc
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2019-
|
12
|
+
date: 2019-11-15 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: test-unit
|
@@ -60,10 +60,12 @@ extensions: []
|
|
60
60
|
extra_rdoc_files: []
|
61
61
|
files:
|
62
62
|
- LICENSE
|
63
|
+
- LICENSE~
|
63
64
|
- README.md
|
64
65
|
- lib/moesif_api.rb
|
65
66
|
- lib/moesif_api/api_helper.rb
|
66
67
|
- lib/moesif_api/configuration.rb
|
68
|
+
- lib/moesif_api/configuration.rb~
|
67
69
|
- lib/moesif_api/controllers/api_controller.rb
|
68
70
|
- lib/moesif_api/controllers/base_controller.rb
|
69
71
|
- lib/moesif_api/controllers/health_controller.rb
|
@@ -76,6 +78,7 @@ files:
|
|
76
78
|
- lib/moesif_api/http/http_response.rb
|
77
79
|
- lib/moesif_api/http/unirest_client.rb
|
78
80
|
- lib/moesif_api/models/base_model.rb
|
81
|
+
- lib/moesif_api/models/campaign_model.rb
|
79
82
|
- lib/moesif_api/models/company_model.rb
|
80
83
|
- lib/moesif_api/models/event_model.rb
|
81
84
|
- lib/moesif_api/models/event_request_model.rb
|
@@ -106,7 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
106
109
|
- !ruby/object:Gem::Version
|
107
110
|
version: '0'
|
108
111
|
requirements: []
|
109
|
-
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 2.7.7
|
110
114
|
signing_key:
|
111
115
|
specification_version: 4
|
112
116
|
summary: moesif_api
|