emailvision 1.1.0 → 2.0.0

data/lib/emailvision.rb

@@ -1,16 +1,18 @@
 require 'crack/xml'
 require 'httparty'
+require 'active_support/inflector'
+require 'logger'
 
 # Emailvision API wrapper
-# 
-# More infos @ http://emvapi.emv3.com/apiccmd/services/rest?_wadl&_type=xml
-#
-# Call example :
-# resource path="url/createUnsubscribeUrl/" --> url.create_unsubscribe_url.call :params => value1
 #
 module Emailvision
   autoload :Api, 'emailvision/api'
   autoload :Exception, 'emailvision/exception'
   autoload :Logger, 'emailvision/logger'
   autoload :Relation, 'emailvision/relation'
+  
+  if defined?(Rails)
+	  require 'emailvision/railtie'
+	  require 'generators/install'
+	end
 end

data/lib/emailvision/api.rb

@@ -2,89 +2,130 @@ module Emailvision
   class Api    
     include HTTParty
     default_timeout 30
-    format :plain
-
-    attr_accessor :token
+    format :xml
     
-    HTTP_VERBS = [:get, :post]
-
-    def initialize(login = nil, password = nil, key = nil, params = {})
-      @login = login || EMV_LOGIN || ENV['EMV_LOGIN']
-      @password = password || EMV_PASSWORD || ENV['EMV_PASSWORD']
-      @key = key || EMV_KEY || ENV['EMV_KEY']
+    # HTTP verbs allowed to trigger a call-chain
+    HTTP_VERBS = [:get, :post].freeze  
 
-      @default_params = params
-    end
-    
-    HTTP_VERBS.each do |http_verb|
-      define_method(http_verb) do
-        Emailvision::Relation.new(self, http_verb)
-      end
+    # Attributes
+    class << self
+      attr_accessor :token, :server_name, :endpoint, :login, :password, :key, :debug
     end
+    attr_accessor :token, :server_name, :endpoint, :login, :password, :key, :debug
 
-    # http_verb = (get, post, ...)
-    # method = Method to call
-    # params = Extra parameters (optionnal)
-    def call(http_verb, method, params = {})
-      params ||= {}
-
-      # Build uri and parameters
-      uri = endpoint + method
-      params = @default_params.merge params
+    def initialize(params = {})      
+      yield(self) if block_given?      
       
-      # Send request
-      raw_result = self.class.send http_verb, uri, :query => params      
-      
-      # Parse response
-      http_code = raw_result.header.code
-      parsed_result = Crack::XML.parse raw_result.body
-
-      # Return response or raise an exception if request failed
-      if (http_code == "200") and (parsed_result and parsed_result["response"])
-        parsed_result["response"]["result"] || parsed_result["response"]
-      else        
-        raise Emailvision::Exception.new "#{http_code} - #{raw_result.body}"
-      end
-    end
-
-    # Connection token
-    def token=(value)
-      @token = value
-      @default_params = @default_params.merge({:token => token})
-    end
-
-    # Endpoint base uri
-    def endpoint
-      'https://emvapi.emv3.com/apiccmd/services/rest/'
-    end
-
+      self.server_name ||= params[:server_name]  || self.class.server_name
+      self.endpoint    ||= params[:endpoint]     || self.class.endpoint
+      self.login       ||= params[:login]        || self.class.login
+      self.password    ||= params[:password]     || self.class.password
+      self.key         ||= params[:key]          || self.class.key
+      self.token       ||= params[:token]        || self.class.token
+      self.debug       ||= params[:debug]        || self.class.debug      
+    end   
+    
     # ----------------- BEGIN Pre-configured methods -----------------
 
     # Login to Emailvision API
     # Return :
     # - True if the connection has been established
     # - False if the connection cannot be established or has already been established
-    def login
+    def open_connection
       return false if connected?
       self.token = get.connect.open.call :login => @login, :password => @password, :key => @key
       connected?
     end
 
-    # Logout to Emailvision API
+    # Logout from Emailvision API
     # Return :
     # - True if the connection has been destroyed
     # - False if the connection cannot be destroyed or has already been destroyed    
-    def logout
+    def close_connection
       return false unless connected?
       get.connect.close.call if connected?
-      self.token = nil
-      connected?
+      invalidate_token!
+      not connected?
     end
 
     # Check whether the connection has been established or not
     def connected?
       !token.nil?
     end
-    # ----------------- END Pre-configured methods -----------------
-  end  
+    
+    def invalidate_token!
+      self.token = nil
+    end
+    # ----------------- END Pre-configured methods -----------------    
+
+    # Perform the API call
+    # http_verb = (get, post, ...)
+    # method = Method to call
+    # content = Content to send (optionnal)
+    def call(http_verb, method, content = {})
+      params ||= {}      
+
+      # 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 !"
+      end
+
+      # Build uri and parameters
+      uri = base_uri + method
+      query = token ? {:token => token} : {}
+      query.merge! content
+      
+      # Send request
+      logger.send "#{uri} with content : #{content}"
+      response = self.class.send http_verb, uri, :query => query
+      
+      # Parse response
+      http_code = response.header.code
+      content = Crack::XML.parse response.body
+      logger.receive content.inspect
+
+      # Return response or raise an exception if request failed
+      if (http_code == "200") and (content and content["response"])
+        content["response"]["result"] || content["response"]
+      else        
+        raise Emailvision::Exception.new "#{http_code} - #{content}"
+      end
+    end    
+
+		# Set token
+    # Override
+    def token=(value)
+      @token = value
+    end
+    
+    # Set endpoint
+    # Override
+    def endpoint=(value)
+	    invalidate_token!	    
+	  	@endpoint = value	  	
+	  end
+
+    # Base uri
+    def base_uri
+      "http://#{server_name}/#{endpoint}/services/rest/"
+    end
+    
+    # Generate call-chain triggers
+    HTTP_VERBS.each do |http_verb|
+      define_method(http_verb) do
+        Emailvision::Relation.new(self, http_verb)
+      end
+    end    
+    
+	  private
+	
+	  def logger      
+	    if @logger.nil?
+	      @logger = Emailvision::Logger.new(STDOUT)
+	      @logger.level = (debug ? Logger::DEBUG : Logger::WARN)
+	    end
+	    @logger
+	  end    
+    
+  end    
 end

data/lib/emailvision/exception.rb

@@ -1,4 +1,14 @@
 module Emailvision
-  class Exception < ::Exception    
+  class Exception < ::Exception 
+    
+    attr_accessor :http_status, :error
+    
+    def initializer(http_status, error)
+      self.http_status = http_status
+      self.error = error
+      
+      super("EMV API returns #{http_status} status code")
+    end
+       
   end
 end

data/lib/emailvision/logger.rb

@@ -1,6 +1,13 @@
 module Emailvision
   class Logger < ::Logger
     
+    attr_accessor :debug
+    
+    def initializer(*args)
+	    debug = false
+	    super args
+	  end
+    
     # Log a message sent to emailvision
     def send(message)
       info("[Emailvision] Send -> #{message}")

data/lib/emailvision/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails'
+
+module Emailvision
+	class Railtie < Rails::Railtie
+		
+		generators do
+		  require 'generators/install'
+		end		
+	
+	  config.to_prepare do
+	    file = "#{Rails.root}/config/emailvision.yml"
+	    
+	    if File.exist?(file)
+	      config = YAML.load_file(file)[Rails.env] || {}
+	      
+  	    Emailvision::Api.server_name  = config['server_name']
+  	    Emailvision::Api.endpoint     = config['endpoint']
+  	    Emailvision::Api.login        = config['login']
+  	    Emailvision::Api.password     = config['password']
+  	    Emailvision::Api.key          = config['key']	      
+  	    Emailvision::Api.debug        = config['debug']  	    
+	    end	    
+	  end		
+	
+	end
+end

data/lib/emailvision/relation.rb

@@ -5,17 +5,17 @@ module Emailvision
       @instance = instance
       @http_verb = http_verb
       @uri = []
-      @params = {}
+      @options = {}
     end
     
     def call(*args)
-      @params.merge! extract_args(args)
-      @instance.call @http_verb, @uri.join('/'), @params
+      @options.merge! extract_args(args)
+      @instance.call @http_verb, @uri.join('/'), @options
     end
   
     def method_missing(method, *args)
       @uri << method.to_s.camelize(:lower)
-      @params.merge! extract_args(args)
+      @options.merge! extract_args(args)
       self            
     end    
     

data/lib/generators/install.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Emailvision
+  module Generators
+    class Install < Rails::Generators::Base
+      
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_config        
+        copy_file "emailvision.yml", "config/emailvision.yml" unless File.exist?("config/emailvision.yml")
+      end
+
+    end    
+  end
+end

data/lib/generators/templates/emailvision.yml

@@ -0,0 +1,15 @@
+development:
+    server_name:
+    login: 
+    password: 
+    key: 
+production:
+    server_name: 
+    login: 
+    password: 
+    key: 
+test:
+    server_name: 
+    login: 
+    password: 
+    key:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emailvision
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2164322100 !ruby/object:Gem::Requirement
+  requirement: &2164271140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,18 +21,18 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164322100
+  version_requirements: *2164271140
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &2164321620 !ruby/object:Gem::Requirement
+  requirement: &2164270660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2164321620
+  version_requirements: *2164270660
 description: REST API wrapper interacting with Emailvision
 email: basgys@gmail.com
 executables: []
@@ -42,8 +42,11 @@ files:
 - lib/emailvision/api.rb
 - lib/emailvision/exception.rb
 - lib/emailvision/logger.rb
+- lib/emailvision/railtie.rb
 - lib/emailvision/relation.rb
 - lib/emailvision.rb
+- lib/generators/install.rb
+- lib/generators/templates/emailvision.yml
 homepage: http://github.com/basgys/emailvision
 licenses: []
 post_install_message: