emarsys 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb69af7c3e5a8574c609396438fb0c8bd98669a
-  data.tar.gz: 7624b2f1909182375b5373462240b4947a02f6a1
+  metadata.gz: dc2e05dfded9bc3e85a484b0a100dd0bbee2c4c3
+  data.tar.gz: c6a286becd3fb612d9e379f794430e5f8fa6740c
 SHA512:
-  metadata.gz: 859b05d96793b5fec1071afbb5a6fae628ab0829c9e1739e6a7c98185301b3bfa4dca0749b40bc4b93c0e8b92ebdfce450c4221461e0e6b6b04195a4e48c45d3
-  data.tar.gz: defafe1ddfa3e4ff987bd271e415276ce280d60206d0fbbd3b9bd4bf3831b9440de42cd75f89e50d2df0e99a87eaf64d6a4d14eb48389d6c317084b416c912ea
+  metadata.gz: a27a34fa7afd4d4e182dfa6e6d8948490f8d095cacca5c3fc018d1a45c699588e91ee75fe193ac395c88654f7876e23f73e9df3c0412150d2c5dce05c26556dd
+  data.tar.gz: c344e9354da2b659f2edb4243d9b5e8a8abce6a124b4b83886bd4ac210cfe2ae564038ef62e639d549529f38ce4988342dc5e414cd0091694d163e5f1314dd4d

data/README.md

@@ -208,6 +208,15 @@ Please refer to the code for detailed instructions of each method.
 
 ### HEAD (not yet released)
 
+### v0.2.2
+
+* Allow batch updates to create missing contacts ([#22](https://github.com/Absolventa/emarsys-rb/pull/22))
+* Add support for the data export API ([#23]((https://github.com/Absolventa/emarsys-rb/pull/23))
+
+### v0.2.1
+
+* Added basic support for rate-limiting response from Emarsys API ([#21](https://github.com/Absolventa/emarsys-rb/pull/21))
+
 ### v0.2.0
 * Added country mapping ([#17](https://github.com/Absolventa/emarsys-rb/pull/17))
 * Proper encoding of GET parameters ([#11](https://github.com/Absolventa/emarsys-rb/pull/11))

data/lib/emarsys/data_objects/contact.rb

@@ -38,13 +38,15 @@ module Emarsys
       # @param key_id [Integer, String] internal id of key field
       # @param key_value [Integer, String] value of interal id field
       # @param params [Hash] Contact information to update
+      # @param create_if_not_exists [Boolean] Whether to create contact if it does not exist
       # @return [Hash] internal id of the contact
       # @example
       #   Emarsys::Contact.update('app_id', 23, {:firstname => "Jon", :lastname => "Doe"})
-      #   Emarsys::Contact.update('3', 'john.doe@example.com', {'1' => "Jon", '2' => "Doe"})
-      def update(key_id, key_value, params = {})
+      #   Emarsys::Contact.update('3', 'john.doe@example.com', {'1' => "Jon", '2' => "Doe"}, true)
+      def update(key_id, key_value, params = {}, create_if_not_exists = false)
+        path = "contact#{create_if_not_exists ? '/?create_if_not_exists=1' : ''}"
         transformed_key_id = transform_key_id(key_id)
-        put "contact", params.merge!({'key_id' => transformed_key_id, transformed_key_id => key_value})
+        put path, params.merge!({'key_id' => transformed_key_id, transformed_key_id => key_value})
       end
 
       # Batch creation of contacts.
@@ -66,15 +68,19 @@ module Emarsys
       #
       # @param key_id [Integer, String] internal id of key field
       # @param params [Hash] Contact information of each new contact
+      # @param create_if_not_exists [Boolean] Whether to create non-existing contacts
       # @example
       #   Emarsys::Contact.update_batch(
-      #     'email', {:app_id => 1, :firstname => "Jon", :lastname => "Doe"},
-      #              {:app_id => 2, :firstname => "Jane", :lastname => "Doe"}
+      #     'email',
+      #     [{:email => "john@example.com", :firstname => "Jon", :lastname => "Doe"},
+      #      {:email => "jane@example.com", :firstname => "Jane", :lastname => "Doe"}],
+      #     true
       #   )
       #
       # TODO params should be parameterized with field mappings
-      def update_batch(key_id, params = [])
-        put "contact", {'key_id' => transform_key_id(key_id), 'contacts' => params}
+      def update_batch(key_id, params = [], create_if_not_exists = false)
+        path = "contact#{create_if_not_exists ? '/?create_if_not_exists=1' : ''}"
+        put path, {'key_id' => transform_key_id(key_id), 'contacts' => params}
       end
 
       # Get list of emails send to a contact

data/lib/emarsys/data_objects/email.rb

@@ -125,9 +125,33 @@ module Emarsys
         raise "Not implemented yet"
       end
 
-      # TODO POST /getresponses
-      def export_responses(params = {})
-        raise "Not implemented yet"
+      # Exports the selected fields of all contacts who responded to emails
+      # within the specified time range.
+      #
+      # @param distribution_method [String] ftp or local
+      # @param time_range [array] Array with two elements (start date, end date)
+      # @param contact_fields [array] Array of contact field IDs
+      # @param sources [array] Array which defines sources
+      # @param analysis_fields [array] Array that defines the contact behaviours to analyse
+      # @option params [hash]
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::Email.export_responses(
+      #     'local',
+      #     ['2012-02-09', '2014-08-13'],
+      #     [1, 3],
+      #     ['trackable_links'],
+      #     [5, 8, 13]
+      #   )
+      def export_responses(distribution_method, time_range, contact_fields, sources, analysis_fields, params = {})
+        params.merge!(
+          :distribution_method => distribution_method,
+          :time_range => time_range,
+          :contact_fields => Emarsys::ParamsConverter.new(contact_fields).convert_to_ids,
+          :sources => sources,
+          :analysis_fields => analysis_fields
+        )
+        post "email/getresponses", params
       end
     end
   end

data/lib/emarsys/data_objects/export.rb

@@ -16,6 +16,21 @@ module Emarsys
       def resource(id)
         get "export/#{id}", {}
       end
+
+      # Download export data
+      #
+      # @param id [Integer, String] The internal emarsys id
+      # @option offset [Integer] Defines the ID to start listing from
+      # @option limit [Integer] Defines how many IDs are listed
+      # @return [String] text/csv
+      # @example
+      #   Emarsys::Export.data(2)
+      def data(id, offset = nil, limit = nil)
+        params = {}
+        params.merge!(:offset => offset) if offset
+        params.merge!(:limit => limit) if limit
+        get "export/#{id}/data", params
+      end
     end
 
   end

data/lib/emarsys/params_converter.rb

@@ -9,22 +9,37 @@ module Emarsys
     end
 
     def convert_to_ids
+      params.is_a?(Hash) ? convert_hash_to_ids : convert_array_to_ids
+    end
+
+    def convert_to_identifiers
       new_hash = {}
       params.each do |key, value|
-        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key.to_s}
-        new_hash.merge!({ (matching_attributes.nil? ? key : matching_attributes[:id]) => value })
+        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
     end
 
-    def convert_to_identifiers
+    private
+
+    def convert_hash_to_ids
       new_hash = {}
       params.each do |key, value|
-        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 })
+        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
     end
 
+    def convert_array_to_ids
+      new_array = []
+      params.each do |key|
+        matching_attributes = Emarsys::FieldMapping::ATTRIBUTES.find{|elem| elem[:identifier] == key.to_s}
+        new_array << (matching_attributes.nil? ? key : matching_attributes[:id])
+      end
+      new_array
+    end
+
   end
 end

data/lib/emarsys/response.rb

@@ -4,10 +4,15 @@ module Emarsys
     attr_accessor :code, :text, :data, :status
 
     def initialize(response)
-      json = JSON.parse(response)
-      self.code = json['replyCode']
-      self.text = json['replyText']
-      self.data = json['data']
+      if response.headers[:content_type] == 'text/csv'
+        self.code = 0
+        self.data = response.body
+      else
+        json = JSON.parse(response)
+        self.code = json['replyCode']
+        self.text = json['replyText']
+        self.data = json['data']
+      end
       self.status = response.code if response.respond_to?(:code)
     end
 

data/lib/emarsys/version.rb

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

data/spec/emarsys/data_objects/contact_spec.rb

@@ -25,6 +25,12 @@ describe Emarsys::Contact do
       Emarsys::Contact.update(3, 'jane.doe@example.com', stub_params)
       expect(stub).to have_been_requested.once
     end
+    it "may create non-existing contact" do
+      stub_params = {1 => 'Jane', 2 => "Doe"}
+      stub = stub_request(:put, "https://api.emarsys.net/api/v2/contact/?create_if_not_exists=1").with(:body => stub_params.merge!({'key_id' => 3, 3 => 'jane.doe@example.com'}).to_json).to_return(standard_return_body)
+      Emarsys::Contact.update(3, 'jane.doe@example.com', stub_params, true)
+      expect(stub).to have_been_requested.once
+    end
   end
 
   describe ".create_batch" do
@@ -43,6 +49,12 @@ describe Emarsys::Contact do
       Emarsys::Contact.update_batch(3, stub_params)
       expect(stub).to have_been_requested.once
     end
+    it "may create non-existing contacts" do
+      stub_params = [{1 => 'Jane', 2 => "Doe"}, {1 => 'Paul', 2 => 'Tester'}]
+      stub = stub_request(:put, "https://api.emarsys.net/api/v2/contact/?create_if_not_exists=1").with(:body => {'key_id' => 3, 'contacts' => stub_params}.to_json).to_return(standard_return_body)
+      Emarsys::Contact.update_batch(3, stub_params, true)
+      expect(stub).to have_been_requested.once
+    end
   end
 
   describe ".contact_history" do

data/spec/emarsys/data_objects/export_spec.rb

@@ -8,4 +8,12 @@ describe Emarsys::Export do
       ).to have_been_requested.once
     end
   end
+
+  describe ".data" do
+    it "requests export data" do
+      expect(
+        stub_get('export/123/data') { Emarsys::Export.data(123) }
+      ).to have_been_requested.once
+    end
+  end
 end

data/spec/emarsys/response_spec.rb

@@ -2,18 +2,54 @@ require 'spec_helper'
 
 describe Emarsys::Response do
 
+  class FakeResponse
+    attr_accessor :body
+
+    def initialize(body)
+      self.body = body
+    end
+
+    def to_str
+      body
+    end
+
+    module JSON
+      # Value taken from an actual response from Emarsys
+      def headers
+        {:content_type => 'text/html; charset=utf-8'}
+      end
+    end
+
+    module CSV
+      def headers
+        {:content_type => 'text/csv'}
+      end
+    end
+  end
+
   describe '#initialize' do
-    it 'sets code, text and data attributes on initialize' do
-      response_string = "{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}"
-      response = Emarsys::Response.new(response_string)
-      expect(response.code).to eq(0)
-      expect(response.text).to eq("Something")
-      expect(response.data).to eq(1)
+    context "json" do
+      let(:response_string) { "{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}" }
+      let(:response) { Emarsys::Response.new(FakeResponse.new(response_string).extend(FakeResponse::JSON)) }
+      it 'sets code, text and data attributes on initialize' do
+        expect(response.code).to eq(0)
+        expect(response.text).to eq("Something")
+        expect(response.data).to eq(1)
+      end
+    end
+    context "csv" do
+      let(:response_string) { "user_id,Vorname,E-Mail,Version Name,Url,Zeit\r\n" }
+      let(:response) { Emarsys::Response.new(FakeResponse.new(response_string).extend(FakeResponse::CSV)) }
+      it 'sets code and data attributes on initialize' do
+        expect(response.code).to eq(0)
+        expect(response.data).to eq("user_id,Vorname,E-Mail,Version Name,Url,Zeit\r\n")
+      end
     end
   end
 
   describe '#result' do
-    let(:response) { Emarsys::Response.new("{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}") }
+    let(:response_string) { "{\"replyCode\":0,\"replyText\":\"Something\",\"data\":1}" }
+    let(:response) { Emarsys::Response.new(FakeResponse.new(response_string).extend(FakeResponse::JSON)) }
 
     it "returns data if code is 0" do
       allow(response).to receive(:code).and_return(0)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client