responsys-api 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdb555ebc25a9e36220f23db35cce71c6699447a
-  data.tar.gz: 07f3955ef5d568caf42437dfaf9497556908eb3e
+  metadata.gz: 6c58dabbbc30ada0598409ef51e03261727c7e9f
+  data.tar.gz: 99998f69378d08f201ef7f2237f5ba539ba7f835
 SHA512:
-  metadata.gz: 6fa7ef72a3a02b7fa83c2f122d0c90b782732adb4548398f44452454a94180a8376902878e80c041cf9531b64a162af5ad5bc591a5c53c2aab83ef2473e8c6a9
-  data.tar.gz: a7615c3c86f6f2d778d7dd3fe376fc40af2b6e8526c527e9ae24293eb4ebe5bfb35ba110c98684b4d2d89b50322b2b160eb7bc804737b77336e02050f987bd1e
+  metadata.gz: ed4209c6e94719176a85d2a509473a324a73663ccc2ab98b947802a98c38bcbd990da8eafcca56a7efeae46a4cb6e7325171f43ee16212f64827d31528088f8b
+  data.tar.gz: 6f1c45aede0988f1d8bbe4961eb70dedbc3d062f7be0d8bff92177fc07b862f155de88a3a5b4be2672711162e497c173c3cd34a9e39667f16792bfd7331362b2

data/.travis.yml

@@ -4,9 +4,11 @@ rvm:
   - 2.1.2
 gemfile:
   - Gemfile
+before_install:
+  - gem install bundler -v 1.11.2
 notifications:
   email:
     on_success: never
     on_failure: never
   slack:
-    secure: 8b8dwwpHEw7vYd5Vma/BK2dZBrKYpFtu8TN8+NtpW8Xp+boYY3hEaFCeeEySzDvacCBZFKjjvDxverOFd4jqml2MtOukNZ/zlFc7ZVybGsNirfisNucS7auvwoWPwVrzrHoNpB5nTLU4tm0tWdaKkfLa4Yssr/tEO8yBIGwT8ds=
+    secure: 8b8dwwpHEw7vYd5Vma/BK2dZBrKYpFtu8TN8+NtpW8Xp+boYY3hEaFCeeEySzDvacCBZFKjjvDxverOFd4jqml2MtOukNZ/zlFc7ZVybGsNirfisNucS7auvwoWPwVrzrHoNpB5nTLU4tm0tWdaKkfLa4Yssr/tEO8yBIGwT8ds=

data/README.md

@@ -2,6 +2,8 @@
 
 A gem to help you communicate to the Responsys Interact SOAP API. Currently working of Responsys Interact version 6.20.
 
