esendex 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9cb035158a9964f5fb7f6bb2719915755e0b6e6
-  data.tar.gz: dd8655c31f2d0712ed387d596a714ad6901e5b3c
+  metadata.gz: ac1d98a5009c85639396fc251b7f1fe73c709321
+  data.tar.gz: 1a38f74ae0ef3da6fc6f98549b9dc5512f7b57d6
 SHA512:
-  metadata.gz: 30b5201c1c965b9ae62a6dc148ffc42c9d14983a76ee635a42378279bb4e3d77984eb15d35c804316ba26e23b7dbd1407165af3152f5b7ca34627b2a26e7964b
-  data.tar.gz: db9c603a303f20819bbfa00e0dbe6c453f53761aad3a76319289881a6897e01e9102a408f307f764652560cb71a8e4b3e7dad8af4d4120cb0993104ac9c35ee2
+  metadata.gz: 375d165b04e43b38e7607d7a077395c3070f99603797249fee0432da43eb48dcedcbc982b3c11c63a195824afa2e6e37e644b8948c05ed2c2d65800352bbee5d
+  data.tar.gz: 70e8d44120d20d906dea4e2102b8024254f2ad1ce530a5bdaefe13b768293cf415e8054b62f86533c80a8f43089d01c2f139f6ea36af83fa90dd519149a01716

data/app/controllers/esendex/application_controller.rb

@@ -1,4 +1,4 @@
-module Esendex
-  class ApplicationController < ActionController::Base
-  end
-end
+module Esendex
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/esendex/inbound_messages_controller.rb

@@ -1,12 +1,12 @@
-module Esendex
-  class InboundMessagesController < ApplicationController
-    include PushNotificationHandler
-
-    def create
-      process_notification :inbound_message, request.body
-      render text: "OK"
-    rescue => e
-      render_error e
-    end
-  end
+module Esendex
+  class InboundMessagesController < ApplicationController
+    include PushNotificationHandler
+
+    def create
+      process_notification :inbound_message, request.body
+      render text: "OK"
+    rescue => e
+      render_error e
+    end
+  end
 end

data/app/controllers/esendex/message_delivered_events_controller.rb

@@ -1,12 +1,12 @@
-module Esendex
-  class MessageDeliveredEventsController < ApplicationController
-    include PushNotificationHandler
-
-    def create
-      process_notification :message_delivered_event, request.body
-      render text: "OK"
-    rescue => e
-      render_error e
-    end
-  end
+module Esendex
+  class MessageDeliveredEventsController < ApplicationController
+    include PushNotificationHandler
+
+    def create
+      process_notification :message_delivered_event, request.body
+      render text: "OK"
+    rescue => e
+      render_error e
+    end
+  end
 end

data/app/controllers/esendex/message_failed_events_controller.rb

@@ -1,12 +1,12 @@
-module Esendex
-  class MessageFailedEventsController < ApplicationController
-    include PushNotificationHandler
-
-    def create
-      process_notification :message_failed_event, request.body
-      render text: "OK"
-    rescue => e
-      render_error e
-    end
-  end
+module Esendex
+  class MessageFailedEventsController < ApplicationController
+    include PushNotificationHandler
+
+    def create
+      process_notification :message_failed_event, request.body
+      render text: "OK"
+    rescue => e
+      render_error e
+    end
+  end
 end

data/app/controllers/esendex/push_notification_handler.rb

@@ -1,42 +1,42 @@
-# Common behaviour for all push notification controllers
-# 
-module Esendex
-  module PushNotificationHandler
-
-    # Used by controllers to handle incoming push notification
-    # 
-    # type        - Symbol indicating type
-    # source      - String request body of the notification
-    # 
-    # Returns nothing
-    def process_notification(type, source)
-       
-      if handler = Esendex.send("#{type}_handler")
-        notification_class = Esendex.const_get(type.to_s.camelize)
-        notification = notification_class.from_xml source
-        handler.call notification
-      else
-        logger.info "Received #{type} push notification but no handler configured" if defined?(logger)
-      end
-
-    end
-
-    def render_error(error)
-      lines = []
-      lines << "Path: #{request.path}"
-      request.body.rewind
-      lines << "Notification XML:\r\n#{request.body.read}"
-      lines << "Error: #{error.class.name} #{error.message}"
-      if Esendex.suppress_error_backtrace
-        lines << "[backtrace suppressed]"
-      else
-        lines << error.backtrace.join("\r\n")
-      end
-      lines << "---"
-      lines << "Ruby #{RUBY_VERSION}"
-      lines << "Rails #{Rails::VERSION::STRING}"
-      lines << Esendex.user_agent
-      render text: lines.join("\r\n"), status: 500
-    end
-  end
+# Common behaviour for all push notification controllers
+# 
+module Esendex
+  module PushNotificationHandler
+
+    # Used by controllers to handle incoming push notification
+    # 
+    # type        - Symbol indicating type
+    # source      - String request body of the notification
+    # 
+    # Returns nothing
+    def process_notification(type, source)
+       
+      if handler = Esendex.send("#{type}_handler")
+        notification_class = Esendex.const_get(type.to_s.camelize)
+        notification = notification_class.from_xml source
+        handler.call notification
+      else
+        logger.info "Received #{type} push notification but no handler configured" if defined?(logger)
+      end
+
+    end
+
+    def render_error(error)
+      lines = []
+      lines << "Path: #{request.path}"
+      request.body.rewind
+      lines << "Notification XML:\r\n#{request.body.read}"
+      lines << "Error: #{error.class.name} #{error.message}"
+      if Esendex.suppress_error_backtrace
+        lines << "[backtrace suppressed]"
+      else
+        lines << error.backtrace.join("\r\n")
+      end
+      lines << "---"
+      lines << "Ruby #{RUBY_VERSION}"
+      lines << "Rails #{Rails::VERSION::STRING}"
+      lines << Esendex.user_agent
+      render text: lines.join("\r\n"), status: 500
+    end
+  end
 end

