mailup 1.1.0

data/lib/mailup/stats/recipient.rb

@@ -0,0 +1,303 @@
+module MailUp
+  module Stats
+    class Recipient
+      attr_accessor :api
+
+      def initialize(id, api)
+          @api = api
+          @id = id
+      end
+
+      # Paged list of messages received by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageDeliveries
+      #
+      # @example
+      #
+      #   deliveries = mailup.console.recipient(154).deliveries
+      #   deliveries['TotalElementsCount']
+      #   => 10
+      #   deliveries['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def deliveries(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Deliveries", params: params)
+      end
+      
+      # Count of messages received by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of deliveries.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientMessageDeliveries
+      #
+      # @example
+      #
+      #   deliveries = mailup.console.recipient(154).deliveries_count
+      #   => 324
+      #
+      def deliveries_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Deliveries")
+      end
+      
+      # Paged list of messages viewed by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageViews
+      #
+      # @example
+      #
+      #   views = mailup.console.recipient(154).views
+      #   views['TotalElementsCount']
+      #   => 10
+      #   views['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def views(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Views", params: params)
+      end
+      
+      # Count of messages viewed by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of views.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientMessageViews
+      #
+      # @example
+      #
+      #   views = mailup.console.recipient(154).views_count
+      #   => 324
+      #
+      def views_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Views")
+      end
+      
+      # Paged list of bounces with details returned by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageBouncesDetails
+      #
+      # @example
+      #
+      #   bounces = mailup.console.recipient(154).bounces_details
+      #   bounces['TotalElementsCount']
+      #   => 10
+      #   bounces['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def bounces_details(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/BouncesDetails", params: params)
+      end
+
+      # Paged list of bounces returned by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageBounces
+      #
+      # @example
+      #
+      #   bounces = mailup.console.recipient(154).bounces
+      #   bounces['TotalElementsCount']
+      #   => 10
+      #   bounces['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def bounces(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Bounces", params: params)
+      end
+      
+      # Count of bounces returned by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of bounces.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientMessageBounces
+      #
+      # @example
+      #
+      #   views = mailup.console.recipient(154).bounces_count
+      #   => 324
+      #
+      def bounces_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Bounces")
+      end
+      
+      # Paged list of unsubscriptions done by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientUnsubscriptions
+      #
+      # @example
+      #
+      #   unsubscribes = mailup.console.recipient(154).unsubscribes
+      #   unsubscribes['TotalElementsCount']
+      #   => 10
+      #   unsubscribes['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def unsubscribes(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Unsubscriptions", params: params)
+      end
+      
+      # Count of unsubscriptions done by the specified recipient.
+      #
+      #
+      # @return [Integer] Count of unsubscribes.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientUnsubscriptions
+      #
+      # @example
+      #
+      #   unsubscribes = mailup.console.recipient(154).unsubscribes_count
+      #   => 324
+      #
+      def unsubscribes_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Unsubscriptions")
+      end
+
+      # Verbose paged list of message clicks on a link done by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods#Emailstatisticsmethods-ListRecipientClickDetailsByDate
+      #
+      # @example
+      #
+      #   clicks = mailup.console.recipient(154).clicks_details
+      #   clicks['TotalElementsCount']
+      #   => 10
+      #   clicks['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def clicks_details(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/ClicksDetails", params: params)
+      end
+      
+      # Paged list of message clicks on a link done by the specified recipient.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListRecipientMessageClicks
+      #
+      # @example
+      #
+      #   clicks = mailup.console.recipient(154).clicks
+      #   clicks['TotalElementsCount']
+      #   => 10
+      #   clicks['Items'].first['Subject']
+      #   => "Message Subject"
+      #
+      def clicks(params = {})
+        @api.get("#{@api.path}/Recipient/#{@id}/List/Clicks", params: params)
+      end
+      
+      # Count of clicks on a link in the specified email.
+      #
+      #
+      # @return [Integer] Count of clicks.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountRecipientClicks
+      #
+      # @example
+      #
+      #   clicks = mailup.console.recipient(154).clicks_count
+      #   => 324
+      #
+      def clicks_count
+        @api.get("#{@api.path}/Recipient/#{@id}/Count/Clicks")
+      end
+
+    end
+  end
+end

data/lib/mailup/version.rb

@@ -0,0 +1,4 @@
+module MailUp
+  API_VERSION = "1.1"
+  VERSION = "1.1.0"
+end

data/mailup.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailup/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mailup"
+  gem.version       = MailUp::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Brian Getting"]
+  gem.email         = ["brian@tatem.ae"]
+  gem.homepage      = "https://github.com/mailup/mailup-ruby"
+  gem.summary       = "Ruby wrapper for the MailUp REST API"
+  gem.description   = "A Ruby gem for interacting with the MailUp REST 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 'oauth2', '>= 0.9.2'
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'mailup'

data/spec/mailup/console/base_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+# Console API Methods
+describe MailUp::Console do
+  before(:each){ init_mailup }
+
+  it 'should return a console base object' do
+    @mailup.console.should be_an_instance_of(MailUp::Console::Base)
+  end
+
+  it 'should have the correct API path' do
+    @mailup.console.api.path.should eq("/API/v#{MailUp::API_VERSION}/Rest/ConsoleService.svc/Console")
+  end
+
+  %w(email images recipient user).each do |resource|
+    context resource do
+      it "should return a #{resource} object" do
+        test = @mailup.console.send(resource.to_sym)
+        test.should be_an_instance_of(Object.const_get "MailUp::Console::#{resource.capitalize}")
+      end
+    end
+  end
+
+  %w(group import list).each do |resource|
+    context resource do
+      it "should return a #{resource} object" do
+        test = @mailup.console.send(resource.to_sym, 1)
+        test.should be_an_instance_of(Object.const_get "MailUp::Console::#{resource.capitalize}")
+      end
+    end
+  end
+
+end

data/spec/mailup/console/email_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe MailUp::Console::Email do
+  before(:each){ init_mailup }
+  
+  %w(send).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.email.should respond_to(method.to_sym)
+    end
+  end
+
+  it "should fire the correct POST request for send" do
+    email = "test@email.com"
+    id = rand(100).abs
+    @mailup.console.email.api.should_receive(:post).with("#{@mailup.console.email.api.path}/Email/Send", {body: {:idMessage => id, :Email => email}})
+    @mailup.console.email.send(id, email)
+  end
+
+end

data/spec/mailup/console/group_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe MailUp::Console::Group do
+  before(:each) { init_mailup }
+
+  %w(add_recipients recipients subscribe unsubscribe send_message).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.group(1).should respond_to(method.to_sym)
+    end
+  end
+
+  it "should fire the correct POST request for add_recipients" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.group(1).api.should_receive(:post).with("#{@mailup.console.group(1).api.path}/Group/1/Recipients", {body: payload})
+    @mailup.console.group(1).add_recipients(payload)
+  end
+
+  it "should fire the correct GET request for recipients" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.group(1).api.should_receive(:get).with("#{@mailup.console.group(1).api.path}/Group/1/Recipients", {params: {}})
+    @mailup.console.group(1).recipients
+  end
+
+  it "should fire the correct POST request for subscribe" do
+    id = rand(100).abs
+    @mailup.console.group(1).api.should_receive(:post).with("#{@mailup.console.group(1).api.path}/Group/1/Subscribe/#{id}")
+    @mailup.console.group(1).subscribe(id)
+  end
+
+  it "should fire the correct DELETE request for unsubscribe" do
+    id = rand(100).abs
+    @mailup.console.group(1).api.should_receive(:delete).with("#{@mailup.console.group(1).api.path}/Group/1/Unsubscribe/#{id}")
+    @mailup.console.group(1).unsubscribe(id)
+  end
+
+  it "should fire the correct POST request for send_message" do
+    id = rand(100).abs
+    @mailup.console.group(1).api.should_receive(:post).with("#{@mailup.console.group(1).api.path}/Group/1/Email/#{id}/Send")
+    @mailup.console.group(1).send_message(id)
+  end
+  
+end

data/spec/mailup/console/images_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe MailUp::Console::Images do
+  before(:each) { init_mailup }
+
+  %w(add_image delete_image list).each do |method|
+    it "should have a #{method} method" do
+      @mailup.console.images.should respond_to(method.to_sym)
+    end
+  end
+
+  it "should fire the correct GET request for list" do
+    @mailup.console.images.api.should_receive(:get).with("#{@mailup.console.images.api.path}/Images")
+    @mailup.console.images.list
+  end
+
+  it "should fire the correct POST request for add_image" do
+    payload = Date._jisx0301("empty hash, please")
+    @mailup.console.images.api.should_receive(:post).with("#{@mailup.console.images.api.path}/Images", {body: payload})
+    @mailup.console.images.add_image(payload)
+  end
+
+  it "should fire the correct DELETE request for delete_image" do
+    path = "/Test/Image/Path"
+    @mailup.console.images.api.should_receive(:delete).with("#{@mailup.console.images.api.path}/Images", {body: path})
+    @mailup.console.images.delete_image(path)
+  end
+
+end