responsys-api 0.1.0 → 0.2.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTlmMTI3NDdjZmE5MjYwYTllNzRiMTU3OTE1ZDc4OGQ2N2EwZTNhNQ==
-  data.tar.gz: !binary |-
-    ZjU1YjUxYWUxMWE0Yzg0NTk0YWRmYTAyNDYxMjI3YmQ1YzNiMzYyNA==
+SHA1:
+  metadata.gz: 6f00d1395d9bcceca1e501060dda3682ba6c9efe
+  data.tar.gz: e7f470e8a49e3bdacc06696ae5eeab07f20686f6
 SHA512:
-  metadata.gz: !binary |-
-    MjAwMmE5OWU3YzRhMjliZjNhZmQ2ODNkNGE3ZWEzOWY4NjAxYmJmMWU5YjE0
-    ZDk1M2MwOTlmZjQyYWRmYTM5ODVkZDQwMzA1MjNmMTkyYWQ2NzJmZTc2NWFl
-    NjdiNTlmMDNlMDMzY2M1YmVlNzYwNTJlZDNjNTEyZjg3NWE0OGE=
-  data.tar.gz: !binary |-
-    NTJlNjI3MDZkOWNhMWI2MDNjNTk3ZDAxMGQ3MWM1ZTdiODM5NGU3ODRjNGI3
-    NmY5MGIxNjE2ZWZkMTc0MDZiOTQ5MzdhZTgzNDMyZWRjMGJhNGM0ZTNkN2Mx
-    YmM2NjY1NTlhOWRhM2Y0NWY5MjkwYTgzZjBjODU1ZWRjNzdlZjU=
+  metadata.gz: 217b1ad9d39b0a44392e7b5ffbbbca9ed27e6d39ff776fae6a55fdd29d3d04b6bfdbe800ede0c767eecaeddd232418b5857bf37eb89caae4f902ce0a7fc25b02
+  data.tar.gz: 2a7fd19395a831029fb5e11b39194d560ba62514a0b26bb07b01a308bc5a87765e2fecd027cb14100130fa57af0b72eaf389a3801c4ae6fdb7e88a33464a5444

data/.travis.yml

@@ -2,6 +2,11 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.1.2
-
 gemfile:
-  - Gemfile
+  - Gemfile
+notifications:
+  email:
+    on_success: never
+    on_failure: never
+  slack:
+    secure: 8b8dwwpHEw7vYd5Vma/BK2dZBrKYpFtu8TN8+NtpW8Xp+boYY3hEaFCeeEySzDvacCBZFKjjvDxverOFd4jqml2MtOukNZ/zlFc7ZVybGsNirfisNucS7auvwoWPwVrzrHoNpB5nTLU4tm0tWdaKkfLa4Yssr/tEO8yBIGwT8ds=

data/lib/responsys/api/all.rb

@@ -1,15 +1,15 @@
+require "responsys/api/authentication"
 require "responsys/api/folder"
 require "responsys/api/list"
-require "responsys/api/session"
 require "responsys/api/table"
 require "responsys/api/campaign"
 
 module Responsys
   module Api
     module All
+      include Responsys::Api::Authentication
       include Responsys::Api::Folder
       include Responsys::Api::List
-      include Responsys::Api::Session
       include Responsys::Api::Table
       include Responsys::Api::Campaign
     end

data/lib/responsys/api/authentication.rb

@@ -0,0 +1,45 @@
+module Responsys
+  module Api
+    module Authentication
+      def login
+        logout if logged_in?
+
+        response = run(:login, credentials)
+        establish_session_id(response)
+        establish_jsession_id(response)
+        set_session_credentials
+      end
+
+      def logout
+        return unless logged_in?
+
+        run_with_credentials(:logout, nil)
+        destroy_session_objects
+      end
+
+      def logged_in?
+        !(session_id.nil? || jsession_id.nil? || header.nil?)
+      end
+
+      private
+
+      def establish_session_id(login_response)
+        @session_id = login_response.body[:login_response][:result][:session_id]
+      end
+
+      def establish_jsession_id(login_response)
+        @jsession_id = login_response.http.cookies[0]
+      end
+
+      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/api/client.rb

@@ -1,68 +1,39 @@
-require "responsys/configuration"
-require "savon"
-require "responsys/helper"
-require "responsys/api/all"
-require "responsys/api/object/all"
-require "singleton"
-
 module Responsys
   module Api
     class Client
-      include Singleton
       include Responsys::Api::All
+      attr_accessor :client
 
-      attr_accessor :credentials, :client, :session_id, :jsession_id, :header
-
-      def initialize
-        settings = Responsys.configuration.settings
-        @credentials = {
-          username: settings[:username],
-          password: settings[:password]
-        }
-
-        ssl_version = settings[:ssl_version] || :TLSv1
-
-        if settings[:debug]
-          @client = Savon.client(wsdl: settings[:wsdl], element_form_default: :qualified, ssl_version: ssl_version, log_level: :debug, log: true, pretty_print_xml: true)
-        else
-          @client = Savon.client(wsdl: settings[:wsdl], element_form_default: :qualified, ssl_version: ssl_version)
-        end
+      #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.
+      class << self
+        alias :instance :new
       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
-          when :result
-            Responsys::Helper.format_response_result(response, action)
-          when :hash
-            Responsys::Helper.format_response_hash(response, action)
+        SessionPool.instance.with do |session|
+          begin
+            session.login
+            response = session.run_with_credentials(action, message)
+            case response_type
+            when :result
+              Responsys::Helper.format_response_result(response, action)
+            when :hash
+              Responsys::Helper.format_response_hash(response, action)
+            end
+          rescue Exception => e
+            Responsys::Helper.format_response_with_errors(e)
+          ensure
+            session.logout
           end
-
-        rescue Exception => e
-          Responsys::Helper.format_response_with_errors(e)
-        ensure
-          logout
         end
       end
 
       def available_operations
-        @client.operations
-      end
-
-      private
-
-      def run(method, message)
-        @client.call(method.to_sym, message: message)
-      end
-
-      def run_with_credentials(method, message, cookie, header)
-        @client.call(method.to_sym, message: message, cookies: cookie, soap_header: header)
+        SessionPool.instance.with do |session|
+          session.operations
+        end
       end
     end
   end

data/lib/responsys/api/session.rb

@@ -1,44 +1,31 @@
 module Responsys
   module Api
-    module Session
-      def login
-        logout if logged_in?
-
-        response = run("login", credentials)
-        establish_session_id(response)
-        establish_jsession_id(response)
-        set_session_credentials
-      end
-
-      def 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
-
-      def establish_session_id(login_response)
-        @session_id = login_response.body[:login_response][:result][:session_id]
-      end
-
-      def establish_jsession_id(login_response)
-        @jsession_id = login_response.http.cookies[0]
+    class Session
+      attr_accessor :credentials, :session_id, :jsession_id, :header
+      include Responsys::Api::Authentication
+
+      def initialize
+        settings = Responsys.configuration.settings
+        @credentials = {
+          username: settings[:username],
+          password: settings[:password]
+        }
+
+        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
       end
 
-      def set_session_credentials
-        @header = { SessionHeader: { sessionId: session_id } }
+      def run(method, message)
+        @savon_client.call(method.to_sym, message: message)
       end
 
-      def destroy_session_objects
-        @session_id = nil
-        @jsession_id = nil
-        @header = nil
+      def run_with_credentials(method, message)
+        @savon_client.call(method.to_sym, message: message, cookies: jsession_id, soap_header: header)
       end
     end
   end

data/lib/responsys/api/session_pool.rb

@@ -0,0 +1,32 @@
+require "singleton"
+
+module Responsys
+  module Api
+    class SessionPool
+      include Singleton
+      attr_accessor :pool
+      ACCEPTED_SETTINGS = [:timeout, :size]
+
+      class << self
+        alias :init :instance
+      end
+
+      def initialize
+        settings = Responsys.configuration.settings[:sessions]
+        params = if settings
+          settings.select { |option, value| ACCEPTED_SETTINGS.include?(option) }
+        else
+          {}
+        end
+
+        @pool = ConnectionPool.new(params) { Responsys::Api::Session.new }
+      end
+
+      def with
+        @pool.with do |session|
+          yield session
+        end
+      end
+    end
+  end
+end

data/lib/responsys/configuration.rb

@@ -7,7 +7,11 @@ module Responsys
         username: nil,
         password: nil,
         wsdl: "",
-        debug: false
+        debug: false,
+        sessions: {
+          size: 80,
+          timeout: 30
+        }
       }
     end
   end
@@ -22,5 +26,6 @@ module Responsys
 
   def self.configure
     yield(configuration)
+    Responsys::Api::SessionPool.init
   end
-end
+end

data/lib/responsys/i18n/en.yml

@@ -18,6 +18,41 @@ 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_api.rb

@@ -1,9 +1,15 @@
 require "i18n"
+require "connection_pool"
+require "savon"
 
 I18n.load_path.concat Dir.glob( File.dirname(__FILE__) + "/responsys/i18n/*.yml" )
 
 require "responsys/exceptions/all"
 require "responsys/helper"
 require "responsys/configuration"
+require "responsys/api/all"
+require "responsys/api/object/all"
+require "responsys/api/session_pool"
+require "responsys/api/session"
 require "responsys/api/client"
-require "responsys/member"
+require "responsys/member"

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.1.0"
+  spec.version       = "0.2.1"
   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"
@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "savon", "2.6.0"
   spec.add_dependency "wasabi", "3.3.0"
   spec.add_dependency "i18n", "~> 0.6"
+  spec.add_dependency "connection_pool", "2.0.0"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
   spec.add_development_dependency "vcr", "~> 2.5"
   spec.add_development_dependency "webmock", "~> 1.9"
 end

data/spec/api/campaign_spec.rb

@@ -11,20 +11,20 @@ describe Responsys::Api::Campaign do
   let(:custom_event) { Responsys::Api::Object::CustomEvent.new(DATA[:custom_events][:custom_event1][:name]) }
 
   before(:all) do
-    @client = Responsys::Api::Client.instance
+    @client = Responsys::Api::Client.new
   end
 
   context "Trigger Message" do
     it "should return a status of ok when triggering a message for one recipient" do
       VCR.use_cassette("api/campaign/trigger_message_1") do
-        response = Responsys::Api::Client.instance.trigger_message(campaign, [recipientData1])
+        response = Responsys::Api::Client.new.trigger_message(campaign, [recipientData1])
         expect(response[:status]).to eq("ok")
       end
     end
 
     it "should return a status of ok when triggering a message for more than one recipient" do
       VCR.use_cassette("api/campaign/trigger_message_2") do
-        response = Responsys::Api::Client.instance.trigger_message(campaign, [recipientData1,recipientData2])
+        response = Responsys::Api::Client.new.trigger_message(campaign, [recipientData1,recipientData2])
         expect(response[:status]).to eq("ok")
       end
     end
@@ -43,14 +43,14 @@ describe Responsys::Api::Campaign do
   context "#trigger_custom_event" do
     it "should return a status of ok when triggering a custom event for one recipient" do
       VCR.use_cassette("api/campaign/trigger_custom_event_1") do
-        response = Responsys::Api::Client.instance.trigger_custom_event(custom_event, [recipientData1])
+        response = Responsys::Api::Client.new.trigger_custom_event(custom_event, [recipientData1])
         expect(response[:status]).to eq("ok")
       end
     end
 
     it "should return a status of ok when triggering a custom event for more than one recipient" do
       VCR.use_cassette("api/campaign/trigger_custom_event_2") do
-        response = Responsys::Api::Client.instance.trigger_custom_event(custom_event, [recipientData1,recipientData2])
+        response = Responsys::Api::Client.new.trigger_custom_event(custom_event, [recipientData1,recipientData2])
         expect(response[:status]).to eq("ok")
       end
     end

data/spec/api/client_spec.rb

@@ -1,77 +1,15 @@
 require "spec_helper.rb"
-require "responsys/api/client"
-require "singleton"
 
 describe Responsys::Api::Client do
 
-  context "Authentication" do
-    subject { Responsys::Api::Client.instance }
-    let(:savon_client) { double("savon client") }
-
-    before(:context) do
-      @credentials = { username: CREDENTIALS["username"], password: CREDENTIALS["password"] }
-    end
-
-    after(:context) do
-      Singleton.__init__(Responsys::Api::Client)
-    end
-
-    it "should set the credentials" do
-      allow_any_instance_of(Responsys::Api::Client).to receive(:login).and_return(nil)
-
-      responsys = Responsys::Api::Client.instance
-
-      expect(responsys.credentials).to eq({ username: CREDENTIALS["username"], password: CREDENTIALS["password"] })
-    end
-
-    context "login" do
-      before(:example) do
-        response = double("response")
-
-        cookies = %w(fake_jsession_id)
-        body = {
-          login_response: {
-            result: {
-              session_id: "fake_session_id"
-            }
-          }
-        }
-
-        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: 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
-
-        Singleton.__init__(Responsys::Api::Client)
-      end
-
-      it "should set the session ids" do
-        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
-
-      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
+  describe "Authentication methods" do
+    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
 
-    context "logout" do
-      subject { Responsys::Api::Client.instance }
-
-      it "should logout" do
-        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
-
-        subject.logout
-      end
-
-      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
+    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
-end
+
+end