mailchimp_api 1.0.0.pre.10 → 1.0.0.pre.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6fdd7c5517b8795a5317655bf1145e68b2ecabece259b998856be981eba3df
-  data.tar.gz: b00a8146607c40be487607e9364f70d64c565de4629c70b4ccbd841c7d839633
+  metadata.gz: e1558e2a34a6df4a62a33ad95adcbad36e8ca962ba6598af347f03b5721bed4f
+  data.tar.gz: c4fd86b6e6994d92286f7ab63668e3578d2df89e0224353d6ca9b69c258c73ca
 SHA512:
-  metadata.gz: 66859f76241ce09d94c5d91b10411b0bed47d88ca2ab044f1758f2ca155e4b3ad6a8d58c184df8bf9df5745db13a053177174fa4502231a06ec12ac535091815
-  data.tar.gz: 60186078d7b5b3e942f6c9e418cbccc637dd74e8a48b976e1badbc54b3d6478f2513dd0e09978cabbc71aead6c7886510bbd0ab63f2bb7614ae432716922d5e4
+  metadata.gz: d4fa7b461537628d84b8cc5fdc4b02ace8f0d32de2c03dffa763c003e3ef0ea30c73c56cf7ee34f075cba10ae03214e7130377077052b35198ecc469af5ba3cb
+  data.tar.gz: b1792d1ed32d4007222bfd51d8c0010c1905dcfff17d7ce1adab380fc354b2dbf3d37cb4d0ee931a1a873d50c701c741a9ee137f4ac81846f7796fbc203014b9

data/CHANGELOG.md

@@ -11,6 +11,7 @@
 - Support of '/lists/<id>/members/<id>/notes'
 - Support of '/lists/<id>/members/<id>/tags'
 - Support of '/lists/<id>/segments'
+- Support of '/lists/<id>/segments/<id>/members'
 - Support of '/lists/<id>/merge-fields'
 - Support of '/lists/<id>/signup-forms'
 - `.count` support

data/lib/mailchimp_api/collection_parsers/segment_member.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MailchimpAPI::CollectionParsers
+  class SegmentMember < Base
+    def element_key
+      'members'
+    end
+  end
+end

data/lib/mailchimp_api/exceptions.rb

@@ -6,4 +6,10 @@ module MailchimpAPI
       super
     end
   end
+
+  class InvalidOperation < StandardError
+    def initialize(msg = 'The requested operation is not valid')
+      super
+    end
+  end
 end

data/lib/mailchimp_api/resources/list.rb

@@ -12,5 +12,6 @@ module MailchimpAPI
     has_many :members,             class_name: 'MailchimpAPI::Member'
     has_many :merge_fields,        class_name: 'MailchimpAPI::MergeField'
     has_many :signup_forms,        class_name: 'MailchimpAPI::SignupForm'
+    has_many :segments,            class_name: 'MailchimpAPI::Segment'
   end
 end

data/lib/mailchimp_api/resources/member.rb

@@ -40,5 +40,13 @@ module MailchimpAPI
         connection.post path, nil, self.class.headers
       end
     end
+
+    # Tags should be provided as an array of the form [{name: 'tag1', status: 'active'}, {name: 'tag2', status: 'inactive'}]
+    def update_tags(tags)
+      path = element_path(prefix_options) + '/tags'
+      body = { tags: tags }.to_json
+
+      connection.post path, body, self.class.headers
+    end
   end
 end

data/lib/mailchimp_api/resources/segment.rb

@@ -9,5 +9,15 @@ module MailchimpAPI
     self.collection_parser = CollectionParsers::Segment
 
     self.prefix = '/3.0/lists/:list_id/'
+
+    # The path to get segment members is '/3.0/lists/:list_id/segments/:segment_id/members'
+    # Unfortunately, ActiveResource does not support nested resources, only single parent resources:
+    #
+    # https://github.com/rails/activeresource/blob/4accda8bc03ceae0ad626f8cec0b4751e89a58ad/lib/active_resource/associations.rb#L151
+    #
+    # Using a has_many, there is no way to include the `list_id`, so we just create our own members method.
+    def members(params = {})
+      @members ||= MailchimpAPI::SegmentMember.find(:all, params: { segment_id: id }.deep_merge(prefix_options).deep_merge(params))
+    end
   end
 end

data/lib/mailchimp_api/resources/segment_member.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MailchimpAPI
+  class SegmentMember < Base
+    extend MailchimpAPI::Support::Countable
+
+    self.collection_parser = CollectionParsers::SegmentMember
+    self.element_name = 'member'
+    self.collection_name = 'members'
+
+    self.prefix = '/3.0/lists/:list_id/segments/:segment_id/'
+
+    def update
+      raise MailchimpAPI::InvalidOperation.new 'Cannot update SegmentMember. Please use POST to add to a Segment, or DELETE to remove from a Segment.'
+    end
+  end
+end

data/lib/mailchimp_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MailchimpAPI
-  VERSION = '1.0.0.pre.10'
+  VERSION = '1.0.0.pre.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.10
+  version: 1.0.0.pre.11
 platform: ruby
 authors:
 - rewind.io
@@ -186,6 +186,7 @@ files:
 - lib/mailchimp_api/collection_parsers/merge_field.rb
 - lib/mailchimp_api/collection_parsers/note.rb
 - lib/mailchimp_api/collection_parsers/segment.rb
+- lib/mailchimp_api/collection_parsers/segment_member.rb
 - lib/mailchimp_api/collection_parsers/signup_form.rb
 - lib/mailchimp_api/collection_parsers/tag.rb
 - lib/mailchimp_api/configuration.rb
@@ -204,6 +205,7 @@ files:
 - lib/mailchimp_api/resources/merge_field.rb
 - lib/mailchimp_api/resources/note.rb
 - lib/mailchimp_api/resources/segment.rb
+- lib/mailchimp_api/resources/segment_member.rb
 - lib/mailchimp_api/resources/signup_form.rb
 - lib/mailchimp_api/resources/support/countable.rb
 - lib/mailchimp_api/resources/support/patch_update.rb