quest_back 0.0.1

data/spec/fixtures/get_quests_success.xml

@@ -0,0 +1,32 @@
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+   <s:Body>
+      <GetQuestsResponse xmlns="https://integration.questback.com/2011/03">
+         <GetQuestsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
+            <Quests>
+               <Quest>
+                  <QuestId>4567668</QuestId>
+                  <SecurityLock>m0pI8orKJp</SecurityLock>
+                  <QuestTitle>Skalars spørreundersøkelse</QuestTitle>
+                  <Startdate>2014-02-18T00:00:00</Startdate>
+                  <EndDate>2017-03-01T00:00:00</EndDate>
+                  <State>Active</State>
+                  <TotalInvitationsSent>0</TotalInvitationsSent>
+                  <TotalResponseCount>0</TotalResponseCount>
+                  <LastResponseDate>0001-01-01T00:00:00</LastResponseDate>
+                  <DefaultLanguageId>2989</DefaultLanguageId>
+                  <Languages>
+                     <Language>
+                        <LanguageId>2989</LanguageId>
+                        <LanguageName>Norwegian (Bokmål)</LanguageName>
+                     </Language>
+                  </Languages>
+               </Quest>
+            </Quests>
+            <PageInfo>
+               <PageSize>10</PageSize>
+               <TotalCount>1</TotalCount>
+            </PageInfo>
+         </GetQuestsResult>
+      </GetQuestsResponse>
+   </s:Body>
+</s:Envelope>

data/spec/fixtures/quest_back.wsdl

@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:i0="https://integration.questback.com/2011/03" xmlns:msc="http://schemas.microsoft.com/ws/2005/12/wsdl/contract" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://tempuri.org/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsa10="http://www.w3.org/2005/08/addressing" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:wsap="http://schemas.xmlsoap.org/ws/2004/08/addressing/policy" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex" xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="QuestBackService" targetNamespace="http://tempuri.org/">
+   <wsp:Policy wsu:Id="BasicHttpBinding_QuestBackIntegrationLibrary_policy">
+      <wsp:ExactlyOne>
+         <wsp:All>
+            <sp:TransportBinding xmlns:sp="http://schemas.xmlsoap.org/ws/2005/07/securitypolicy">
+               <wsp:Policy>
+                  <sp:TransportToken>
+                     <wsp:Policy>
+                        <sp:HttpsToken RequireClientCertificate="false" />
+                     </wsp:Policy>
+                  </sp:TransportToken>
+                  <sp:AlgorithmSuite>
+                     <wsp:Policy>
+                        <sp:Basic256 />
+                     </wsp:Policy>
+                  </sp:AlgorithmSuite>
+                  <sp:Layout>
+                     <wsp:Policy>
+                        <sp:Strict />
+                     </wsp:Policy>
+                  </sp:Layout>
+               </wsp:Policy>
+            </sp:TransportBinding>
+         </wsp:All>
+      </wsp:ExactlyOne>
+   </wsp:Policy>
+   <wsdl:import namespace="https://integration.questback.com/2011/03" location="https://integration.questback.com/Integration.svc?wsdl=wsdl0" />
+   <wsdl:types />
+   <wsdl:binding name="BasicHttpBinding_QuestBackIntegrationLibrary" type="i0:QuestBackIntegrationLibrary">
+      <wsp:PolicyReference URI="#BasicHttpBinding_QuestBackIntegrationLibrary_policy" />
+      <soap:binding transport="http://schemas.xmlsoap.org/soap/http" />
+      <wsdl:operation name="GetQuests">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetQuests" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+         <wsdl:fault name="QuestBackServiceFaultFault">
+            <soap:fault name="QuestBackServiceFaultFault" use="literal" />
+         </wsdl:fault>
+      </wsdl:operation>
+      <wsdl:operation name="GetQuestQuestions">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetQuestQuestions" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="AddEmailInvitees">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/AddEmailInvitees" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="AddRespondentsData">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/AddRespondentsData" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="AddRespondentsDataWithoutEmailInvitation">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/AddRespondentsDataWithoutEmailInvitation" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="AddRespondentsDataWithSmsInvitation">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/AddRespondentsDataWithSmsInvitation" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="GetInvitationResponseCounts">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetInvitationResponseCounts" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="GetInviteesInfo">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetInviteesInfo" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="GetAnswers">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetAnswers" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="GetResponses">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetResponses" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="GetRespondentsData">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetRespondentsData" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+      </wsdl:operation>
+      <wsdl:operation name="GetLanguageList">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/GetLanguageList" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+         <wsdl:fault name="QuestBackServiceFaultFault">
+            <soap:fault name="QuestBackServiceFaultFault" use="literal" />
+         </wsdl:fault>
+      </wsdl:operation>
+      <wsdl:operation name="TestConnection">
+         <soap:operation soapAction="https://integration.questback.com/2011/03/QuestBackIntegrationLibrary/TestConnection" style="document" />
+         <wsdl:input>
+            <soap:body use="literal" />
+         </wsdl:input>
+         <wsdl:output>
+            <soap:body use="literal" />
+         </wsdl:output>
+         <wsdl:fault name="QuestBackServiceFaultFault">
+            <soap:fault name="QuestBackServiceFaultFault" use="literal" />
+         </wsdl:fault>
+      </wsdl:operation>
+   </wsdl:binding>
+   <wsdl:service name="QuestBackService">
+      <wsdl:port name="BasicHttpBinding_QuestBackIntegrationLibrary" binding="tns:BasicHttpBinding_QuestBackIntegrationLibrary">
+         <soap:address location="https://integration.questback.com/Integration.svc" />
+      </wsdl:port>
+   </wsdl:service>
+</wsdl:definitions>

data/spec/fixtures/test_connection_failure.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+  <s:Body>
+    <s:Fault>
+      <faultcode>s:Client</faultcode>
+      <faultstring xml:lang="nb-NO">Invalid username or password.</faultstring>
+      <detail>
+        <QuestBackServiceFault xmlns="https://integration.questback.com/2011/03" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
+          <Operation>Authentication</Operation>
+          <ProblemType>Invalid username or password.</ProblemType>
+        </QuestBackServiceFault>
+      </detail>
+    </s:Fault>
+  </s:Body>
+</s:Envelope>

data/spec/fixtures/test_connection_success.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+  <s:Body>
+    <TestConnectionResponse xmlns="https://integration.questback.com/2011/03">
+      <TestConnectionResult>Connection sucessful. you are connected to namespace: https://integration.questback.com/2011/03</TestConnectionResult>
+    </TestConnectionResponse>
+  </s:Body>
+</s:Envelope>

data/spec/quest_back/api_spec.rb

@@ -0,0 +1,257 @@
+require 'spec_helper'
+
+describe QuestBack::Api, type: :request do
+  let(:config) do
+    QuestBack::Configuration.new(
+      wsdl: path_to_fixture('quest_back.wsdl'),
+      username: 'my-username',
+      password: 'my-password'
+    )
+  end
+
+  let(:expected_default_message) do
+    {
+      user_info: {
+        'Username' => 'my-username',
+        'Password' => 'my-password'
+      }
+    }
+  end
+
+  subject { described_class.new config: config }
+
+  describe "#client" do
+    it "is a savon client" do
+      expect(subject.client).to be_a Savon::Client
+    end
+
+    it "sets proxy building client" do
+      config.http_proxy = 'http://127.0.0.1/'
+
+      Savon::Client.should_receive(:new).
+        with(hash_including(proxy: 'http://127.0.0.1/')).
+        and_return :client
+
+      expect(subject.client).to eq  :client
+    end
+  end
+
+
+  describe "operations" do
+    describe "#test_connection" do
+      context "success" do
+        it "calls with correct message and response is successful" do
+          savon.expects(:test_connection).with(message: expected_default_message).returns success_fixture_for 'test_connection'
+          response = subject.test_connection
+          expect(response).to be_successful
+        end
+      end
+
+      context "failure" do
+        it "raises error" do
+          savon.expects(:test_connection).with(message: :any).returns failure_fixture_for 'test_connection'
+          expect { subject.test_connection }.to raise_error Savon::SOAPFault
+        end
+      end
+    end
+
+
+
+    describe "#get_quests" do
+      it "makes call with expected arguments" do
+        expected_message = expected_default_message.merge(
+          paging_info: {'PageNo' => 0, 'PageSize' => 50},
+          quest_filter: '',
+          order!: QuestBack::Api::ORDER[:get_quests]
+        )
+
+        savon.expects(:get_quests).with(message: expected_message).returns success_fixture_for 'get_quests'
+        response = subject.get_quests
+        expect(response).to be_successful
+      end
+
+      it "is possible to override default paging info" do
+        expected_message = expected_default_message.merge(
+          paging_info: {'PageNo' => 0, 'PageSize' => 1},
+          quest_filter: '',
+          order!: QuestBack::Api::ORDER[:get_quests]
+        )
+
+        savon.expects(:get_quests).with(message: expected_message).returns success_fixture_for 'get_quests'
+        response = subject.get_quests paging_info: {page_size: 1}
+        expect(response).to be_successful
+      end
+
+      it "has expected results" do
+        savon.expects(:get_quests).with(message: :any).returns success_fixture_for 'get_quests'
+        response = subject.get_quests
+
+        result = response.results.first
+
+        expect(result[:quest_id]).to eq '4567668'
+        expect(result[:security_lock]).to eq 'm0pI8orKJp'
+        expect(result[:state]).to eq 'Active'
+      end
+    end
+
+
+
+    describe "#get_language_list" do
+      it "makes call with expected arguments" do
+        savon.expects(:get_language_list).with(message: expected_default_message).returns success_fixture_for 'get_language_list'
+        response = subject.get_language_list
+        expect(response).to be_successful
+      end
+
+      it "has all known languages" do
+        savon.expects(:get_language_list).with(message: :any).returns success_fixture_for 'get_language_list'
+        response = subject.get_language_list
+
+        expect(response.results.length).to eq 145
+      end
+    end
+
+
+
+    describe "#add_email_invitees" do
+      it "makes call with expected arguments" do
+        expected_message = expected_default_message.merge(
+          quest_info: {'QuestId' => 4567668, 'SecurityLock' => 'm0pI8orKJp'},
+          emails: {'array:string' => ['inviso@skalar.no', 'th@skalar.no']},
+          sendduplicate: false,
+          order!: QuestBack::Api::ORDER[:add_email_invitees] - [:language_id]
+        )
+
+
+        savon.expects(:add_email_invitees).with(message: expected_message).returns success_fixture_for 'add_email_invitees'
+        response = subject.add_email_invitees(
+          quest_info: {
+            quest_id: 4567668,
+            security_lock: 'm0pI8orKJp'
+          },
+          emails: ['inviso@skalar.no', 'th@skalar.no']
+        )
+        expect(response).to be_successful
+      end
+
+      it "is possible to override defaults" do
+        expected_message = expected_default_message.merge(
+          quest_info: {'QuestId' => 4567668, 'SecurityLock' => 'm0pI8orKJp'},
+          emails: {'array:string' => ['inviso@skalar.no', 'th@skalar.no']},
+          sendduplicate: true,
+          order!: QuestBack::Api::ORDER[:add_email_invitees] - [:language_id]
+        )
+
+        savon.expects(:add_email_invitees).with(message: expected_message).returns success_fixture_for 'add_email_invitees'
+        response = subject.add_email_invitees(
+          quest_info: {
+            quest_id: 4567668,
+            security_lock: 'm0pI8orKJp'
+          },
+          emails: ['inviso@skalar.no', 'th@skalar.no'],
+          sendduplicate: true
+        )
+      end
+
+      it "fails if you give it keys which are not known" do
+        expect { subject.add_email_invitees(foo: 'bar') }.to raise_error ArgumentError
+      end
+
+      it "has expected result" do
+        savon.expects(:add_email_invitees).with(message: :any).returns success_fixture_for 'add_email_invitees'
+        response = subject.add_email_invitees(
+          quest_info: {quest_id: 4567668, security_lock: 'm0pI8orKJp'},
+          emails: ['inviso@skalar.no', 'th@skalar.no'],
+        )
+
+        expect(response.result).to eq 'Added 2 invitations to QuestId:4567668'
+      end
+    end
+
+
+    describe "#add_respondents_data" do
+      it "makes call with expected arguments" do
+        expected_message = expected_default_message.merge(
+          quest_info: {'QuestId' => 4567668, 'SecurityLock' => 'm0pI8orKJp'},
+          respondents_data: {
+            'RespondentDataHeader' => {
+              'RespondentDataHeader' => [
+                {
+                  'Title' => 'Epost',
+                  'enum:Type' => 2,
+                  'IsEmailField' => true,
+                  'IsSmsField' => false
+                },
+                {
+                  'Title' => 'Mobil',
+                  'enum:Type' => 2,
+                  'IsEmailField' => false,
+                  'IsSmsField' => true
+                },
+                {
+                  'Title' => 'Navn',
+                  'enum:Type' => 2,
+                  'IsEmailField' => false,
+                  'IsSmsField' => false
+                },
+                {
+                  'Title' => 'Alder',
+                  'enum:Type' => 1,
+                  'IsEmailField' => false,
+                  'IsSmsField' => false
+                }
+              ]
+            },
+            'RespondentData' => {'array:string' => ['th@skalar.no;404 40 404;Thorbjorn;32']},
+            'Delimiter' => ';',
+            'AllowDuplicate' => true,
+            'AddAsInvitee' => true,
+            order!: ["RespondentDataHeader", "RespondentData", "Delimiter", "AllowDuplicate", "AddAsInvitee"]
+          } ,
+          order!: QuestBack::Api::ORDER[:add_respondents_data] - [:language_id]
+        )
+
+
+        savon.expects(:add_respondents_data).with(message: expected_message).returns success_fixture_for 'add_respondents_data'
+        response = subject.add_respondents_data(
+          quest_info: {quest_id: 4567668, security_lock: 'm0pI8orKJp'},
+          respondents_data: {
+            respondent_data_header: {
+              respondent_data_header: [
+                {
+                  title: 'Epost',
+                  type: QuestBack::Api.respondent_data_header_type_for(:text),
+                  is_email_field: true,
+                  is_sms_field: false,
+                },
+                {
+                  title: 'Mobil',
+                  type: QuestBack::Api.respondent_data_header_type_for(:text),
+                  is_email_field: false,
+                  is_sms_field: true,
+                },
+                {
+                  title: 'Navn',
+                  type: QuestBack::Api.respondent_data_header_type_for(:text),
+                  is_email_field: false,
+                  is_sms_field: false,
+                },
+                {
+                  title: 'Alder',
+                  type: QuestBack::Api.respondent_data_header_type_for(:numeric),
+                  is_email_field: false,
+                  is_sms_field: false,
+                },
+              ]
+            },
+            respondent_data: ['th@skalar.no;404 40 404;Thorbjorn;32'],
+            allow_duplicate: true,
+            add_as_invitee: true
+          }
+        )
+
+        expect(response).to be_successful
+      end
+    end
+  end
+end

data/spec/quest_back/configuration_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe QuestBack::Configuration do
+  describe "#initialize" do
+    it "has default wsdl URL" do
+      expect(described_class.new.wsdl).to eq 'https://integration.questback.com/integration.svc?wsdl'
+    end
+
+    it "assigns incomming attributes" do
+      config = described_class.new username: 'name', password: 'password', http_proxy: 'http://127.0.0.1/'
+
+      expect(config.username).to eq 'name'
+      expect(config.password).to eq 'password'
+      expect(config.http_proxy).to eq 'http://127.0.0.1/'
+    end
+  end
+end

data/spec/quest_back/response_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe QuestBack::Response, type: :request do
+  let(:http) do
+    double(
+      body: success_fixture_for('get_quests'),
+      error?: false
+    )
+  end
+  let(:globals) { Savon::GlobalOptions.new }
+  let(:locals) { {} }
+  let(:savon_response) { Savon::Response.new(http, globals, locals) }
+
+  subject { described_class.new savon_response, operation_name: :get_quests, result_key_nestings: [:quests, :quest] }
+
+
+  describe "#result" do
+    context "singular result" do
+      before { http.stub(:body).and_return success_fixture_for('get_quests') }
+
+      it "returns the result of it's body" do
+        expect(subject.result).to eq savon_response.body[:get_quests_response][:get_quests_result][:quests][:quest]
+      end
+    end
+
+    context "multiple result" do
+      before { http.stub(:body).and_return success_fixture_for('get_quests_multiple_response') }
+
+      it "fails" do
+        expect { subject.result }.to raise_error QuestBack::Error::MultipleResultsFound
+      end
+    end
+  end
+
+  describe "#results" do
+    context "singular result" do
+      before { http.stub(:body).and_return success_fixture_for('get_quests') }
+
+      it "returns the result of it's body wrapped in an array" do
+        expect(subject.results).to eq Array.wrap(savon_response.body[:get_quests_response][:get_quests_result][:quests][:quest])
+      end
+    end
+
+    context "multiple result" do
+      before { http.stub(:body).and_return success_fixture_for('get_quests_multiple_response') }
+
+      it "returns the result" do
+        expect(subject.results).to eq savon_response.body[:get_quests_response][:get_quests_result][:quests][:quest]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+require 'quest_back'
+require "savon/mock/spec_helper"
+
+
+
+module RequestHelpers
+  def success_fixture_for(name)
+    read_fixture "#{name}_success.xml"
+  end
+
+  def failure_fixture_for(name)
+    read_fixture "#{name}_failure.xml"
+  end
+
+  def read_fixture(filename)
+    File.read path_to_fixture(filename)
+  end
+
+  def path_to_fixture(filename)
+    File.join(File.dirname(__FILE__), 'fixtures', filename)
+  end
+end
+
+
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # Mock savon request tests
+  c.include Savon::SpecHelper, type: :request
+  c.include RequestHelpers, type: :request
+  c.before(type: :request) { savon.mock! }
+  c.after(type: :request) { savon.unmock! }
+end