email_center_api 0.0.1 → 0.0.2

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 test_email_center.rb
+config/email_center_api.yml

data/README.md

@@ -20,22 +20,75 @@ Or install it yourself as:
 
 ## Usage
 
-Experimental and Feature Incomplete. Will allow some manipulation of
-lists and recipients.
+### General configuration
 
-Try it out with something like this:
-
-    require 'rubygems'
     require 'email_center_api'
-    require 'pry'
 
+This will load a configuration yaml file from:
+
+    'config/email_center_api.yml'
+
+You can set a custom configuration file with:
+
+    EmailCenterApi.config_path = 'path/to/config'
+
+The config file should contain the keys:
+
+    base_uri
+    username
+    password
+
+### Email Node Class
+
+The 'email' tree can be queried in the following ways:
+
+    # All children elements of a node:
+    EmailCenterApi::Nodes::EmailNode.all(selector)
+
+    # Folders from a node:
+    EmailCenterApi::Nodes::EmailNode.folders(selector)
+
+    # Emails from a node:
+    EmailCenterApi::Nodes::EmailNode.emails(selector)
+
+where the selector contains an optional parameter to select the parent folder in the form:
+
+    {  folder: <folder node id> }
+
+This will return and array of EmailCenterApi::Nodes::EmailNode object.
+
+### Email Node Instance
+
+Each email node is a folder it can be queried in the following ways:
+
+    node = EmailCenterApi::Nodes::EmailNode.all(selector).first
+
+    # All children elements of a node:
+    node.all
+
+    # Folders from a node:
+    node.folders
+
+    # Emails from a node:
+    node.emails
+
+Alternatively an email node can be triggered to send an email:
+
+    node = EmailCenterApi::Nodes::EmailNode.all(selector).first
+
+    # All children elements of a node:
+    node.trigger(<email_address>, <options>)
+
+Where options is a hash containing the relevant profile data for the email.
+See [Maxemail Documentation](http://maxemail.emailcenteruk.com/manual/doku.php?id=maxemail:v6:webservices:email_send#trigger) for more details.
+
+### Email Template Node Instance
+
+Can be used to query all templates within the tree:
 
-    EmailCenterApi.configure do |config|
-      config.username = 'yourusername'
-      config.password = 'yourpassword'
-    end
+    EmailCenterApi::Nodes::TemplateNode.all
 
-    binding.pry    
+This returns a array of template instances which exposes ```name``` and ```nodeId``` attributes.
 
 ## Contributing
 

data/config/email_center_api.example.yml

@@ -0,0 +1,3 @@
+base_uri: 'https://maxemail.emailcenteruk.com/api/json/'
+username: username@foo.com
+password: password

data/email_center_api.gemspec

@@ -9,17 +9,18 @@ Gem::Specification.new do |gem|
   gem.version       = EmailCenterApi::VERSION
   gem.authors       = ["Ed Robinson"]
   gem.email         = Base64.decode64("ZWQucm9iaW5zb25AcmVldm9vLmNvbQ==\n")
-  gem.description   = %q{ A RubyGem That wraps EmailCenter's maxemail JSON Api }
-  gem.summary       = %q{ A RubyGem That wraps EmailCenter's maxemail JSON Api }
+  gem.description   = "A RubyGem That wraps EmailCenter's maxemail JSON Api"
+  gem.summary       = "A RubyGem That wraps EmailCenter's maxemail JSON Api"
   gem.homepage      = "https://github.com/reevoo/email_center_api"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_dependency("httparty", "~> 0.9.0")
+  gem.add_dependency("httparty", "~> 0.11.0")
   gem.add_dependency("json", "~> 1.7.5")
   gem.add_development_dependency("fakeweb", "~> 1.3.0")
-  gem.add_development_dependency("rspec", "~> 2.11.0")
+  gem.add_development_dependency("rspec", "~> 2.14.0")
   gem.add_development_dependency("pry")
+  gem.add_development_dependency("pry-debugger")
 end

data/lib/email_center_api.rb

@@ -1,13 +1,37 @@
-require "httparty"
-require "email_center_api/version"
-require "email_center_api/configuration"
-require "email_center_api/base"
+module EmailCenterApi
+  class AllErrors < StandardError; end
+  class ApiError < AllErrors; end
+  class HttpError < AllErrors; end
+  class HttpTimeoutError < AllErrors; end
 
+  DEFAULT_PATH = 'config/email_center_api.yml'
 
-module EmailCenterApi
-  extend Configuration
+  def config
+    @config ||= YAML.load_file(config_path)
+  end
+
+  def config_path
+    @config_path || DEFAULT_PATH
+  end
+
+  def config_path=(path)
+    @config_path = path
+    @config = nil
+  end
+
+  extend self
 end
 
-require "email_center_api/list"
-require "email_center_api/recipient"
+require 'httparty'
+require 'yaml'
+require 'delegate'
+
+require "email_center_api/nodes/template_node"
+require "email_center_api/nodes/email_node"
 
+require "email_center_api/http_client"
+require "email_center_api/response_validator"
+require "email_center_api/query"
+require "email_center_api/actions"
+
+require "email_center_api/version"

data/lib/email_center_api/actions.rb

@@ -0,0 +1,17 @@
+module EmailCenterApi
+  class Actions
+
+    def trigger(email_id, email_address, options)
+      get(
+        method: 'trigger',
+        emailID: email_id,
+        emailAddress: email_address,
+        profileData: options
+      ).validate_and_return_response
+    end
+
+    def get(query)
+      ResponseValidator.new(HttpClient.get('/email_send', :query => query))
+    end
+  end
+end

data/lib/email_center_api/http_client.rb

@@ -0,0 +1,47 @@
+module EmailCenterApi
+  class HttpClient
+
+    class << self
+      def get(*args)
+        with_retries do
+          connection.get(*args)
+        end
+      end
+
+      def connection
+        @connection ||= Connection.tap{ |con| con.configure(EmailCenterApi.config) }
+      end
+
+      def reset
+        @connection = nil
+      end
+
+      private
+
+      def with_retries(attempts=3)
+        error = nil
+        attempts.times do
+          begin
+            return yield
+          rescue Timeout::Error => e
+            error = e
+          end
+        end
+        raise EmailCenterApi::HttpTimeoutError.new(error.message)
+      end
+    end
+
+    class Connection
+      include HTTParty
+      default_timeout 10
+
+      class << self
+
+        def configure(config)
+          base_uri config['base_uri']
+          basic_auth config['username'], config['password']
+        end
+      end
+    end
+  end
+end

data/lib/email_center_api/nodes/email_node.rb

@@ -0,0 +1,81 @@
+module EmailCenterApi::Nodes
+  class EmailNode
+    TREE_ROOT = 'email'
+
+    class << self
+      def all(selectors={})
+        where(
+          selectors[:folder] || 0,
+          ->(node) { true }
+        )
+      end
+
+      def folders(selectors={})
+        where(
+          selectors[:folder] || 0,
+          ->(node) { node['nodeClass'] == 'folder' }
+        )
+      end
+
+      def emails(selectors={})
+        where(
+          selectors[:folder] || 0,
+          ->(node) { node['nodeClass'] =~ /^email/ }
+        )
+      end
+
+      private
+
+      def where(folder_id, selector)
+        EmailCenterApi::Query.new(TREE_ROOT)
+        .tree('folder', folder_id)
+        .select { |node| selector.call(node) }
+        .map { |node| build(node) }
+      rescue EmailCenterApi::AllErrors
+        []
+      end
+
+      def build(node)
+        new(node['text'], node['nodeId'], node['nodeClass'])
+      end
+    end
+
+    attr_reader :name, :node_id, :node_class
+
+    def initialize(name, node_id, node_class)
+      @name = name
+      @node_id = node_id.to_i
+      @node_class = node_class
+    end
+
+    def ==(other)
+      name == other.name &&
+      node_id == other.node_id &&
+      node_class == other.node_class
+    end
+
+    def all
+      super unless is_folder?
+      self.class.all(parent: node_id)
+    end
+
+    def folders
+      super unless is_folder?
+      self.class.folders(parent: node_id)
+    end
+
+    def emails
+      super unless is_folder?
+      self.class.emails(folder: node_id)
+    end
+
+    def trigger(email_address, options={})
+      super if is_folder?
+      EmailCenterApi::Actions.new.trigger(node_id, email_address, options)
+    end
+
+    def is_folder?
+      node_class == 'folder'
+    end
+  end
+end

data/lib/email_center_api/nodes/template_node.rb

@@ -0,0 +1,22 @@
+module EmailCenterApi::Nodes
+  class TemplateNode
+    TREE_ROOT = 'email_template'
+
+    attr_reader :name, :node_id
+
+    def initialize(name, node_id)
+      @name = name
+      @node_id = node_id.to_i
+    end
+
+    def self.all
+      response = EmailCenterApi::Query.new(TREE_ROOT).root
+      response.first['children'].map do |template|
+        self.new(
+          template['text'],
+          template['nodeId']
+        )
+      end
+    end
+  end
+end

data/lib/email_center_api/query.rb

@@ -0,0 +1,44 @@
+module EmailCenterApi
+  class Query
+    class TreeRootRequired < StandardError; end
+
+    attr_reader :tree_root
+
+    def initialize(tree_root=nil)
+      @tree_root = tree_root
+    end
+
+    def root
+      raise TreeRootRequired if tree_root.nil?
+      get(
+        method: 'fetchRoot',
+        tree: tree_root,
+        children: ['root']
+      ).validate_and_return_response
+    end
+
+    def tree(node_class, node_id)
+      raise TreeRootRequired if tree_root.nil?
+      get(
+        method: 'fetchTree',
+        :tree => tree_root,
+        :nodeClass => node_class,
+        nodeId: node_id
+      ).validate_and_return_response
+    end
+
+    def node(node_class, node_id)
+      get(
+        method: 'fetchNode',
+        nodeClass: node_class,
+        nodeId: node_id
+      ).validate_and_return_response
+    end
+
+    private
+
+    def get(query)
+      ResponseValidator.new(HttpClient.get('/tree', :query => query))
+    end
+  end
+end

data/lib/email_center_api/response_validator.rb

@@ -0,0 +1,31 @@
+module EmailCenterApi
+  class ResponseValidator
+    attr_reader :response
+    def initialize(response)
+      @response = response
+    end
+
+    def validate_and_return_response
+      raise_errors unless successful?
+      response
+    end
+
+    private
+
+    def raise_errors
+      if response['msg']
+        raise EmailCenterApi::ApiError, "Api Error: #{response['msg']}"
+      else
+        raise EmailCenterApi::HttpError, "status: #{response.code}"
+      end
+    end
+
+    def successful?
+      response.success? && missing_failure_status?
+    end
+
+    def missing_failure_status?
+      !(response.is_a?(Hash) && response['success'] == false)
+    end
+  end
+end

data/lib/email_center_api/version.rb

@@ -1,3 +1,3 @@
 module EmailCenterApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fake_web_helpers/email.rb

@@ -0,0 +1,36 @@
+module FakeWebHelpers
+  class Email
+    class << self
+
+      def setup
+        setup_email_to_trigger
+        setup_email_trigger
+      end
+
+      def setup_email_to_trigger
+        url = "https://test:test@maxemail.emailcenteruk.com/api/json/tree?method=fetchTree&tree=email&nodeClass=folder&nodeId=123"
+
+        FakeWeb.register_uri(:get, url,
+          :body => [email_to_trigger].to_json,
+          :content_type => 'application/json')
+      end
+
+      def setup_email_trigger
+        url = "https://test:test@maxemail.emailcenteruk.com/api/json/email_send?method=trigger&emailID=10&emailAddress=test%40reevoo.com&profileData[Reviews][retailer_product_name]=Test%20product&profileData[Reviews][retailer_name]=test%20retailer&profileData[Reviews][retailer_from]=reply%40reevoo.com"
+
+        FakeWeb.register_uri(:get, url,
+          :body => {success: true, message: "Email queued successfully"}.to_json,
+          :content_type => 'application/json')
+      end
+
+      private
+
+      def email_to_trigger
+        {text: "Test Email", nodeId: "10", nodeClass: "email"}
+      end
+    end
+  end
+end
+
+FakeWebHelpers::Email.setup
+