emarsys 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31cbab3211176489903574030ce2a194b17f44aa
-  data.tar.gz: 3ddda91a55d7a46918cdd26c3fc94f5b52a66918
+  metadata.gz: 247a91fcb90eb1b733aeaf081416020ed0a01b55
+  data.tar.gz: 6aa2a34c4e5b4c5e6d0a9021665e329c265661b0
 SHA512:
-  metadata.gz: 5fb1f42e3cf6ef978fd1d321d0fc8ef406f4b92f928fd52eb7cc9adfda2f07f8014cef71e674a84debb9a2bd8bf8ca895d3e35e02d1203cf32ba181f68beca72
-  data.tar.gz: f0dd1aa961efbb2d166dc2098a9a654f2789848e1a8fba371fe3a465010ddf87b09e2a413ba33d3b52bdb992d0e4890c8d14b56c718e969f5ea5d8e4d8c24fd9
+  metadata.gz: c85175b2fa275793ae0de36b67c81048c15a928e6daa3f073acc58df33cd5a786a250a8fce410b8983db2e0503d1f36d3795a2ba9e2bb03c4c46b128f6d107e4
+  data.tar.gz: b9ccae40c2c73ee2eb0c851eb1a8040ab253daed9b673f226ee2f0c96a1228cdca0e9b4b327f1fda41bdc833ca72c91ec23b28d3b299a5502b4b6f23e31604ea

data/lib/emarsys/client.rb

@@ -40,5 +40,13 @@ module Emarsys
     def calculated_digest
       Digest::SHA1.hexdigest(header_nonce + header_created + password)
     end
+
+    def open_timeout
+      Emarsys::Configuration.for(account).open_timeout
+    end
+
+    def read_timeout
+      Emarsys::Configuration.for(account).read_timeout
+    end
   end
 end

data/lib/emarsys/configuration.rb

@@ -50,5 +50,11 @@ module Emarsys
       @api_password or raise ArgumentError.new('api_password is not set')
     end
 
+    # @!attribute open_timeout
+    #   @return [Integer] Connect Timeout. default: RestClient timeout which is 60s
+    # @!attribute read_timeout
+    #   @return [Integer] Read Timeout. default: RestClient timeout which is 60s
+    attr_accessor :open_timeout, :read_timeout
+
   end
 end

data/lib/emarsys/data_objects/email.rb

@@ -153,6 +153,24 @@ module Emarsys
         )
         post account, "email/getresponses", params
       end
+
+      # http://documentation.emarsys.com/resource/developers/endpoints/email/query-responses/
+      def responses(type:, start_date: nil, end_date: nil, campaign_id: nil, account: nil)
+        params = { type: type }
+        if !campaign_id.nil?
+          params.merge!(campaign_id: campaign_id)
+        elsif !start_date.nil? && !end_date.nil?
+          params.merge!(start_date: start_date, end_date: end_date)
+        else
+          raise "Either campaign_id OR start_date/end_date must be provided"
+        end
+        post account, "email/responses", params
+      end
+
+      # http://documentation.emarsys.com/resource/developers/endpoints/email/query-responses-result/
+      def responses_result(query_id, account: nil)
+        get account, "email/#{query_id}/responses", {}
+      end
     end
   end
 end

data/lib/emarsys/request.rb

@@ -6,29 +6,32 @@ module Emarsys
 
     def initialize(account, http_verb, path, params = {})
       self.path = path
-      self.http_verb = http_verb
+      self.http_verb = http_verb.to_sym
       self.params = params
       self.account = account
     end
 
     def send_request
-      case http_verb.to_sym
-      when :post
-        RestClient.post(emarsys_uri, converted_params.to_json, :content_type => :json, :x_wsse => client.x_wsse_string) do |response, request, result, &block|
-          Emarsys::Response.new(response)
-        end
-      when :put
-        RestClient.put emarsys_uri, converted_params.to_json, :content_type => :json, :x_wsse => client.x_wsse_string do |response, request, result, &block|
-          Emarsys::Response.new(response)
-        end
-      when :delete
-        RestClient.delete(emarsys_uri, :content_type => :json, :x_wsse => client.x_wsse_string) do |response, request, result, &block|
-          Emarsys::Response.new(response)
-        end
-      else
-        RestClient.get(emarsys_uri, :content_type => :json, :x_wsse => client.x_wsse_string) do |response, request, result, &block|
-          Emarsys::Response.new(response)
-        end
+      args = {
+        method: http_verb,
+        url: emarsys_uri,
+        headers: { content_type: :json, x_wsse: client.x_wsse_string }
+      }
+
+      if client.open_timeout
+        args.merge!(open_timeout: client.open_timeout)
+      end
+
+      if client.read_timeout
+        args.merge!(read_timeout: client.read_timeout)
+      end
+
+      if [:post, :put].include?(http_verb)
+        args.merge!(payload: converted_params.to_json)
+      end
+
+      RestClient::Request.execute(args) do |response, request, result, &block|
+        Emarsys::Response.new(response)
       end
     end
 

data/lib/emarsys/version.rb

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

data/spec/emarsys/data_objects/email_spec.rb

@@ -91,4 +91,21 @@ describe Emarsys::Email do
     end
   end
 
+  describe ".responses" do
+    it "queries responses" do
+      stub_params = { type: "received", campaign_id: 123 }
+      stub = stub_request(:post, "https://api.emarsys.net/api/v2/email/responses").with(:body => stub_params.to_json).to_return(standard_return_body)
+      Emarsys::Email.responses(stub_params)
+      expect(stub).to have_been_requested.once
+    end
+  end
+
+  describe ".responses_result" do
+    it "queries responses result" do
+      expect(
+        stub_get('email/123/responses') { Emarsys::Email.responses_result(123) }
+      ).to have_been_requested.once
+    end
+  end
+
 end

data/spec/emarsys/request_spec.rb

@@ -1,12 +1,11 @@
 require 'spec_helper'
 
 describe Emarsys::Request do
-  let(:client) { Emarsys::Client.new }
   let(:request) { Emarsys::Request.new(nil, 'get', 'some-path', {:a => 1}) }
 
   describe '#initialize' do
     it 'sets client, path, http_verb and params attributes on initialize' do
-      expect(request.http_verb).to eq('get')
+      expect(request.http_verb).to eq(:get)
       expect(request.path).to eq("some-path")
       expect(request.params).to eq({:a => 1})
     end
@@ -24,4 +23,16 @@ describe Emarsys::Request do
     end
   end
 
+  describe '#send_request' do
+    let(:client) { Emarsys::Client.new }
+    it 'sets timeouts if configured' do
+      allow(request).to receive(:client).and_return(client)
+      allow(client).to receive(:read_timeout).and_return(2)
+      expect(RestClient::Request).to receive(:execute).with(
+        hash_including(read_timeout: 2)
+      )
+      request.send_request
+    end
+  end
+
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: emarsys
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Daniel Schoppmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-21 00:00:00.000000000 Z
+date: 2017-08-23 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
+  name: rest-client
   prerelease: false
+  type: :runtime
   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
+  name: bundler
   prerelease: false
+  type: :development
   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
+  name: rake
   prerelease: false
+  type: :development
   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
+  name: rspec
   prerelease: false
+  type: :development
   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
+  name: webmock
   prerelease: false
+  type: :development
   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
@@ -155,24 +155,24 @@ homepage: https://github.com/Absolventa/emarsys-rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.8
+signing_key:
 specification_version: 4
 summary: Easy to use ruby library for Emarsys Marketing Suite.
 test_files: