itrp-client 1.0.14 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 147dc4446fd8b16a6719124e8ab21a41d200ae5c
-  data.tar.gz: fcad65d016b1d9f06d4868cddcf8a9557a7844fc
+  metadata.gz: 89081124a0ce058991107658acc89152c8d4118e
+  data.tar.gz: b92af38225ebdbd0592f508b4e5ddd7fb6c6983c
 SHA512:
-  metadata.gz: 25d6c3c1ceb110176e1a86ed019db1c79766db489785adec61dfa67cc8742cfff5f460d33d78830ff2b632b3a6b6cc098f3ccc72d0321b652e225bdc02406aff
-  data.tar.gz: 5faa62a7886b27adc35b3edfe86078d372521fbb6bef80c66e749411a57ce49394a2630b54f20fdb456c02ea8db43be14ee0ffa76b3e149ee019b60df4d6db86
+  metadata.gz: 232eeb5ef89f2e2f6c83266eb95a777ecccfa891e9b7fed8ea88c51c332183c7ffec3aaaed8eb259c66a540a0d86d0152fb65612aab779f463cd8ad7b24f6249
+  data.tar.gz: acc1b94b7a6ea21c695a0f44ef3d332a601f0ac3c77af43499c79cb386424aa0958498a5d2cb62b4184f83eb96b04356b99129b3f693f81663767db02e257cf4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    itrp-client (1.0.13)
+    itrp-client (1.1.0)
       activesupport
       gem_config
       mime-types
@@ -9,26 +9,28 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.2.5.1)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.4.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     gem_config (0.3.1)
-    hashdiff (0.2.3)
+    hashdiff (0.3.1)
     i18n (0.7.0)
     json (1.8.3)
-    mime-types (3.0)
+    mime-types (3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2015.1120)
-    minitest (5.8.4)
-    rake (10.5.0)
+    mime-types-data (3.2016.0521)
+    minitest (5.9.1)
+    public_suffix (2.0.4)
+    rake (11.3.0)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -43,15 +45,15 @@ GEM
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
     safe_yaml (1.0.4)
-    simplecov (0.11.1)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    webmock (1.22.6)
+    webmock (2.1.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -65,7 +67,7 @@ DEPENDENCIES
   rake
   rspec (~> 3.3.0)
   simplecov
-  webmock
+  webmock (~> 2)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 ITRP Inc.
+Copyright (c) 2016 ITRP Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/itrp-client.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name                  = "itrp-client"
   spec.version               = Itrp::Client::VERSION
   spec.platform              = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
   spec.authors               = ["ITRP"]
   spec.email                 = %q{developers@itrp.com}
   spec.description           = %q{Client for accessing the ITRP REST API}
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'rspec', "~> 3.3.0"
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'webmock', "~> 2"
   spec.add_development_dependency 'simplecov'
 
 end

data/lib/itrp/client.rb

@@ -225,7 +225,7 @@ module Itrp
       path
     end
 
-    # Expand one parameter, e.g. (:"created_at=>", DateTime.now) to "created_at=%3E22011-12-16T12:24:41+01:00"
+    # Expand one parameter, e.g. (:"created_at=>", DateTime.now) to "created_at=%3E22011-12-16T12:24:41%2B01:00"
     def expand_param(key, value)
       param = uri_escape(key.to_s).gsub('%3D', '=') # handle :"updated_at=>" or :"person_id!=" parameters
       param << '=' unless key['=']
@@ -237,10 +237,10 @@ module Itrp
     def typecast(value, escape = true)
       case value.class.name.to_sym
         when :NilClass    then ''
-        when :String      then escape ? URI.escape(value) : value
+        when :String      then escape ? uri_escape(value) : value
         when :TrueClass   then 'true'
         when :FalseClass  then 'false'
-        when :DateTime    then value.new_offset(0).iso8601
+        when :DateTime    then datetime = value.new_offset(0).iso8601; escape ? uri_escape(datetime) : datetime
         when :Date        then value.strftime("%Y-%m-%d")
         when :Time        then value.strftime("%H:%M")
         # do not convert arrays in put/post requests as squashing arrays is only used in filtering
@@ -278,41 +278,45 @@ module Itrp
       response
     end
 
+    # parse the given URI to [domain, port, ssl, path]
+    def ssl_domain_port_path(uri)
+      uri = URI.parse(uri)
+      ssl = uri.scheme == 'https'
+      [ssl, uri.host, uri.port, uri.path]
+    end
+
+  end
+
+  module SendWithRateLimitBlock
     # Wraps the _send method with retries when the server does not responsd, see +initialize+ option +:rate_limit_block+
-    def _send_with_rate_limit_block(request, domain = @domain, port = @port, ssl = @ssl)
-      return _send_without_rate_limit_block(request, domain, port, ssl) unless option(:block_at_rate_limit)
+    def _send(request, domain = @domain, port = @port, ssl = @ssl)
+      return super(request, domain, port, ssl) unless option(:block_at_rate_limit)
       now = Time.now
       begin
-        _response = _send_without_rate_limit_block(request, domain, port, ssl)
+        _response = super(request, domain, port, ssl)
         @logger.warn { "Request throttled, trying again in 5 minutes: #{_response.message}" } and sleep(300) if _response.throttled?
       end while _response.throttled? && (Time.now - now) < 3660 # max 1 hour and 1 minute
       _response
     end
-    alias_method_chain :_send, :rate_limit_block
+  end
+  Client.send(:prepend, SendWithRateLimitBlock)
 
+  module SendWithRetries
     # Wraps the _send method with retries when the server does not responsd, see +initialize+ option +:retries+
-    def _send_with_retries(request, domain = @domain, port = @port, ssl = @ssl)
+    def _send(request, domain = @domain, port = @port, ssl = @ssl)
       retries = 0
       sleep_time = 2
       total_retry_time = 0
       begin
-        _response = _send_without_retries(request, domain, port, ssl)
+        _response = super(request, domain, port, ssl)
         @logger.warn { "Request failed, retry ##{retries += 1} in #{sleep_time} seconds: #{_response.message}" } and sleep(sleep_time) if _response.empty? && option(:max_retry_time) > 0
         total_retry_time += sleep_time
         sleep_time *= 2
       end while _response.empty? && total_retry_time < option(:max_retry_time)
       _response
     end
-    alias_method_chain :_send, :retries
-
-    # parse the given URI to [domain, port, ssl, path]
-    def ssl_domain_port_path(uri)
-      uri = URI.parse(uri)
-      ssl = uri.scheme == 'https'
-      [ssl, uri.host, uri.port, uri.path]
-    end
-
   end
+  Client.send(:prepend, SendWithRetries)
 end
 
 # HTTPS with certificate bundle

data/lib/itrp/client/version.rb

@@ -1,5 +1,5 @@
 module Itrp
   class Client
-    VERSION = '1.0.14'
+    VERSION = '1.1.0'
   end
 end

data/spec/lib/itrp/attachments_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe Itrp::Attachments do
+
+  before(:each) do
+    @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    @attachments = Itrp::Attachments.new(@client)
+  end
+
+  context 'upload_attachments!' do
+    it 'should not do anything when no :attachments are present' do
+      expect(@attachments.upload_attachments!('/requests', {status: :in_progress})).to be_nil
+    end
+
+    it 'should not do anything when :attachments is nil' do
+      expect(@attachments.upload_attachments!('/requests', {attachments: nil})).to be_nil
+    end
+
+    it 'should not do anything when :attachments is empty' do
+      expect(@attachments.upload_attachments!('/requests', {attachments: []})).to be_nil
+      expect(@attachments.upload_attachments!('/requests', {attachments: [nil]})).to be_nil
+    end
+
+    it 'should show a error if no attachment may be uploaded' do
+      stub_request(:get, 'https://api.itrp.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
+      expect_log('Attachments not allowed for /sites/1', :error)
+      expect(@attachments.upload_attachments!('/sites/1', {attachments: ['file1.png']})).to be_nil
+    end
+
+    it 'should raise an exception if no attachment may be uploaded' do
+      stub_request(:get, 'https://api.itrp.com/v1/sites/1?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'site 1'}.to_json)
+      message = 'Attachments not allowed for /sites/1'
+      expect{ @attachments.upload_attachments!('/sites/1', {attachments: ['file1.png'], attachments_exception: true}) }.to raise_error(::Itrp::UploadFailed, message)
+    end
+
+    it 'should add /new to the path for new records' do
+      stub_request(:get, 'https://api.itrp.com/v1/sites/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {missing: 'storage'}.to_json)
+      expect_log('Attachments not allowed for /sites', :error)
+      expect(@attachments.upload_attachments!('/sites', {attachments: ['file1.png']})).to be_nil
+    end
+
+    [ [:requests,          :note],
+      [:problems,          :note],
+      [:contracts,         :remarks],
+      [:cis,               :remarks],
+      [:flsas,             :remarks],
+      [:slas,              :remarks],
+      [:service_instances, :remarks],
+      [:service_offerings, :summary],
+      [:any_other_model,   :note]].each do |model, attribute|
+
+      it "should replace :attachments with :#{attribute}_attachments after upload at /#{model}" do
+        stub_request(:get, "https://api.itrp.com/v1/#{model}/new?attachment_upload_token=true").with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
+        expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', false).ordered{ 'uploaded file1.png' }
+        expect(@attachments).to receive(:upload_attachment).with('conf', 'file2.zip', false).ordered{ 'uploaded file2.zip' }
+        data = {leave: 'me alone', attachments: %w(file1.png file2.zip)}
+        @attachments.upload_attachments!("/#{model}", data)
+        expect(data[:attachments]).to be_nil
+        expect(data[:leave]).to eq('me alone')
+        expect(data[:"#{attribute}_attachments"]).to eq(['uploaded file1.png', 'uploaded file2.zip'].to_json)
+      end
+    end
+
+    it 'should set raise_exception flag to true when :attachments_exception is set' do
+      stub_request(:get, 'https://api.itrp.com/v1/requests/new?attachment_upload_token=true').with(basic_auth: ['secret', 'x']).to_return(body: {storage_upload: 'conf'}.to_json)
+      expect(@attachments).to receive(:upload_attachment).with('conf', 'file1.png', true).ordered{ 'uploaded file1.png' }
+      data = {leave: 'me alone', attachments: 'file1.png', attachments_exception: true}
+      @attachments.upload_attachments!('/requests', data)
+      expect(data[:attachments]).to be_nil
+      expect(data[:attachments_exception]).to be_nil
+      expect(data[:leave]).to eq('me alone')
+      expect(data[:note_attachments]).to eq(['uploaded file1.png'].to_json)
+    end
+  end
+
+  context 'upload_attachment' do
+
+    it 'should log an exception when the file could not be found' do
+      expect_log('Attachment upload failed: file does not exist: unknown_file', :error)
+      expect(@attachments.send(:upload_attachment, nil, 'unknown_file', false)).to be_nil
+    end
+
+    it 'should raise an exception when the file could not be found' do
+      message = 'Attachment upload failed: file does not exist: unknown_file'
+      expect{ @attachments.send(:upload_attachment, nil, 'unknown_file', true) }.to raise_error(::Itrp::UploadFailed, message)
+    end
+
+    context 'aws' do
+      before(:each) do
+        @aws_conf = {
+            provider: 'aws',
+            upload_uri: 'https://itrp.s3.amazonaws.com/',
+            access_key: "AKIA6RYQ",
+            success_url: "https://mycompany.itrp.com/s3_success?sig=99e82e8a046",
+            policy: "eydlgIH0=",
+            signature: 'nbhdec4k=',
+            upload_path: 'attachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/'
+        }
+        @key_template = 'attachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/${filename}'
+        @key = 'attachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/upload.txt'
+
+        @multi_part_body = "--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"Content-Type\"\r\n\r\napplication/octet-stream\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"x-amz-server-side-encryption\"\r\n\r\nAES256\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"key\"\r\n\r\nattachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/${filename}\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"AWSAccessKeyId\"\r\n\r\nAKIA6RYQ\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"acl\"\r\n\r\nprivate\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"signature\"\r\n\r\nnbhdec4k=\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"success_action_status\"\r\n\r\n201\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"policy\"\r\n\r\neydlgIH0=\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"file\"; filename=\"#{@fixture_dir}/upload.txt\"\r\nContent-Type: text/plain\r\n\r\ncontent\r\n--0123456789ABLEWASIEREISAWELBA9876543210--"
+        @multi_part_headers = {'Accept'=>'*/*', 'Content-Type'=>'multipart/form-data; boundary=0123456789ABLEWASIEREISAWELBA9876543210', 'User-Agent'=>'Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6'}
+      end
+
+      it 'should open a file from disk' do
+        expect(@attachments).to receive(:aws_upload).with(@aws_conf, @key_template, @key, kind_of(File))
+        expect(@attachments.send(:upload_attachment, @aws_conf, "#{@fixture_dir}/upload.txt", false)).to eq({key: @key, filesize: 7})
+      end
+
+      it 'should sent the upload to AWS' do
+        stub_request(:post, 'https://itrp.s3.amazonaws.com/').with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: 'OK', status: 303, headers: {'Location' => 'https://mycompany.itrp.com/s3_success?sig=99e82e8a046'})
+        stub_request(:get, "https://api.itrp.com/v1/s3_success?sig=99e82e8a046&key=#{@key}").with(basic_auth: ['secret', 'x']).to_return(body: {}.to_json)
+        expect(@attachments.send(:upload_attachment, @aws_conf, "#{@fixture_dir}/upload.txt", false)).to eq({key: @key, filesize: 7})
+      end
+
+      it 'should report an error when AWS upload fails' do
+        stub_request(:post, 'https://itrp.s3.amazonaws.com/').with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: %(<?xml version="1.0" encoding="UTF-8"?>\n<Error><Code>AccessDenied</Code><Message>Invalid according to Policy</Message><RequestId>1FECC4B719E426B1</RequestId><HostId>15+14lXt+HlF</HostId></Error>), status: 303, headers: {'Location' => 'https://mycompany.itrp.com/s3_success?sig=99e82e8a046'})
+        expect_log("Attachment upload failed: AWS upload to https://itrp.s3.amazonaws.com/ for #{@key} failed: Invalid according to Policy", :error)
+        expect(@attachments.send(:upload_attachment, @aws_conf, "#{@fixture_dir}/upload.txt", false)).to be_nil
+      end
+
+      it 'should report an error when ITRP confirmation fails' do
+        stub_request(:post, 'https://itrp.s3.amazonaws.com/').with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: 'OK', status: 303, headers: {'Location' => 'https://mycompany.itrp.com/s3_success?sig=99e82e8a046'})
+        stub_request(:get, "https://api.itrp.com/v1/s3_success?sig=99e82e8a046&key=#{@key}").with(basic_auth: ['secret', 'x']).to_return(body: {message: 'oops!'}.to_json)
+        expect_log('Request failed: oops!', :error)
+        expect_log("Attachment upload failed: ITRP confirmation s3_success?sig=99e82e8a046 for #{@key} failed: oops!", :error)
+        expect(@attachments.send(:upload_attachment, @aws_conf, "#{@fixture_dir}/upload.txt", false)).to be_nil
+      end
+
+      it 'should raise an exception when AWS upload fails' do
+        stub_request(:post, 'https://itrp.s3.amazonaws.com/').with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: %(<?xml version="1.0" encoding="UTF-8"?>\n<Error><Code>AccessDenied</Code><Message>Invalid according to Policy</Message><RequestId>1FECC4B719E426B1</RequestId><HostId>15+14lXt+HlF</HostId></Error>), status: 303, headers: {'Location' => 'https://mycompany.itrp.com/s3_success?sig=99e82e8a046'})
+        message = "Attachment upload failed: AWS upload to https://itrp.s3.amazonaws.com/ for #{@key} failed: Invalid according to Policy"
+        expect{ @attachments.send(:upload_attachment, @aws_conf, "#{@fixture_dir}/upload.txt", true) }.to raise_error(::Itrp::UploadFailed, message)
+      end
+    end
+
+    context 'itrp' do
+      before(:each) do
+        @itrp_conf = {
+            provider: 'local',
+            upload_uri: 'https://api.itrp.com/attachments',
+            upload_path: 'attachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/'
+        }
+        @key_template = 'attachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/${filename}'
+        @key = 'attachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/upload.txt'
+
+        @multi_part_body = "--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"Content-Type\"\r\n\r\napplication/octet-stream\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"file\"; filename=\"#{@spec_dir}/support/fixtures/upload.txt\"\r\nContent-Type: text/plain\r\n\r\ncontent\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"key\"\r\n\r\nattachments/5/reqs/000/070/451/zxxb4ot60xfd6sjg/${filename}\r\n--0123456789ABLEWASIEREISAWELBA9876543210--"
+        @multi_part_headers = {'Accept'=>'*/*', 'Content-Type'=>'multipart/form-data; boundary=0123456789ABLEWASIEREISAWELBA9876543210', 'User-Agent'=>'Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6'}
+      end
+
+      it 'should open a file from disk' do
+        expect(@attachments).to receive(:itrp_upload).with(@itrp_conf, @key_template, @key, kind_of(File))
+        expect(@attachments.send(:upload_attachment, @itrp_conf, "#{@fixture_dir}/upload.txt", false)).to eq({key: @key, filesize: 7})
+      end
+
+      it 'should sent the upload to ITRP' do
+        stub_request(:post, 'https://api.itrp.com/v1/attachments').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {}.to_json)
+        expect(@attachments.send(:upload_attachment, @itrp_conf, "#{@fixture_dir}/upload.txt", false)).to eq({key: @key, filesize: 7})
+      end
+
+      it 'should report an error when ITRP upload fails' do
+        stub_request(:post, 'https://api.itrp.com/v1/attachments').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {message: 'oops!'}.to_json)
+        expect_log('Request failed: oops!', :error)
+        expect_log("Attachment upload failed: ITRP upload to https://api.itrp.com/attachments for #{@key} failed: oops!", :error)
+        expect(@attachments.send(:upload_attachment, @itrp_conf, "#{@fixture_dir}/upload.txt", false)).to be_nil
+      end
+
+      it 'should raise an exception when ITRP upload fails' do
+        stub_request(:post, 'https://api.itrp.com/v1/attachments').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {message: 'oops!'}.to_json)
+        expect_log('Request failed: oops!', :error)
+        message = "Attachment upload failed: ITRP upload to https://api.itrp.com/attachments for #{@key} failed: oops!"
+        expect{ @attachments.send(:upload_attachment, @itrp_conf, "#{@fixture_dir}/upload.txt", true) }.to raise_error(::Itrp::UploadFailed, message)
+      end
+    end
+
+  end
+end

data/spec/lib/itrp/certificate_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe 'ca-bundle.crt' do
+
+  it 'should be able to connect to the ITRP API' do
+    WebMock.allow_net_connect!
+    client = Itrp::Client.new(api_token: 'invalid', max_retry_time: -1)
+    result = {}
+
+    # no exception concerning the certificate
+    expect { result[:response] = client.get('me') }.not_to raise_error
+    response = result[:response]
+    expect(response.valid?).to be_falsey
+
+    # expecting 401 error
+    expect(response.message).to eq('401: Access credentials required')
+  end
+
+  it 'should be able to connect to S3' do
+    WebMock.allow_net_connect!
+    http = Net::HTTP.new('itrp-eu.s3-eu-west-1.amazonaws.com', 443)
+    http.read_timeout = 1
+    http.use_ssl = true
+
+    # no SSL error please
+    expect{ http.start{ |_http| _http.request(Net::HTTP::Get.new('/exports/20141107/')) } }.to never_raise(OpenSSL::SSL::SSLError)
+  end
+end

data/spec/lib/itrp/client_spec.rb

@@ -0,0 +1,527 @@
+require 'spec_helper'
+
+describe Itrp::Client do
+
+  context 'Itrp.config' do
+    before(:each) do
+      Itrp.configure do |config|
+        config.max_retry_time = 120 # override default value (5400)
+        config.api_token = 'secret' # set value
+      end
+    end
+
+    it 'should define the MAX_PAGE_SIZE' do
+      expect(Itrp::Client::MAX_PAGE_SIZE).to eq(100)
+    end
+
+    it 'should use the Itrp configuration' do
+      client = Itrp::Client.new
+      expect(client.option(:host)).to eq('https://api.itrp.com') # default value
+      expect(client.option(:api_token)).to eq('secret')          # value set using Itrp.config
+      expect(client.option(:max_retry_time)).to eq(120)          # value overridden in Itrp.config
+    end
+
+    it 'should override the Itrp configuration' do
+      client = Itrp::Client.new(host: 'https://demo.itrp.com', api_token: 'unknown', block_at_rate_limit: true)
+      expect(client.option(:read_timeout)).to eq(25)              # default value
+      expect(client.option(:host)).to eq('https://demo.itrp.com') # default value overridden in Client.new
+      expect(client.option(:api_token)).to eq('unknown')          # value set using Itrp.config and overridden in Client.new
+      expect(client.option(:max_retry_time)).to eq(120)           # value overridden in Itrp.config
+      expect(client.option(:block_at_rate_limit)).to eq(true)     # value overridden in Client.new
+    end
+
+    [:host, :api_version, :api_token].each do |required_option|
+      it "should require option #{required_option}" do
+        expect { Itrp::Client.new(required_option => '') }.to raise_error("Missing required configuration option #{required_option}")
+      end
+    end
+
+    [ ['https://api.itrp.com',        true,  'api.itrp.com',     443],
+      ['https://api.example.com:777', true,  'api.example.com',  777],
+      ['http://itrp.example.com',     false, 'itrp.example.com', 80],
+      ['http://itrp.example.com:777', false, 'itrp.example.com', 777]
+    ].each do |host, ssl, domain, port|
+      it 'should parse ssl, host and port' do
+        client = Itrp::Client.new(host: host)
+        expect(client.instance_variable_get(:@ssl)).to eq(ssl)
+        expect(client.instance_variable_get(:@domain)).to eq(domain)
+        expect(client.instance_variable_get(:@port)).to eq(port)
+      end
+    end
+  end
+
+  it 'should set the ca-bundle.crt file' do
+    http = Net::HTTP.new('https://api.itrp.com')
+    http.use_ssl = true
+
+    on_disk = `ls #{http.ca_file}`
+    expect(on_disk).not_to match(/cannot access/)
+    expect(on_disk).to match(/\/ca-bundle.crt$/)
+  end
+
+  describe 'headers' do
+    before(:each) do
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    end
+
+    it 'should set the content type header' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).with(headers: {'Content-Type' => 'application/json'}).to_return(body: {name: 'my name'}.to_json)
+      @client.get('me')
+      expect(stub).to have_been_requested
+    end
+
+    it 'should add the X-ITRP-Account header' do
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1, account: 'test')
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).with(headers: {'X-ITRP-Account' => 'test'}).to_return(body: {name: 'my name'}.to_json)
+      client.get('me')
+      expect(stub).to have_been_requested
+    end
+
+    it 'should add the X-ITRP-Source header' do
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1, source: 'myapp')
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).with(headers: {'X-ITRP-Source' => 'myapp'}).to_return(body: {name: 'my name'}.to_json)
+      client.get('me')
+      expect(stub).to have_been_requested
+    end
+
+    it 'should be able to override headers' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).with(headers: {'Content-Type' => 'application/x-www-form-urlencoded'}).to_return(body: {name: 'my name'}.to_json)
+      @client.get('me', {}, {'Content-Type' => 'application/x-www-form-urlencoded'})
+      expect(stub).to have_been_requested
+    end
+
+    it 'should set the other headers' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).with(headers: {'X-ITRP-Other' => 'value'}).to_return(body: {name: 'my name'}.to_json)
+      @client.get('me', {}, {'X-ITRP-Other' => 'value'})
+      expect(stub).to have_been_requested
+    end
+
+    it 'should accept headers in the each call' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/requests?fields=subject&page=1&per_page=100').with(basic_auth: ['secret', 'x']).with(headers: {'X-ITRP-Secret' => 'special'}).to_return(body: [{id: 1, subject: 'Subject 1'}, {id: 2, subject: 'Subject 2'}, {id: 3, subject: 'Subject 3'}].to_json)
+      @client.each('requests', {fields: 'subject'}, {'X-ITRP-Secret' => 'special'}) do |request|
+        expect(request[:subject]).to eq("Subject #{request[:id]}")
+      end
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context 'each' do
+    before(:each) do
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    end
+
+    it 'should yield each result' do
+      stub_request(:get, 'https://api.itrp.com/v1/requests?fields=subject&page=1&per_page=100').with(basic_auth: ['secret', 'x']).to_return(body: [{id: 1, subject: 'Subject 1'}, {id: 2, subject: 'Subject 2'}, {id: 3, subject: 'Subject 3'}].to_json)
+      nr_of_requests = @client.each('requests', {fields: 'subject'}) do |request|
+        expect(request[:subject]).to eq("Subject #{request[:id]}")
+      end
+      expect(nr_of_requests).to eq(3)
+    end
+
+    it 'should retrieve multiple pages' do
+      stub_page1 = stub_request(:get, 'https://api.itrp.com/v1/requests?page=1&per_page=2').with(basic_auth: ['secret', 'x']).to_return(body: [{id: 1, subject: 'Subject 1'}, {id: 2, subject: 'Subject 2'}].to_json, headers: {'Link' => '<https://api.itrp.com/v1/requests?page=1&per_page=2>; rel="first",<https://api.itrp.com/v1/requests?page=2&per_page=2>; rel="next",<https://api.itrp.com/v1/requests?page=2&per_page=2>; rel="last"'})
+      stub_page2 = stub_request(:get, 'https://api.itrp.com/v1/requests?page=2&per_page=2').with(basic_auth: ['secret', 'x']).to_return(body: [{id: 3, subject: 'Subject 3'}].to_json, headers: {'Link' => '<https://api.itrp.com/v1/requests?page=1&per_page=2>; rel="first",<https://api.itrp.com/v1/requests?page=1&per_page=2>; rel="prev",<https://api.itrp.com/v1/requests?page=2&per_page=2>; rel="last"'})
+      nr_of_requests = @client.each('requests', {per_page: 2}) do |request|
+        expect(request[:subject]).to eq("Subject #{request[:id]}")
+      end
+      expect(nr_of_requests).to eq(3)
+      expect(stub_page2).to have_been_requested
+    end
+  end
+
+  context 'get' do
+    before(:each) do
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    end
+
+    it 'should return a response' do
+      stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'my name'}.to_json)
+      response = @client.get('me')
+      expect(response[:name]).to eq('my name')
+    end
+
+    describe 'parameters' do
+
+      [[nil, ''],
+       [ 'normal',     'normal'],
+       [ 'hello;<',    'hello%3B%3C'],
+       [ true,         'true'],
+       [ false,        'false'],
+       [ DateTime.now, DateTime.now.new_offset(0).iso8601.gsub('+', '%2B')],
+       [ Date.new,     Date.new.strftime('%Y-%m-%d')],
+       [ Time.now,     Time.now.strftime('%H:%M')],
+       [ ['first', 'second;<', true], 'first,second%3B%3C,true']
+      ].each do |param_value, url_value|
+        it "should cast #{param_value.class.name}: '#{param_value}' to '#{url_value}'" do
+          stub = stub_request(:get, "https://api.itrp.com/v1/me?value=#{url_value}").with(basic_auth: ['secret', 'x']).to_return(body: {name: 'my name'}.to_json)
+          @client.get('me', {value: param_value})
+          expect(stub).to have_been_requested
+        end
+      end
+
+      it 'should not cast arrays in post and put calls' do
+        client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+        stub = stub_request(:post, 'https://api.itrp.com/v1/people').with(basic_auth: ['secret', 'x']).with(body: {user_ids: [1, 2, 3]}, headers: {'X-ITRP-Custom' => 'custom'}).to_return(body: {id: 101}.to_json)
+        client.post('people', {user_ids: [1, 2, 3]}, {'X-ITRP-Custom' => 'custom'})
+        expect(stub).to have_been_requested
+      end
+
+      it 'should not cast hashes in post and put calls' do
+        client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+        stub = stub_request(:patch, 'https://api.itrp.com/v1/people/55').with(basic_auth: ['secret', 'x']).with(body: '{"contacts_attributes":{"0":{"protocol":"email","label":"work","uri":"work@example.com"}}}', headers: {'X-ITRP-Custom' => 'custom'}).to_return(body: {id: 101}.to_json)
+        client.put('people/55', {contacts_attributes: {0 => {protocol: :email, label: :work, uri: 'work@example.com'}}}, {'X-ITRP-Custom' => 'custom'})
+        expect(stub).to have_been_requested
+      end
+
+      it 'should not double escape symbols' do
+        client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+        stub = stub_request(:patch, 'https://api.itrp.com/v1/people/55').with(basic_auth: ['secret', 'x']).with(body: '{"status":"waiting_for"}').to_return(body: {id: 101}.to_json)
+        client.put('people/55', {status: :waiting_for})
+        expect(stub).to have_been_requested
+      end
+
+      it 'should handle fancy filter operations' do
+        now = DateTime.now
+        stub = stub_request(:get, "https://api.itrp.com/v1/people?created_at=>#{now.new_offset(0).iso8601.gsub('+', '%2B')}&id!=15").with(basic_auth: ['secret', 'x']).to_return(body: {name: 'my name'}.to_json)
+        @client.get('people', {'created_at=>' => now, 'id!=' => 15})
+        expect(stub).to have_been_requested
+      end
+
+      it 'should append parameters' do
+        stub = stub_request(:get, 'https://api.itrp.com/v1/people?id!=15&primary_email=me@example.com').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'my name'}.to_json)
+        @client.get('people?id!=15', {primary_email: 'me@example.com'})
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
+  context 'patch' do
+    [:put, :patch].each do |method|
+      it 'should send patch requests with parameters and headers for #{method} calls' do
+        client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+        stub = stub_request(:patch, 'https://api.itrp.com/v1/people/1').with(basic_auth: ['secret', 'x']).with(body: {name: 'New Name'}, headers: {'X-ITRP-Custom' => 'custom'}).to_return(body: {id: 1}.to_json)
+        client.send(method, 'people/1', {name: 'New Name'}, {'X-ITRP-Custom' => 'custom'})
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
+  context 'post' do
+    it 'should send post requests with parameters and headers' do
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+      stub = stub_request(:post, 'https://api.itrp.com/v1/people').with(basic_auth: ['secret', 'x']).with(body: {name: 'New Name'}, headers: {'X-ITRP-Custom' => 'custom'}).to_return(body: {id: 101}.to_json)
+      client.post('people', {name: 'New Name'}, {'X-ITRP-Custom' => 'custom'})
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context 'delete' do
+    it 'should send delete requests with parameters and headers' do
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+      stub = stub_request(:delete, 'https://api.itrp.com/v1/people?id=value').with(basic_auth: ['secret', 'x']).with(headers: {'X-ITRP-Custom' => 'custom'}).to_return(body: {id: 101}.to_json)
+      client.delete('people', {id: 'value'}, {'X-ITRP-Custom' => 'custom'})
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context 'attachments' do
+    before(:each) do
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+    end
+
+    it 'should not log an error for XML responses' do
+      xml = %(<?xml version="1.0" encoding="UTF-8"?>\n<details>some info</details>)
+      stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(body: xml)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug)
+      expect_log("XML response:\n#{xml}", :debug)
+      response = @client.get('me')
+      expect(response.valid?).to be_falsey
+      expect(response.raw.body).to eq(xml)
+    end
+
+    it 'should not log an error for redirects' do
+      stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(body: '', status: 303, headers: {'Location' => 'http://redirect.example.com/to/here'})
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug)
+      expect_log('Redirect: http://redirect.example.com/to/here', :debug)
+      response = @client.get('me')
+      expect(response.valid?).to be_falsey
+      expect(response.raw.body).to be_nil
+    end
+
+    it "should not parse attachments for get requests" do
+      expect(Itrp::Attachments).not_to receive(:new)
+      stub_request(:get, 'https://api.itrp.com/v1/requests/777?attachments=/tmp/first.png,/tmp/second.zip&note=note').with(basic_auth: ['secret', 'x']).to_return(body: {id: 777, upload_called: false}.to_json)
+
+      response = @client.get('/requests/777', {note: 'note', attachments: ['/tmp/first.png', '/tmp/second.zip'] })
+      expect(response.valid?).to be_truthy
+      expect(response[:upload_called]).to be_falsey
+    end
+
+    [:post, :patch].each do |method|
+      it "should parse attachments for #{method} requests" do
+        attachments = double('Itrp::Attachments')
+        expect(attachments).to receive(:upload_attachments!) do |path, data|
+          expect(path).to eq '/requests/777'
+          expect(data[:attachments]).to eq ['/tmp/first.png', '/tmp/second.zip']
+          data.delete(:attachments)
+          data[:note_attachments] = 'processed'
+        end
+        expect(Itrp::Attachments).to receive(:new).with(@client){ attachments }
+        stub_request(method, 'https://api.itrp.com/v1/requests/777').with(basic_auth: ['secret', 'x']).with(body: {note: 'note', note_attachments: 'processed' }).to_return(body: {id: 777, upload_called: true}.to_json)
+
+        response = @client.send(method, '/requests/777', {note: 'note', attachments: ['/tmp/first.png', '/tmp/second.zip'] })
+        expect(response.valid?).to be_truthy
+        expect(response[:upload_called]).to be_truthy
+      end
+    end
+
+  end
+
+  context 'import' do
+    before(:each) do
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+      @multi_part_body = "--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npeople\r\n--0123456789ABLEWASIEREISAWELBA9876543210\r\nContent-Disposition: form-data; name=\"file\"; filename=\"#{@fixture_dir}/people.csv\"\r\nContent-Type: text/comma-separated-values\r\n\r\nPrimary Email,Name\nchess.cole@example.com,Chess Cole\ned.turner@example.com,Ed Turner\r\n--0123456789ABLEWASIEREISAWELBA9876543210--"
+      @multi_part_headers = {'Accept'=>'*/*', 'Content-Type'=>'multipart/form-data; boundary=0123456789ABLEWASIEREISAWELBA9876543210', 'User-Agent'=>'Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6'}
+
+      @import_queued_response = {body: {state: 'queued'}.to_json}
+      @import_processing_response = {body: {state: 'processing'}.to_json}
+      @import_done_response = {body: {state: 'done', results: {errors: 0, updated: 1, created: 1, failures: 0, unchanged: 0, deleted: 0}}.to_json}
+      @import_failed_response = {body: {state: 'error', message: 'Invalid byte sequence in UTF-8 on line 2', results: {errors: 1, updated: 1, created: 0, failures: 1, unchanged: 0, deleted: 0}}.to_json}
+      @server_failed_response = {body: {state: 'error', message: 'Invalid byte sequence in UTF-8 on line 2', results: {errors: 1, updated: 1, created: 0, failures: 1, unchanged: 0, deleted: 0}}.to_json}
+      allow(@client).to receive(:sleep)
+    end
+
+    it 'should import a CSV file' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      expect_log("Import file '#{@fixture_dir}/people.csv' successfully uploaded with token '68ef5ef0f64c0'.")
+
+      response = @client.import(File.new("#{@fixture_dir}/people.csv"), 'people')
+      expect(response[:token]).to eq('68ef5ef0f64c0')
+    end
+
+    it 'should import a CSV file by filename' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      response = @client.import("#{@fixture_dir}/people.csv", 'people')
+      expect(response[:token]).to eq('68ef5ef0f64c0')
+    end
+
+    it 'should wait for the import to complete' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@import_queued_response, @import_processing_response, @import_done_response)
+
+      # verify the correct log statement are made
+      expect_log('Sending POST request to api.itrp.com:443/v1/import', :debug)
+      expect_log("Response:\n{\n  \"token\": \"68ef5ef0f64c0\"\n}", :debug)
+      expect_log("Import file '#{@fixture_dir}/people.csv' successfully uploaded with token '68ef5ef0f64c0'.")
+      expect_log('Sending GET request to api.itrp.com:443/v1/import/68ef5ef0f64c0', :debug)
+      expect_log("Response:\n{\n  \"state\": \"queued\"\n}", :debug)
+      expect_log("Import of '#{@fixture_dir}/people.csv' is queued. Checking again in 30 seconds.", :debug)
+      expect_log('Sending GET request to api.itrp.com:443/v1/import/68ef5ef0f64c0', :debug)
+      expect_log("Response:\n{\n  \"state\": \"processing\"\n}", :debug)
+      expect_log("Import of '#{@fixture_dir}/people.csv' is processing. Checking again in 30 seconds.", :debug)
+      expect_log('Sending GET request to api.itrp.com:443/v1/import/68ef5ef0f64c0', :debug)
+      expect_log("Response:\n{\n  \"state\": \"done\",\n  \"results\": {\n    \"errors\": 0,\n    \"updated\": 1,\n    \"created\": 1,\n    \"failures\": 0,\n    \"unchanged\": 0,\n    \"deleted\": 0\n  }\n}", :debug)
+
+      response = @client.import("#{@fixture_dir}/people.csv", 'people', true)
+      expect(response[:state]).to eq('done')
+      expect(response[:results][:updated]).to eq(1)
+      expect(progress_stub).to have_been_requested.times(3)
+    end
+
+    it 'should wait for the import to fail' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@import_queued_response, @import_processing_response, @import_failed_response)
+
+      expect{ @client.import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Itrp::Exception, "Unable to monitor progress for people import. Invalid byte sequence in UTF-8 on line 2")
+      expect(progress_stub).to have_been_requested.times(3)
+    end
+
+    it 'should not continue when there is an error connecting to ITRP' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/import/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@import_queued_response, @import_processing_response).then.to_raise(StandardError.new('network error'))
+
+      expect{ @client.import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Itrp::Exception, "Unable to monitor progress for people import. 500: No Response from Server - network error for 'api.itrp.com:443/v1/import/68ef5ef0f64c0'")
+      expect(progress_stub).to have_been_requested.times(3)
+    end
+
+    it 'should return an invalid response in case waiting for progress is false' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {message: 'oops!'}.to_json)
+      response = @client.import("#{@fixture_dir}/people.csv", 'people', false)
+      expect(response.valid?).to be_falsey
+      expect(response.message).to eq('oops!')
+    end
+
+    it 'should raise an UploadFailed exception in case waiting for progress is true' do
+      stub_request(:post, 'https://api.itrp.com/v1/import').with(basic_auth: ['secret', 'x']).with(body: @multi_part_body, headers: @multi_part_headers).to_return(body: {message: 'oops!'}.to_json)
+      expect{ @client.import("#{@fixture_dir}/people.csv", 'people', true) }.to raise_error(Itrp::UploadFailed, 'Failed to queue people import. oops!')
+    end
+
+  end
+
+
+  context 'export' do
+    before(:each) do
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+
+      @export_queued_response = {body: {state: 'queued'}.to_json}
+      @export_processing_response = {body: {state: 'processing'}.to_json}
+      @export_done_response = {body: {state: 'done', url: 'https://download.example.com/export.zip?AWSAccessKeyId=12345'}.to_json}
+      allow(@client).to receive(:sleep)
+    end
+
+    it 'should export multiple types' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people,people_contact_details'}).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      expect_log("Export for 'people,people_contact_details' successfully queued with token '68ef5ef0f64c0'.")
+
+      response = @client.export(['people', 'people_contact_details'])
+      expect(response[:token]).to eq('68ef5ef0f64c0')
+    end
+
+    it 'should indicate when nothing is exported' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people', from: '2012-03-30T23:00:00+00:00'}).to_return(status: 204)
+      expect_log("No changed records for 'people' since 2012-03-30T23:00:00+00:00.")
+
+      response = @client.export('people', DateTime.new(2012,03,30,23,00,00))
+      expect(response[:token]).to be_nil
+    end
+
+    it 'should export since a certain time' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people', from: '2012-03-30T23:00:00+00:00'}).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      expect_log("Export for 'people' successfully queued with token '68ef5ef0f64c0'.")
+
+      response = @client.export('people', DateTime.new(2012,03,30,23,00,00))
+      expect(response[:token]).to eq('68ef5ef0f64c0')
+    end
+
+    it 'should wait for the export to complete' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people'}).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/export/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@export_queued_response, @export_processing_response, @export_done_response)
+
+      # verify the correct log statement are made
+      expect_log('Sending POST request to api.itrp.com:443/v1/export', :debug)
+      expect_log(%(Response:\n{\n  "token": "68ef5ef0f64c0"\n}), :debug)
+      expect_log("Export for 'people' successfully queued with token '68ef5ef0f64c0'.")
+      expect_log('Sending GET request to api.itrp.com:443/v1/export/68ef5ef0f64c0', :debug)
+      expect_log(%(Response:\n{\n  "state": "queued"\n}), :debug)
+      expect_log("Export of 'people' is queued. Checking again in 30 seconds.", :debug)
+      expect_log('Sending GET request to api.itrp.com:443/v1/export/68ef5ef0f64c0', :debug)
+      expect_log(%(Response:\n{\n  "state": "processing"\n}), :debug)
+      expect_log("Export of 'people' is processing. Checking again in 30 seconds.", :debug)
+      expect_log('Sending GET request to api.itrp.com:443/v1/export/68ef5ef0f64c0', :debug)
+      expect_log(%(Response:\n{\n  "state": "done",\n  "url": "https://download.example.com/export.zip?AWSAccessKeyId=12345"\n}), :debug)
+
+      response = @client.export('people', nil, true)
+      expect(response[:state]).to eq('done')
+      expect(response[:url]).to eq('https://download.example.com/export.zip?AWSAccessKeyId=12345')
+      expect(progress_stub).to have_been_requested.times(3)
+    end
+
+    it 'should not continue when there is an error connecting to ITRP' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people'}).to_return(body: {token: '68ef5ef0f64c0'}.to_json)
+      progress_stub = stub_request(:get, 'https://api.itrp.com/v1/export/68ef5ef0f64c0').with(basic_auth: ['secret', 'x']).to_return(@export_queued_response, @export_processing_response).then.to_raise(StandardError.new('network error'))
+
+      expect{ @client.export('people', nil, true) }.to raise_error(Itrp::Exception, "Unable to monitor progress for 'people' export. 500: No Response from Server - network error for 'api.itrp.com:443/v1/export/68ef5ef0f64c0'")
+      expect(progress_stub).to have_been_requested.times(3)
+    end
+
+    it 'should return an invalid response in case waiting for progress is false' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people'}).to_return(body: {message: 'oops!'}.to_json)
+      response = @client.export('people')
+      expect(response.valid?).to be_falsey
+      expect(response.message).to eq('oops!')
+    end
+
+    it 'should raise an UploadFailed exception in case waiting for progress is true' do
+      stub_request(:post, 'https://api.itrp.com/v1/export').with(basic_auth: ['secret', 'x']).with(body: {type: 'people'}).to_return(body: {message: 'oops!'}.to_json)
+      expect{ @client.export('people', nil, true) }.to raise_error(Itrp::UploadFailed, "Failed to queue 'people' export. oops!")
+    end
+
+  end
+
+  context 'retry' do
+    it 'should not retry when max_retry_time = -1' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_raise(StandardError.new('network error'))
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+      expect_log("Request failed: 500: No Response from Server - network error for 'api.itrp.com:443/v1/me'", :error)
+
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(1)
+      expect(response.valid?).to be_falsey
+      expect(response.message).to eq("500: No Response from Server - network error for 'api.itrp.com:443/v1/me'")
+    end
+
+    it 'should not retry 4 times when max_retry_time = 16' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_raise(StandardError.new('network error'))
+      [2,4,8,16].each_with_index do |secs, i|
+        expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+        expect_log("Request failed, retry ##{i+1} in #{secs} seconds: 500: No Response from Server - network error for 'api.itrp.com:443/v1/me'", :warn)
+      end
+
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: 16)
+      allow(client).to receive(:sleep)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(4)
+      expect(response.valid?).to be_falsey
+      expect(response.message).to eq("500: No Response from Server - network error for 'api.itrp.com:443/v1/me'")
+    end
+
+    it 'should return the response after retry succeeds' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_raise(StandardError.new('network error')).then.to_return(body: {name: 'my name'}.to_json)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+      expect_log("Request failed, retry #1 in 2 seconds: 500: No Response from Server - network error for 'api.itrp.com:443/v1/me'", :warn)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+      expect_log(%(Response:\n{\n  "name": "my name"\n}), :debug )
+
+      client = Itrp::Client.new(api_token: 'secret', max_retry_time: 16)
+      allow(client).to receive(:sleep)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(2)
+      expect(response.valid?).to be_truthy
+      expect(response[:name]).to eq('my name')
+    end
+  end
+
+  context 'rate limiting' do
+    it 'should not block on rate limit when block_at_rate_limit is false' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+      expect_log("Request failed: 429: Too Many Requests", :error)
+
+      client = Itrp::Client.new(api_token: 'secret', block_at_rate_limit: false)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(1)
+      expect(response.valid?).to be_falsey
+      expect(response.message).to eq('429: Too Many Requests')
+    end
+
+    it 'should block on rate limit when block_at_rate_limit is true' do
+      stub = stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(status: 429, body: {message: 'Too Many Requests'}.to_json).then.to_return(body: {name: 'my name'}.to_json)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+      expect_log('Request throttled, trying again in 5 minutes: 429: Too Many Requests', :warn)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug )
+      expect_log(%(Response:\n{\n  "name": "my name"\n}), :debug )
+
+      client = Itrp::Client.new(api_token: 'secret', block_at_rate_limit: true)
+      allow(client).to receive(:sleep)
+      response = client.get('me')
+      expect(stub).to have_been_requested.times(2)
+      expect(response.valid?).to be_truthy
+      expect(response[:name]).to eq('my name')
+    end
+  end
+
+  context 'logger' do
+    before(:each) do
+      @logger = Logger.new(STDOUT)
+      @client = Itrp::Client.new(api_token: 'secret', max_retry_time: -1, logger: @logger)
+    end
+
+    it 'should be possible to override the default logger' do
+      stub_request(:get, 'https://api.itrp.com/v1/me').with(basic_auth: ['secret', 'x']).to_return(body: {name: 'my name'}.to_json)
+      expect_log('Sending GET request to api.itrp.com:443/v1/me', :debug, @logger )
+      expect_log(%(Response:\n{\n  "name": "my name"\n}), :debug, @logger )
+      @client.get('me')
+    end
+  end
+end