responsys-api 0.0.8 → 0.0.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmRlYWRjMDA4YTliNzE3NGY2NzIzZGUyYjM3OTkyNjUyNGFkZmI1Yw==
+    NThlNWRiM2JmMDc1ZDJhNGM2ZjI1YWMwZjhiMGViYzM4MGI3ZGEyMw==
   data.tar.gz: !binary |-
-    MjA4Nzc5MzFmMzVkZmNkYTlmOWZkZTZjNWMxMDM0NzhkOGQ0NDVjNw==
+    ZDkyMzQ2YTA3NzNlNjJhYzVkYjg1NWZmYjYyMDgzZTQ1ZWE2NzY2Nw==
 SHA512:
   metadata.gz: !binary |-
-    NTNiYzIzYjNjYWRmZDYyYWEyZWE3N2I1ODQxNmEwOTYzY2Q1M2EyNWE1NWZk
-    ZjI2MGRmODMzZDc2OGMzZTdhM2NmMTVhOGQwZGRhN2Y5OWJkNThiNDBhYzg3
-    Njk2NTZhOGMwMDIxZGJjNTBlY2Q2YWM1OGZhNGFlMGM3MDZiNzA=
+    ZjA1YzZmYjU5N2FiYzMzY2VlZjcyYTAwZWI3ZDljOTAxMDkyNjE2NzY3MmI5
+    ZTQ0NzAzNzYxZDIzNmVjM2RjYTA1MzhhNDMwYmNhMWMzYWY1YjQ1MzE5Yjdm
+    N2FhMmM0ZWEzYzExYmRkMTJmMGMxMDBmOTM0OWQwOGU2NGU0Yzc=
   data.tar.gz: !binary |-
-    YzZmYzk1NTkwOGMyOTRmOTUyYjYxOWY1NTdkNzM1NDgyNjFlZjhkNjVkZjgy
-    ZDkyYjU0M2E3MzYxNjc2YjE2YzAxZjUyOWVkMTk4MmUyYzA5MTBlMGU5NjVj
-    Njg5NGYxOWEyZjc5ZjhmZGRjYTFhNGZkMDU4MDZlODE0ODJmODE=
+    MWFlYzk1Y2E3ZGRjYTUyNTY3NzU0ODE3NzMwZTk4ZjgyODkzYTYzZDAwODM3
+    ZDcxYWZmZmM4NmUyOWJlNDFhZjRkYzRmZWU4YmIzNDc3YmZmNDA5OTZjOTBj
+    YTc1NGQ5ZDRlOWJlY2Y0MjI2YTc5N2UxM2EwMWY0ZmRiYmVhYzA=

data/.gitignore

@@ -20,3 +20,6 @@ lib/.DS_Store
 lib/responsys/.DS_Store
 .rvmrc
 .idea/
+.ruby-version
+
+spec/api_credentials.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+
+gemfile:
+  - Gemfile

data/README.md

@@ -1,4 +1,4 @@
-# ResponsysApi
+# ResponsysApi ![Master branch build status](https://travis-ci.org/dandemeyere/responsys-api.svg?branch=master)
 
 A gem to help you communicate to the Responsys Interact SOAP API. Currently working of Responsys Interact version 6.20.
 
@@ -10,7 +10,7 @@ Have a look at our [wiki](https://github.com/dandemeyere/responsys-api/wiki) to
 
 Add this line to your application"s Gemfile:
 
-    gem "responsys-api", "~> 0.0.6"
+    gem "responsys-api", "~> 0.0.8"
 
 Or install it locally with:
 

data/Rakefile

@@ -1 +1,12 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rake/testtask"
+
+task :default => [:test]
+
+task :test do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = "spec/**/*_spec.rb"
+  end
+  Rake::Task["spec"].execute
+end

data/lib/responsys/api/campaign.rb

@@ -6,7 +6,7 @@ module Responsys
       include Responsys::Exceptions
 
       def trigger_message(campaign, recipients)
-        raise ParameterException, I18n.t("api.campaign.incorrect_recipients_type") unless recipients.is_a? Array
+        raise ParameterException, Responsys::Helper.get_message("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

@@ -27,12 +27,14 @@ module Responsys
         else
           @client = Savon.client(wsdl: settings[:wsdl], element_form_default: :qualified, ssl_version: ssl_version)
         end
-
-        login
       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
+
         begin
+          login
+
           response = run_with_credentials(action, message, jsession_id, header)
 
           case response_type
@@ -43,14 +45,9 @@ module Responsys
           end
 
         rescue Exception => e
-          error_response = Responsys::Helper.format_response_with_errors(e)
-
-          if error_response[:error][:code] == "INVALID_SESSION_ID"
-            login
-            api_method(action, message, response_type)
-          else
-            error_response
-          end
+          Responsys::Helper.format_response_with_errors(e)
+        ensure
+          logout
         end
       end
 

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

@@ -10,7 +10,7 @@ module Responsys
           if AVAILABLE_EMAIL_FORMAT.include? email_format
             @email_format_string = email_format
           else
-            raise ParameterException, I18n.t("api.object.email_format.incorrect_email_format")
+            raise ParameterException, Responsys::Helper.get_message("api.object.email_format.incorrect_email_format")
           end
         end
 

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

@@ -10,7 +10,7 @@ module Responsys
           if FIELD_TYPES.include? field_type
             @field_type_string = field_type
           else
-            raise ParameterException, I18n.t("api.object.field_type.incorrect_field_type")
+            raise ParameterException, Responsys::Helper.get_message("api.object.field_type.incorrect_field_type")
           end
         end
 

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

@@ -6,7 +6,7 @@ module Responsys
         attr_accessor :name, :value
 
         def initialize(name = "", value = "")
-          raise ParameterException, I18n.t("api.object.optional_data.incorrect_optional_data_type") unless (name.is_a? String) && (value.is_a? String)
+          raise ParameterException, Responsys::Helper.get_message("api.object.optional_data.incorrect_optional_data_type") unless (name.is_a? String) && (value.is_a? String)
           @name = name
           @value = value
         end

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

@@ -10,7 +10,7 @@ module Responsys
           if AVAILABLE_QUERY_COLUMN.include? query_column
             @query_column_string = query_column
           else
-            raise ParameterException, I18n.t("api.object.query_column.incorrect_query_column")
+            raise ParameterException, Responsys::Helper.get_message("api.object.query_column.incorrect_query_column")
           end
         end
 

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

@@ -6,7 +6,7 @@ module Responsys
         attr_accessor :field_values
 
         def initialize(field_values)
-          raise ParameterException, I18n.t("api.object.record.incorrect_field_values_type") unless field_values.is_a? Array
+          raise ParameterException, Responsys::Helper.get_message("api.object.record.incorrect_field_values_type") unless field_values.is_a? Array
           @field_values = field_values
         end
 

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

@@ -7,7 +7,7 @@ module Responsys
         attr_accessor :field_names, :records
 
         def initialize(data)
-          raise ParameterException, I18n.t("api.object.record_data.incorrect_record_data_type") unless data.is_a? Array
+          raise ParameterException, Responsys::Helper.get_message("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

@@ -2,6 +2,8 @@ module Responsys
   module Api
     module Session
       def login
+        logout if logged_in?
+
         response = run("login", credentials)
         establish_session_id(response)
         establish_jsession_id(response)
@@ -9,7 +11,14 @@ module Responsys
       end
 
       def logout
-        api_method(:logout)
+        return unless logged_in?
+
+        run_with_credentials(:logout, nil, jsession_id, header)
+        destroy_session_objects
+      end
+
+      def logged_in?
+        !(session_id.nil? || jsession_id.nil? || header.nil?)
       end
 
       private
@@ -25,6 +34,12 @@ module Responsys
       def set_session_credentials
         @header = { SessionHeader: { sessionId: session_id } }
       end
+
+      def destroy_session_objects
+        @session_id = nil
+        @jsession_id = nil
+        @header = nil
+      end
     end
   end
 end

data/lib/responsys/helper.rb

@@ -77,7 +77,15 @@ module Responsys
     end
 
     def self.format_response_with_message(i18n_key)
-      { status: "failure", error: { http_status_code: "", code: i18n_key.split('.')[-1], message: I18n.t(i18n_key) } }
+      { status: "failure", error: { http_status_code: "", code: i18n_key.split('.')[-1], message: get_message(i18n_key) } }
+    end
+
+    def self.get_message(key)
+      begin
+        I18n.t(key, scope: :responsys_api, locale: I18n.locale, raise: true)
+      rescue I18n::MissingTranslationData
+        I18n.t(key, scope: :responsys_api, locale: :en)
+      end
     end
   end
 end

data/lib/responsys/i18n/en.yml

@@ -1,20 +1,25 @@
 en:
-  api:
-    object:
-      field_type:
-        incorrect_field_type: The field type string you provided is incorrect
-      query_column:
-        incorrect_query_column: The query column you provided is incorrect
-      record_data:
-        incorrect_record_data_type: The data you provided is not an array
-      optional_data:
-        incorrect_optional_data_type: The name and value need to be Strings
-      email_format:
-        incorrect_email_format: The email format is not supported
-      record:
-        incorrect_field_values_type: The field_values must be an array
-    campaign:
-      incorrect_recipients_type: Recipients parameter must be an array
-  member:
-    riid_missing: Variable riid is not provided to the member
-    record_not_found: The member has not been found in the list
+  responsys_api:
+    api:
+      object:
+        field_type:
+          incorrect_field_type: The field type string you provided is incorrect
+        query_column:
+          incorrect_query_column: The query column you provided is incorrect
+        record_data:
+          incorrect_record_data_type: The data you provided is not an array
+        optional_data:
+          incorrect_optional_data_type: The name and value need to be Strings
+        email_format:
+          incorrect_email_format: The email format is not supported
+        record:
+          incorrect_field_values_type: The field_values must be an array
+      client:
+        api_method:
+          wrong_action_login: Please use the dedicated login method
+          wrong_action_logout: Please use the dedicated logout method
+      campaign:
+        incorrect_recipients_type: Recipients parameter must be an array
+    member:
+      riid_missing: Variable riid is not provided to the member
+      record_not_found: The member has not been found in the list

data/lib/responsys/i18n/fr.yml

@@ -0,0 +1,21 @@
+fr:
+  responsys_api:
+    api:
+      object:
+        field_type:
+          incorrect_field_type: Le type fourni à l'objet FieldType est incorrect
+        query_column:
+          incorrect_query_column: La colonne de recherche est incorrecte
+        record_data:
+          incorrect_record_data_type: La donnée fournie n'est pas de type Array
+        optional_data:
+          incorrect_optional_data_type: Le nom et la valeur doivent être de type String
+        email_format:
+          incorrect_email_format: Le format de l'email est incorrect
+        record:
+          incorrect_field_values_type: L'objet fournissant les valeurs doit être de type Array
+      campaign:
+        incorrect_recipients_type: La liste des destinataires doit être de type Array
+    member:
+      riid_missing: Le riid n'est pas fournie à l'objet Member
+      record_not_found: L'enregistrement n'a pas été trouvé dans la liste

data/lib/responsys_api.rb

@@ -1,8 +1,6 @@
 require "i18n"
 
-I18n.load_path << File.expand_path("../responsys/i18n/en.yml", __FILE__)
-I18n.locale = :en
-I18n.enforce_available_locales = false
+I18n.load_path.concat Dir.glob( File.dirname(__FILE__) + "/responsys/i18n/*.yml" )
 
 require "responsys/exceptions/all"
 require "responsys/helper"

data/responsys-api.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "responsys-api"
-  spec.version       = "0.0.8"
+  spec.version       = "0.0.9"
   spec.authors       = ["Dan DeMeyere", "Florian Lorrain", "Morgan Griggs", "Mike Rocco"]
   spec.email         = ["dan@thredup.com", "florian.lorrain@thredup.com", "morgan@thredup.com", "michael.rocco@thredup.com"]
   spec.description   = "A gem to integrate with the Responsys SOAP API"

data/spec/api/campaign_spec.rb

@@ -5,9 +5,7 @@ describe Responsys::Api::Campaign do
 
   context "Trigger Message" do
     before(:all) do
-      VCR.use_cassette("api/campaign/login") do
-        @client = Responsys::Api::Client.instance
-      end
+      @client = Responsys::Api::Client.instance
     end
 
     before(:each) do
@@ -17,10 +15,8 @@ describe Responsys::Api::Campaign do
     end
 
     it "should pass api_method a message Hash" do
-      VCR.use_cassette("api/campaign/login") do
-        expect(@client).to receive(:api_method).with(anything, be_a_kind_of(Hash))
-        @client.trigger_message(@campaign, [@recipientData])
-      end
+      expect(@client).to receive(:api_method).with(anything, be_a_kind_of(Hash))
+      @client.trigger_message(@campaign, [@recipientData])
     end
   end
 

data/spec/api/client_spec.rb

@@ -4,43 +4,12 @@ require "singleton"
 
 describe Responsys::Api::Client do
 
-  context "expired session" do
-    before(:example) do
-      allow_any_instance_of(Responsys::Api::Client).to receive(:login).and_return(nil)
-
-      Responsys::Api::Client.instance.instance_variable_set(:@session_id, "fake_session_id")
-      Responsys::Api::Client.instance.instance_variable_set(:@jsession_id, HTTPI::Cookie.new("jsessionid=fakejsessionid; Path=/; HttpOnly"))
-      Responsys::Api::Client.instance.instance_variable_set(:@header, { SessionHeader: { sessionId: "fake_session_id" } })
-    end
-
-    it "should ask for a new session" do
-      VCR.use_cassette("api/client/expired_session") do
-        expect_any_instance_of(Responsys::Api::Client).to receive(:login).exactly(1).times.and_call_original
-        result = Responsys::Api::Client.instance.api_method(:list_folders)
-
-        expect(result[:status]).to eq("ok")
-      end
-    end
-
-    it "should rerun the request with a new session id" do
-      VCR.use_cassette("api/client/expired_session") do
-        expect_any_instance_of(Responsys::Api::Client).to receive(:login).exactly(1).times.and_call_original
-
-        expect(Responsys::Api::Client.instance.header[:SessionHeader][:sessionId]).to eq("fake_session_id")
-
-        Responsys::Api::Client.instance.api_method(:list_folders)
-
-        expect(Responsys::Api::Client.instance.header[:SessionHeader][:sessionId]).to eq("5GXdGHHKOLqsf4ukCpwQYz3B0b")
-      end
-    end
-
-  end
-
   context "Authentication" do
+    subject { Responsys::Api::Client.instance }
     let(:savon_client) { double("savon client") }
 
     before(:context) do
-      @credentials = { username: "your_responsys_username", password: "your_responsys_password" }
+      @credentials = { username: CREDENTIALS["username"], password: CREDENTIALS["password"] }
     end
 
     after(:context) do
@@ -52,7 +21,7 @@ describe Responsys::Api::Client do
 
       responsys = Responsys::Api::Client.instance
 
-      expect(responsys.credentials).to eq({ username: "your_responsys_username", password: "your_responsys_password" })
+      expect(responsys.credentials).to eq({ username: CREDENTIALS["username"], password: CREDENTIALS["password"] })
     end
 
     context "login" do
@@ -71,7 +40,7 @@ describe Responsys::Api::Client do
         allow(response).to receive(:body).and_return(body)
         allow(response).to receive(:http).and_return(double("cookies", cookies: cookies))
 
-        allow(Savon).to receive(:client).with({ wsdl: "https://wsxxxx.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl", element_form_default: :qualified, ssl_version: :TLSv1}).and_return(savon_client) #Avoid the verification of the wsdl
+        allow(Savon).to receive(:client).with({ wsdl: CREDENTIALS["wsdl"], element_form_default: :qualified, ssl_version: :TLSv1}).and_return(savon_client) #Avoid the verification of the wsdl
         allow_any_instance_of(Responsys::Api::Client).to receive(:run).with("login", @credentials).and_return(response) #Verification of credentials
         allow(savon_client).to receive(:call).with(:login, @credentials ).and_return(response) #Actual login call
 
@@ -79,28 +48,29 @@ describe Responsys::Api::Client do
       end
 
       it "should set the session ids" do
-        instance = Responsys::Api::Client.instance #Get it
+        subject.login
+
+        expect(subject.header).to eq({ SessionHeader: { sessionId: "fake_session_id" } }) #Test the ids are right
+        expect(subject.jsession_id).to eq("fake_jsession_id")
+      end
 
-        expect(instance.header).to eq({ SessionHeader: { sessionId: "fake_session_id" } }) #Test the ids are right
-        expect(instance.jsession_id).to eq("fake_jsession_id")
+      it "should refuse the access to api_method for login" do
+        expect{ subject.api_method(:login) }.to raise_error("Please use the dedicated login method")
       end
     end
 
     context "logout" do
-      before(:example) do
-        allow(Savon).to receive(:client).with({ wsdl: "https://wsxxxx.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl", element_form_default: :qualified, ssl_version: :TLSv1}).and_return(savon_client) #Avoid the verification of the wsdl
-        allow_any_instance_of(Responsys::Api::Client).to receive(:login).and_return(nil) #Avoid credentials checking
-
-        Singleton.__init__(Responsys::Api::Client)
-      end
+      subject { Responsys::Api::Client.instance }
 
       it "should logout" do
-        instance = Responsys::Api::Client.instance #Get it
+        allow(subject).to receive(:logged_in?).and_return(true)
+        expect(subject).to receive(:run_with_credentials).with(:logout, anything, anything, anything) #Check the call is actually being done
 
-        allow(Responsys::Helper).to receive(:format_response_hash).with(any_args) #We dont want to parse the response
-        expect(savon_client).to receive(:call).with(:logout, anything) #Check the call is actually being done
+        subject.logout
+      end
 
-        instance.logout
+      it "should refuse the access to api_method for logout" do
+          expect{ subject.api_method(:logout) }.to raise_error("Please use the dedicated logout method")
       end
     end
   end