+:warning: The REST version of the GEM is available on a [WIP branch](https://github.com/dandemeyere/responsys-api/tree/migration-to-rest-apis)
+
 ## Documentation
 
 Have a look at our [wiki](https://github.com/dandemeyere/responsys-api/wiki) to understand the functionality this gem offers, how  to use it, and some tips to help you avoid the same mistakes we ran into! If you have any questions or if you want to report a bug please create an [issue](https://github.com/dandemeyere/responsys-api/issues).
@@ -27,13 +29,15 @@ Responsys.configure do |config|
     password: "your_responsys_password",
     wsdl: "https://wsXXXX.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl",
     debug: false,
-    ssl_version: :TLSv1
+    enabled: true,
+    savon_settings: { # Any Savon 2 settings, below are the default options
+      ssl_version: :TLSv1,
+      element_form_default: :qualified
+    }
   }
 end
 ```
 
-Note that the debug option is optional and is set to false by default.
-
 ### Example
 ```ruby
 #!/usr/bin/env ruby

data/lib/responsys/api/campaign.rb

@@ -6,8 +6,8 @@ module Responsys
       include Responsys::Exceptions
 
       def trigger_custom_event(custom_event, recipients)
-        raise ParameterException, Responsys::Helper.get_message("api.campaign.incorrect_recipients_type") unless recipients.is_a? Array
-        raise ParameterException, Responsys::Helper.get_message("api.object.custom_event.incorrect_event_object") unless custom_event.is_a? Responsys::Api::Object::CustomEvent
+        raise ParameterException.new("api.campaign.incorrect_recipients_type") unless recipients.is_a? Array
+        raise ParameterException.new("api.object.custom_event.incorrect_event_object") unless custom_event.is_a? Responsys::Api::Object::CustomEvent
 
         message = {
           customEvent: custom_event.to_api,
@@ -17,7 +17,7 @@ module Responsys
       end
 
       def trigger_message(campaign, recipients)
-        raise ParameterException, Responsys::Helper.get_message("api.campaign.incorrect_recipients_type") unless recipients.is_a? Array
+        raise ParameterException.new("api.campaign.incorrect_recipients_type") unless recipients.is_a? Array
         message = {
           campaign: campaign.to_api,
           recipientData: recipients.map(&:to_api)

data/lib/responsys/api/client.rb

@@ -2,6 +2,7 @@ module Responsys
   module Api
     class Client
       include Responsys::Api::All
+      include Responsys::Exceptions
       attr_accessor :client
 
       #TODO allows to keep the use of .instance. The client is no longer a singleton so it needs to be removed in a newer release.
@@ -9,8 +10,17 @@ module Responsys
         alias :instance :new
       end
 
+      def initialize
+        @raise_exceptions = false
+      end
+
       def api_method(action, message = nil, response_type = :hash)
-        raise Responsys::Helper.get_message("api.client.api_method.wrong_action_#{action.to_s}") if action.to_sym == :login || action.to_sym == :logout
+        raise ParameterException.new("api.client.api_method.wrong_action_#{action.to_s}") if action.to_sym == :login || action.to_sym == :logout
+
+        unless Responsys.configuration.enabled?
+          raise DisabledException.new if @raise_exceptions
+          return "disabled"
+        end
 
         SessionPool.instance.with do |session|
           begin
@@ -25,12 +35,26 @@ module Responsys
             else
              response
             end
-          rescue Exception => e
+          rescue Savon::Error => e
             Responsys::Helper.format_response_with_errors(e)
           end
         end
       end
 
+      # For internal use ONLY
+      def run(exception_raising = false)
+        old_raise_exceptions = @raise_exceptions
+        @raise_exceptions = exception_raising
+        begin
+          yield(self)
+        rescue DisabledException => e
+          raise e if @raise_exceptions
+          return "disabled"
+        ensure
+          @raise_exceptions = old_raise_exceptions
+        end
+      end
+
       def available_operations
         SessionPool.instance.with do |session|
           session.operations

data/lib/responsys/api/list.rb

@@ -4,6 +4,7 @@ module Responsys
   module Api
     module List
       include Responsys::Api::Object
+
       def retrieve_list_members(interact_object, query_column, field_list, ids_to_retrieve)
         message = {
           list: interact_object.to_api,
@@ -15,24 +16,19 @@ module Responsys
         api_method(:retrieve_list_members, message)
       end
 
-      def merge_list_members(interact_object, record_data, merge_rule = ListMergeRule.new)
+      def merge_list_members(interact_object, record_data, merge_rule = ListMergeRule.new, riid = false)
         message = {
           list: interact_object.to_api,
           recordData: record_data.to_api,
           mergeRule: merge_rule.to_api
         }
 
-        api_method(:merge_list_members, message)
+        method_name = riid ? "merge_list_members_riid" : "merge_list_members"
+        api_method(method_name.to_sym, message)
       end
 
       def merge_list_members_riid(interact_object, record_data, merge_rule = ListMergeRule.new)
-        message = {
-          list: interact_object.to_api,
-          recordData: record_data.to_api,
-          mergeRule: merge_rule.to_api
-        }
-
-        api_method(:merge_list_members_riid, message)
+        merge_list_members(interact_object, record_data, merge_rule, true)
       end
     end
   end

data/lib/responsys/api/object/custom_event.rb

@@ -6,7 +6,7 @@ module Responsys
         attr_accessor :event_name, :event_id, :event_string_data_mapping, :event_number_data_mapping, :event_date_data_mapping
 
         def initialize(event_name="", event_id="", options={})
-          raise ParameterException, Responsys::Helper.get_message("api.object.custom_event.empty_event") if event_name.blank? && event_id.blank?
+          raise ParameterException.new("api.object.custom_event.empty_event") if event_name.blank? && event_id.blank?
           @event_name = event_name || ""
           @event_id = event_id || ""
           @event_string_data_mapping = options[:event_string_data_mapping] || ""

data/lib/responsys/api/object/record_data.rb

@@ -7,7 +7,7 @@ module Responsys
         attr_accessor :field_names, :records
 
         def initialize(data)
-          raise ParameterException, Responsys::Helper.get_message("api.object.record_data.incorrect_record_data_type") unless data.is_a? Array
+          raise ParameterException.new("api.object.record_data.incorrect_record_data_type") unless data.is_a? Array
 
           self.field_names = data.map { |record| record.keys }.flatten.uniq
 

data/lib/responsys/api/session.rb

@@ -5,19 +5,10 @@ module Responsys
       include Responsys::Api::Authentication
 
       def initialize
-        settings = Responsys.configuration.settings
-        @credentials = {
-          username: settings[:username],
-          password: settings[:password]
-        }
+        global_configuration = Responsys.configuration
 
-        ssl_version = settings[:ssl_version] || :TLSv1
-
-        if settings[:debug]
-          @savon_client = Savon.client(wsdl: settings[:wsdl], element_form_default: :qualified, ssl_version: ssl_version, log_level: :debug, log: true, pretty_print_xml: true)
-        else
-          @savon_client = Savon.client(wsdl: settings[:wsdl], element_form_default: :qualified, ssl_version: ssl_version)
-        end
+        @credentials = global_configuration.api_credentials
+        @savon_client = Savon.client(global_configuration.savon_settings)
       end
 
       def run(method, message)

data/lib/responsys/configuration.rb

@@ -3,17 +3,40 @@ module Responsys
     attr_accessor :settings
 
     def initialize
-      @settings = {
-        username: nil,
-        password: nil,
-        wsdl: "",
-        debug: false,
-        sessions: {
-          size: 80,
-          timeout: 30
+      @settings = {}
+    end
+
+    def savon_settings
+      settings_hash = if @settings[:wsdl].present?
+        { wsdl: @settings[:wsdl] }
+      else
+        {
+          endpoint: @settings[:endpoint],
+          namespace: @settings[:namespace]
         }
+      end
+
+      @settings[:savon_settings].merge(settings_hash)
+    end
+
+    def api_credentials
+      {
+        username: @settings[:username],
+        password: @settings[:password]
       }
     end
+
+    def session_settings
+      @settings[:sessions]
+    end
+
+    def debug?
+      !!(@settings[:debug])
+    end
+
+    def enabled?
+      !!(@settings[:enabled])
+    end
   end
 
   class << self
@@ -26,6 +49,73 @@ module Responsys
 
   def self.configure
     yield(configuration)
+
+    check_configuration
+
+    prepare!
+
     Responsys::Api::SessionPool.init
   end
+
+  private
+
+  def self.check_configuration
+    raise Responsys::Exceptions::GenericException.new("configuration.api_description_not_provided") if absent_api_description?
+    raise Responsys::Exceptions::GenericException.new("configuration.api_credentials_not_provided") if absent_api_credentials?
+  end
+
+  def self.prepare!
+    @configuration.settings = default_settings_hash.merge(@configuration.settings)
+    @configuration.settings[:savon_settings] = savon_settings
+    @configuration.settings[:sessions] = sessions
+
+    add_debug_options! if @configuration.debug?
+  end
+
+  def self.savon_settings
+    default_settings_hash[:savon_settings].merge!(@configuration.settings[:savon_settings])
+  end
+
+  def self.sessions
+    default_settings_hash[:sessions].merge!(@configuration.settings[:sessions])
+  end
+
+  def self.add_debug_options!
+    @configuration.settings[:savon_settings] = debug_savon_options.merge!(@configuration.settings[:savon_settings])
+  end
+
+  def self.debug_savon_options
+    { log_level: :debug, log: true, pretty_print_xml: true }
+  end
+
+  def self.absent_api_description?
+    wsdl = @configuration.settings[:wsdl].present?
+    endpoint = @configuration.settings[:endpoint].present?
+    namespace = @configuration.settings[:namespace].present?
+
+    return false if wsdl
+
+    return !(endpoint && namespace) if endpoint || namespace
+
+    true
+  end
+
+  def self.absent_api_credentials?
+    @configuration.settings[:username].blank? || @configuration.settings[:password].blank?
+  end
+
+  def self.default_settings_hash
+    {
+      enabled: true,
+      debug: false,
+      sessions: {
+        size: 80,
+        timeout: 30
+      },
+      savon_settings: {
+        ssl_version: :TLSv1,
+        element_form_default: :qualified
+      }
+    }
+  end
 end

data/lib/responsys/exceptions.rb

@@ -0,0 +1,25 @@
+module Responsys
+  module Exceptions
+    class BaseException < Exception
+      def initialize(message_key = nil)
+        if message_key.nil?
+          super
+        else
+          super(Responsys::Helper.get_message(message_key))
+        end
+      end
+    end
+
+    class ParameterException < Responsys::Exceptions::BaseException
+    end
+
+    class DisabledException < Responsys::Exceptions::BaseException
+      def initialize
+        super("gem_is_disabled")
+      end
+    end
+
+    class GenericException < Responsys::Exceptions::BaseException
+    end
+  end
+end

data/lib/responsys/i18n/en.yml

@@ -1,5 +1,9 @@
 en:
   responsys_api:
+    gem_is_disabled: "The query couldn't be performed because the GEM is disabled."
+    configuration:
+      api_description_not_provided: A WSDL or endpoint+namespace is needed.
+      api_credentials_not_provided: No credentials are provided in the configuration.
     api:
       object:
         field_type:
@@ -18,41 +22,6 @@ en:
           empty_event: The event_name or event_id must be specified
           incorrect_event_object: "custom_event must be a CustomEvent instance"
       client:
-        available_methods:
-          - wsdl
-          - endpoint
-          - namespace
-          - raise_errors
-          - proxy
-          - headers
-          - open_timeout
-          - read_timeout
-          - ssl_verify_mode
-          - ssl_version
-          - ssl_cert_file
-          - ssl_cert_key_file
-          - ssl_ca_cert_file
-          - ssl_cert_key_password
-          - convert_request_keys_to
-          - soap_header
-          - element_form_default
-          - env_namespace
-          - namespace_identifier
-          - namespaces
-          - encoding
-          - soap_version
-          - basic_auth
-          - digest_auth
-          - wsse_auth
-          - wsse_timestamp
-          - ntlm
-          - strip_namespaces
-          - convert_response_tags_to
-          - logger
-          - log_level
-          - log
-          - filters
-          - pretty_print_xml
         api_method:
           wrong_action_login: Please use the dedicated login method
           wrong_action_logout: Please use the dedicated logout method

data/lib/responsys/member.rb

@@ -7,10 +7,9 @@ module Responsys
     include Responsys::Api::Object
     attr_accessor :email, :user_riid, :client
 
-    def initialize(email, riid = nil, client = Client.instance)
+    def initialize(email, riid = nil)
       @email = email
       @user_riid = riid
-      @client = client
     end
 
     def add_to_list(list, subscribe = false, details = {}, update_record = false)
@@ -29,54 +28,70 @@ module Responsys
       data = data.merge( safe_details )
       record = RecordData.new([data])
 
-      @client.merge_list_members_riid(list, record, ListMergeRule.new(insertOnNoMatch: true, updateOnMatch: ( update_record ? 'REPLACE_ALL' : 'NO_UPDATE' )))
+      Client.new.run do |client|
+        client.merge_list_members_riid(list, record, ListMergeRule.new(insertOnNoMatch: true, updateOnMatch: (update_record ? 'REPLACE_ALL' : 'NO_UPDATE')))
+      end
     end
 
     def retrieve_profile_extension(profile_extension, fields)
-      return Responsys::Helper.format_response_with_message("member.riid_missing") if @user_riid.nil?
-      return Responsys::Helper.format_response_with_message("member.record_not_found") unless present_in_profile?(profile_extension)
+      Client.new.run do |client|
+        return Responsys::Helper.format_response_with_message("member.riid_missing") if @user_riid.nil?
+        return Responsys::Helper.format_response_with_message("member.record_not_found") unless present_in_profile?(profile_extension, true)
 
-      @client.retrieve_profile_extension_records(profile_extension, QueryColumn.new("RIID"), fields, [@user_riid])
+        client.retrieve_profile_extension_records(profile_extension, QueryColumn.new("RIID"), fields, [@user_riid])
+      end
     end
 
     def subscribe(list)
-      update(list, [{ EMAIL_ADDRESS_: @email, EMAIL_PERMISSION_STATUS_: "I" }])
+      Client.new.run do |client|
+        update(list, [{ EMAIL_ADDRESS_: @email, EMAIL_PERMISSION_STATUS_: "I" }])
+      end
     end
 
     def unsubscribe(list)
-      update(list, [{ EMAIL_ADDRESS_: @email, EMAIL_PERMISSION_STATUS_: "O" }])
+      Client.new.run do |client|
+        update(list, [{ EMAIL_ADDRESS_: @email, EMAIL_PERMISSION_STATUS_: "O" }])
+      end
     end
 
     def update(list, data)
-      return Responsys::Helper.format_response_with_message("member.record_not_found") unless present_in_list?(list)
+      Client.new.run(true) do |client|
+        return Responsys::Helper.format_response_with_message("member.record_not_found") unless present_in_list?(list, true)
 
-      record = RecordData.new(data)
-      @client.merge_list_members(list, record)
+        record = RecordData.new(data)
+        client.merge_list_members(list, record)
+      end
     end
 
-    def present_in_profile?(list)
-      return Responsys::Helper.format_response_with_message("member.riid_missing") if @user_riid.nil?
+    def present_in_profile?(list, raising = false)
+      Client.new.run(raising) do |client|
+        return Responsys::Helper.format_response_with_message("member.riid_missing") if @user_riid.nil?
 
-      response = lookup_profile_via_key(list, "RIID", @user_riid)
+        response = lookup_profile_via_key(list, "RIID", @user_riid)
 
-      !(response[:status] == "failure" && response[:error][:code] == "RECORD_NOT_FOUND")
+        !(response[:status] == "failure" && response[:error][:code] == "RECORD_NOT_FOUND")
+      end
     end
 
-    def present_in_list?(list)
-      if !@user_riid.nil?
-        response = lookup_list_via_key(list, "RIID", @user_riid)
-      else
-        response = lookup_list_via_key(list, "EMAIL_ADDRESS", @email)
-      end
+    def present_in_list?(list, raising = false)
+      Client.new.run(raising) do |client|
+        if !@user_riid.nil?
+          response = lookup_list_via_key(list, "RIID", @user_riid)
+        else
+          response = lookup_list_via_key(list, "EMAIL_ADDRESS", @email)
+        end
 
-      !(response[:status] == "failure" && response[:error][:code] == "RECORD_NOT_FOUND")
+        !(response[:status] == "failure" && response[:error][:code] == "RECORD_NOT_FOUND")
+      end
     end
 
-    def subscribed?(list)
-      return Responsys::Helper.format_response_with_message("member.record_not_found") unless present_in_list?(list)
+    def subscribed?(list, raising = false)
+      Client.new.run(raising) do |client|
+        return Responsys::Helper.format_response_with_message("member.record_not_found") unless present_in_list?(list, true)
 
-      response = @client.retrieve_list_members(list, QueryColumn.new("EMAIL_ADDRESS"), %w(EMAIL_PERMISSION_STATUS_), [@email])
-      response[:data][0][:EMAIL_PERMISSION_STATUS_] == "I"
+        response = client.retrieve_list_members(list, QueryColumn.new("EMAIL_ADDRESS"), %w(EMAIL_PERMISSION_STATUS_), [@email])
+        response[:data][0][:EMAIL_PERMISSION_STATUS_] == "I"
+      end
     end
 
     private
@@ -102,11 +117,11 @@ module Responsys
     end
 
     def lookup_profile_via_key(profile_extension, key, value)
-      @client.retrieve_profile_extension_records(profile_extension, QueryColumn.new(key), %w(RIID_), [value])
+      Client.new.run(true) { |client| client.retrieve_profile_extension_records(profile_extension, QueryColumn.new(key), %w(RIID_), [value]) }
     end
 
     def lookup_list_via_key(list, key, value)
-      @client.retrieve_list_members(list, QueryColumn.new(key), %w(EMAIL_PERMISSION_STATUS_), [value])
+      Client.new.run(true) { |client| client.retrieve_list_members(list, QueryColumn.new(key), %w(EMAIL_PERMISSION_STATUS_), [value]) }
     end
   end
 end