emarsys 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91da527fa70b69756d7dca70b153ec103be4c52ed2fc189b6d8eb6d4036637a
-  data.tar.gz: 1ac969e7acf008b6cc07ae032d3c8ce42b8cdcf398b61bb3b51db0ff14c18533
+  metadata.gz: 6b81b5ea5557ce933b016de58af06badeb2b1ee6b031d77f347bb6d1f9e0d35c
+  data.tar.gz: '0619224ab0ba8a19979790f05dee342178ad8e19e609ec2633414e93b4c6207f'
 SHA512:
-  metadata.gz: b512d98dc2a1acbb56a1e783fb00a6e3d915d58a66ea1c773b9c92ea444b4724734e004273ee72758b16179b10b304656a07ad56bd5bd406606fe0d9726c02a0
-  data.tar.gz: 955e9a9626883406b3e029929475dbf04971f3411b5c2112626f7faacd0796c7a0216caf9f1548587d686d4d5e54b1a3c29870fc5a376f7f94ef65673c04eb42
+  metadata.gz: 2bbfd1f981a63b2758326af0db33bdb5267f60de7128c1211335e8c2b2da861aaf080d13d5b5c9f172e5362ea647e41e625fbaf796506fcd51c12d01ff43e72c
+  data.tar.gz: 1699e55fc9459ce7c84f84b73a1bccbebacbb041f6631b1c73fa9ed388e88e98bc63aa7d68fb44645a3dff565d8fbfd561913a09ca205a7f5dbc833ccbf9f53b

data/.gitignore

