mailchimp_api_v3 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +38 -0
  3. data/.hound.yml +4 -0
  4. data/.rspec +2 -0
  5. data/.rubocop.yml +26 -0
  6. data/CODE_OF_CONDUCT.md +15 -0
  7. data/Gemfile +2 -0
  8. data/Guardfile +16 -0
  9. data/LICENSE +29 -0
  10. data/README.md +44 -0
  11. data/lib/mailchimp.rb +8 -0
  12. data/lib/mailchimp/account.rb +14 -0
  13. data/lib/mailchimp/client.rb +44 -0
  14. data/lib/mailchimp/client/remote.rb +79 -0
  15. data/lib/mailchimp/collection.rb +45 -0
  16. data/lib/mailchimp/collection/paging.rb +70 -0
  17. data/lib/mailchimp/exception.rb +40 -0
  18. data/lib/mailchimp/instance.rb +31 -0
  19. data/lib/mailchimp/interest.rb +9 -0
  20. data/lib/mailchimp/interest_categories.rb +23 -0
  21. data/lib/mailchimp/interest_category.rb +19 -0
  22. data/lib/mailchimp/interests.rb +25 -0
  23. data/lib/mailchimp/list.rb +20 -0
  24. data/lib/mailchimp/lists.rb +21 -0
  25. data/lib/mailchimp/member.rb +15 -0
  26. data/lib/mailchimp/members.rb +23 -0
  27. data/lib/mailchimp/version.rb +3 -0
  28. data/mailchimp_api_v3.gemspec +34 -0
  29. data/spec/fixtures/cassettes/mailchimp.yml +710 -0
  30. data/spec/fixtures/cassettes/members.yml +266 -0
  31. data/spec/mailchimp/account_spec.rb +17 -0
  32. data/spec/mailchimp/client_spec.rb +56 -0
  33. data/spec/mailchimp/exception_spec.rb +45 -0
  34. data/spec/mailchimp/interest_categories_spec.rb +55 -0
  35. data/spec/mailchimp/interest_category_spec.rb +27 -0
  36. data/spec/mailchimp/interest_spec.rb +22 -0
  37. data/spec/mailchimp/interests_spec.rb +49 -0
  38. data/spec/mailchimp/list_spec.rb +36 -0
  39. data/spec/mailchimp/lists_spec.rb +15 -0
  40. data/spec/mailchimp/member_spec.rb +21 -0
  41. data/spec/mailchimp/members_spec.rb +34 -0
  42. data/spec/mailchimp_spec.rb +20 -0
  43. data/spec/spec_helper.rb +29 -0
  44. data/spec/support/api_key.rb +7 -0
  45. data/spec/support/vcr_setup.rb +14 -0
  46. metadata +288 -0