data/config/routes.rb

@@ -1,5 +1,5 @@
-Esendex::Engine.routes.draw do
-  resources :message_delivered_events, only: [:create]
-  resources :message_failed_events, only: [:create]
-  resources :inbound_messages, only: [:create]
-end
+Esendex::Engine.routes.draw do
+  resources :message_delivered_events, only: [:create]
+  resources :message_failed_events, only: [:create]
+  resources :inbound_messages, only: [:create]
+end

data/lib/esendex.rb

@@ -1,62 +1,63 @@
-module Esendex
-  require_relative 'esendex/version'
-  require_relative 'esendex/exceptions'
-  require_relative 'esendex/api_connection'
-  require_relative 'esendex/hash_serialisation'
-  
-  require_relative 'esendex/account'
-  require_relative 'esendex/dispatcher_result'
-  require_relative 'esendex/inbound_message'
-  require_relative 'esendex/message'
-  require_relative 'esendex/message_batch_submission'
-  require_relative 'esendex/message_delivered_event'
-  require_relative 'esendex/message_failed_event'
-  
-  # Load Rails extensions if Rails present
-  if defined?(Rails)
-    require_relative 'esendex/railtie' 
-    require_relative 'esendex/engine'
-  end
-
-  API_NAMESPACE = 'http://api.esendex.com/ns/'
-  API_HOST = 'https://api.esendex.com'
-
-  # Public - used to configure the gem prior to use
-  # 
-  #   Esendex.configure do |config|
-  #     config.username = 'username'
-  #     config.password = 'password'
-  #     config.account_reference = 'account reference'
-  #   end
-  # 
-  def self.configure
-    yield self if block_given?
-  end
-
-  class << self
-    # credentials for authentication
-    attr_writer :account_reference, :username, :password
-
-    # lambdas for handling push notifications
-    attr_accessor :message_delivered_event_handler, :message_failed_event_handler, :inbound_message_handler
-
-    # behaviour config
-    attr_accessor :suppress_error_backtrace
-
-    def account_reference
-      @account_reference ||= ENV['ESENDEX_ACCOUNT']
-    end
-
-    def username
-      @username ||= ENV['ESENDEX_USERNAME']
-    end
-
-    def password
-      @password ||= ENV['ESENDEX_PASSWORD']
-    end
-  end
-
-  def self.user_agent
-    "EsendexRubyGem/#{Esendex::VERSION}"
-  end
-end
+module Esendex
+  require_relative 'esendex/version'
+  require_relative 'esendex/exceptions'
+  require_relative 'esendex/api_connection'
+  require_relative 'esendex/hash_serialisation'
+  
+  require_relative 'esendex/account'
+  require_relative 'esendex/dispatcher_result'
+  require_relative 'esendex/inbound_message'
+  require_relative 'esendex/message'
+  require_relative 'esendex/voice_message'
+  require_relative 'esendex/message_batch_submission'
+  require_relative 'esendex/message_delivered_event'
+  require_relative 'esendex/message_failed_event'
+  
+  # Load Rails extensions if Rails present
+  if defined?(Rails)
+    require_relative 'esendex/railtie' 
+    require_relative 'esendex/engine'
+  end
+
+  API_NAMESPACE = 'http://api.esendex.com/ns/'
+  API_HOST = 'https://api.esendex.com'
+
+  # Public - used to configure the gem prior to use
+  # 
+  #   Esendex.configure do |config|
+  #     config.username = 'username'
+  #     config.password = 'password'
+  #     config.account_reference = 'account reference'
+  #   end
+  # 
+  def self.configure
+    yield self if block_given?
+  end
+
+  class << self
+    # credentials for authentication
+    attr_writer :account_reference, :username, :password
+
+    # lambdas for handling push notifications
+    attr_accessor :message_delivered_event_handler, :message_failed_event_handler, :inbound_message_handler
+
+    # behaviour config
+    attr_accessor :suppress_error_backtrace
+
+    def account_reference
+      @account_reference ||= ENV['ESENDEX_ACCOUNT']
+    end
+
+    def username
+      @username ||= ENV['ESENDEX_USERNAME']
+    end
+
+    def password
+      @password ||= ENV['ESENDEX_PASSWORD']
+    end
+  end
+
+  def self.user_agent
+    "EsendexRubyGem/#{Esendex::VERSION}"
+  end
+end

data/lib/esendex/account.rb

@@ -1,44 +1,44 @@
-require 'nokogiri'
-
-module Esendex
-  class Account
-    DEFAULT_DATE_OFFSET = 90
-    
-    attr_accessor :reference
-    
-    def initialize(account_reference = Esendex.account_reference)
-      @reference = account_reference
-    end
-    
-    def api_connection
-      @api_connection ||= ApiConnection.new
-    end
-
-    def messages_remaining
-      response = api_connection.get "/v1.0/accounts"
-      doc = Nokogiri::XML(response.body)
-      node = doc.at_xpath("//api:account[api:reference='#{@reference}']/api:messagesremaining", 'api' => Esendex::API_NAMESPACE)
-      raise AccountReferenceError.new if node.nil?
-      node.content.to_i
-    end
-
-    def send_message(args={})
-      raise ArgumentError.new(":to required") unless args[:to]
-      raise ArgumentError.new(":body required") unless args[:body]
-
-      send_messages [Message.new(args[:to], args[:body], args[:from])]
-    end
-    
-    def send_messages(messages)
-      batch_submission = MessageBatchSubmission.new(@reference, messages)
-      response = api_connection.post("/v1.0/messagedispatcher", batch_submission.to_s)
-      DispatcherResult.from_xml response.body
-    end
-
-    def sent_messages(args={})
-      SentMessageClient
-        .new(api_connection)
-        .get_messages(args.merge(account_reference: reference))
-    end
-  end
-end
+require 'nokogiri'
+
+module Esendex
+  class Account
+    DEFAULT_DATE_OFFSET = 90
+    
+    attr_accessor :reference
+    
+    def initialize(account_reference = Esendex.account_reference)
+      @reference = account_reference
+    end
+    
+    def api_connection
+      @api_connection ||= ApiConnection.new
+    end
+
+    def messages_remaining
+      response = api_connection.get "/v1.0/accounts"
+      doc = Nokogiri::XML(response.body)
+      node = doc.at_xpath("//api:account[api:reference='#{@reference}']/api:messagesremaining", 'api' => Esendex::API_NAMESPACE)
+      raise AccountReferenceError.new if node.nil?
+      node.content.to_i
+    end
+
+    def send_message(args={})
+      raise ArgumentError.new(":to required") unless args[:to]
+      raise ArgumentError.new(":body required") unless args[:body]
+
+      send_messages [Message.new(args[:to], args[:body], args[:from])]
+    end
+    
+    def send_messages(messages)
+      batch_submission = MessageBatchSubmission.new(@reference, messages)
+      response = api_connection.post("/v1.0/messagedispatcher", batch_submission.to_s)
+      DispatcherResult.from_xml response.body
+    end
+
+    def sent_messages(args={})
+      SentMessageClient
+        .new(api_connection)
+        .get_messages(args.merge(account_reference: reference))
+    end
+  end
+end

data/lib/esendex/api_connection.rb

@@ -1,29 +1,29 @@
-require 'nestful'
-
-module Esendex
-  class ApiConnection
-
-    def initialize
-      @connection = Nestful::Connection.new(Esendex::API_HOST)
-      @connection.user = Esendex.username
-      @connection.password = Esendex.password
-      @connection.auth_type = :basic
-    end
-
-    def default_headers
-      { 'User-Agent' => Esendex.user_agent }
-    end
-
-    def get(url)
-      @connection.get url, default_headers
-    rescue => e
-      raise Esendex::ApiErrorFactory.new.get_api_error(e)
-    end
-
-    def post(url, body)
-      @connection.post url, body, default_headers
-    rescue => e
-      raise Esendex::ApiErrorFactory.new.get_api_error(e)
-    end
-  end
-end
+require 'nestful'
+
+module Esendex
+  class ApiConnection
+
+    def initialize
+      @connection = Nestful::Connection.new(Esendex::API_HOST)
+      @connection.user = Esendex.username
+      @connection.password = Esendex.password
+      @connection.auth_type = :basic
+    end
+
+    def default_headers
+      { 'User-Agent' => Esendex.user_agent }
+    end
+
+    def get(url)
+      @connection.get url, default_headers
+    rescue => e
+      raise Esendex::ApiErrorFactory.new.get_api_error(e)
+    end
+
+    def post(url, body)
+      @connection.post url, body, default_headers
+    rescue => e
+      raise Esendex::ApiErrorFactory.new.get_api_error(e)
+    end
+  end
+end