@@ -1,3 +1,4 @@
+.idea/*
 *.gem
 *.rbc
 .bundle

data/CHANGELOG.md

@@ -1,10 +1,20 @@
 # Changelog
 
+## v1.4.1
+
+* Allow nonspecific arguments for the `export_registrations` call
+
+## v1.4.0 - DIVERTED FROM ORIGINAL PROJECT
+
+* Fix add attributes method  ([#67](https://github.com/Absolventa/emarsys-rb/pull/67))
+* Fix CSV data export ([#68](https://github.com/Absolventa/emarsys-rb/pull/68))
+* Other minor fixes, typos and gem updates
+
 ## v0.4.0
 
-* Add supported segment endpoints and remove the deprecated one ([#64]https://github.com/Absolventa/emarsys-rb/pull/64)
+* Add supported segment endpoints and remove the deprecated one ([#64](https://github.com/Absolventa/emarsys-rb/pull/64))
 
-## v0.3.13 
+## 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))

data/README.md

@@ -2,6 +2,10 @@
 
 Simple Ruby wrapper for the Emarsys API.
 
+## Note
+
+This fork was created because the original author doesn't seem to be merging PRs anymore. If that gets rectified, I'll close this repo. In the meantime I'll start release from the original version + 1.0.0 (e.g. 0.4.0 -> 1.4.0).
+
 ## Installation
 
     gem install emarsys
@@ -12,16 +16,16 @@ This wrapper tries to implement all available methods of the Emarsys API in a
 Ruby-like fashion. However, the Emarsys API lacks a decent amount of methods that
 you expect an API to provide.
 Thus, if methods are missing or a certain implementation
-style was choosen it is most likely due to the inconsistency of the API itself.
+style was chosen it is most likely due to the inconsistency of the API itself.
 Feel free to get in touch or submit a pull request if you encounter any problems.
 
 Must-known facts about the Emarsys API:
 
 * Emarsys uses internal IDs as field identifiers. E.g. 'email' is mapped to the value 3.
 This gem tries to work around this by letting you specify a field mapping constant.
-* certain methods require the specification of a key-field, e.g. the email (internally refered to as '3' again).
+* certain methods require the specification of a key-field, e.g. the email (internally referred to as '3' again).
 * Return values differ from method to method due to the way the Emarsys API is implemented.
-Thus, a Hash as a return value or an Array of Hashes was choosen as the global return object. Basically it is a parsed JSON response.
+Thus, a Hash as a return value or an Array of Hashes was chosen as the global return object. Basically it is a parsed JSON response.
 * Please refer to the Emarsys API documentation for detailed information on parameters, return values or error codes.
 * The list of available countries is defined by Emarsys, and uses internal Emarsys-specific IDs.  A utility class is
 provided to map [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 "ISO 3166-1 alpha-2") data (aka 2-letter country codes) to internal Emarsys country IDs.

data/emarsys.gemspec

@@ -4,26 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'emarsys/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "emarsys"
-  spec.version       = Emarsys::VERSION
-  spec.authors       = ["Daniel Schoppmann"]
-  spec.email         = ["daniel.schoppmann@absolventa.de"]
-  spec.description   = %q{A Ruby library for interacting with the Emarsys API.}
-  spec.summary       = %q{Easy to use ruby library for Emarsys Marketing Suite.}
-  spec.homepage      = "https://github.com/Absolventa/emarsys-rb"
-  spec.license       = "MIT"
+  spec.name = "emarsys"
+  spec.version = Emarsys::VERSION
+  spec.authors = ["Daniel Schoppmann", "Palatinate Tech", "Rory Sinclair"]
+  spec.email = [ "daniel.schoppmann@absolventa.de", "info@palatinategroup.com","rory@asw.com"]
+  spec.description = %q{A Ruby library for interacting with the Emarsys API.}
+  spec.summary = %q{Easy to use ruby library for Emarsys Marketing Suite.}
+  spec.homepage = "https://github.com/ygt/emarsys-rb"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.metadata = {
+    "github_repo" => "ssh://github.com/Absolventa/emarsys-rb"
+  }
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency "rest-client"
+  spec.add_dependency "rest-client", "~> 2.1.0"
 
-  spec.add_development_dependency "bundler", "~> 2.1.4"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 3.5.0"
-  spec.add_development_dependency "webmock", "~> 2.3.2"
-  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "bundler", "~> 2.2.4"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "webmock", "~> 3.14.0"
+  spec.add_development_dependency "timecop", "~> 0.9.4"
 end

data/lib/emarsys/client.rb

@@ -26,7 +26,7 @@ module Emarsys
     end
 
     def header_password_digest
-      Base64.encode64(calculated_digest).gsub("\n", "")
+      Base64.strict_encode64(calculated_digest).strip
     end
 
     def header_nonce

data/lib/emarsys/data_objects/contact.rb

@@ -14,8 +14,8 @@ module Emarsys
       # @param params [Hash] Contact information to create
       # @return [Hash] internal id of the contact
       # @example
-      #   Emarsys::Contact.create('app_id', 23, {:firstname => "Jon", :lastname => "Doe"})
-      #   Emarsys::Contact.create('3', 'john.doe@example.com', {'1' => "Jon", '2' => "Doe"})
+      #   Emarsys::Contact.create(key_id: 'app_id', key_value: 23, params: {:firstname => "Jon", :lastname => "Doe"})
+      #   Emarsys::Contact.create(key_id: '3', key_value: 'john.doe@example.com', params:  {'1' => "Jon", '2' => "Doe"})
       def create(key_id:, key_value:, params: {}, account: nil)
         transformed_key_id = transform_key_id(key_id)
         post account, "contact", params.merge!({'key_id' => transformed_key_id, transformed_key_id => key_value})
@@ -27,8 +27,8 @@ module Emarsys
       # @param key_value [Integer, String] value of internal id field
       # @return [Hash] internal emarsys id of the contact
       # @example
-      #   Emarsys::Contact.emarsys_id('email', 'john.dow@example.com')
-      #   Emarsys::Contact.emarsys_id(1, 'John')
+      #   Emarsys::Contact.emarsys_id(key_id: 'email', key_value: 'john.dow@example.com')
+      #   Emarsys::Contact.emarsys_id(key_id: 1, key_value: 'John')
       def emarsys_id(key_id:, key_value:, account: nil)
         get account, "contact", {"#{transform_key_id(key_id).to_s}" => key_value}
       end
@@ -41,8 +41,8 @@ module Emarsys
       # @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"}, true)
+      #   Emarsys::Contact.update(key_id: 'app_id', key_value: 23, params: {:firstname => "Jon", :lastname => "Doe"})
+      #   Emarsys::Contact.update(key_id: '3', key_value: 'john.doe@example.com', params: {'1' => "Jon", '2' => "Doe"}, true)
       def update(key_id:, key_value:, params: {}, create_if_not_exists: false, account: nil)
         path = "contact#{create_if_not_exists ? '/?create_if_not_exists=1' : ''}"
         transformed_key_id = transform_key_id(key_id)
@@ -55,8 +55,11 @@ module Emarsys
       # @param params [Hash] Contact information of each new contact
       # @example
       #   Emarsys::Contact.create_batch(
-      #     'email', {:app_id => 1, :firstname => "Jon", :lastname => "Doe"},
-      #              {:app_id => 2, :firstname => "Jane", :lastname => "Doe"}
+      #     key_id: 'email',
+      #     params: [
+      #       {:app_id => 1, :firstname => "Jon", :lastname => "Doe"},
+      #       {:app_id => 2, :firstname => "Jane", :lastname => "Doe"}
+      #     ]
       #   )
       #
       def create_batch(key_id:, params: [], account: nil)
@@ -70,10 +73,12 @@ module Emarsys
       # @param create_if_not_exists [Boolean] Whether to create non-existing contacts
       # @example
       #   Emarsys::Contact.update_batch(
-      #     'email',
-      #     [{:email => "john@example.com", :firstname => "Jon", :lastname => "Doe"},
-      #      {:email => "jane@example.com", :firstname => "Jane", :lastname => "Doe"}],
-      #     true
+      #     key_id: 'email',
+      #     params: [
+      #       {:email => "john@example.com", :firstname => "Jon", :lastname => "Doe"},
+      #       {:email => "jane@example.com", :firstname => "Jane", :lastname => "Doe"}
+      #     ],
+      #     create_if_not_exists: true
       #   )
       #
       def update_batch(key_id:, params: [], create_if_not_exists: false, account: nil)
@@ -87,8 +92,8 @@ module Emarsys
       # @param key_value [Integer, String] value of internal id field
       # @return [Hash]
       # @example
-      #   Emarsys::Contact.update('app_id', 23, {:firstname => "Jon", :lastname => "Doe"})
-      #   Emarsys::Contact.update('3', 'john.doe@example.com', {'1' => "Jon", '2' => "Doe"}, true)
+      #   Emarsys::Contact.delete(key_id: 'app_id', key_value: 23)
+      #   Emarsys::Contact.delete(key_id: '3', key_value: 'john.doe@example.com')
       def delete(key_id:, key_value:, account: nil)
         path = "contact/delete"
         transformed_key_id = transform_key_id(key_id)
@@ -100,7 +105,7 @@ module Emarsys
       # @param contacts [array] Array of contact ids
       # @return [Hash] result data
       # @example
-      #   Emarsys::Contact.contact_history([1,2,3]
+      #   Emarsys::Contact.contact_history(contacts: [1,2,3]
       def contact_history(contacts:, account: nil)
         post account, "contact/getcontacthistory", {'contacts' => contacts}
       end
@@ -112,7 +117,7 @@ module Emarsys
       # @param fields [array] requested fields. If empty, all are considered
       # @return [Hash] result data
       # @example
-      #   Emarsys::Contact.search('3', ['john.doe@example.com'], [1,2,3])
+      #   Emarsys::Contact.search(key_id: '3', key_value: ['john.doe@example.com'], fields: [1,2,3])
       #
       # TODO transform fields to numeric fields
       def search(key_id:, key_values:, fields: [], account: nil)
@@ -150,12 +155,13 @@ module Emarsys
       # @return [Hash] result data
       # @example
       #   Emarsys::Contact.export_registrations(distribution_method: 'local', time_range: ["2013-01-01","2013-12-31"], contact_fields: [1,2,3])
-      def export_registrations(distribution_method:, time_range:, contact_fields:, account: nil)
-        post account, "contact/getregistrations", {
+      def export_registrations(distribution_method:, time_range:, contact_fields:, account: nil, **params)
+        params.merge!(
           distribution_method: distribution_method,
           time_range: time_range,
           contact_fields: contact_fields
-        }
+        )
+        post account, "contact/getregistrations", params
       end
 
       # @private

data/lib/emarsys/data_objects/email.rb

@@ -86,10 +86,10 @@ module Emarsys
         params = {}
 
         if !launch_id.nil?
-          params.merge!(launch_id: launch_id) 
+          params.merge!(launch_id: launch_id)
         end
 
-        if !start_date.nil? 
+        if !start_date.nil?
           params.merge!(start_date: start_date)
         end
 
@@ -141,7 +141,7 @@ module Emarsys
       def unsubscribe(account: nil, **params)
         post account, "email/unsubscribe", params
       end
-      
+
       # https://help.emarsys.com/hc/en-us/articles/115004523714
       def email_launches(id, account: nil)
         post account, "email/getlaunchesofemail", emailId: id
@@ -159,11 +159,11 @@ module Emarsys
       # @return [Hash] Result data
       # @example
       #   Emarsys::Email.export_responses(
-      #     'local',
-      #     ['2012-02-09', '2014-08-13'],
-      #     [1, 3],
-      #     ['trackable_links'],
-      #     [5, 8, 13]
+      #     distribution_method: 'local',
+      #     time_range: ['2012-02-09', '2014-08-13'],
+      #     contact_fields: [1, 3],
+      #     sources: ['trackable_links'],
+      #     analysis_fields: [5, 8, 13]
       #   )
       def export_responses(distribution_method:, time_range:, contact_fields:, sources:, analysis_fields:, account: nil, **params)
         params.merge!(

data/lib/emarsys/field_mapping.rb

@@ -65,7 +65,7 @@ module Emarsys::FieldMapping
   end
 
   def self.add_attributes(attrs)
-    @custom_attributes.concat([attrs].flatten)
+    attributes.concat([attrs].flatten)
   end
 
   def self.excluded_default_attributes?

data/lib/emarsys/response.rb

@@ -4,7 +4,7 @@ module Emarsys
     attr_accessor :code, :text, :data, :status
 
     def initialize(response)
-      if response.headers[:content_type] == 'text/csv'
+      if response.headers[:content_type]&.start_with?('text/csv')
         self.code = 0
         self.data = response.body
       else

data/lib/emarsys/version.rb

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

data/spec/emarsys/client_spec.rb

@@ -47,12 +47,12 @@ describe Emarsys::Client do
       end
 
       it 'encodes string with Base64' do
-        expect(Base64).to receive(:encode64).with("something").and_return("something_base64_encoded")
+        expect(Base64).to receive(:strict_encode64).with("something").and_return("something_base64_encoded")
         Emarsys::Client.new.header_password_digest
       end
 
       it 'strips of \n character' do
-        expect(Base64).to receive(:encode64).with("something").and_return("something_base64_encoded\n")
+        expect(Base64).to receive(:strict_encode64).with("something").and_return("something_base64_encoded\n")
         expect(Emarsys::Client.new.header_password_digest).to eq("something_base64_encoded")
       end
     end

data/spec/emarsys/data_objects/contact_spec.rb

@@ -118,7 +118,7 @@ describe Emarsys::Contact do
 
   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]}
+      stub_params = {add_field_names_header: 0, distribution_method: 'local', time_range: ["2013-01-01","2013-12-31"], contact_fields: [1,2,3]}
       stub = stub_request(:post, "https://api.emarsys.net/api/v2/contact/getregistrations").with(:body => stub_params.to_json).to_return(standard_return_body)
       Emarsys::Contact.export_registrations(stub_params)
       expect(stub).to have_been_requested.once

data/spec/emarsys/field_mapping_spec.rb

@@ -66,8 +66,15 @@ describe Emarsys::FieldMapping do
         {: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])
+
+      stub_const('Emarsys::FieldMapping::ATTRIBUTES', attributes)
+
+      mapping_to_be_added = {
+        id: 2000, identifier: 'baz', name: 'Baz'
+      }
+
+      Emarsys::FieldMapping.add_attributes(mapping_to_be_added)
+      expect(Emarsys::FieldMapping.attributes).to include(attributes[0], attributes[1], mapping_to_be_added)
     end
   end
 

data/spec/emarsys/response_spec.rb

@@ -22,7 +22,7 @@ describe Emarsys::Response do
 
     module CSV
       def headers
-        {:content_type => 'text/csv'}
+        {:content_type => 'text/csv;charset=UTF-8'}
       end
     end
   end

metadata

@@ -1,102 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Daniel Schoppmann
-autorequire: 
+- Palatinate Tech
+- Rory Sinclair
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.4
 description: A Ruby library for interacting with the Emarsys API.
 email:
 - daniel.schoppmann@absolventa.de
+- info@palatinategroup.com
+- rory@asw.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -165,11 +169,12 @@ files:
 - spec/emarsys/response_spec.rb
 - spec/emarsys_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/Absolventa/emarsys-rb
+homepage: https://github.com/ygt/emarsys-rb
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  github_repo: ssh://github.com/Absolventa/emarsys-rb
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Easy to use ruby library for Emarsys Marketing Suite.
 test_files: