emarsys 0.3.12 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1de1c48fb3545c89c9fdb3fc80ebfa2c19682b6
-  data.tar.gz: 6cf4f2051c2682ef2142b1dc7ce0975bc5f7fb93
+  metadata.gz: 438c871d801d4782d2e87ed2fc095847b5323a64
+  data.tar.gz: 9d01a343ecb897f827d3b0e543fb08382e73d540
 SHA512:
-  metadata.gz: f4380603561017185eb9d64ac71dbd34e59a77248c764bf0912c8613c48e76817e701e7ac73236aa9fcb2021b144d7250fb2aab1aa28670b8f0c498c605d6518
-  data.tar.gz: 86b1102c8b9e66dbbaeddfe35464516e9100c77f32f505637ab76023ed2ec6a512397746837060be2abdb4c514abc07bed01f253427d51021f53c218b1fd5524
+  metadata.gz: c1b1ae69f75b6d77168dee74a56166942266084119f7ba169b3eecf7726bfdd6ef1d4e810195b014bcf3564d6a97f3e1bb1e254638abf0545d54f9ee4e0d7844
+  data.tar.gz: f846c1d9637cf3050fca1b249df4023f1ea6e2f766cec60eb3c46f8ddb9b53b41c91ca47df081d9fa2f4f0f6384c52152b8d11402c5859808d879da38b5cea52

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.3.13 
+
+* Add method to delete ContactList by ID ([#63](https://github.com/Absolventa/emarsys-rb/pull/63))
+* Use correct endpoint in ContactList.remove_contacts ([#62](https://github.com/Absolventa/emarsys-rb/pull/62))
+* Improved Contact.query method ([#61](https://github.com/Absolventa/emarsys-rb/pull/61))
+
+## v0.3.12
+
+* Documentation update for Segments (change to README only)
+
+## v0.3.11
+
+* Add support for Segments API ([#58](https://github.com/Absolventa/emarsys-rb/pull/58))
+
 ## v0.3.10
 
 * Fix 'Invalid Password' error ([#55](https://github.com/Absolventa/emarsys-rb/pull/55))

data/README.md

@@ -158,6 +158,9 @@ Emarsys::ContactList.collection
 
 # Create a contact list
 Emarsys::ContactList.create
+
+# Delete a contact list
+Emarsys::ContactList.delete(123)
 ```
 
 #### Emails

data/lib/emarsys/data_objects/contact.rb

@@ -121,15 +121,27 @@ module Emarsys
 
       # Query contacts by custom
       #
-      # @param key_id [Integer, String] The key used to query
-      # @param key_value [String] Value of internal id field
       # @param return_value [Integer, String] Value of internal id field
+      # @param account [String] The account to use
+      # @param opts [Mixed] Further symbols to pass down to the request
       # @return [Hash] result data
       # @example
-      #   Emarsys::Contact.query('3', 'john.doe@example.com', 'uid')
-      #
-      def query(key_id:, key_value:, return_value: , account: nil)
-        get account, "contact/query", { key_id => key_value, 'return' => return_value}
+      #   # Get all emails from the emarsys account
+      #   Emarsys::Contact.query(return_value: 'email')
+      #   # Get the ID of the account with a specific email
+      #   Emarsys::Contact.query(key_id: '_email', key_value: 'john.doe@example.com', return_value: 'email')
+      #   Emarsys::Contact.query(key_id: 3, key_value: 'jane.doe@example.com', return_value: 'email')
+      def query(return_value:, account: nil, **opts)
+        if opts.key?(:key_id) && opts.key?(:key_value)
+          id, value = [opts.delete(:key_id), opts.delete(:key_value)]
+          opts["#{transform_key_id(id).to_s}"] = value
+        end
+
+        opts = opts.each_with_object({}) do |(key, val), memo|
+          memo[key.to_s] = val
+        end
+
+        get account, 'contact/query', opts.merge('return' => return_value)
       end
 
       # Exports the selected fields of contacts whoch registered in the specified time range

data/lib/emarsys/data_objects/contact_list.rb

@@ -29,6 +29,16 @@ module Emarsys
         post account, "contactlist", params
       end
 
+      # Delete a contact list
+      #
+      # @param id [Integer] Internal contact list id
+
+      # @example
+      #   Emarsys::ContactList.delete(751283429)
+      def delete(id, account: nil)
+        post account, "contactlist/#{id}/deletelist", {}
+      end
+
       # Add a contacts to a specific contact list
       #
       # This cannot be an instance method, because the API does not allow to retrieve a single resource. How crappy is that?
@@ -40,7 +50,7 @@ module Emarsys
       #
       # This cannot be an instance method, because the API does not allow to retrieve a single resource. How crappy is that?
       def remove_contacts(id, key_id:, external_ids: [], account: nil)
-        post account, "contactlist/#{id}/remove", {'key_id' => key_id, 'external_ids' => external_ids}
+        post account, "contactlist/#{id}/delete", {'key_id' => key_id, 'external_ids' => external_ids}
       end
 
     end

data/lib/emarsys/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Emarsys
-  VERSION = "0.3.12"
+  VERSION = "0.3.13"
 end

data/spec/emarsys/data_objects/contact_spec.rb

@@ -102,6 +102,18 @@ describe Emarsys::Contact do
       Emarsys::Contact.query(key_id: 3, key_value: 'jane.doe@example.com', return_value: 'email')
       expect(stub).to have_been_requested.once
     end
+
+    it "transforms the key_id correctly to its id" do
+      stub = stub_request(:get, "https://api.emarsys.net/api/v2/contact/query/?3=jane.doe@example.com&return=email").to_return(standard_return_body)
+      Emarsys::Contact.query(key_id: '_email', key_value: 'jane.doe@example.com', return_value: 'email')
+      expect(stub).to have_been_requested.once
+    end
+
+    it "allows to get all contacts" do
+      stub = stub_request(:get, "https://api.emarsys.net/api/v2/contact/query/?return=email").to_return(standard_return_body)
+      Emarsys::Contact.query(return_value: 'email')
+      expect(stub).to have_been_requested.once
+    end
   end
 
   describe ".export_registrations" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
 platform: ruby
 authors:
 - Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client