active_campaign_wrapper 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. checksums.yaml +7 -0
  2. data/.env.sample +2 -0
  3. data/.gitignore +20 -0
  4. data/.rspec +4 -0
  5. data/.rubocop.yml +6 -0
  6. data/.travis.yml +10 -0
  7. data/CODE_OF_CONDUCT.md +74 -0
  8. data/Gemfile +6 -0
  9. data/LICENSE +21 -0
  10. data/README.md +539 -0
  11. data/Rakefile +21 -0
  12. data/active_campaign_wrapper.gemspec +48 -0
  13. data/bin/console +14 -0
  14. data/bin/setup +8 -0
  15. data/lib/active_campaign_wrapper.rb +21 -0
  16. data/lib/active_campaign_wrapper/api/contact/arguments.rb +18 -0
  17. data/lib/active_campaign_wrapper/api/custom_field/arguments.rb +15 -0
  18. data/lib/active_campaign_wrapper/api/list/arguments.rb +19 -0
  19. data/lib/active_campaign_wrapper/client.rb +73 -0
  20. data/lib/active_campaign_wrapper/configuration.rb +59 -0
  21. data/lib/active_campaign_wrapper/core/contact_automation_gateway.rb +16 -0
  22. data/lib/active_campaign_wrapper/core/contact_gateway.rb +66 -0
  23. data/lib/active_campaign_wrapper/core/contact_score_value_gateway.rb +16 -0
  24. data/lib/active_campaign_wrapper/core/contact_tag_gateway.rb +32 -0
  25. data/lib/active_campaign_wrapper/core/custom_field_gateway.rb +46 -0
  26. data/lib/active_campaign_wrapper/core/custom_field_option_gateway.rb +30 -0
  27. data/lib/active_campaign_wrapper/core/custom_field_value_gateway.rb +44 -0
  28. data/lib/active_campaign_wrapper/core/email_activity_gateway.rb +16 -0
  29. data/lib/active_campaign_wrapper/core/list_gateway.rb +46 -0
  30. data/lib/active_campaign_wrapper/core/tag_gateway.rb +40 -0
  31. data/lib/active_campaign_wrapper/helpers.rb +88 -0
  32. data/lib/active_campaign_wrapper/version.rb +5 -0
  33. metadata +288 -0
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ module Core
5
+ class CustomFieldGateway
6
+ def initialize(client)
7
+ @client = client
8
+ @config = client.config
9
+ end
10
+
11
+ def all(**params)
12
+ @config.get('/fields', query: params)
13
+ end
14
+
15
+ def create(params)
16
+ params = { field: params }
17
+ @config.post(
18
+ '/fields',
19
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
20
+ params,
21
+ ActiveCampaignWrapper::Api::CustomField::Arguments::SNAKE_CASED[:create]
22
+ )
23
+ )
24
+ end
25
+
26
+ def delete(field_id)
27
+ @config.delete("/fields/#{field_id}")
28
+ end
29
+
30
+ def update(field_id, params)
31
+ params = { field: params }
32
+ @config.put(
33
+ "/fields/#{field_id}",
34
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
35
+ params,
36
+ ActiveCampaignWrapper::Api::CustomField::Arguments::SNAKE_CASED[:create]
37
+ )
38
+ )
39
+ end
40
+
41
+ def find(field_id)
42
+ @config.get("/fields/#{field_id}")
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,30 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ module Core
5
+ class CustomFieldOptionGateway
6
+ def initialize(client)
7
+ @client = client
8
+ @config = client.config
9
+ end
10
+
11
+ def create(params)
12
+ params = { field_options: params }
13
+ @config.post(
14
+ '/fieldOption/bulk',
15
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
16
+ params
17
+ )
18
+ )
19
+ end
20
+
21
+ def find(field_option_id)
22
+ @config.get("/fieldOptions/#{field_option_id}")
23
+ end
24
+
25
+ def delete(field_option_id)
26
+ @config.delete("/fieldOptions/#{field_option_id}")
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ module Core
5
+ class CustomFieldValueGateway
6
+ def initialize(client)
7
+ @client = client
8
+ @config = client.config
9
+ end
10
+
11
+ def all(**params)
12
+ @config.get('/fieldValues', query: params)
13
+ end
14
+
15
+ def create(params, use_defaults: false)
16
+ params = { field_value: params, use_defaults: use_defaults }
17
+ @config.post(
18
+ '/fieldValues',
19
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
20
+ params
21
+ )
22
+ )
23
+ end
24
+
25
+ def delete(field_value_id)
26
+ @config.delete("/fieldValues/#{field_value_id}")
27
+ end
28
+
29
+ def update(field_value_id, params, use_defaults: false)
30
+ params = { field_value: params, use_defaults: use_defaults }
31
+ @config.put(
32
+ "/fieldValues/#{field_value_id}",
33
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
34
+ params
35
+ )
36
+ )
37
+ end
38
+
39
+ def find(field_value_id)
40
+ @config.get("/fieldValues/#{field_value_id}")
41
+ end
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ module Core
5
+ class EmailActivityGateway
6
+ def initialize(client)
7
+ @client = client
8
+ @config = client.config
9
+ end
10
+
11
+ def all(**params)
12
+ @config.get('/emailActivities', query: params)
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ module Core
5
+ class ListGateway
6
+ def initialize(client)
7
+ @client = client
8
+ @config = client.config
9
+ end
10
+
11
+ def all(**params)
12
+ @config.get('/lists', query: params)
13
+ end
14
+
15
+ def create(params)
16
+ params = { list: params }
17
+ @config.post(
18
+ '/lists',
19
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
20
+ params,
21
+ ActiveCampaignWrapper::Api::List::Arguments::SNAKE_CASED[:create]
22
+ )
23
+ )
24
+ end
25
+
26
+ def delete(list_id)
27
+ @config.delete("/lists/#{list_id}")
28
+ end
29
+
30
+ def update(list_id, params)
31
+ params = { list: params }
32
+ @config.put(
33
+ "/lists/#{list_id}",
34
+ body: ActiveCampaignWrapper::Helpers.normalize_body(
35
+ params,
36
+ ActiveCampaignWrapper::Api::List::Arguments::SNAKE_CASED[:create]
37
+ )
38
+ )
39
+ end
40
+
41
+ def find(list_id)
42
+ @config.get("/lists/#{list_id}")
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ module Core
5
+ class TagGateway
6
+ def initialize(client)
7
+ @client = client
8
+ @config = client.config
9
+ end
10
+
11
+ def all(**params)
12
+ @config.get('/tags', query: params)
13
+ end
14
+
15
+ def create(params)
16
+ params = { tag: params }
17
+ @config.post(
18
+ '/tags',
19
+ body: ActiveCampaignWrapper::Helpers.normalize_body(params)
20
+ )
21
+ end
22
+
23
+ def delete(tag_id)
24
+ @config.delete("/tags/#{tag_id}")
25
+ end
26
+
27
+ def update(tag_id, params)
28
+ params = { tag: params }
29
+ @config.put(
30
+ "/tags/#{tag_id}", body:
31
+ ActiveCampaignWrapper::Helpers.normalize_body(params)
32
+ )
33
+ end
34
+
35
+ def find(tag_id)
36
+ @config.get("/tags/#{tag_id}")
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,88 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'active_support/core_ext/string'
4
+
5
+ module ActiveCampaignWrapper
6
+ module Helpers
7
+ module_function
8
+
9
+ def normalize_response(response)
10
+ raise ActiveCampaignWrapper::AuthorizationError, response.message if response.unauthorized?
11
+ raise ActiveCampaignWrapper::Error, response.message unless response.success?
12
+
13
+ if response&.body.present?
14
+ transform_keys(response, [:underscore])
15
+ else
16
+ {}
17
+ end
18
+ end
19
+
20
+ def normalize_body(params, skip_normalization = [])
21
+ return unless params.is_a?(Hash)
22
+
23
+ params = transform_keys(
24
+ params || {},
25
+ %i[camelcase lower],
26
+ skip_normalization
27
+ )
28
+ params.to_json
29
+ end
30
+
31
+ # Transforms case of all hash keys
32
+ # @note this is used to always output a hash response
33
+ #
34
+ # @param [Hash] hash initial hash before transformation
35
+ # @param [Symbol, Symbol] [:underscore] or [:camelcase, :lower] DEFAULT: underscore
36
+ # @return [Hash]
37
+ #
38
+ def transform_keys(hash, case_style, skip_normalization = [])
39
+ hash.each_with_object({}) do |(key, value), memo|
40
+ memo[transform_key(key, case_style, skip_normalization)] = transform_value(value, case_style, skip_normalization)
41
+ end
42
+ end
43
+
44
+ #
45
+ # Transform the provided keys case and lastly symbolize it
46
+ #
47
+ # @param [String, Symbol] key the name of the key to change case
48
+ # @param [Symbol, Symbol] [:underscore] or [:camelcase, :lower] DEFAULT: underscore
49
+ # @return [Symbol] the transformed key
50
+ #
51
+ def transform_key(key, case_style, skip_normalization = [])
52
+ unless skip_normalization.include?(key)
53
+ key = key.to_s.public_send(*case_style)
54
+ end
55
+ key.to_sym
56
+ end
57
+
58
+ #
59
+ # Transform all values
60
+ # @note used for nested values like hashes and arrays
61
+ #
62
+ # @param [Object] value the value to transform
63
+ # @param [Symbol, Symbol] [:underscore] or [:camelcase, :lower] DEFAULT: underscore
64
+ # @return [Object]
65
+ #
66
+ def transform_value(value, case_style, skip_normalization = [])
67
+ case value
68
+ when Hash
69
+ transform_keys(value, case_style, skip_normalization)
70
+ when Array
71
+ transform_array(value, case_style, skip_normalization)
72
+ else
73
+ value
74
+ end
75
+ end
76
+
77
+ def transform_array(collection, case_style, skip_normalization = [])
78
+ collection.map do |element|
79
+ case element
80
+ when Hash
81
+ transform_keys(element, case_style, skip_normalization)
82
+ else
83
+ element
84
+ end
85
+ end
86
+ end
87
+ end
88
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module ActiveCampaignWrapper
4
+ VERSION = '0.1.0'
5
+ end
metadata ADDED
@@ -0,0 +1,288 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: active_campaign_wrapper
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Anmol Yousaf
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-03-24 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 5.2.4.3
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 5.2.4.3
27
+ - !ruby/object:Gem::Dependency
28
+ name: httparty
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0.14'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0.14'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 2.1.4
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 2.1.4
55
+ - !ruby/object:Gem::Dependency
56
+ name: codecov
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.1'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: dotenv
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2.5'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '2.5'
83
+ - !ruby/object:Gem::Dependency
84
+ name: pry
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 0.14.0
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 0.14.0
97
+ - !ruby/object:Gem::Dependency
98
+ name: rake
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '13.0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '13.0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rspec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: 3.10.0
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: 3.10.0
125
+ - !ruby/object:Gem::Dependency
126
+ name: rspec-json_expectations
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '1.2'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '1.2'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rubocop
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: 1.11.0
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: 1.11.0
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop-performance
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '1.5'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '1.5'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rubocop-rspec
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '1.37'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '1.37'
181
+ - !ruby/object:Gem::Dependency
182
+ name: simplecov
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '0.16'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '0.16'
195
+ - !ruby/object:Gem::Dependency
196
+ name: vcr
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - "~>"
200
+ - !ruby/object:Gem::Version
201
+ version: 6.0.0
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - "~>"
207
+ - !ruby/object:Gem::Version
208
+ version: 6.0.0
209
+ - !ruby/object:Gem::Dependency
210
+ name: webmock
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - "~>"
214
+ - !ruby/object:Gem::Version
215
+ version: 3.12.1
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - "~>"
221
+ - !ruby/object:Gem::Version
222
+ version: 3.12.1
223
+ description: ActiveCampaign REST API
224
+ email:
225
+ - anmolyousaf94@gmail.com
226
+ executables: []
227
+ extensions: []
228
+ extra_rdoc_files: []
229
+ files:
230
+ - ".env.sample"
231
+ - ".gitignore"
232
+ - ".rspec"
233
+ - ".rubocop.yml"
234
+ - ".travis.yml"
235
+ - CODE_OF_CONDUCT.md
236
+ - Gemfile
237
+ - LICENSE
238
+ - README.md
239
+ - Rakefile
240
+ - active_campaign_wrapper.gemspec
241
+ - bin/console
242
+ - bin/setup
243
+ - lib/active_campaign_wrapper.rb
244
+ - lib/active_campaign_wrapper/api/contact/arguments.rb
245
+ - lib/active_campaign_wrapper/api/custom_field/arguments.rb
246
+ - lib/active_campaign_wrapper/api/list/arguments.rb
247
+ - lib/active_campaign_wrapper/client.rb
248
+ - lib/active_campaign_wrapper/configuration.rb
249
+ - lib/active_campaign_wrapper/core/contact_automation_gateway.rb
250
+ - lib/active_campaign_wrapper/core/contact_gateway.rb
251
+ - lib/active_campaign_wrapper/core/contact_score_value_gateway.rb
252
+ - lib/active_campaign_wrapper/core/contact_tag_gateway.rb
253
+ - lib/active_campaign_wrapper/core/custom_field_gateway.rb
254
+ - lib/active_campaign_wrapper/core/custom_field_option_gateway.rb
255
+ - lib/active_campaign_wrapper/core/custom_field_value_gateway.rb
256
+ - lib/active_campaign_wrapper/core/email_activity_gateway.rb
257
+ - lib/active_campaign_wrapper/core/list_gateway.rb
258
+ - lib/active_campaign_wrapper/core/tag_gateway.rb
259
+ - lib/active_campaign_wrapper/helpers.rb
260
+ - lib/active_campaign_wrapper/version.rb
261
+ homepage: https://github.com/anmol-yousaf/active_campaign_wrapper
262
+ licenses:
263
+ - MIT
264
+ metadata:
265
+ allowed_push_host: https://rubygems.org/
266
+ homepage_uri: https://github.com/anmol-yousaf/active_campaign_wrapper
267
+ source_code_uri: https://github.com/anmol-yousaf/active_campaign_wrapper
268
+ changelog_uri: https://github.com/anmol-yousaf/active_campaign_wrapper
269
+ post_install_message:
270
+ rdoc_options: []
271
+ require_paths:
272
+ - lib
273
+ required_ruby_version: !ruby/object:Gem::Requirement
274
+ requirements:
275
+ - - ">="
276
+ - !ruby/object:Gem::Version
277
+ version: 2.3.0
278
+ required_rubygems_version: !ruby/object:Gem::Requirement
279
+ requirements:
280
+ - - ">="
281
+ - !ruby/object:Gem::Version
282
+ version: '0'
283
+ requirements: []
284
+ rubygems_version: 3.1.2
285
+ signing_key:
286
+ specification_version: 4
287
+ summary: REST API for ActiveCampaign
288
+ test_files: []