emailvision 2.1.22 → 2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWY1ODBhM2MyNTZkYzdkZGQ5YWNhYTQwYWU0MzQ5Y2IzM2MxZGE4MA==
+  data.tar.gz: !binary |-
+    YjdmZDM5M2RlN2U2YzJjYjY2NDIxNWM0YWM1OTYxYWEyZGMwZWU4Mw==
+SHA512:
+  metadata.gz: !binary |-
+    YmNhZDA1NTM2MDYzYzI4NWIyMTZlMTU1NzdmZWJiNWM2OTQzMmY5ZWE5YzBm
+    NjRiZmM2NTVjYzk5NjYzMjU4MzYwNzMzZjU4MTMxY2MxYjAwMDIwNjM1Nzc2
+    M2FmYjkwZDViOGI4ZGQ1ODNiODQzYjExZDUyNTIyZWE2MjMyNjg=
+  data.tar.gz: !binary |-
+    YzMxNDhjOTNlMWM0ZGQ3NzMwNGVmMzYyMjIyOWQ1YmNiYzU2OTRhZjk3NmJl
+    Y2VlMTk0ZWJlYjAyN2I0NmVlOTQzNTI4YzhmMmRiMjdlZGUyMzVjMWRkNWMw
+    NGYwNzNmYzI5MDc4MDZjMmFjNTEyZWQ2OWY4YmVlOWJhNzFlY2Y=

data/lib/emailvision.rb

@@ -10,10 +10,15 @@ module Emailvision
   autoload :Api, 'emailvision/api'
   autoload :Exception, 'emailvision/exception'
   autoload :Logger, 'emailvision/logger'
+  autoload :MalformedResponse, 'emailvision/malformed_response'
   autoload :Relation, 'emailvision/relation'
+  autoload :Request, 'emailvision/request'
+  autoload :RequestError, 'emailvision/request_error'
+  autoload :Response, 'emailvision/response'
+  autoload :SessionError, 'emailvision/session_error'
   autoload :Tools, 'emailvision/tools'
   autoload :Notification, 'emailvision/notification'
-  autoload :Version, 'emailvision/version'
+  autoload :Version, 'emailvision/version'  
 
   if defined?(Rails)
     require 'emailvision/railtie'

data/lib/emailvision/api.rb

@@ -30,6 +30,15 @@ module Emailvision
 
     # ----------------- BEGIN Pre-configured methods -----------------
 
+    # Reset session
+    #
+    # Useful when the session has expired.
+    #
+    def reset_session
+      close_connection
+      open_connection      
+    end
+
     # Login to Emailvision API
     #
     # @return [Boolean] true if the connection has been established.
@@ -74,49 +83,20 @@ module Emailvision
 
     # Perform an API call
     #
-    # @param [:get, :post] HTTP verb to use for the API call
-    # @param [String] method to call on the API
-    # @param [Hash] request parameters (optionnal)
+    # @param [Emailvsion::Request] Request to perform
     #
-    def call(http_verb, method, parameters = {})
-      params ||= {}
-
+    def call(request)
       # == Check presence of these essential attributes ==
       unless server_name and endpoint
-        raise Emailvision::Exception.new "Cannot make an API call without a server name and an endpoint !"
+        raise Emailvision::Exception, "Cannot make an API call without a server name and an endpoint !"
       end
 
-      # == Sanitize parameters ==
-      parameters = Emailvision::Tools.sanitize_parameters(parameters)
-
-      retries = 2
-      begin
-        uri = prepare_uri(method, parameters)
-        body = prepare_body(parameters)
-
-        logger.send "#{uri} with query : #{parameters} and body : #{body}"
+      with_retries do
+        logger.send "#{request.uri} with query : #{request.parameters} and body : #{request.body}"
 
-        response = perform_request(http_verb, uri, parameters, body)
+        response = perform_request(request)
 
-        extract_response(response)
-      rescue Emailvision::Exception => e
-        if e.message =~ /Your session has expired/ or e.message =~ /The maximum number of connection allowed per session has been reached/
-          self.close_connection
-          self.open_connection
-          if((retries -= 1) >= 0)
-            retry
-          else
-            raise e
-          end
-        else
-          raise e
-        end
-      rescue Errno::ECONNRESET, Timeout::Error => e
-        if((retries -= 1) >= 0)
-          retry
-        else
-          raise e
-        end
+        Emailvision::Response.new(response, logger).extract        
       end
     end
 
@@ -147,57 +127,18 @@ module Emailvision
     # Generate call-chain triggers
     HTTP_VERBS.each do |http_verb|
       define_method(http_verb) do
-        Emailvision::Relation.new(self, http_verb)
+        Emailvision::Relation.new(self, build_request(http_verb))
       end
     end
 
     private
 
-      def prepare_uri(method, parameters)
-        uri = base_uri + method
-        if parameters[:uri]
-          uri += token ? "/#{token}/" : '/'
-          uri += (parameters[:uri].respond_to?(:join) ? parameters[:uri] : [parameters[:uri]]).compact.join '/'
-          parameters.delete :uri
-        elsif parameters[:body]
-          uri += token ? "/#{token}/" : '/'
-        else
-          parameters[:token] = token
-        end
-        uri
-      end
-
-      def prepare_body(parameters)
-        body = parameters[:body] || {}
-        parameters.delete :body
-        # 2. Camelize all keys
-        body = Emailvision::Tools.r_camelize body
-        # 3. Convert to xml
-        Emailvision::Tools.to_xml_as_is body
+      def build_request(http_verb)
+        Emailvision::Request.new(http_verb, token, server_name, endpoint)
       end
 
-      def perform_request(http_verb, uri, parameters, body)
-        self.class.send http_verb, uri, :query => parameters, :body => body, :timeout => 30
-      end
-
-      def extract_response(response)
-        http_code = response.header.code
-        content = {}
-        begin
-          content = Crack::XML.parse response.body
-        rescue MultiXml::ParseError => e
-          logger.send "#{uri} Error when parsing response body (#{e.to_s})"
-        end
-        logger.receive content.inspect
-
-        if (http_code == "200") and (content and content["response"])
-          response = content["response"]["result"] || content["response"] 
-        else
-          raise Emailvision::Exception.new "#{http_code} - #{content}"
-        end
-      end
-
-      def format_response()
+      def perform_request(request)
+        self.class.send request.http_verb, base_uri + request.uri, :query => request.parameters, :body => request.body, :timeout => 30
       end
 
       def assign_attributes(parameters)
@@ -207,6 +148,19 @@ module Emailvision
         end
       end
 
+      def with_retries
+        retries = 3
+        begin
+          yield
+        rescue Errno::ECONNRESET, Timeout::Error => e          
+          if ((retries -= 1) > 0)
+            retry
+          else
+            raise e
+          end          
+        end
+      end
+
       def logger
         if @logger.nil?
           @logger = Emailvision::Logger.new(STDOUT)

data/lib/emailvision/exception.rb

@@ -2,21 +2,7 @@ module Emailvision
   
   # API default exception
   #
-  class Exception < ::Exception
-
-    attr_accessor :http_status, :error
-
-    # Initialize
-    #
-    # @param [Integer] HTTP status code
-    # @param [String] Error message
-    # 
-    def initializer(http_status, error)
-      self.http_status = http_status
-      self.error = error
-
-      super("EMV API returns #{http_status} status code")
-    end
+  class Exception < ::StandardError
 
   end
 end

data/lib/emailvision/malformed_response.rb

@@ -0,0 +1,10 @@
+module Emailvision
+
+  # Malformed response
+  #
+  # This error is raised when the response from Emailvision
+  # cannot be parsed.
+  class MalformedResponse < Exception
+  end
+
+end

data/lib/emailvision/relation.rb

@@ -3,12 +3,12 @@ module Emailvision
   # Relation is used for API-chained call
   # 
   # e.g. emv.get.campaign.last(:limit => 5).call
-  #    
+  # 
   class Relation
 
-    def initialize(instance, http_verb)
+    def initialize(instance, request)
       @instance = instance
-      @http_verb = http_verb
+      @request = request
       @uri = []
       @options = {}
     end
@@ -20,7 +20,8 @@ module Emailvision
     #
     def call(*args)
       @options.merge! extract_args(args)
-      @instance.call @http_verb, @uri.join('/'), @options
+      @request.prepare(@uri.join('/'), @options)
+      @instance.call(@request)
     end
 
     def method_missing(method, *args)

data/lib/emailvision/request.rb

@@ -0,0 +1,67 @@
+module Emailvision
+
+  # Request object
+  # 
+  # This class aims to format the request for Emailvision
+  #
+  class Request
+
+    attr_reader(
+      :http_verb,
+      :token,
+      :server_name,
+      :endpoint,
+      :uri,
+      :body,
+      :parameters
+    )
+
+    def initialize(http_verb, token, server_name, endpoint)
+      @http_verb = http_verb
+      @token = token
+      @server_name = server_name
+      @endpoint = endpoint
+    end
+
+    def prepare(uri, parameters)
+      @uri = uri
+      @parameters = parameters || {}
+
+      @uri = prepare_uri
+      @body = prepare_body
+    end
+
+    private
+
+      def prepare_uri
+        uri = @uri
+        if parameters[:uri]
+          uri += token ? "/#{token}/" : '/'
+          uri += (parameters[:uri].respond_to?(:join) ? parameters[:uri] : [parameters[:uri]]).compact.join '/'
+          parameters.delete :uri
+        elsif parameters[:body]
+          uri += token ? "/#{token}/" : '/'
+        else
+          parameters[:token] = token
+        end
+        uri
+      end
+
+      def prepare_body
+        body = parameters[:body] || {}
+        parameters.delete :body
+        # 2. Camelize all keys
+        body = Emailvision::Tools.r_camelize body
+        # 3. Convert to xml
+        Emailvision::Tools.to_xml_as_is body
+      end
+
+      def assign_attributes(attibutes)
+        attibutes or return
+        attibutes.each do |attribute, value|
+          public_send("#{attribute}=", value)
+        end
+      end      
+
+  end
+end

data/lib/emailvision/request_error.rb

@@ -0,0 +1,11 @@
+module Emailvision
+
+  # Malformed response
+  #
+  # This error is raised when the response from Emailvision
+  # cannot be parsed.
+  class RequestError < Exception
+    
+  end
+
+end

data/lib/emailvision/response.rb

@@ -0,0 +1,52 @@
+module Emailvision
+
+  # Response object
+  # 
+  # This class aims to extract the response from Emailvision
+  #
+  class Response
+
+    attr_reader :response, :logger
+
+    def initialize(response, logger)
+      @response = response
+      @logger = logger
+    end
+
+    def extract      
+      logger.receive(content.inspect)
+
+      if succeed?
+        response = content["response"]["result"] || content["response"] 
+      else
+        handle_errors
+      end
+    rescue MultiXml::ParseError, REXML::ParseException => error
+      wrapped_error = Emailvision::MalformedResponse.new(error)
+      raise wrapped_error, "Error when parsing response body"
+    end
+
+    private
+
+      def succeed?
+        (http_code == "200") and (content and content["response"])
+      end
+
+      def handle_errors
+        if content =~ /Your session has expired/ or content =~ /The maximum number of connection allowed per session has been reached/
+          raise Emailvision::SessionError, content
+        else
+          raise Emailvision::RequestError, content
+        end
+      end
+
+      def content
+        @content ||= Crack::XML.parse(response.body)
+      end
+
+      def http_code
+        response.header.code
+      end
+
+  end
+end

data/lib/emailvision/session_error.rb

@@ -0,0 +1,10 @@
+module Emailvision
+
+  # Session  Error
+  #
+  # This error is raised when the token has expired
+  # or the number of connections has been reached
+  class SessionError < Exception
+  end
+
+end

data/lib/emailvision/version.rb

@@ -1,3 +1,3 @@
 module Emailvision
-  Version = VERSION = '2.1.22'
+  Version = VERSION = '2.2'
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: emailvision
 version: !ruby/object:Gem::Version
-  version: 2.1.22
-  prerelease: 
+  version: '2.2'
 platform: ruby
 authors:
 - Bastien Gysler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,25 +55,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
 description: REST API wrapper interacting with Emailvision
 email: basgys@gmail.com
 executables: []
@@ -90,37 +81,42 @@ files:
 - lib/emailvision/api.rb
 - lib/emailvision/exception.rb
 - lib/emailvision/logger.rb
+- lib/emailvision/malformed_response.rb
 - lib/emailvision/notification.rb
 - lib/emailvision/railtie.rb
 - lib/emailvision/relation.rb
+- lib/emailvision/request.rb
+- lib/emailvision/request_error.rb
+- lib/emailvision/response.rb
+- lib/emailvision/session_error.rb
 - lib/emailvision/tools.rb
 - lib/emailvision/version.rb
 - lib/emailvision.rb
 - lib/generators/install.rb
 - lib/generators/templates/emailvision.yml
 homepage: http://github.com/basgys/emailvision
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Emailvision
 test_files: []
 has_rdoc: