emarsys 0.3.9 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e155b83198c03cb4fea3ae86224908fd3a95e31d
-  data.tar.gz: 91c5aca80394f07dea3dd1bf43abb07398e795fe
+SHA256:
+  metadata.gz: b91da527fa70b69756d7dca70b153ec103be4c52ed2fc189b6d8eb6d4036637a
+  data.tar.gz: 1ac969e7acf008b6cc07ae032d3c8ce42b8cdcf398b61bb3b51db0ff14c18533
 SHA512:
-  metadata.gz: f6f4a47b51d23e43ed2c5ba4c03a9e62cc47913134425dac1c172d4251c27f23e88f7ae50d8d32aaf02bad8f3f4161bdb11e823ad172d0c0c194e1ac744f25af
-  data.tar.gz: '082ae5439611b7b7d515664c6cd493cc18a7a8d17f108b4a0e2656600111f60a8164dcf36cc886ab4a7770a3ee48d3f586f89abbb37fa2c624b2869c156eff0a'
+  metadata.gz: b512d98dc2a1acbb56a1e783fb00a6e3d915d58a66ea1c773b9c92ea444b4724734e004273ee72758b16179b10b304656a07ad56bd5bd406606fe0d9726c02a0
+  data.tar.gz: 955e9a9626883406b3e029929475dbf04971f3411b5c2112626f7faacd0796c7a0216caf9f1548587d686d4d5e54b1a3c29870fc5a376f7f94ef65673c04eb42

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 sudo: false
-cache:
-  bundler: true
+before_install:
+    - gem install bundler
 rvm:
-- jruby-9.0.5.0
-- 2.2.2
+- jruby-9.2.11.0
 - 2.3.1
+- 2.5.8

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## v0.4.0
+
+* Add supported segment endpoints and remove the deprecated one ([#64]https://github.com/Absolventa/emarsys-rb/pull/64)
+
+## 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))
+
+## v0.3.9
+
+* Add 'query' support to Contact data object ([#53](https://github.com/Absolventa/emarsys-rb/pull/53))
+
+## v0.3.5 - v0.3.8
+
+* Documentation TODO
+
 ## v0.3.4
 
 * Allow accessing of error code ([#35](https://github.com/Absolventa/emarsys-rb/pull/35))

data/README.md

@@ -144,8 +144,12 @@ Emarsys::Contact.create(key_id: 4980, key_value: 10, params: {1 => "Jane", 2 =>
 # Update a contact with key_field (one example with mapped identifier, one without)
 Emarsys::Contact.update(key_id: 'email', key_value: "jane.doe@example.com", params: {firstname: "John", lastname: "Doe"})
 Emarsys::Contact.update(key_id: 3, key_value: "jane.doe@example.com", params: {1 => "John", 2 => "Doe"})
+
+# Query contact information
+Emarsys::Contact.query('3', 'john.doe@example.com', 'uid')
 ```
 
+
 #### ContactList
 
 ```ruby
@@ -154,6 +158,12 @@ Emarsys::ContactList.collection
 
 # Create a contact list
 Emarsys::ContactList.create
+
+# Delete a contact list
+Emarsys::ContactList.delete(123)
+
+# List all contacts in a contact list
+Emarsys::ContactList.contacts(123)
 ```
 
 #### Emails
@@ -227,6 +237,16 @@ Emarsys::Language.collection
 Emarsys::Segment.collection
 ```
 
+```ruby
+# Run a segment for multiple contacts
+Emarsys::Segment.run(123)
+```
+
+```ruby
+# Check the status of a segment run
+Emarsys::Segment.status('foo123')
+```
+
 #### Source
 
 ```ruby

data/emarsys.gemspec

@@ -17,11 +17,13 @@ Gem::Specification.new do |spec|
   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_development_dependency "bundler", "~> 1.3"
+  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.0"
+  spec.add_development_dependency "webmock", "~> 2.3.2"
+  spec.add_development_dependency "timecop"
 end

data/lib/emarsys.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require "base64"
+require 'erb'
 require 'json'
 require 'rest_client'
 require 'uri'

data/lib/emarsys/client.rb

@@ -34,7 +34,7 @@ module Emarsys
     end
 
     def header_created
-      Time.now.utc.iso8601
+      @header_created ||= Time.now.utc.iso8601
     end
 
     def calculated_digest

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

@@ -16,6 +16,14 @@ module Emarsys
         get account, 'contactlist', {}
       end
 
+      # List contacts in a contact list
+      # Reference: https://dev.emarsys.com/v2/contact-lists/list-contacts-in-a-contact-list
+      # 
+      # @param id [Integer] The contact list id
+      def contacts(id, account: nil)
+        get account, "contactlist/#{id}/", {}
+      end
+
       # Create a new contact list
       #
       # @param params [Hash] Contact list information to create
@@ -29,6 +37,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 +58,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/data_objects/segment.rb

@@ -16,6 +16,23 @@ module Emarsys
         get account, 'filter', {}
       end
 
+      # Run a Segment for Multiple Contacts
+      # Reference: https://dev.emarsys.com/v2/segments/run-a-contact-segment-batch
+      #
+      # @param id [Integer] the id of the segment
+      def run(id, account: nil)
+        path = "filter/#{id}/runs"
+        post account, path, {}
+      end
+
+      # Poll the Status of a Segment Run for Multiple Contacts
+      # Reference: https://dev.emarsys.com/v2/segments/poll-the-status-of-a-segment-run-for-multiple-contacts
+      #
+      # @param run_id [String] the id of the segment run, @see #run
+      def status(run_id, account: nil)
+        path = "filter/runs/#{run_id}"
+        get account, path, {}
+      end
     end
   end
 

data/lib/emarsys/version.rb

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

data/spec/emarsys/client_spec.rb

@@ -83,6 +83,15 @@ describe Emarsys::Client do
       it 'uses current timestamp format' do
         expect(Emarsys::Client.new.header_created).to eq(Time.now.utc.iso8601)
       end
+
+      it 'only generates time once' do
+        client = Emarsys::Client.new
+        header_created = Timecop.travel(Time.now - 10) do
+          client.header_created
+        end
+
+        expect(client.header_created).to eq(header_created)
+      end
     end
 
     describe '#calculated_digest' do

data/spec/emarsys/data_objects/contact_list_spec.rb

@@ -8,4 +8,11 @@ describe Emarsys::ContactList do
       ).to have_been_requested.once
     end
   end
+  describe ".contacts" do
+    it "requests all contacts in the given contact list" do
+      expect(
+        stub_get("contactlist/123/") { Emarsys::ContactList.contacts(123) }
+      ).to have_been_requested.once
+    end
+  end
 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

data/spec/emarsys/data_objects/segment_spec.rb

@@ -7,5 +7,19 @@ describe Emarsys::Segment do
         stub_get("filter") { Emarsys::Segment.collection }
       ).to have_been_requested.once
     end
+    describe ".run" do
+      it "requests a run for a segment for multiple contacts" do
+        expect(
+          stub_post("filter/123/runs") { Emarsys::Segment.run(123) }
+        ).to have_been_requested.once
+      end
+    end
+    describe ".status" do
+      it "requests the status of the given segment run" do
+        expect(
+          stub_get("filter/runs/foo-333-bar") { Emarsys::Segment.status('foo-333-bar') }
+        ).to have_been_requested.once
+      end
+    end
   end
 end

data/spec/emarsys/response_spec.rb

@@ -59,7 +59,8 @@ describe Emarsys::Response do
   end
 
   describe 'error response' do
-    let(:response_string) { "{\"replyCode\":1,\"replyText\":\"Something\",\"data\":1}" }
+    let(:reply_code) { 1 }
+    let(:response_string) { "{\"replyCode\":#{reply_code},\"replyText\":\"Something\",\"data\":1}" }
     let(:fake_response) { FakeResponse.new(response_string).extend(FakeResponse::JSON) }
     let(:response) { Emarsys::Response.new(fake_response) }
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'emarsys'
 require 'rspec'
 require 'webmock/rspec'
+require 'timecop'
 
 WebMock.disable_net_connect!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-20 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,30 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 description: A Ruby library for interacting with the Emarsys API.
 email:
 - daniel.schoppmann@absolventa.de
@@ -163,15 +177,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Easy to use ruby library for Emarsys Marketing Suite.