emma-ruby 0.0.1

data/lib/emma/api/members.rb

@@ -0,0 +1,135 @@
+# @see http://api.myemma.com/api/external/members.html
+
+module Emma
+  module API
+    module Members
+      # Get detailed information on a particular member, including all custom fields.
+      def get_member_by_id(id, params = {})
+        get("/members/#{id}", params)
+      end
+
+      # Get a basic listing of all members in an account.
+      def my_members(params = {})
+        get("/members", params)
+      end
+
+      # Get detailed information on a particular member, including all custom fields, by email address instead of ID.
+      def get_member_by_email(email, params = {})
+        get("/members/email/#{email}", params)
+      end
+
+      # If a member has been opted out, returns the details of their optout, specifically date and mailing_id.
+      def get_optout_member(id)
+        get("/members/#{id}/optout")
+      end
+
+      # Update a member’s status to optout keyed on email address instead of an ID.
+      def optout(email)
+        put("/members/email/optout/#{email}")
+      end
+
+      # Add new members or update existing members in bulk. If you are doing actions for a single member please see the add_member() call below.
+      def add_members(params = {})
+        post("/members", params)
+      end
+
+      # Adds or updates a single audience member. If you are performing actions on bulk members please use the add_members() call above.
+      def add_member(params = {})
+        post("/members/add", params)
+      end
+
+      # Adds member and triggers the opt-out workflow. Use when you want to send a confirmation email.
+      def add_member_signup(params = {})
+        post("/members/signup", params)
+      end
+
+      # Delete an array of members.
+      def remove_members(params = {})
+        put("/members/delete", params)
+      end
+
+      # Change the status for an array of members.
+      def change_members_status(params = {})
+        put("/members/status", params)
+      end
+
+      # Update a single member’s information.
+      def update_member(id, params = {})
+        put("/members/#{id}", params)
+      end
+
+      # Delete the specified member.
+      def remove_member(id)
+        delete("/members/#{id}")
+      end
+
+      # Get the groups to which a member belongs.
+      def get_members_groups(id)
+        get("/members/#{id}/groups")
+      end
+
+      # Add a single member to one or more groups.
+      def add_member_to_groups(id, params)
+        put("/members/#{id}/groups", params)
+      end
+
+      # Remove a single member from one or more groups.
+      def remove_member_from_groups(id, params)
+        put("/members/#{id}/groups/remove", params)
+      end
+
+      # Delete all members.
+      def remove_all_members
+        delete("/members")
+      end
+
+      # Remove the specified member from all groups.
+      def remove_member_from_all_groups(id)
+        delete("/members/#{id}/groups")
+      end
+
+      # Remove multiple members from groups.
+      def remove_multiple_members_from_groups(params = {})
+        put("/members/groups/remove", params)
+      end
+
+      # Get the entire mailing history for a member.
+      def get_mailing_history_for_member(id)
+        get("/members/#{id}/mailings")
+      end
+
+      # Get a list of members affected by this import.
+      def imported_members(import_id)
+        get("/members/imports/#{import_id}/members")
+      end
+
+      # Get information and statistics about this import.
+      def import_stats(import_id)
+        get("/members/imports/#{import_id}")
+      end
+
+      # Get information about all imports for this account.
+      def my_imports
+        get("/members/imports")
+      end
+
+      # Update an import record to be marked as ‘deleted’.
+      def delete_import
+        delete("/members/imports/delete")
+      end
+
+      # Copy all account members of one or more statuses into a group.
+      def copy_members_to_group(group_id, params = {})
+        put("/members/#{group_id}/copy", params)
+      end
+
+      # Update the status for a group of members, based on their current
+      # status. Valid statuses id are (‘a’,’e’, ‘f’, ‘o’) active, error, forwarded, optout.
+      def update_group_members_status(status_from, status_to, group_id = nil)
+        params = {}
+        params[:group_id] = group_id unless group_id.nil?
+        put("/members/status/#{status_from}/to/#{status_to}", params)
+      end
+    end
+  end
+end

data/lib/emma/api/response.rb

@@ -0,0 +1,36 @@
+# @see http://api.myemma.com/api/external/response.html
+
+module Emma
+  module API
+    module Response
+      # Get the response summary for an account.
+      # This method will return a month-based time series of data including sends, opens, clicks, mailings, forwards, and opt-outs. 
+      # Test mailings and forwards are not included in the data returned.
+      def my_account_summary(params = {})
+        get("/response", params)
+      end
+      
+      # Get the response summary for a particular mailing.
+      # This method will return the counts of each type of response activity for a particular mailing.
+      def single_response_summary(id)
+        get("/response/#{id}")
+      end
+      
+      # Get the list of messages by id by a particular action
+      # actions include (sends, in_progress, deliveries, opens, links, clicks, forwards, optouts, signups, shares, customer_shares, customer_share_clicks)
+      def response_mailing_information(id, action = 'sends', params = {})
+        get("/response/#{id}/#{action}", params)
+      end
+      
+      # Get the customer share associated with the share id.
+      def customer_share_information(share_id, params = {})
+        get("/response/#{share_id}/customer_share", params)
+      end
+      
+      # Get overview of shares pertaining to this mailing_id.
+      def mailing_shares_overview(id)
+        get("/response/#{id}/shares/overview")
+      end
+    end
+  end
+end

data/lib/emma/api/searches.rb

@@ -0,0 +1,38 @@
+# @see http://api.myemma.com/api/external/searches.html
+
+module Emma
+  module API
+    module Searches
+      # Retrieve a list of saved searches.
+      def my_searches(params = {})
+        get("/searches", params)
+      end
+      
+      # Get the details for a saved search.
+      def single_search(id, params = {})
+        get("/searches/#{id}", params)
+      end
+      
+      # Create a saved search.
+      def create_search(params = {})
+        post("/searches", params)
+      end
+      
+      # Update a saved search.
+      # No parameters are required, but either the name or criteria parameter must be present for an update to occur.
+      def update_search(id, params = {})
+        put("/searches/#{id}", params)
+      end
+      
+      # Delete a saved search. The member records referred to by the search are not affected.
+      def remove_search(id)
+        delete("/searches/#{id}")
+      end
+      
+      # Get the members matching the search.
+      def get_members_of_search(id)
+        get("/searches/#{id}/members")
+      end
+    end
+  end
+end

data/lib/emma/api/triggers.rb

@@ -0,0 +1,37 @@
+# @see http://api.myemma.com/api/external/triggers.html
+
+module Emma
+  module API
+    module Triggers
+      # Get a basic listing of all triggers in an account.
+      def my_triggers(params = {})
+        get("/triggers")
+      end
+      
+      # Create a new trigger.
+      def add_trigger(params = {})
+        post("/triggers", params)
+      end
+      
+      # Look up a trigger by trigger id.
+      def get_trigger_by_id(id)
+        get("/triggers/#{id}")
+      end
+      
+      # Update or edit a trigger.
+      def update_trigger(id, params = {})
+        put("/triggers/#{id}", params)
+      end
+      
+      # Delete a trigger.
+      def remove_trigger(id)
+        delete("/triggers/#{id}")
+      end
+      
+      # Get mailings sent by a trigger.
+      def get_trigger_mailings(id, params = {})
+        get("/triggers/#{id}/mailings", params)
+      end
+    end
+  end
+end

data/lib/emma/api/webhooks.rb

@@ -0,0 +1,42 @@
+# @see http://api.myemma.com/api/external/webhooks.html
+
+module Emma
+  module API
+    module Webhooks
+      # Get a basic listing of all webhooks associated with an account.
+      def my_webhooks(params = {})
+        get("/webhooks")
+      end
+      
+      # Get information for a specific webhook belonging to a specific account.
+      def get_webhook(id)
+        get("/webhooks/#{id}")
+      end
+      
+      # Get a listing of all event types that are available for webhooks.
+      def webhook_events(id)
+        get("/webhooks/#{id}/events")
+      end
+      
+      # Create an new webhook.
+      def add_webhook(params = {})
+        post("/webhooks", params)
+      end
+      
+      # Update an existing webhook. Takes the same params as create_webhook.
+      def update_webhook(id, params = {})
+        put("/webhooks/#{id}", params)
+      end
+      
+      # Deletes an existing webhook.
+      def remove_webhook(id)
+        delete("/webhooks/#{id}")
+      end
+      
+      # Delete all webhooks registered for an account.
+      def remove_all_webhooks
+        delete("/webhooks")
+      end
+    end
+  end
+end

data/lib/emma/client.rb

@@ -0,0 +1,92 @@
+require 'json'
+require 'httparty'
+require 'emma/configurable'
+require 'emma/api/members'
+require 'emma/api/fields'
+require 'emma/api/groups'
+require 'emma/api/mailings'
+require 'emma/api/response'
+require 'emma/api/searches'
+require 'emma/api/triggers'
+require 'emma/api/webhooks'
+
+
+module Emma
+  class Client
+    include HTTParty
+    
+    # Include individual modules
+    include Emma::API::Members
+    include Emma::API::Fields
+    include Emma::API::Groups
+    include Emma::API::Mailings
+    include Emma::API::Response
+    include Emma::API::Searches
+    include Emma::API::Triggers
+    include Emma::API::Webhooks
+    
+    base_uri "https://api.e2ma.net"
+    
+    attr_accessor :account_id, :private_key, :public_key
+    
+    # On insantiation set instance variables into memory
+    def initialize(options = {})
+      Emma::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Emma.instance_variable_get(:"@#{key}"))
+      end
+      @default_params = {:basic_auth => {:username => @public_key, :password => @private_key}}
+    end
+    
+    # HTTP GET Request
+    def get(path, query = {})
+      request(:get, path, query)
+    end
+    
+    # HTTP POST Request
+    def post(path, params = {})
+      # options = {:body => params.to_json}
+      request(:post, path, params)
+    end
+    
+    # HTTP PUT Request
+    def put(path, params = {})
+      # options = {:body => params.to_json}
+      request(:put, path, params)
+    end
+    
+    # HTTP DELETE Request
+    def delete(path, query = {})
+      request(:delete, path, query)
+    end
+    
+    private
+      # Performs Call to API
+      def request(method, path, params = {})
+        self.class.debug_output($stderr) if @debug
+        setup_http_body(method, params)
+        
+        uri = base_api_uri + path
+        response = self.class.send(method.to_sym, uri, @default_params)
+        parse(response)
+      end
+      
+      def setup_http_body(method, params)
+        unless params.empty?
+          @default_params.merge!({:query => params}) if [:get, :delete].include? method
+          @default_params.merge!({:body => params.to_json}) if [:put, :post].include? method
+        end
+        @default_params
+      end
+      
+      # Appends account id to base_uri
+      def base_api_uri
+        "#{self.class.base_uri}/#{@account_id}"
+      end
+      
+      # Return parsed response from API Call
+      def parse(response)
+        return JSON.parse('[' + response.body + ']').first
+      end
+    
+  end
+end

data/lib/emma/configurable.rb

@@ -0,0 +1,21 @@
+module Emma
+  module Configurable
+    class << self
+      # all keys (instance vars) available
+      def keys
+        @keys ||= [
+            :account_id,
+            :public_key,
+            :private_key,
+            :debug
+          ]
+      end
+    end
+    
+    private
+      # return mapped Hash of available keys
+      def options
+        Hash[Emma::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+      end
+  end
+end

data/lib/emma/version.rb

@@ -0,0 +1,3 @@
+module Emma
+  VERSION = "0.0.1"
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'vcr'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'emma'
+
+VCR.configure do |c|
+  c.cassette_library_dir  = 'test/fixtures/vcr_cassettes'
+  c.default_cassette_options = { :record => :new_episodes }
+  c.hook_into :webmock
+end

data/test/test_emma_interface.rb

@@ -0,0 +1,88 @@
+require_relative 'helper'
+
+class TestEmmaInterface < Test::Unit::TestCase
+  
+  context "attributes" do
+    setup do
+      @_env_account_id = ENV['EMMA_ACCOUNT_ID']
+      @_env_public_key = ENV['EMMA_PUBLIC_KEY']
+      @_env_private_key = ENV['EMMA_PRIVATE_KEY']
+
+      ENV.delete 'EMMA_ACCOUNT_ID'
+      ENV.delete 'EMMA_PUBLIC_KEY'
+      ENV.delete 'EMMA_PRIVATE_KEY'
+
+      @account_id = '12345678'
+      @pub_key = 'test_public_key'
+      @private_key = 'test_private_key'
+      @debug = true
+    end
+
+    teardown do
+      ENV['EMMA_ACCOUNT_ID'] = @_env_account_id
+      ENV['EMMA_PUBLIC_KEY'] = @_env_public_key
+      ENV['EMMA_PRIVATE_KEY'] = @_env_private_key
+    end
+    
+    should "No API due to no Account ID" do
+      @em = Emma::Setup.new
+      assert_equal nil, @em.account_id
+    end
+    
+    should "No API due to no Pub Key" do
+      @em = Emma::Setup.new(@account_id)
+      assert_equal nil, @em.public_key
+    end
+    
+    should "No API due to no Private Key" do
+      @em = Emma::Setup.new(@account_id, @public_key)
+      assert_equal nil, @em.private_key
+    end
+    
+    should "set the Account ID via the setter" do
+      @em = Emma::Setup.new
+      @em.account_id = @account_id
+      assert_equal @account_id, @em.account_id
+    end
+    
+    should "set the Public Key via the setter" do
+      @em = Emma::Setup.new
+      @em.public_key = @pub_key
+      assert_equal @pub_key, @em.public_key
+    end
+    
+    should "set the Private Key via the setter" do
+      @em = Emma::Setup.new
+      @em.private_key = @private_key
+      assert_equal @private_key, @em.private_key
+    end
+    
+    should "turn on debug mode via the setter" do
+      @em = Emma::Setup.new
+      @em.debug = @debug
+      assert_equal @debug, @em.debug
+    end
+    
+    should "set the Account ID via the Environment variable" do
+      ENV['EMMA_ACCOUNT_ID'] = @account_id
+      @em = Emma::Setup.new
+      assert_equal @account_id, @em.account_id
+      ENV.delete 'EMMA_ACCOUNT_ID'
+    end
+    
+    should "set the Public Key via the Environment variable" do
+      ENV['EMMA_PUBLIC_KEY'] = @public_key
+      @em = Emma::Setup.new
+      assert_equal @public_key, @em.public_key
+      ENV.delete 'EMMA_PUBLIC_KEY'
+    end
+    
+    should "set the Private Key via the Environment variable" do
+      ENV['EMMA_PRIVATE_KEY'] = @private_key
+      @em = Emma::Setup.new
+      assert_equal @private_key, @em.private_key
+      ENV.delete 'EMMA_PRIVATE_KEY'
+    end
+  end
+
+end