emarsys 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bf69d01042a7b64304940391651c7fe3a99d96c
-  data.tar.gz: c7aa084a93d3f0201e617bfe6d2f040c7eddde84
+  metadata.gz: e155b83198c03cb4fea3ae86224908fd3a95e31d
+  data.tar.gz: 91c5aca80394f07dea3dd1bf43abb07398e795fe
 SHA512:
-  metadata.gz: 702951ca24054c4bbf36e5442e6346e5ab112a778c91b53f1b1ebd24be9a1fdaae6bbfc10550408665c40edf55b02a60e67ffb5cdb9e55630f4c6f05831b01e8
-  data.tar.gz: 7913423d7bc03c272f187ba172f9f80b77aa69eb90c2738b62d48a591292d71b594ba37a32b1aeb27a2af41d6a9310703772153e999bc791a04dbe1de1b9d8ae
+  metadata.gz: f6f4a47b51d23e43ed2c5ba4c03a9e62cc47913134425dac1c172d4251c27f23e88f7ae50d8d32aaf02bad8f3f4161bdb11e823ad172d0c0c194e1ac744f25af
+  data.tar.gz: '082ae5439611b7b7d515664c6cd493cc18a7a8d17f108b4a0e2656600111f60a8164dcf36cc886ab4a7770a3ee48d3f586f89abbb37fa2c624b2869c156eff0a'

data/README.md

@@ -70,14 +70,14 @@ which that can be overwritten. It will be picked up automatically. E.g.:
 
 ```ruby
 # Complete overwrite
-Emarsys::FieldMapping::ATTRIBUTES = [
+Emarsys::FieldMapping.set_attributes([
   {:id => 0, :identifier => 'interests', :name => 'Interests'},
   {:id => 1, :identifier => 'firstname', :name => 'First Name'},
   {:id => 2, :identifier => 'lastname',  :name => 'Last Name'},
-]
+])
 
 # Add to the Mapping-Constant
-Emarsys::FieldMapping::ATTRIBUTES << {:id => 100, :identifier => 'user_id', :name => "User-ID"}
+Emarsys::FieldMapping.add_attributes({:id => 100, :identifier => 'user_id', :name => "User-ID"})
 ```
 
 All Emarsys predefined system fields are prefixed with an underscore, e.g. '_firstname' or '_revenue' in order to not

data/lib/emarsys/data_objects/contact.rb

@@ -119,6 +119,19 @@ module Emarsys
         post account, "contact/getdata", {'keyId' => key_id, 'keyValues' => key_values, 'fields' => fields}
       end
 
+      # 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
+      # @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}
+      end
+
       # Exports the selected fields of contacts whoch registered in the specified time range
       #
       # @param params [hash] hash of parameters according to emarsys API
@@ -135,7 +148,7 @@ module Emarsys
 
       # @private
       def transform_key_id(key_id)
-        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key_id.to_s}
+        matching_attributes = Emarsys::FieldMapping.attributes.find{|elem| elem[:identifier] == key_id.to_s}
         matching_attributes.nil? ? key_id : matching_attributes[:id]
       end
 

data/lib/emarsys/data_objects/event.rb

@@ -23,14 +23,16 @@ module Emarsys
       # @param key_id [Integer, String] The identifer of the key field (e.g. 3 for 'email')
       # @param external_id [String] The id of the given filed specified with key_id (e.g. 'test@example.com')
       # @option data [Hash] data hash for transactional mails
+      # @option attachment [Array] array containing an attachment for transactional mails
       # @return [Hash] Result data
       # @example
       #   Emarsys::Event.trigger(2, 3, 'test@example.com')
       #   Emarsys::Event.trigger(2, 'user_id', 57687, {:global => {:name => "Special Name"}})
-      def trigger(id, key_id:, external_id:, data: {}, account: nil)
+      def trigger(id, key_id:, external_id:, data: {}, attachment: [], account: nil)
         transformed_key_id = transform_key_id(key_id)
-        params = {:key_id => transformed_key_id, :external_id => external_id}
-        params.merge!(:data => data) if not data.empty?
+        params = { key_id: transformed_key_id, external_id: external_id }
+        params.merge!(data: data) if not data.empty?
+        params.merge!(attachment: attachment) if not attachment.empty?
         post account, "event/#{id}/trigger", params
       end
 
@@ -52,7 +54,7 @@ module Emarsys
 
       # @private
       def transform_key_id(key_id)
-        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key_id.to_s}
+        matching_attributes = Emarsys::FieldMapping.attributes.find{|elem| elem[:identifier] == key_id.to_s}
         matching_attributes.nil? ? key_id : matching_attributes[:id]
       end
     end

data/lib/emarsys/field_mapping.rb

@@ -53,4 +53,23 @@ module Emarsys::FieldMapping
     {:id => 48,  :identifier => '_date_of_first_registration', :name => 'Date of first registration'}
   ]
 
+  def self.attributes
+    return @custom_attributes if excluded_default_attributes?
+    return ATTRIBUTES.dup.concat(@custom_attributes) if @custom_attributes
+    ATTRIBUTES
+  end
+
+  def self.set_attributes(attrs)
+    @exclude_default_attributes = true
+    @custom_attributes = [attrs].flatten
+  end
+
+  def self.add_attributes(attrs)
+    @custom_attributes.concat([attrs].flatten)
+  end
+
+  def self.excluded_default_attributes?
+    @exclude_default_attributes == true
+  end
+
 end

data/lib/emarsys/params_converter.rb

@@ -15,7 +15,7 @@ module Emarsys
     def convert_to_identifiers
       new_hash = {}
       params.each do |key, value|
-        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:id] == key.to_i && key.to_i != 0}
+        matching_attributes = Emarsys::FieldMapping.attributes.find{|elem| elem[:id] == key.to_i && key.to_i != 0}
         new_hash.merge!({ (matching_attributes.nil? ? key : matching_attributes[:identifier]) => value })
       end
       new_hash
@@ -26,7 +26,7 @@ module Emarsys
     def convert_hash_to_ids
       new_hash = {}
       params.each do |key, value|
-        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key.to_s}
+        matching_attributes = Emarsys::FieldMapping.attributes.find{|elem| elem[:identifier] == key.to_s}
         new_hash.merge!({ (matching_attributes.nil? ? key : matching_attributes[:id]) => value })
       end
       new_hash
@@ -35,7 +35,7 @@ module Emarsys
     def convert_array_to_ids
       new_array = []
       params.each do |key|
-        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key.to_s}
+        matching_attributes = Emarsys::FieldMapping.attributes.find{|elem| elem[:identifier] == key.to_s}
         new_array << (matching_attributes.nil? ? key : matching_attributes[:id])
       end
       new_array

data/lib/emarsys/version.rb

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

data/spec/emarsys/data_objects/contact_spec.rb

@@ -96,6 +96,14 @@ describe Emarsys::Contact do
     end
   end
 
+  describe ".query" do
+    it "queries contact data based on search params" 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: 3, key_value: 'jane.doe@example.com', return_value: 'email')
+      expect(stub).to have_been_requested.once
+    end
+  end
+
   describe ".export_registrations" do
     it "requests contact data export based on parameters" do
       stub_params = {distribution_method: 'local', time_range: ["2013-01-01","2013-12-31"], contact_fields: [1,2,3]}

data/spec/emarsys/data_objects/event_spec.rb

@@ -21,6 +21,12 @@ describe Emarsys::Event do
       Emarsys::Event.trigger(123, key_id: 3, external_id: 'jane.doe@example.com', data: {'global' => {'my_placeholder' => 'Something'}})
       expect(stub).to have_been_requested.once
     end
+
+    it "requests event trigger with an attachment" do
+      stub = stub_request(:post, "https://api.emarsys.net/api/v2/event/123/trigger").with(:body => {'key_id' => 3, 'external_id' => "jane.doe@example.com", attachment: [ {  filename: 'something.pdf', data:  'Something' } ]}.to_json).to_return(standard_return_body)
+      Emarsys::Event.trigger(123, key_id: 3, external_id: 'jane.doe@example.com', attachment: [ {  filename: 'something.pdf', data:  'Something' } ])
+      expect(stub).to have_been_requested.once
+    end
   end
 
   describe ".trigger_multiple" do

data/spec/emarsys/field_mapping_spec.rb

@@ -8,7 +8,67 @@ describe Emarsys::FieldMapping do
 
   it "defines constant ATTRBUTES as an array if hashes" do
     expect(Emarsys::FieldMapping::ATTRIBUTES).to be_a(Array)
-    Emarsys::FieldMapping::ATTRIBUTES.map{|elem| expect(elem).to be_a(Hash) }
+    expect(Emarsys::FieldMapping::ATTRIBUTES).to all(be_a(Hash))
+  end
+
+  describe '.attributes' do
+    describe 'backward-compatibility' do
+      it 'defines an array of hashes' do
+        expect(Emarsys::FieldMapping.attributes).to be_a(Array)
+        expect(Emarsys::FieldMapping.attributes).to all(be_a(Hash))
+      end
+
+      it 'returns the content of ATTRIBUTES by default' do
+        attributes_stub = double('ATTRIBUTES')
+        stub_const('Emarsys::FieldMapping::ATTRIBUTES', attributes_stub)
+
+        expect(Emarsys::FieldMapping.attributes).to eq(attributes_stub)
+      end
+    end
+  end
+
+  describe '.set_attributes' do
+    it 'redefines attributes' do
+      attributes = [
+        {:id => 101,   :identifier => 'foo', :name => 'Foo'},
+        {:id => 102,   :identifier => 'bar', :name => 'Bar'}
+      ]
+
+      Emarsys::FieldMapping.set_attributes(attributes)
+      expect(Emarsys::FieldMapping.attributes).to match_array(attributes)
+    end
+
+    it 'turns off use of default-predefined ATTRIBUTES' do
+      attributes_stub = double('ATTRIBUTES')
+      allow(attributes_stub).to receive(:<<).and_return(attributes_stub)
+
+      stub_const('Emarsys::FieldMapping::ATTRIBUTES', attributes_stub)
+
+      mapping_to_be_added = {
+        id: 2000, identifier: 'foo', name: 'Foo'
+      }
+
+      attributes = [
+        {:id => 101,   :identifier => 'foo', :name => 'Foo'},
+        {:id => 102,   :identifier => 'bar', :name => 'Bar'}
+      ]
+
+      Emarsys::FieldMapping.set_attributes(attributes)
+      Emarsys::FieldMapping::ATTRIBUTES << mapping_to_be_added
+
+      expect(Emarsys::FieldMapping.attributes).to match_array(attributes)
+    end
+  end
+
+  describe '.add_attributes' do
+    it "merges attributes" do
+      attributes = [
+        {:id => 101,   :identifier => 'foo', :name => 'Foo'},
+        {:id => 102,   :identifier => 'bar', :name => 'Bar'}
+      ]
+      Emarsys::FieldMapping.add_attributes(attributes)
+      expect(Emarsys::FieldMapping.attributes).to include(attributes[0], attributes[1])
+    end
   end
 
 end

data/spec/emarsys/params_converter_spec.rb

@@ -9,7 +9,10 @@ describe Emarsys::ParamsConverter do
       {:id => 1,   :identifier => 'first_name', :name => 'First Name'},
       {:id => 2,   :identifier => 'last_name',  :name => 'Last Name'},
     ]
-    stub_const("Emarsys::FieldMapping::ATTRIBUTES", attributes)
+
+    allow(Emarsys::FieldMapping).to receive(:attributes).and_return(
+      attributes
+    )
   end
 
   describe 'with attributes' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client