emailvision 2.1.20 → 2.1.21

data/lib/emailvision.rb

@@ -13,6 +13,7 @@ module Emailvision
   autoload :Relation, 'emailvision/relation'
   autoload :Tools, 'emailvision/tools'
   autoload :Notification, 'emailvision/notification'
+  autoload :Version, 'emailvision/version'
 
   if defined?(Rails)
     require 'emailvision/railtie'

data/lib/emailvision/api.rb

@@ -1,4 +1,7 @@
 module Emailvision
+
+  # This is where the communication with the API is made.
+  #
   class Api
     include HTTParty
     default_timeout 30
@@ -15,6 +18,11 @@ module Emailvision
     end
     attr_accessor *ATTRIBUTES
 
+    # Initialize
+    #
+    # @param [Hash] Instance attributes to assign
+    # @yield Freshly-created instance (optionnal)
+    #
     def initialize(params = {})
       yield(self) if block_given?
       assign_attributes(params)
@@ -23,9 +31,9 @@ module Emailvision
     # ----------------- 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
+    #
+    # @return [Boolean] true if the connection has been established.
+    #
     def open_connection
       return false if connected?
       self.token = get.connect.open.call :login => @login, :password => @password, :key => @key
@@ -33,9 +41,9 @@ module Emailvision
     end
 
     # Logout from Emailvision API
-    # Return :
-    # - True if the connection has been destroyed
-    # - False if the connection cannot be destroyed or has already been destroyed    
+    #
+    # @return [Boolean] true if the connection has been destroyed
+    #
     def close_connection
       if connected?
         get.connect.close.call
@@ -49,19 +57,27 @@ module Emailvision
     end
 
     # Check whether the connection has been established or not
+    #
+    # @return [Boolean] true if the connection has been establshed
+    #
     def connected?
       !token.nil?
     end
     
+    # When a token is no longer valid, this method can be called.
+    # The #connected? method will return false
+    #
     def invalidate_token!
       self.token = nil
     end
     # ----------------- END Pre-configured methods -----------------    
 
-    # Perform the API call
-    # http_verb = (get, post, ...)
-    # method = Method to call
-    # parameters = Parameters to send (optionnal)
+    # 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)
+    #
     def call(http_verb, method, parameters = {})
       params ||= {}
 
@@ -104,20 +120,26 @@ module Emailvision
       end
     end
 
-    # Set token
-    # Override
+    # Set a new token
+    #
+    # @param [String] new token
+    #
     def token=(value)
       @token = value
     end
 
-    # Set endpoint
-    # Override
+    # Change API endpoint.
+    # This will close the connection to the current endpoint
+    #
+    # @param [String] new endpoint (apimember, apiccmd, apitransactional, ...)
+    #
     def endpoint=(value)
       close_connection
       @endpoint = value
     end
 
     # Base uri
+    #
     def base_uri
       "http://#{server_name}/#{endpoint}/services/rest/"
     end

data/lib/emailvision/exception.rb

@@ -1,8 +1,16 @@
 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

data/lib/emailvision/logger.rb

@@ -1,4 +1,7 @@
 module Emailvision
+  
+  # API logger class
+  #
   class Logger < ::Logger
 
     attr_accessor :debug
@@ -9,11 +12,15 @@ module Emailvision
     end
 
     # Log a message sent to emailvision
+    #
+    # @param [String] message
     def send(message)
       info("[Emailvision] Send -> #{message}")
     end
 
     # Log a message received from emailvision
+    #
+    # @param [String] message    
     def receive(message)
       info("[Emailvision] Receive -> #{message}")
     end

data/lib/emailvision/relation.rb

@@ -1,4 +1,9 @@
 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)
@@ -8,6 +13,11 @@ module Emailvision
       @options = {}
     end
 
+    # Trigger the API call
+    #
+    # @param [Object] parameters
+    # @return [Object] data returned from Emailvision
+    #
     def call(*args)
       @options.merge! extract_args(args)
       @instance.call @http_verb, @uri.join('/'), @options

data/lib/emailvision/tools.rb

@@ -1,6 +1,15 @@
 module Emailvision
+  
+  # Toolbox for the API
+  # This class is mainly used to convert data
+  #  
   class Tools
 
+    # Sanitize values from a Hash
+    #
+    # @param [Hash] hash to sanitize
+    # @return [Hash] sanitized hash
+    #
     def self.sanitize_parameters(parameters)
       r_each(parameters) do |value|
         if value.kind_of?(DateTime) or value.kind_of?(Time)
@@ -21,6 +30,11 @@ module Emailvision
       date.strftime('%d/%m/%Y')
     end
 
+    # Convert hash keys to camel case
+    #
+    # @param [Object] structure to camelize
+    # @return [Object] structure with keys camelized (if any)
+    #
     def self.r_camelize(obj)
       if obj.is_a?(Hash)
         new_obj = {}
@@ -39,6 +53,11 @@ module Emailvision
       end
     end
 
+    # Convert data structure to XML
+    #
+    # @param [Object] structure to convert
+    # @return [String] XML structure
+    #
     def self.to_xml_as_is(obj)
       obj_xml = ""
 
@@ -51,6 +70,11 @@ module Emailvision
       obj_xml
     end
 
+    # Iterate throught a Hash recursively
+    #
+    # @param [Hash] structure to iterate
+    # @yield called for each data
+    #
     def self.r_each(hash, &block)
       return enum_for(:dfs, hash) unless block
  

data/lib/emailvision/version.rb

@@ -0,0 +1,3 @@
+module Emailvision
+  Version = VERSION = '2.1.21'
+end

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: emailvision
 version: !ruby/object:Gem::Version
-  version: 2.1.20
+  version: 2.1.21
+  prerelease: 
 platform: ruby
 authors:
 - Bastien Gysler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: crack
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,13 +54,15 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -65,6 +73,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -85,30 +94,33 @@ files:
 - lib/emailvision/railtie.rb
 - lib/emailvision/relation.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: []
-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: 2.1.4
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Emailvision
 test_files: []
+has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjNmNWYyZDRlZjNkZWFhYmIwOGM5NmJkOThiN2EwNzUwMmNkM2FmYg==
-  data.tar.gz: !binary |-
-    ODJhYzFlMDU4YTBkN2VmZTkwNDhkNmU3N2JlNmIyZTIyNmMzMTg1OQ==
-SHA512:
-  metadata.gz: !binary |-
-    MGI4ZTQ4NzViZmE1ZjQ3MTIyNGRiZjNmMWJiNjU4MzJiMWQ1MzgzYmFkMDI1
-    MjNkODk2MGMxMWY5ZmU1MzUwOWFhYjQ3NTdmYzE3ODRiNGI1NWI2YWI2Nzk5
-    YzQ1YzMyMzBhYjM3YmFlOTVmMDdkYmJkZTgyZGYzZWFjOTNiMDY=
-  data.tar.gz: !binary |-
-    MzI1MDEwNDYxZDQxMTg5MTJhZWE2NTI2MjE1ZjVmMTE3YTlmZWRlYWM4ZmM2
-    M2IzNGExNDIyMDY5NjNjZDZlZjg3Nzg2ODI1NzJhOTFlNTFkMjVjYWFlMTAz
-    MWNhYzVkN2IwZGQ3NGI4YmEzNDk4NTdkMTA4MjM4ZjAxMDQxY2I=