emarsys 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f51e63dffed54e43665b658688f037b8faca2eb7
-  data.tar.gz: 318259a5924f0cf0817b7ceabf8a47ac01bd4228
+  metadata.gz: 7bf69d01042a7b64304940391651c7fe3a99d96c
+  data.tar.gz: c7aa084a93d3f0201e617bfe6d2f040c7eddde84
 SHA512:
-  metadata.gz: eec320a70c5f20ed23287e40897714d8d98fe6a04ac56e0c2e850bd321ce2e40dcbd3e7a1421fec4d4eb2be9ebffcfc06ba8a6f86a2c8057b8d530a9a8489544
-  data.tar.gz: 297f2b1dc6a5084d4ff46333c63571903c6fe33a188052f70c28a54b039a05dd018480018113d444ec63eac6c52fa765017eae5dd1c90f2bf8299f1905047273
+  metadata.gz: 702951ca24054c4bbf36e5442e6346e5ab112a778c91b53f1b1ebd24be9a1fdaae6bbfc10550408665c40edf55b02a60e67ffb5cdb9e55630f4c6f05831b01e8
+  data.tar.gz: 7913423d7bc03c272f187ba172f9f80b77aa69eb90c2738b62d48a591292d71b594ba37a32b1aeb27a2af41d6a9310703772153e999bc791a04dbe1de1b9d8ae

data/lib/emarsys/data_objects/contact.rb

@@ -10,7 +10,7 @@ module Emarsys
       # Create a new contact. The given params are transformed to emarsys ids.
       #
       # @param key_id [Integer, String] internal id of key field
-      # @param key_value [Integer, String] value of interal id field
+      # @param key_value [Integer, String] value of internal id field
       # @param params [Hash] Contact information to create
       # @return [Hash] internal id of the contact
       # @example
@@ -21,10 +21,10 @@ module Emarsys
         post account, "contact", params.merge!({'key_id' => transformed_key_id, transformed_key_id => key_value})
       end
 
-      # Get the interal emarsys id of a contact. The given params are transformed to emarsys ids.
+      # Get the internal emarsys id of a contact. The given params are transformed to emarsys ids.
       #
       # @param key_id [Integer, String] internal id of key field
-      # @param key_value [Integer, String] value of interal id field
+      # @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')
@@ -36,7 +36,7 @@ module Emarsys
       # Update a contact. The given params are transformed to emarsys ids.
       #
       # @param key_id [Integer, String] internal id of key field
-      # @param key_value [Integer, String] value of interal id field
+      # @param key_value [Integer, String] value of internal 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
@@ -84,7 +84,7 @@ module Emarsys
       # Delete a contact. The given params are transformed to emarsys ids.
       #
       # @param key_id [Integer, String] internal id of key field
-      # @param key_value [Integer, String] value of interal id field
+      # @param key_value [Integer, String] value of internal id field
       # @return [Hash]
       # @example
       #   Emarsys::Contact.update('app_id', 23, {:firstname => "Jon", :lastname => "Doe"})

data/lib/emarsys/data_objects/email.rb

@@ -81,14 +81,23 @@ module Emarsys
         post account, "email/#{id}/preview", {:version => version}
       end
 
-      # View response summary of an email
-      #
-      # @param id [Integer, String] Internal email id
-      # @return [Hash] Result data
-      # @example
-      #   Emarsys::Email.response_summary(1)
-      def response_summary(id, account: nil)
-        get account, "email/#{id}/responsesummary", {}
+      # http://documentation.emarsys.com/resource/developers/endpoints/email/response-summary/
+      def response_summary(id, launch_id: nil, start_date: nil, end_date: nil, account: nil)
+        params = {}
+
+        if !launch_id.nil?
+          params.merge!(launch_id: launch_id) 
+        end
+
+        if !start_date.nil? 
+          params.merge!(start_date: start_date)
+        end
+
+        if !end_date.nil?
+          params.merge!(end_date: end_date)
+        end
+
+        get account, "email/#{id}/responsesummary", params
       end
 
       # Instruct emarsys to send a test mail
@@ -120,9 +129,22 @@ module Emarsys
         post account, "email/#{id}/getdeliverystatus", params
       end
 
-      # TODO POST /getlaunchesofemail
+      # Tracking email campaign unsubscribes
+      #
+      # @param params [hash] unsubscribe parameters
+      # @option params [String] 'contact_uid'
+      # @option params [String] 'email_id'
+      # @option params [String] 'launch_list_id'
+      # @return [Hash] Result data
+      # @example
+      #   Emarsys::Email.unsubscribe({contact_uid: '1', email_id: '1', launch_list_id: '1'})
+      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)
-        raise "Not implemented yet"
+        post account, "email/getlaunchesofemail", emailId: id
       end
 
       # Exports the selected fields of all contacts who responded to emails

data/lib/emarsys/data_objects/field.rb

@@ -33,6 +33,28 @@ module Emarsys
       def choice(id, account: nil)
         get account, "field/#{id}/choice", {}
       end
+
+      # Create a new custom field
+      #
+      # @param name [String] name of the new field
+      # @param application_type [String] type of the new field
+      # @param string_id [String] optional string_id for the new field
+      # @return [Hash] Result Data
+      # @example
+      #   Emarsys::Field.create(
+      #     name: 'New field',
+      #     application_type: 'shorttext',
+      #     string_id: 'string_id_for_the_new_field'
+      #   )
+      #   Emarsys::Field.create(
+      #     name: 'New number field',
+      #     application_type: 'numeric'
+      #   )
+      def create(name:, application_type:, string_id: nil, account: nil)
+        params = { name: name, application_type: application_type }
+        params[:string_id] = string_id if string_id
+        post account, 'field', params
+      end
     end
 
   end

data/lib/emarsys/data_objects/file.rb

@@ -23,7 +23,7 @@ module Emarsys
       #
       # @param filename [String] The filename
       # @param file [String] Base64 encoded version of the file
-      # @param folder [Integer, String] optinal folder to out te file into
+      # @param folder [Integer, String] optional folder to put the file into
       # @return [Hash] Result data
       # @example
       #   Emarsys::File.create("my_file.jpg", "asdhkajsh...")

data/lib/emarsys/version.rb

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

data/spec/emarsys/data_objects/email_spec.rb

@@ -83,10 +83,25 @@ describe Emarsys::Email do
     end
   end
 
+  describe ".unsubscribe" do
+    it "tracks unsubscribes with contact and list details" do
+      stub_params = {contact_uid: '1', email_id: '1', launch_list_id: '1'}
+      stub = stub_request(:post, "https://api.emarsys.net/api/v2/email/unsubscribe").with(:body => stub_params.to_json).to_return(standard_return_body)
+
+      Emarsys::Email.unsubscribe(stub_params)
+      expect(stub).to have_been_requested.once
+    end
+  end
+
   describe ".response_summary" do
     it "requests a single email" do
-      expect(
-        stub_get('email/123/responsesummary') { Emarsys::Email.response_summary(123) }
+      stub_params = {
+        launch_id: 123,
+        start_date: '2013-12-01 23:00:00',
+        end_date: '2013-12-02 23:00:00'
+      }
+      expect(stub_get('email/123/responsesummary/?end_date=2013-12-02%2023:00:00&launch_id=123&start_date=2013-12-01%2023:00:00') { 
+        Emarsys::Email.response_summary(123, stub_params) }
       ).to have_been_requested.once
     end
   end
@@ -108,4 +123,15 @@ describe Emarsys::Email do
     end
   end
 
+  describe ".email_launches" do
+    it "queries email launches" do
+      stub_params = { emailId: 123 }
+      stub = stub_request(:post, 'https://api.emarsys.net/api/v2/email/getlaunchesofemail')
+      .with(body: stub_params.to_json)
+      .to_return(standard_return_body)
+      Emarsys::Email.email_launches(123) 
+      expect(stub).to have_been_requested.once
+    end
+  end
+
 end

data/spec/emarsys/data_objects/field_spec.rb

@@ -22,4 +22,14 @@ describe Emarsys::Field do
       ).to have_been_requested.once
     end
   end
+
+  describe '.create' do
+    it 'creates a new custom field' do
+      expect(
+        stub_post('field') do
+          Emarsys::Field.create(name: 'New field', application_type: 'shorttext')
+        end
+      ).to have_been_requested.once
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -25,3 +25,9 @@ def stub_get(path, &block)
   yield if block_given?
   stub
 end
+
+def stub_post(path, &block)
+  stub = stub_request(:post, "https://api.emarsys.net/api/v2/#{path}").to_return(standard_return_body)
+  yield if block_given?
+  stub
+end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Daniel Schoppmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2018-01-12 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: A Ruby library for interacting with the Emarsys API.
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -161,17 +161,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Easy to use ruby library for Emarsys Marketing Suite.