@@ -0,0 +1,22 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp::List::InterestCategory::Interest, vcr: { cassette_name: 'mailchimp' } do
6
+ let(:lists) { Mailchimp.connect.lists }
7
+ let(:list) { lists.first }
8
+ let(:interest_category) { list.interest_categories.first }
9
+ let(:interest) { interest_category.interests.first }
10
+
11
+ it 'is the expected class' do
12
+ expect(interest).to be_a Mailchimp::List::InterestCategory::Interest
13
+ end
14
+
15
+ it 'has a name' do
16
+ expect(interest.name).to eq 'red'
17
+ end
18
+
19
+ it 'has an id' do
20
+ expect(interest.id).to eq '3fbb48c043'
21
+ end
22
+ end
@@ -0,0 +1,49 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp::List::InterestCategory::Interests, vcr: { cassette_name: 'mailchimp' } do
6
+ let(:list) { Mailchimp.connect.lists.first }
7
+ let(:interest_category) { list.interest_categories.first }
8
+ let(:interests) { interest_category.interests }
9
+
10
+ it 'is the expected class' do
11
+ expect(interests).to be_a Mailchimp::List::InterestCategory::Interests
12
+ end
13
+
14
+ it 'has a count' do
15
+ expect(interests.count).to eq 1
16
+ end
17
+
18
+ context 'adding a new instance' do
19
+ context '#create' do
20
+ it 'can add a new instance' do
21
+ data = { 'name' => 'Green' }
22
+ interest = interests.create data
23
+ expect(interest).to be_a Mailchimp::List::InterestCategory::Interest
24
+ expect(interest.name).to eq 'Green'
25
+ end
26
+
27
+ it 'fails adding an instance with the same details' do
28
+ data = { 'name' => 'Red' }
29
+ expect { interests.create data }.to raise_error Mailchimp::Exception::Duplicate
30
+ end
31
+ end
32
+
33
+ context '#first_or_create' do
34
+ it 'finds an instance with the same details' do
35
+ data = { 'name' => 'Red' }
36
+ interest = interests.first_or_create data
37
+ expect(interest).to be_a Mailchimp::List::InterestCategory::Interest
38
+ expect(interest.name).to eq 'red' # Note case
39
+ end
40
+
41
+ it 'creates a new instance if one does not yet exist' do
42
+ data = { 'name' => 'Amber' }
43
+ interest = interests.first_or_create data
44
+ expect(interest).to be_a Mailchimp::List::InterestCategory::Interest
45
+ expect(interest.name).to eq 'Amber'
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,36 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp::List, vcr: { cassette_name: 'mailchimp' } do
6
+ let(:lists) { Mailchimp.connect.lists }
7
+ let(:list) { lists.first }
8
+
9
+ it 'is the expected class' do
10
+ expect(list).to be_a Mailchimp::List
11
+ end
12
+
13
+ it 'has a name' do
14
+ expect(list.name).to eq 'My first list'
15
+ end
16
+
17
+ it 'has an id' do
18
+ expect(list.id).to eq 'e73f5910ca'
19
+ end
20
+
21
+ it 'has an id + name method' do
22
+ expect(list.id_and_name).to eq 'e73f5910ca___My first list'
23
+ end
24
+
25
+ it 'has a members collection' do
26
+ members = list.members
27
+ expect(members).to be_an Array
28
+ expect(members.sample).to be_a Mailchimp::List::Member
29
+ end
30
+
31
+ it 'has a interest_categories collection' do
32
+ interest_categories = list.interest_categories
33
+ expect(interest_categories).to be_an Array
34
+ expect(interest_categories.sample).to be_a Mailchimp::List::InterestCategory
35
+ end
36
+ end
@@ -0,0 +1,15 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp::Lists, vcr: { cassette_name: 'mailchimp' } do
6
+ let(:lists) { Mailchimp.connect.lists }
7
+
8
+ it 'is the expected class' do
9
+ expect(lists).to be_a Mailchimp::Lists
10
+ end
11
+
12
+ it 'has a count' do
13
+ expect(lists.count).to eq 1
14
+ end
15
+ end
@@ -0,0 +1,21 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp::List::Member, vcr: { cassette_name: 'mailchimp' } do
6
+ let(:lists) { Mailchimp.connect.lists }
7
+ let(:list) { lists.first }
8
+ let(:member) { list.members.first }
9
+
10
+ it 'is the expected class' do
11
+ expect(member).to be_a Mailchimp::List::Member
12
+ end
13
+
14
+ it 'has a name' do
15
+ expect(member.name).to eq 'Ann Example'
16
+ end
17
+
18
+ it 'has an id' do
19
+ expect(member.id).to eq '140b91c107d2058dee730e75be0b1151'
20
+ end
21
+ end
@@ -0,0 +1,34 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp::List::Members, vcr: { cassette_name: 'members' } do
6
+ let(:page_size) { 10 }
7
+ let(:member_count) { 37 }
8
+ let(:list) { Mailchimp.connect.lists.first }
9
+ let(:members) { list.members 'page_size' => page_size }
10
+
11
+ it 'is the expected class' do
12
+ expect(members).to be_a Mailchimp::List::Members
13
+ end
14
+
15
+ it 'has a count' do
16
+ expect(members.count).to eq member_count
17
+ end
18
+
19
+ it 'returns pages of members' do
20
+ counts = []
21
+ members.find_in_pages { |p| counts << p.count }
22
+ expect(counts).to eq [page_size, page_size, page_size, 7]
23
+ end
24
+
25
+ it 'returns all members by paging' do
26
+ count = 0
27
+ members.find_each { |_| count += 1 }
28
+ expect(count).to eq member_count
29
+ end
30
+
31
+ it 'has a Member for each item' do
32
+ expect(members.sample).to be_a Mailchimp::List::Member
33
+ end
34
+ end
@@ -0,0 +1,20 @@
1
+ # encoding: utf-8
2
+ require 'spec_helper'
3
+ require 'mailchimp'
4
+
5
+ describe Mailchimp do
6
+ it 'has an API key to work with' do
7
+ expect(api_key?).to be_truthy
8
+ end
9
+
10
+ it 'does not attempt to connect without an API key in the right format' do
11
+ expect { Mailchimp.connect '' }.to raise_error { |e|
12
+ expect(e).to be_a Mailchimp::Exception::APIKeyError
13
+ expect(e.message).to eq 'Invalid API key format'
14
+ }
15
+ end
16
+
17
+ it 'connects with an API key' do
18
+ expect { Mailchimp.connect }.not_to raise_error
19
+ end
20
+ end
@@ -0,0 +1,29 @@
1
+ unless ENV['NO_SIMPLECOV']
2
+ require 'simplecov'
3
+ require 'coveralls'
4
+
5
+ if ENV['CIRCLE_ARTIFACTS']
6
+ dir = File.join('..', '..', '..', ENV['CIRCLE_ARTIFACTS'], 'coverage')
7
+ SimpleCov.coverage_dir(dir)
8
+ end
9
+
10
+ SimpleCov.start
11
+ Coveralls.wear! if ENV['COVERALLS_REPO_TOKEN']
12
+ end
13
+
14
+ # Requires supporting ruby files with custom matchers and macros, etc,
15
+ # in spec/support/ and its subdirectories.
16
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
17
+
18
+ RSpec.configure do |config|
19
+ # Run specs in random order to surface order dependencies. If you find an
20
+ # order dependency and want to debug it, you can fix the order by providing
21
+ # the seed, which is printed after each run.
22
+ # --seed 1234
23
+ config.order = 'random'
24
+
25
+ # Manually-added
26
+ config.color = true
27
+ config.tty = true
28
+ config.formatter = :documentation
29
+ end
@@ -0,0 +1,7 @@
1
+ require 'yaml'
2
+
3
+ ENV['MAILCHIMP_API_KEY'] ||= YAML.load_file('api_key.yml')['api_key'] if File.exist?('api_key.yml')
4
+
5
+ def api_key?
6
+ ENV.key? 'MAILCHIMP_API_KEY'
7
+ end
@@ -0,0 +1,14 @@
1
+ require 'vcr'
2
+
3
+ VCR.configure do |c|
4
+ c.configure_rspec_metadata!
5
+ c.cassette_library_dir = 'spec/fixtures/cassettes'
6
+ c.hook_into :webmock
7
+
8
+ c.default_cassette_options = {
9
+ # record: :new_episodes,
10
+ decode_compressed_response: true,
11
+ match_requests_on: [:method, :uri, :headers, :body],
12
+ allow_playback_repeats: true
13
+ }
14
+ end
metadata ADDED
@@ -0,0 +1,288 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mailchimp_api_v3
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Xenapto
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-07-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rest-client
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.6'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.6'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.8'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.8'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.3'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.3'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec_junit_formatter
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0.2'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0.2'
69
+ - !ruby/object:Gem::Dependency
70
+ name: gem-release
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '0.7'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '0.7'
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.10'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.10'
97
+ - !ruby/object:Gem::Dependency
98
+ name: coveralls
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.8'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.8'
111
+ - !ruby/object:Gem::Dependency
112
+ name: vcr
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '2.9'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '2.9'
125
+ - !ruby/object:Gem::Dependency
126
+ name: webmock
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '1.21'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '1.21'
139
+ - !ruby/object:Gem::Dependency
140
+ name: guard
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '2.12'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '2.12'
153
+ - !ruby/object:Gem::Dependency
154
+ name: guard-rspec
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '4.5'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '4.5'
167
+ - !ruby/object:Gem::Dependency
168
+ name: guard-rubocop
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '1.2'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '1.2'
181
+ - !ruby/object:Gem::Dependency
182
+ name: rubocop
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '0.32'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '0.32'
195
+ description: A simple gem to interact with Mailchimp through their API v3
196
+ email:
197
+ - developers@xenapto.com
198
+ executables: []
199
+ extensions: []
200
+ extra_rdoc_files: []
201
+ files:
202
+ - ".gitignore"
203
+ - ".hound.yml"
204
+ - ".rspec"
205
+ - ".rubocop.yml"
206
+ - CODE_OF_CONDUCT.md
207
+ - Gemfile
208
+ - Guardfile
209
+ - LICENSE
210
+ - README.md
211
+ - lib/mailchimp.rb
212
+ - lib/mailchimp/account.rb
213
+ - lib/mailchimp/client.rb
214
+ - lib/mailchimp/client/remote.rb
215
+ - lib/mailchimp/collection.rb
216
+ - lib/mailchimp/collection/paging.rb
217
+ - lib/mailchimp/exception.rb
218
+ - lib/mailchimp/instance.rb
219
+ - lib/mailchimp/interest.rb
220
+ - lib/mailchimp/interest_categories.rb
221
+ - lib/mailchimp/interest_category.rb
222
+ - lib/mailchimp/interests.rb
223
+ - lib/mailchimp/list.rb
224
+ - lib/mailchimp/lists.rb
225
+ - lib/mailchimp/member.rb
226
+ - lib/mailchimp/members.rb
227
+ - lib/mailchimp/version.rb
228
+ - mailchimp_api_v3.gemspec
229
+ - spec/fixtures/cassettes/mailchimp.yml
230
+ - spec/fixtures/cassettes/members.yml
231
+ - spec/mailchimp/account_spec.rb
232
+ - spec/mailchimp/client_spec.rb
233
+ - spec/mailchimp/exception_spec.rb
234
+ - spec/mailchimp/interest_categories_spec.rb
235
+ - spec/mailchimp/interest_category_spec.rb
236
+ - spec/mailchimp/interest_spec.rb
237
+ - spec/mailchimp/interests_spec.rb
238
+ - spec/mailchimp/list_spec.rb
239
+ - spec/mailchimp/lists_spec.rb
240
+ - spec/mailchimp/member_spec.rb
241
+ - spec/mailchimp/members_spec.rb
242
+ - spec/mailchimp_spec.rb
243
+ - spec/spec_helper.rb
244
+ - spec/support/api_key.rb
245
+ - spec/support/vcr_setup.rb
246
+ homepage: https://github.com/Xenapto/mailchimp_api_v3
247
+ licenses:
248
+ - BSD
249
+ metadata: {}
250
+ post_install_message:
251
+ rdoc_options: []
252
+ require_paths:
253
+ - lib
254
+ required_ruby_version: !ruby/object:Gem::Requirement
255
+ requirements:
256
+ - - ">="
257
+ - !ruby/object:Gem::Version
258
+ version: '0'
259
+ required_rubygems_version: !ruby/object:Gem::Requirement
260
+ requirements:
261
+ - - ">="
262
+ - !ruby/object:Gem::Version
263
+ version: '0'
264
+ requirements: []
265
+ rubyforge_project:
266
+ rubygems_version: 2.4.8
267
+ signing_key:
268
+ specification_version: 4
269
+ summary: 'Example: Mailchimp.new(mc_key).lists'
270
+ test_files:
271
+ - spec/fixtures/cassettes/mailchimp.yml
272
+ - spec/fixtures/cassettes/members.yml
273
+ - spec/mailchimp/account_spec.rb
274
+ - spec/mailchimp/client_spec.rb
275
+ - spec/mailchimp/exception_spec.rb
276
+ - spec/mailchimp/interest_categories_spec.rb
277
+ - spec/mailchimp/interest_category_spec.rb
278
+ - spec/mailchimp/interest_spec.rb
279
+ - spec/mailchimp/interests_spec.rb
280
+ - spec/mailchimp/list_spec.rb
281
+ - spec/mailchimp/lists_spec.rb
282
+ - spec/mailchimp/member_spec.rb
283
+ - spec/mailchimp/members_spec.rb
284
+ - spec/mailchimp_spec.rb
285
+ - spec/spec_helper.rb
286
+ - spec/support/api_key.rb
287
+ - spec/support/vcr_setup.rb
288
+ has_rdoc: