quest_back 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71ac294356aae1fe3423d0cba13cb705a1245cfd
-  data.tar.gz: 99bf75d03a7984badd0291ba474d27e07b9796fd
+  metadata.gz: 11586d8a26f2c49c1fa272a5a0f74f93c1682f0d
+  data.tar.gz: cbda0b537c75e65812d6904271e66a74003fad9b
 SHA512:
-  metadata.gz: 83d3d479391da098c8c62d9bc1d157c0fe14708c1ad320cb76d61605519b3404ce133648a8a38007c00cc9a436882f8f052d269786c05590e8b3ab56ce180d91
-  data.tar.gz: f030b1fa5a1f02645e39386cc630cde2c08d5f5e06d2a7dd02938bb941c15905192df38c24bfe467ae3bec4c645cdffb16d5a0fb299977aa8d5c223cfe7d9299
+  metadata.gz: 936152bee1653f4d3633f8b5ce8d68e7a3dbe615b316fbe824466039836dfd6c27685034dab9e8d9bb335ce6d9b38e98cc48fe058e62d1867ddab5f2e4780800
+  data.tar.gz: 3c165b8129933a20cac0fb18420efec47c7ce7826f805bb66c58fcb27050f11cf077bd1e68a139ea494b99cb28a855759fb93d2f6d248fe723ed2bacb8b8f0ea

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.0.2 (unreleased)
+* Support for operation `add_respondents_data_with_sms_invitation`.
+
+## 0.0.1
+* Added `QuestBack.debug!` option. Does not send request, logs generated XML.
+* Basic operations `test_connection`, `get_quests`, `get_language_list`,
+  `add_email_invitees` and `add_respondents_data`.
+* Simple `QuestBack::Response` object for wrapping Savon's response and
+  provide an interface for reading out response's `result` or `results`.
+* Configuration and authentication.

data/README.md

@@ -1,6 +1,6 @@
 # QuestBack
 
-Simply Ruby client for QuestBack's SOAP API.
+Simple Ruby client for QuestBack's SOAP API.
 
 ### WARNING
 
@@ -8,8 +8,8 @@ This gem is not complete and may lack many functions provided by QuestBack.
 Please feel free to contribute and make pull requests.
 
 It is also very simplistic, only using simple hashes for both sending in arguments to the API and returning responses.
-The hash you send as argument to operation methods is more or less sent on to QuestBack.
-Maybe this will change in the future with real objects sent in to the API.
+The hash you send as argument to an operation methods is more or less passed on directly to QuestBack. We do some
+transformation of the has to match the expectations of QuestBack's API.
 
 
 
@@ -30,17 +30,25 @@ Or install it yourself as:
 
 ## Usage
 
-### Get access - test client in console
+### Getting access to API
 
 1. Go to https://response.questback.com/soapdocs/integration/ and request white listing of the IP you will make requests from.
 2. Sign in to QuestBack. Go to your account's page and fill in "Integration username and password".
    If you have no fields under Integration Information you have to contact QuestBack to get access.
-3. Copy config.example.yml to config.yml and insert your username and password.
-4. `QuestBack.conf!` to load config.yml as default config.
-5. `QuestBack::Client.new.test_connection` to make a test connection API call. On successful connection this returns string with current namespace of integration library.
 
+### Create an API client
 
-### Example of usage
+```ruby
+api = QuestBack::Api.new(
+  config: QuestBack::Configuration.new(username: "username", password: "password")
+)
+
+response = api.test_connection
+response.result
+=> "Connection sucessful. you are connected to namespace: https://integration.questback.com/2011/03"
+```
+
+### Examples
 
 ```ruby
 # Read quests
@@ -81,19 +89,19 @@ response = api.add_respondents_data(
           title: 'Epost',
           type: QuestBack::Api.respondent_data_header_type_for(:text),
           is_email_field: true,
-          is_sms_field: false,
+          is_sms_field: false
         },
         {
           title: 'Navn',
           type: QuestBack::Api.respondent_data_header_type_for(:text),
           is_email_field: false,
-          is_sms_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,
+          is_sms_field: false
         },
       ]
     },
@@ -105,6 +113,33 @@ response = api.add_respondents_data(
 
 response.result
 => "Added 1 respondent data to QuestId :4567668"
+
+
+# Add respondent data with sms invitation
+response = api.add_respondents_data_with_sms_invitation(
+  quest_info: {quest_id: 4567668, security_lock: 'm0pI8orKJp'},
+  respondents_data: {
+    respondent_data_header: {
+      respondent_data_header: [
+        {
+          title: 'Phone',
+          type: QuestBack::Api.respondent_data_header_type_for(:text),
+          is_email_field: false,
+          is_sms_field: true
+        }
+      ]
+    },
+    respondent_data: ['4711223344'],
+    allow_duplicate: true,
+    add_as_invitee: true
+  },
+  sms_from_number: 11111111,
+  sms_from_text: 'Inviso AS',
+  sms_message: 'Hello - please join our quest!'
+)
+
+response.result
+=> "Sms message created successfully"
 ```
 
 ### Debug XML without making a request
@@ -145,3 +180,12 @@ QuestBack.remove_debug! # Activates real requests again
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+#### Test client in console
+
+After cloning the repository you may do this to make it a bit more convenient working
+with the code in your console while developing.
+
+1. Copy config.example.yml to config.yml and insert your username and password.
+2. Load console `bundle console` and do `QuestBack.conf!` to load config.yml as default config.
+3. `QuestBack::Client.new.test_connection` to make a test connection API call. On successful connection this returns string with current namespace of integration library.

data/lib/quest_back/api.rb

@@ -19,7 +19,11 @@ module QuestBack
     ORDER = {
       get_quests: [:user_info, :paging_info, :quest_filter],
       add_email_invitees: [:user_info, :quest_info, :emails, :sendduplicate, :language_id],
-      add_respondents_data: [:user_info, :quest_info, :respondents_data, :language_id]
+      add_respondents_data: [:user_info, :quest_info, :respondents_data, :language_id],
+      add_respondents_data_with_sms_invitation: [
+        :user_info, :quest_info, :respondents_data, :language_id,
+        :sms_from_number, :sms_from_text, :sms_message
+      ]
     }
 
     # In order to provide a simple response.result and response.results interface
@@ -34,7 +38,8 @@ module QuestBack
       get_quests: [:quests, :quest],
       get_language_list: [:language],
       add_email_invitees: [],
-      add_respondents_data: []
+      add_respondents_data: [],
+      add_respondents_data_with_sms_invitation: []
     }
 
     RESPONDENTS_HEADER_TYPE = {
@@ -48,7 +53,9 @@ module QuestBack
     }
 
     def self.respondent_data_header_type_for(type)
-      RESPONDENTS_HEADER_TYPE.fetch(type.to_sym) { fail ArgumentError, "#{type.to_s.inspect} is an unkown respondent data header type." }
+      RESPONDENTS_HEADER_TYPE.fetch(type.to_sym) do
+        fail ArgumentError, "#{type.to_s.inspect} is an unkown respondent data header type."
+      end
     end
 
     # Public: Creates a new API gateway object.
@@ -165,6 +172,51 @@ module QuestBack
       call :add_respondents_data, attributes, include_defaults: [:respondents_data]
     end
 
+    # Public: Add respondent data to a quest with SMS invitation
+    #
+    # attributes    -   Attributes sent to QuestBack
+    #
+    #
+    # Example
+    #
+    #   response = api.add_respondents_data_with_sms_invitation(
+    #     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: 'Phone',
+    #             type: QuestBack::Api.respondent_data_header_type_for(:text),
+    #             is_email_field: false,
+    #             is_sms_field: true,
+    #           }
+    #         ]
+    #       },
+    #       # According to QuestBack's doc you can only do one respondent data,
+    #       # even though it for sure is an array. Phone numbers must be given
+    #       # on with country code first.
+    #       respondent_data: ['th@skalar.no;4711223344'],
+    #       allow_duplicate: true,
+    #       add_as_invitee: true
+    #     },
+    #     sms_from_number: 11111111,
+    #     sms_from_text: 'Inviso AS',
+    #     sms_message: 'Hello - please join our quest!'
+    #   )
+    #
+    # You may override respondent_data's delimiter in string too.
+    #
+    # Returns QuestBack::Response
+    def add_respondents_data_with_sms_invitation(attributes = {})
+      call :add_respondents_data_with_sms_invitation, attributes, include_defaults: [:respondents_data]
+    end
+
 
 
 
@@ -235,7 +287,7 @@ module QuestBack
         unkown_keys = attributes.keys - order
 
         if unkown_keys.any?
-          fail ArgumentError, "Unkown attributes given to #{options[:operation_name]}: #{unkown_keys.join(', ')}. Attributes' order needs to be configured in #{self.class.name}::ORDER."
+          fail ArgumentError, "Unkown attribute(s) given to #{options[:operation_name]}: #{unkown_keys.join(', ')}. Attributes' order is defined in #{self.class.name}::ORDER, but you sent in something we do not have."
         end
 
         message[:order!] = order & message.keys

data/lib/quest_back/version.rb

@@ -1,3 +1,3 @@
 module QuestBack
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/add_respondents_data_with_sms_invitation_failure.xml

@@ -0,0 +1,8 @@
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+  <s:Body>
+    <s:Fault>
+      <faultcode>s:Client</faultcode>
+      <faultstring xml:lang="nb-NO">Invalid input: Failed to parse sms number! Number:aaaa</faultstring>
+    </s:Fault>
+  </s:Body>
+</s:Envelope>

data/spec/fixtures/add_respondents_data_with_sms_invitation_success.xml

@@ -0,0 +1,7 @@
+<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+   <s:Body>
+      <AddRespondentsDataWithSmsInvitationResponse xmlns="https://integration.questback.com/2011/03">
+         <AddRespondentsDataWithSmsInvitationResult>Sms message created successfully</AddRespondentsDataWithSmsInvitationResult>
+      </AddRespondentsDataWithSmsInvitationResponse>
+   </s:Body>
+</s:Envelope>

data/spec/quest_back/api_spec.rb

@@ -253,5 +253,86 @@ describe QuestBack::Api, type: :request do
         expect(response).to be_successful
       end
     end
+
+    describe "#add_respondents_data_with_sms_invitation" 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
+                }
+              ]
+            },
+            'RespondentData' => {'array:string' => ['th@skalar.no;404 40 404']},
+            'Delimiter' => ';',
+            'AllowDuplicate' => true,
+            'AddAsInvitee' => true,
+            order!: ["RespondentDataHeader", "RespondentData", "Delimiter", "AllowDuplicate", "AddAsInvitee"]
+          },
+          sms_from_number: 11111111,
+          sms_from_text: 'Inviso AS',
+          sms_message: 'Hello - please join our quest!',
+          order!: QuestBack::Api::ORDER[:add_respondents_data_with_sms_invitation] - [:language_id]
+        )
+
+
+        savon.expects(:add_respondents_data_with_sms_invitation)
+          .with(message: expected_message)
+          .returns success_fixture_for 'add_respondents_data_with_sms_invitation'
+
+
+        response = subject.add_respondents_data_with_sms_invitation(
+          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,
+                }
+              ]
+            },
+            respondent_data: ['th@skalar.no;404 40 404'],
+            allow_duplicate: true,
+            add_as_invitee: true
+          },
+          sms_from_number: 11111111,
+          sms_from_text: 'Inviso AS',
+          sms_message: 'Hello - please join our quest!'
+        )
+
+        expect(response).to be_successful
+      end
+
+      it "fails with soap error when phone number isn't parsable" do
+        savon.expects(:add_respondents_data_with_sms_invitation)
+          .with(message: :any)
+          .returns failure_fixture_for 'add_respondents_data_with_sms_invitation'
+
+        expect {
+          subject.add_respondents_data_with_sms_invitation
+        }.to raise_error Savon::SOAPFault
+      end
+    end
   end
 end

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: quest_back
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Thorbjørn Hermansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.14
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.14
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !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'
 description: 
@@ -93,7 +93,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,6 +110,8 @@ files:
 - quest_back.gemspec
 - spec/fixtures/add_email_invitees_success.xml
 - spec/fixtures/add_respondents_data_success.xml
+- spec/fixtures/add_respondents_data_with_sms_invitation_failure.xml
+- spec/fixtures/add_respondents_data_with_sms_invitation_success.xml
 - spec/fixtures/get_language_list_success.xml
 - spec/fixtures/get_quests_multiple_response_success.xml
 - spec/fixtures/get_quests_success.xml
@@ -129,23 +132,25 @@ 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.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for QuestBack's SOAP API.
 test_files:
 - spec/fixtures/add_email_invitees_success.xml
 - spec/fixtures/add_respondents_data_success.xml
+- spec/fixtures/add_respondents_data_with_sms_invitation_failure.xml
+- spec/fixtures/add_respondents_data_with_sms_invitation_success.xml
 - spec/fixtures/get_language_list_success.xml
 - spec/fixtures/get_quests_multiple_response_success.xml
 - spec/fixtures/get_quests_success.xml